AVM Provider

Automated Valuation Model Method

avm.get_provider(
    search_items, 
    csv=False, 
    output_dir='/output'
)

The AVM Provider provides metadata for an AVM provider.

This method returns an array of AVMProvider products for the given IDs. Optionally creates a csv file

(More information on the AVM Provider product can be found on the Provider Page on the First Street Foundation API Data Dictionary)

Arguments:

• search_items: list/file of int, provider ID to retrieve automated valuation model provider information for.
• csv: bool, whether to create a CSV for the retrieved data.
• output_dir: string, location to output the created CSV (if csv is True).

Example (Command Line):

Call avm.get_avm on a list of FSIDs

python -m firststreet -p avm.get_provider -s 2

Call avm.get_avm on a file of SearchItems

python -m firststreet -p avm.get_provider -s sample_provider.txt

Example (Python File):

# Contents of sample.py
# Create a `FirstStreet` object.  
import firststreet
fs = firststreet.FirstStreet("api-key")

# Call avm.get_avm on a list of FSIDs
provider = fs.avm.get_provider(search_items=[2], csv=True)

# Call avm.get_avm on a file of SearchItems
provider = fs.avm.get_provider(search_items="sample_provider.txt", csv=True)

AVM Provider Objects

AVM Provider Object

Key	Type	Description	Example
providerID	int	The canonical provider ID that provides the AVM	2
providerName	string	Provides the name of the AVM provider.	First Street Foundation
providerLogo	string	A URL representation of the providers company logo.