Welcome to the HouseCanary Analytics API! You can use the HouseCanary Analytics API to access HouseCanary's proprietary analytics as well as public records data.
\nThe HouseCanary API is based on REST.
\nThe base URL of the API is https://api.housecanary.com. All endpoints have request URLs with the following form: {BASE}/{ENDPOINT}.
Each property-data endpoint follows the form: {VERSION}/{LEVEL}/{TARGET}, where {VERSION} is either v2 or v3, {LEVEL} is one of the following values, and {TARGET} is the data descriptor such as value, rental_value, details, etc.
We also feature API endpoints dedicated to accomplishing other tasks, such as managing a portfolio of properties. These are listed below the \"level\" based property data endpoints:
\nNote that while most HouseCanary endpoints are v2 urls, there are a few new endpoints that utilize v3. Be sure to check each endpoint's documentation to confirm the correct base URL structure and version.
\nExample (v2): https://api.housecanary.com/v2/property/value has the version v2, level property, and a target of value, which comprise an endpoint v2/property/value.
Example (v3): https://api.housecanary.com/v3/property/hoa_est has the version v3, level property, and a target of hoa_est, which comprise an endpoint v3/property/hoa_est.
For brevity, we will skip the base URL in most of this document. If the shown URL starts with the slash, the corresponding full URL can always be obtained by prepending it with the base URL.
\nEach request URL allows accessing data for items that belong to the URL's level. Items can be specified by the identifiers in the Levels and Identifiers section.
\nGET request by specifying item identifiers in the query string.In both cases, the requested items are always members of the same level, that of the URL.
\nThe responses to both GET and POST requests are JSON arrays representing the sequence of data chunks, one chunk for each requested item, preserving the request sequence order:
GET requests will contain a single chunk, because the single item was requested.POST requests will contain as many chunks as there were items in the requested sequence.In order to use the HouseCanary API, you must obtain a credentials pair (API Key, API Secret) from your settings page.
Authentication of API requests is made using HTTP Basic Authentication. Use your API Key as the user name and your API Secret as the password for Basic Authentication. HTTPS must be used for all API requests. See the full request examples below that show how to authenticate with the API in various programming languages.
For Authentication failure information, see the Authentication Failures section below.
\nTest credentials are useful for verifying functionality in a development or staging environment. In order to generate test credentials (API Key, API Secret), go to your settings page and use the “New Test API Key” link.
Your test credentials can be used to make test requests. The HouseCanary API maintains a whitelist of items that can be used in test requests. See the Test Lists group of endpoints to retrieve test identifiers for use with test keys at each property-data entity level.
\nTo use the HouseCanary Analytics API, your user account must have permissions enabled for all API components that you want to access. You can check which components you have enabled in the “Analytics API” section of the API settings. If you have any questions about the components you have access to, contact support.
\nDifferent identifiers are used depending on the level of the URL. For example, properties are identified by their addresses, while residential blocks are identified by their census block IDs. The possible identifiers for each level are:
\nproperty: any combination of address, unit, state, city, and zipcode that identifies the US address. Usually, this is address and zipcode or address, city, state. Also, a slug can be used.block: a block_id.blockgroup: a blockgroup_id.zip: a zipcode.metrodiv: a metrodiv.msa: an msa.state: a 2-letter acronym of the US state.All possible identifiers and their descriptions are listed below:
\nUsing a GET request, you can retrieve data for a single item from an endpoint by specifying item identifiers in the query parameters.
GET https://api.housecanary.com/{VERSION}/{ENDPOINT}?{IDENTIFIERS}
{VERSION} is the version relevant to the endpoint you are calling, either v2 or v3.{ENDPOINT} is the specific endpoint you are calling, such as property/value.{IDENTIFIERS} is the URL-encoded string providing item identifiers as an ampersand-separated list of key=value pairs. Exact identifiers depend on the level of the URL, see Levels and Identifiers.Example URL separated into constituent segments:
\n{BASE}: https://api.housecanary.com{VERSION}: v2/{ENDPOINT}: zip/details{IDENTIFIERS}: zipcode=01234Then, combined together:
\n{BASE}/{ENDPOINT}?{IDENTIFIERS}:
https://api.housecanary.com/v2/zip/details?zipcode=01234
Example GET URLs:
\nhttps://api.housecanary.com/v2/property/geocode?address=10216+N+Willow+Ave&zipcode=64157https://api.housecanary.com/v2/property/value?address=10216+N+Willow+Ave&zipcode=64157https://api.housecanary.com/v2/property/value?address=65239+Rosanne+Prairie+St&city=Bayardchester&state=CAhttps://api.housecanary.com/v2/property/rental_value?slug=65239-Rosanne-Prairie-Bayardchester-CA-90113https://api.housecanary.com/v2/block/value_distribution?block_id=012345678901234https://api.housecanary.com/v2/zip/details?zipcode=01234https://api.housecanary.com/v2/msa/hpi_ts?msa=38060Using a POST request, you can retrieve data for multiple items by specifying a sequence of item identifiers in the POST body. We strongly recommend using POST requests for batching whenever possible.
\nNote: POST requests are only supported for the Analytics API. Value Report, Rental Report, and Value Analysis do not support POST requests.
\nPOST https://api.housecanary.com/{VERSION}/{ENDPOINT}
{VERSION} is the version relevant to the endpoint you are calling, either v2 or v3.
{ENDPOINT} is the specific endpoint you are calling, such as property/geocode.
Example POST URL format:
\nhttps://api.housecanary.com/v2/property/geocodehttps://api.housecanary.com/v2/property/component_mget?components=property/details,property/valueAll POST requests must have the Content-Type header set to application/json and the POST body must be a valid json array representing a sequence of requested item identifiers.
There is a limit of 100 items per POST request (i.e. 100 address + zipcode combinations, or 100 block_ids).
\nAll items in a single POST request must have the same set of keys. For property-level POST requests, either address or slug keys must be present for all items so HouseCanary can identify the specific properties.
Each item in the json array must contain one or more of the following keys:
\nExample POST body:
\n[\n {\n \"address\": \"10216 N Willow Ave\",\n \"zipcode\": \"64157\"\n },\n {\n \"address\": \"34813 SE Burrows Way\",\n \"zipcode\": \"98065\"\n }\n]\nThere are limits on how many API requests can be made in a certain period of time. You can see rate limits for your account in API Settings.
\nContact us or view API Settings for custom rate limits.
\nRate limits differ between the Analytics API endpoints and the Value Report endpoints. Rate limits for the Analytics API are counted by the number of components called. One component is the combination of a specific endpoint with an address or other geographic level identifier. Value Report and Value Analysis are rate limited based on number of HTTP requests in the time period.
\nGET property/geocode
\nGET property/component_mget with 2 endpoints specified
\nPOST property/geocode with 3 addresses in the body
\nPOST property/component_mget with 4 endpoints specified and 4 addresses in the body
\nCustom response headers are returned from the API to indicate rate limit information:
\nTLS 1.0, 1.1 and 1.2 are supported. SSL is not supported.
\nThe HouseCanary API is built leveraging the REST paradigm. Under normal conditions, the API will return a response with a 200 OK HTTP status code. If an error occurs, the response will contain the appropriate HTTP status code as described below.
\nBecause a single request can include multiple items or multiple endpoints, each response section returned in a normal 200 response will contain its own api_code and api_code_description fields. These are used to identify business logic errors for those items. The following values may be returned:
We do not charge for sections returned with a 204 api_code.
If one or more required fields for an endpoint are missing in the request, a 400 Bad Request status code will be returned, and the response body will contain an explanation of the error.
\nA common reason for a 400 response is missing required query parameters.
\nWe do not charge for requests that result in a response with a 400 status code.
\nIn the case of authentication failure, a 401 Unauthorized status code will be returned.
\nNote: In the case of an authentication failure, the system will return a 401 without any explanation or description. Should you have any questions on an auth failure, please contact HouseCanary technical support.
\nWe do not charge for requests that result in a response with a 401 status code.
\nIf your organization has made all the component requests allowed under your organization’s rate limit, a 429 Too Many Requests status code will be returned, and the response body will contain the message shown to the right. If you run into this error, you must wait until the UTC epoch time returned in the X-RateLimit-Reset header. If you need a large volume of data, HouseCanary is able to support significantly higher rate limits for enterprise customers. Contact us for more details.
\nWe do not charge for requests that result in a response with a 429 status code.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"HouseCanary Analytics API","slug":"housecanary-analytics-api"}],"owner":"32869976","collectionId":"a2c754cf-2ee8-42d7-85ae-1054ed2f8ff9","publishedId":"2sBXcLhdZN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-09T20:55:48.000Z"},"item":[{"name":"Property Level","item":[{"name":"Census Information","id":"25de159b-161c-487d-ad98-3e2263cea4d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.housecanary.com/v2/property/census?slug=123-Main-St-Apt-1-San-Francisco&address=123 Main St&unit=Apt 1&city=San Francisco&state=CA&zipcode=94105","description":"Identify US Census geographic areas for a given property, useful for demographic analysis and regional comparisons.
\nSource: Census TIGER Data
\nPricing Tier: Included with Subscription
\nUpdated: Annually
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| msa | string | 5-digit Metropolitan Statistical Area ID | 38060 | \n
| msa_name | string | The name of the requested MSA | San Francisco-Oakland-Berkeley, CA | \n
| tribal_land | string | Whether the property is on US-recognized tribal land | \n |
| tract | string | 11-digit 2020 US-census tract number | 060750201004 | \n
| block | string | 15-digit US-census block ID | 060750313013007 | \n
| block_group | string | 12-digit US-census block group ID | 060750201004 | \n
| county_name | string | The name of the county in which the property is located | San Francisco | \n
| fips | string | 5-digit US-census FIPS code for the county in which the property is located | 06075 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"3fb9edcf-befa-4296-b8ba-464e2d320a51","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicRetrieve data from multiple Analytics API endpoints in a single request, enabling efficient and consolidated data access.
\nProvide a comma separated list of property endpoint names in the components query parameter to specify which endpoints you would like to include.
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| components | string | Comma separated list of endpoints to include in the response. | property/details,property/school,property/value | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Comma separated list of endpoints to include in the response.
\n","type":"text/plain"},"key":"components","value":"property/details,property/school,property/value"}],"variable":[]}},"response":[{"id":"53bafc11-3fa6-41aa-8cbc-fc062379170c","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicRetrieve data from multiple Analytics API endpoints in a single request, enabling efficient and consolidated data access.
\nProvide a comma separated list of property endpoint names in the components query parameter to specify which endpoints you would like to include.
\n| Property | Type | Description | Example |
|---|---|---|---|
| components | string | Comma separated list of endpoints to include in the response. | property/details,property/school,property/value | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
Comma separated list of endpoints to include in the response.
\n","type":"text/plain"},"key":"components","value":"property/details,property/school,property/value"}],"variable":[]}},"response":[{"id":"a7317528-63e4-4c24-8bf6-a3d1abbc8482","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicAccess various property attributes from county assessor records, enabling comprehensive property profiling, along with HouseCanary data with additional information
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| type | string | Specify which results are returned updated | \n | [hc, public, both] |
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| subject_address | object | \n | ||
| subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| subject_address.city | string | City where property is located | San Francisco | \n|
| subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| subject_address.state | string | 2-character state abbreviation | CA | \n|
| subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| subject_address.address | string | Street address | 123 Main St | \n|
| subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| public_records | object | Public Record information | \n | |
| public_records.architectural_style | string | Architectural style of the property | Colonial | \n[A-Frame, Bungalow, Cape Cod, Colonial, Contemporary, Conventional, Cottage, Custom, Dome, English, French Provincial, Georgian, High-rise, Historical Log Cabin/Rustic, Mansion, Mediterranean, Modern, Other, Prefab, Modular, Raised Ranch, RanchRambler, Spanish, Traditional, Tudor, Unfinished/Under Construction, Victorian] |
| public_records.attic | string | Attic information | Finished | \n|
| public_records.basement | object | Basement details | \n | |
| public_records.basement.finished_pct | number | Percentage of finished basement | 75.5 | \n|
| public_records.basement.has | boolean | Indicates if the property has a basement | true | \n|
| public_records.basement.total_area | number | Total basement area | 1200 | \n|
| public_records.bathrooms | object | Bathroom information | \n | |
| public_records.bathrooms.full | integer | Number of full bathrooms | 2 | \n|
| public_records.bathrooms.partial | integer | Number of partial bathrooms | 1 | \n|
| public_records.bathrooms.total | number | Total number of bathrooms | 2.5 | \n|
| public_records.bathrooms.total_provided | string | Total number of bathrooms provided | 3 | \n|
| public_records.bathrooms.total_projected | number | Total number of projected bathrooms | 3.5 | \n|
| public_records.bedrooms | integer | Number of bedrooms | 4 | \n|
| public_records.buildings | integer | Number of buildings | 1 | \n|
| public_records.building_quality | string | Quality of the building | Excellent | \n|
| public_records.building_condition_code | string | Condition of the building | Excellent | \n|
| public_records.construction_types | array | Types of construction | \n | |
| public_records.construction_types[] | string | Wood Frame | \n||
| public_records.cooling | array | Cooling systems used | \n | |
| public_records.cooling[] | string | Central Air | \n||
| public_records.fireplace | string | Fireplace information | Gas | \n|
| public_records.fireplaces_total | integer | Total number of fireplaces | 1 | \n|
| public_records.heating | array | Heating systems used | \n | |
| public_records.heating[] | string | Forced air unit | \n[Baseboard, Central, Coal, Convection, Electric, Floor/Wall, Forced air unit, Gas, Geo-thermal, Gravity, Heat Pump, Hot Water, None, Oil, Other, Partial, Propane, Radiant, Solar, Space/Suspended, Steam, Vent, Wood Burning, Yes, Zone] | |
| public_records.legal_description | string | Legal description of the property | Lot 123, Block A, Subdivision X | \n|
| public_records.living_area | number | Total living area of the property (square feet) | 2400.4 | \n|
| public_records.living_area_above_grade | string | Total living area of the property above grade (square feet) | 1800 | \n|
| public_records.living_area_below_grade | string | Total living area of the property below grade (square feet) | 1800 | \n|
| public_records.lot_size | number | Size of the lot (square feet) | 10000 | \n|
| public_records.neighborhood | string | Neighborhood information | Suburban | \n|
| public_records.parcel_id | string | Identifier for the parcel on which the property sits | 1829264TC000011000060A | \n|
| public_records.parking | object | Parking information | \n | |
| public_records.parking.description | string | Description of parking | Attached Garage | \n|
| public_records.parking.garage | integer | Number of garage spaces | 2 | \n|
| public_records.parking.total | integer | Total number of parking spaces | 4 | \n|
| public_records.pool | boolean | Has a pool | true | \n|
| public_records.pool_community | boolean | Whether the property is part of a community with a shared pool | 1829264TC000011000060A | \n|
| public_records.property_type | string | Type of property | SFR | \n[SFR, Townhouse, Condominium, Manufactured/Mobile Home, Multi-Family, Land, Timeshare, Commercial, Other] |
| public_records.property_type_description | string | A description of the property type | Single Family Residential | \n|
| public_records.roof_material | string | The roofing material used on the main structure | Composition Shingle | \n|
| public_records.roof_type | string | Type of roof | Gable | \n[Bowstring Truss, Dome, Flat, Gable, Gable or Hip, Gambrel, Hip, Irr/Cathedral, Mansard, Prestress Concrete, Reinforced Concrete, Rigid frm bar JT, Sawtooth, Shed, Steel frm/truss, Wood Truss] |
| public_records.rooms_total | integer | Total number of rooms | 8 | \n|
| public_records.sewer | boolean | The type of sewer system on the property | Public | \n|
| public_records.sewer_public | boolean | Whether the property is connected to a public sewer system | true | \n|
| public_records.solar_panels | boolean | Whether solar panels are installed | true | \n|
| public_records.stories | integer | Number of above-grade levels of the main structure | 2 | \n|
| public_records.subdivision | boolean | Whether the property is part of a subdivision | true | \n|
| public_records.units_total | integer | 2 | \n||
| public_records.walls_exterior_material | string | Stucco | \n||
| public_records.water | string | The source of the property's water supply | City water | \n|
| public_records.year_built | integer | Year the property was built | 1995 | \n|
| public_records.zoning | object | Zoning information | \n | |
| public_records.zoning.code | string | The zoning code of the property | R-1 | \n|
| public_records.zoning.description | string | Description of zoning | This property is zoned as R-1, which designates it for single-family residential use | \n|
| hc | object | HouseCanary information | \n | |
| hc.architectural_style | string | Architectural style of the property | Contemporary | \n|
| hc.attic | string | Attic information | Unfinished | \n|
| hc.basement | object | Basement details | \n | |
| hc.basement.finished_pct | number | Percentage of finished basement | 50.2 | \n|
| hc.basement.has | boolean | Indicates if the property has a basement | \n | |
| hc.basement.total_area | number | Total basement area | 900 | \n|
| hc.bathrooms | object | Bathroom information | \n | |
| hc.bathrooms.full | integer | Number of full bathrooms | 3 | \n|
| hc.bathrooms.partial | integer | Number of partial bathrooms | 1 | \n|
| hc.bathrooms.total | number | Total number of bathrooms | 3.5 | \n|
| hc.bathrooms.total_provided | string | Total number of bathrooms provided | 4 | \n|
| hc.bathrooms.total_projected | number | Total number of projected bathrooms | 4.5 | \n|
| hc.bedrooms | integer | Number of bedrooms | 3 | \n|
| hc.buildings | integer | Number of buildings | 1 | \n|
| hc.building_quality | string | Quality of the building | Good | \n|
| hc.condition_class | integer | The current condition rating of the property as determined by HouseCanary | C4 | \n|
| hc.construction_types | array | Types of construction | \n | |
| hc.construction_types[] | string | Brick | \n||
| hc.cooling | array | Cooling systems used | \n | |
| hc.cooling[] | string | Ductless Mini Split | \n||
| hc.fireplace | string | Fireplace information | Wood Burning | \n|
| hc.fireplaces_total | integer | Total number of fireplaces | 2 | \n|
| hc.heating | array | Heating systems used | \n | |
| hc.heating[] | string | Radiant Heat | \n[Baseboard, Central, Coal, Convection, Electric, Floor/Wall, Forced air unit, Gas, Geo-thermal, Gravity, Heat Pump, Hot Water, None, Oil, Other, Partial, Propane, Radiant, Solar, Space/Suspended, Steam, Vent, Wood Burning, Yes, Zone] | |
| hc.legal_description | string | Legal description of the property | Lot 456, Block B, Subdivision Y | \n|
| hc.living_area | number | Total living area of the property (square feet) | 1800.4 | \n|
| hc.living_area_above_grade | string | Total living area of the property above grade (square feet) | 1800 | \n|
| hc.living_area_below_grade | string | Total living area of the property below grade (square feet) | 1800 | \n|
| hc.lot_size | integer | Size of the lot (square feet) | 7500 | \n|
| hc.neighborhood | string | Neighborhood information | Urban | \n|
| hc.parcel_id | string | Identifier for the parcel on which the property sits | 1829264TC000011000060A | \n|
| hc.parking | object | Parking information | \n | |
| hc.parking.description | string | Description of parking | Attached Garage | \n|
| hc.parking.garage | integer | Number of garage spaces | 2 | \n|
| hc.parking.total | integer | Total number of parking spaces | 4 | \n|
| hc.pool | boolean | Has a pool | true | \n|
| hc.pool_community | boolean | Whether the property is part of a community with a shared pool | 1829264TC000011000060A | \n|
| hc.property_type | string | Type of property | Condo | \n|
| hc.property_type_description | string | A description of the property type | Single Family Residential | \n|
| hc.roof_material | string | The roofing material used on the main structure | Composition Shingle | \n|
| hc.roof_type | string | Type of roof | Hip | \n|
| hc.rooms_total | integer | Total number of rooms | 6 | \n|
| hc.sewer | boolean | The type of sewer system on the property | Public | \n|
| hc.sewer_public | boolean | Whether the property is connected to a public sewer system | true | \n|
| hc.solar_panels | boolean | Whether solar panels are installed | true | \n|
| hc.stories | integer | Number of above-grade levels of the main structure | 2 | \n|
| hc.subdivision | boolean | Whether the property is part of a subdivision | true | \n|
| hc.units_total | integer | 2 | \n||
| hc.walls_exterior_material | string | Stucco | \n||
| hc.water | string | The source of the property's water supply | City water | \n|
| hc.year_built | integer | Year the property was built | 2008 | \n|
| hc.zoning | object | Zoning information | \n | |
| hc.zoning.code | string | The zoning code of the property | R-1 | \n|
| hc.zoning.description | string | Description of zoning | This property is zoned as R-1, which designates it for single-family residential use | \n|
| assessment | object | Details about the most recent assessment | \n | |
| assessment.apn | string | Assessor Parcel Number | 9876-54-0-00-789 | \n|
| assessment.amount_annual | number | Annual assessment amount | 6800.75 | \n|
| assessment.value_assessed | integer | Assessed value of the property | 350000 | \n|
| assessment.value_assessed_improvement | integer | Assessed value of improvements | 200000 | \n|
| assessment.value_assessed_land | integer | Assessed value of land | 150000 | \n|
| assessment.tax_year | integer | Tax year for assessment | 2023 | \n|
| assessment.year_assessed | integer | Year of assessment | 2022 | \n|
| errors | array | \n | ||
| errors[] | string | \n |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Specify which results are returned updated
\n","type":"text/plain"},"key":"type","value":"both"}],"variable":[]}},"response":[{"id":"22bdddb0-d507-452d-8ee3-5bc65d6fce28","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicAccess various property attributes from county assessor records, enabling comprehensive property profiling, along with HouseCanary data with additional information
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].subject_address | object | \n | ||
| [].subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| [].subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| [].subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| [].subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| [].subject_address.city | string | City where property is located | San Francisco | \n|
| [].subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| [].subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| [].subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| [].subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| [].subject_address.state | string | 2-character state abbreviation | CA | \n|
| [].subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| [].subject_address.address | string | Street address | 123 Main St | \n|
| [].subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| [].subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| [].subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| [].public_records | object | Public Record information | \n | |
| [].public_records.architectural_style | string | Architectural style of the property | Colonial | \n[A-Frame, Bungalow, Cape Cod, Colonial, Contemporary, Conventional, Cottage, Custom, Dome, English, French Provincial, Georgian, High-rise, Historical Log Cabin/Rustic, Mansion, Mediterranean, Modern, Other, Prefab, Modular, Raised Ranch, RanchRambler, Spanish, Traditional, Tudor, Unfinished/Under Construction, Victorian] |
| [].public_records.attic | string | Attic information | Finished | \n|
| [].public_records.basement | object | Basement details | \n | |
| [].public_records.basement.finished_pct | number | Percentage of finished basement | 75.5 | \n|
| [].public_records.basement.has | boolean | Indicates if the property has a basement | true | \n|
| [].public_records.basement.total_area | number | Total basement area | 1200 | \n|
| [].public_records.bathrooms | object | Bathroom information | \n | |
| [].public_records.bathrooms.full | integer | Number of full bathrooms | 2 | \n|
| [].public_records.bathrooms.partial | integer | Number of partial bathrooms | 1 | \n|
| [].public_records.bathrooms.total | number | Total number of bathrooms | 2.5 | \n|
| [].public_records.bathrooms.total_provided | string | Total number of bathrooms provided | 3 | \n|
| [].public_records.bathrooms.total_projected | number | Total number of projected bathrooms | 3.5 | \n|
| [].public_records.bedrooms | integer | Number of bedrooms | 4 | \n|
| [].public_records.buildings | integer | Number of buildings | 1 | \n|
| [].public_records.building_quality | string | Quality of the building | Excellent | \n|
| [].public_records.building_condition_code | string | Condition of the building | Excellent | \n|
| [].public_records.construction_types | array | Types of construction | \n | |
| [].public_records.construction_types[] | string | Wood Frame | \n||
| [].public_records.cooling | array | Cooling systems used | \n | |
| [].public_records.cooling[] | string | Central Air | \n||
| [].public_records.fireplace | string | Fireplace information | Gas | \n|
| [].public_records.fireplaces_total | integer | Total number of fireplaces | 1 | \n|
| [].public_records.heating | array | Heating systems used | \n | |
| [].public_records.heating[] | string | Forced air unit | \n[Baseboard, Central, Coal, Convection, Electric, Floor/Wall, Forced air unit, Gas, Geo-thermal, Gravity, Heat Pump, Hot Water, None, Oil, Other, Partial, Propane, Radiant, Solar, Space/Suspended, Steam, Vent, Wood Burning, Yes, Zone] | |
| [].public_records.legal_description | string | Legal description of the property | Lot 123, Block A, Subdivision X | \n|
| [].public_records.living_area | number | Total living area of the property (square feet) | 2400.4 | \n|
| [].public_records.living_area_above_grade | string | Total living area of the property above grade (square feet) | 1800 | \n|
| [].public_records.living_area_below_grade | string | Total living area of the property below grade (square feet) | 1800 | \n|
| [].public_records.lot_size | number | Size of the lot (square feet) | 10000 | \n|
| [].public_records.neighborhood | string | Neighborhood information | Suburban | \n|
| [].public_records.parcel_id | string | Identifier for the parcel on which the property sits | 1829264TC000011000060A | \n|
| [].public_records.parking | object | Parking information | \n | |
| [].public_records.parking.description | string | Description of parking | Attached Garage | \n|
| [].public_records.parking.garage | integer | Number of garage spaces | 2 | \n|
| [].public_records.parking.total | integer | Total number of parking spaces | 4 | \n|
| [].public_records.pool | boolean | Has a pool | true | \n|
| [].public_records.pool_community | boolean | Whether the property is part of a community with a shared pool | 1829264TC000011000060A | \n|
| [].public_records.property_type | string | Type of property | SFR | \n[SFR, Townhouse, Condominium, Manufactured/Mobile Home, Multi-Family, Land, Timeshare, Commercial, Other] |
| [].public_records.property_type_description | string | A description of the property type | Single Family Residential | \n|
| [].public_records.roof_material | string | The roofing material used on the main structure | Composition Shingle | \n|
| [].public_records.roof_type | string | Type of roof | Gable | \n[Bowstring Truss, Dome, Flat, Gable, Gable or Hip, Gambrel, Hip, Irr/Cathedral, Mansard, Prestress Concrete, Reinforced Concrete, Rigid frm bar JT, Sawtooth, Shed, Steel frm/truss, Wood Truss] |
| [].public_records.rooms_total | integer | Total number of rooms | 8 | \n|
| [].public_records.sewer | boolean | The type of sewer system on the property | Public | \n|
| [].public_records.sewer_public | boolean | Whether the property is connected to a public sewer system | true | \n|
| [].public_records.solar_panels | boolean | Whether solar panels are installed | true | \n|
| [].public_records.stories | integer | Number of above-grade levels of the main structure | 2 | \n|
| [].public_records.subdivision | boolean | Whether the property is part of a subdivision | true | \n|
| [].public_records.units_total | integer | 2 | \n||
| [].public_records.walls_exterior_material | string | Stucco | \n||
| [].public_records.water | string | The source of the property's water supply | City water | \n|
| [].public_records.year_built | integer | Year the property was built | 1995 | \n|
| [].public_records.zoning | object | Zoning information | \n | |
| [].public_records.zoning.code | string | The zoning code of the property | R-1 | \n|
| [].public_records.zoning.description | string | Description of zoning | This property is zoned as R-1, which designates it for single-family residential use | \n|
| [].hc | object | HouseCanary information | \n | |
| [].hc.architectural_style | string | Architectural style of the property | Contemporary | \n|
| [].hc.attic | string | Attic information | Unfinished | \n|
| [].hc.basement | object | Basement details | \n | |
| [].hc.basement.finished_pct | number | Percentage of finished basement | 50.2 | \n|
| [].hc.basement.has | boolean | Indicates if the property has a basement | \n | |
| [].hc.basement.total_area | number | Total basement area | 900 | \n|
| [].hc.bathrooms | object | Bathroom information | \n | |
| [].hc.bathrooms.full | integer | Number of full bathrooms | 3 | \n|
| [].hc.bathrooms.partial | integer | Number of partial bathrooms | 1 | \n|
| [].hc.bathrooms.total | number | Total number of bathrooms | 3.5 | \n|
| [].hc.bathrooms.total_provided | string | Total number of bathrooms provided | 4 | \n|
| [].hc.bathrooms.total_projected | number | Total number of projected bathrooms | 4.5 | \n|
| [].hc.bedrooms | integer | Number of bedrooms | 3 | \n|
| [].hc.buildings | integer | Number of buildings | 1 | \n|
| [].hc.building_quality | string | Quality of the building | Good | \n|
| [].hc.condition_class | integer | The current condition rating of the property as determined by HouseCanary | C4 | \n|
| [].hc.construction_types | array | Types of construction | \n | |
| [].hc.construction_types[] | string | Brick | \n||
| [].hc.cooling | array | Cooling systems used | \n | |
| [].hc.cooling[] | string | Ductless Mini Split | \n||
| [].hc.fireplace | string | Fireplace information | Wood Burning | \n|
| [].hc.fireplaces_total | integer | Total number of fireplaces | 2 | \n|
| [].hc.heating | array | Heating systems used | \n | |
| [].hc.heating[] | string | Radiant Heat | \n[Baseboard, Central, Coal, Convection, Electric, Floor/Wall, Forced air unit, Gas, Geo-thermal, Gravity, Heat Pump, Hot Water, None, Oil, Other, Partial, Propane, Radiant, Solar, Space/Suspended, Steam, Vent, Wood Burning, Yes, Zone] | |
| [].hc.legal_description | string | Legal description of the property | Lot 456, Block B, Subdivision Y | \n|
| [].hc.living_area | number | Total living area of the property (square feet) | 1800.4 | \n|
| [].hc.living_area_above_grade | string | Total living area of the property above grade (square feet) | 1800 | \n|
| [].hc.living_area_below_grade | string | Total living area of the property below grade (square feet) | 1800 | \n|
| [].hc.lot_size | integer | Size of the lot (square feet) | 7500 | \n|
| [].hc.neighborhood | string | Neighborhood information | Urban | \n|
| [].hc.parcel_id | string | Identifier for the parcel on which the property sits | 1829264TC000011000060A | \n|
| [].hc.parking | object | Parking information | \n | |
| [].hc.parking.description | string | Description of parking | Attached Garage | \n|
| [].hc.parking.garage | integer | Number of garage spaces | 2 | \n|
| [].hc.parking.total | integer | Total number of parking spaces | 4 | \n|
| [].hc.pool | boolean | Has a pool | true | \n|
| [].hc.pool_community | boolean | Whether the property is part of a community with a shared pool | 1829264TC000011000060A | \n|
| [].hc.property_type | string | Type of property | Condo | \n|
| [].hc.property_type_description | string | A description of the property type | Single Family Residential | \n|
| [].hc.roof_material | string | The roofing material used on the main structure | Composition Shingle | \n|
| [].hc.roof_type | string | Type of roof | Hip | \n|
| [].hc.rooms_total | integer | Total number of rooms | 6 | \n|
| [].hc.sewer | boolean | The type of sewer system on the property | Public | \n|
| [].hc.sewer_public | boolean | Whether the property is connected to a public sewer system | true | \n|
| [].hc.solar_panels | boolean | Whether solar panels are installed | true | \n|
| [].hc.stories | integer | Number of above-grade levels of the main structure | 2 | \n|
| [].hc.subdivision | boolean | Whether the property is part of a subdivision | true | \n|
| [].hc.units_total | integer | 2 | \n||
| [].hc.walls_exterior_material | string | Stucco | \n||
| [].hc.water | string | The source of the property's water supply | City water | \n|
| [].hc.year_built | integer | Year the property was built | 2008 | \n|
| [].hc.zoning | object | Zoning information | \n | |
| [].hc.zoning.code | string | The zoning code of the property | R-1 | \n|
| [].hc.zoning.description | string | Description of zoning | This property is zoned as R-1, which designates it for single-family residential use | \n|
| [].assessment | object | Details about the most recent assessment | \n | |
| [].assessment.apn | string | Assessor Parcel Number | 9876-54-0-00-789 | \n|
| [].assessment.amount_annual | number | Annual assessment amount | 6800.75 | \n|
| [].assessment.value_assessed | integer | Assessed value of the property | 350000 | \n|
| [].assessment.value_assessed_improvement | integer | Assessed value of improvements | 200000 | \n|
| [].assessment.value_assessed_land | integer | Assessed value of land | 150000 | \n|
| [].assessment.tax_year | integer | Tax year for assessment | 2023 | \n|
| [].assessment.year_assessed | integer | Year of assessment | 2022 | \n|
| [].errors | array | \n | ||
| [].errors[] | string | \n |
Access various property attributes from county assessor records, enabling comprehensive property profiling.
\nSource: Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| property | object | Property information sourced from county public record | \n | |
| property.no_of_buildings | number | Number of buildings | 2 | \n|
| property.attic | boolean | true if home has attic. false otherwise | \n | |
| property.total_bath_count | number | Total bathroom count as recorded by the assessor | 2.5 | \n|
| property.full_bath_count | number | Count of full bathrooms as recorded by the assessor | 2 | \n|
| property.partial_bath_count | number | Partial bathroom count, if provided by the county assessor | 0.5 | \n|
| property.total_number_of_rooms | number | Total number of rooms in the property, including bedrooms, living rooms, kitchens, and other finished spaces. This does not include bathrooms | 5 | \n|
| property.heating | string | Type of heating unit. One of [Yes, No, Baseboard, Central, Coal, Convection, Electric, Floor/Wall, Forced air unit, Gas, Geo-thermal, Gravity, Heat Pump, Hot Water, None, Oil, Other, Partial, Propane, Radiant, Solar, Space/Suspended, Steam, Vent, Wood Burning, Yes, Zone] | forced_air_unit | \n[yes, no, baseboard, central, coal, convection, electric, floor_wall, forced_air_unit, gas, geo_thermal, gravity, heat_pump, hot_water, none, oil, other, partial, propane, radiant, solar, space_suspended, steam, vent, wood_burning, yes, zone] |
| property.heating_fuel_type | string | Type of fuel or energy source used for the property’s primary heating system | gas | \n[coal, electric, gas, geo_thermal, none, oil, propane] |
| property.style | string | Property architectural style. One of [A-Frame, Bungalow, Cape Cod, Colonial, Contemporary, Conventional, Cottage, Custom, Dome, English, French Provincial, Georgian, High-rise, Historical, Log Cabin/Rustic, Mansion, Mediterranean, Modern, Other, Prefab, Modular, Raised Ranch, Ranch/Rambler, Spanish, Traditional, Tudor, Unfinished/Under Construction, Victorian] | a_frame | \n[a_frame, bungalow, cape_cod, colonial, contemporary, conventional, cottage, custom, dome, english, french_provincial, georgian, high_rise, historical, log_cabin_rustic, mansion, mediterranean, modern, other, prefab, modular, raised_ranch, ranch_rambler, spanish, traditional, tudor, unfinished_under_construction, victorian] |
| property.garage_parking_of_cars | number | Number of cars that can be parked in garage areas | 1 | \n|
| property.site_area_acres | number | Total area of the land in acres | 2.5 | \n|
| property.number_of_units | number | Number of units | 20 | \n|
| property.building_area_sq_ft | number | Area of building(s) in square feet | 1974 | \n|
| property.garage_type_parking | string | Type of parking area. One of [Attached Garage, Built-in, Carport, Covered, Detached Garage, Garage, Mixed, None, Offsite, Open, Parking Lot, Parking Structure, Paved/Surfaced, Pole, Ramp, Tuckunder, Underground/Basement, Unimproved, Yes] | carport | \n[attached_garage, built_in, carport, covered, detached_garage, garage, mixed, none, offsite, open, parking_lot, parking_structure, paved_surfaced, pole, ramp, tuckunder, underground_basement, unimproved, yes] |
| property.basement | string | Description of basement. One of [Full Basement, Daylight Full, Full, Improved Basement Finished, Daylight Partial, No Basement, Full Basement, No Basement, Partial Basement, Unfinished Basement] | full_basement | \n[full_basement, daylight_full, full, improved_basement_finished, daylight_partial, no_basement, full_basement, no_basement, partial_basement, unfinished_basement] |
| property.air_conditioning | string | yes if home has air conditioning. no otherwise | yes | \n[yes, no] |
| property.fireplace | string | true if home has fireplace. false otherwise | gas | \n|
| property.pool | boolean | Whether the property has a pool | true | \n|
| property.no_of_stories | number | Number of floors | 3 | \n|
| property.water | string | Water connection. One of [Cistern, Municipal, None, Spring, Well, Yes] | municipal | \n[cistern, municipal, none, spring, well, yes] |
| property.year_built | number | Year the property was constructed | 2005 | \n|
| property.exterior_walls | string | Type of exterior walls. One of [Adobe, Asbestos shingle, Block, Brick, Brick veneer, Combination, Composition, Concrete, Concrete Block, Glass, Log, Marble, Masonry, Metal, Other, Rock, Stone, Shingle (Not Wood), Siding (Alum/Vinyl), Stucco, Tile, Tilt-up (pre-cast concrete), Wood, Wood Shingle, Wood Siding] | wood | \n[adobe, asbestos_shingle, block, brick, brick_veneer, combination, composition, concrete, concrete_block, glass, log, marble, masonry, metal, other, rock, stone, shingle_not_wood, siding_alum_vinyl, stucco, tile, tilt_up_pre_cast_concrete, wood, wood_shingle, wood_siding] |
| property.number_of_bedrooms | number | Number of bedrooms | 5 | \n|
| property.sewer | string | Sewage connection. One of [Municipal, None, Storm, Septic, Yes] | public | \n[municipal, none, storm, septic, yes] |
| property.property_type | string | Type of property | Single Family Residential | \n[Single Family Residential, Townhouse, Condominium, Manufactured/Mobile Home, Multi-Family, Land, Timeshare, Commercial, Other] |
| property.subdivision | string | Subdivision as reported to the assessor | Pinecrest Estates | \n|
| property.building_quality_score | number | Possible building quality score. Values range from 1 to 5. 5 = A grade, 4 = B grade, 4 = C grade, 2 = D grade, 1 = E grade | 2 | \n|
| property.building_condition_score | number | Possible building condition score. Values range from 1 to 5. 5 = Excellent, 4 = Good, 3 = Fair, 2 = Poor, 1 = Unsound | 2 | \n|
| property.construction_type | string | Primary construction material. One of [Adobe, Brick, Concrete, Concrete Block, Dome, Frame, Heavy, Light, Log, Manufactured, Other, Masonry, Metal, Steel, Stone, Tilt-up (pre-cast concrete), Wood, Mixed] | Dome | \n[Adobe, Brick, Concrete, Concrete Block, Dome, Frame, Heavy, Light, Log, Manufactured, Other, Masonry, Metal, Steel, Stone, Tilt-up (pre-cast concrete), Wood, Mixed] |
| property.roof_cover | string | Material the roof is made of. One of [Aluminum, Asbestos, Asphalt, Bermuda, Built-up, Composition Shingle, Concrete, Fiberglass, Gravel/Rock, Gypsum, Masonite/ Cement Shake, Metal, Other, Roll Composition, Slate, Steel, Shingle (Not Wood), Tar & Gravel, Tile, Urethane, Wood, Wood Shake/ Shingles] | Asphalt | \n[Aluminum, Asbestos, Asphalt, Bermuda, Built-up, Composition Shingle, Concrete, Fiberglass, Gravel/Rock, Gypsum, Masonite/ Cement Shake, Metal, Other, Roll Composition, Slate, Steel, Shingle (Not Wood), Tar & Gravel, Tile, Urethane, Wood, Wood Shake/ Shingles] |
| property.roof_type | string | Roof structure. One of [Bowstring Truss, Dome,Flat, Gable, Gable or Hip, Gambrel, Hip, Irr/Cathedral, Mansard, Prestress Concrete, Reinforced Concrete, Rigid frm bar JT, Sawtooth, Shed, Steel frm/truss, Wood Truss] | Dome | \n[Bowstring Truss, Dome, Flat, Gable, Gable or Hip, Gambrel, Hip, Irr/Cathedral, Mansard, Prestress Concrete, Reinforced Concrete, Rigid frm bar JT, Sawtooth, Shed, Steel frm/truss, Wood Truss] |
| property.zoning | string | County-specific property zoning | R-1 Residential | \n|
| assessment | object | Details about the most recent assessment | \n | |
| assessment.apn | string | Assessor's Parcel Number or Parcel Identification Number | 167-77-021 | \n|
| assessment.assessment_year | number | Year the assessment was conducted | 2023 | \n|
| assessment.tax_amount | number | Amount in dollars of tax owed on the property | 3500.75 | \n|
| assessment.total_assessed_value | number | The total current assessed value of both land and improvements (before exemptions, if any) as reported on the county tax/assessment roll. | 500000 | \n|
| assessment.tax_year | number | Tax year for which the assessment applies | 2022 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"6c9e1710-cc24-43f7-bc95-dd27a627d8a2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicOur Property Value Estimation API gives a rough idea of a property's current worth within a set range of accuracy. It uses a reliable Automated Valuation Model and a special rounding method to ensure fairness and security. This method balances speed and accuracy, providing useful estimates for different property types while aiming to be as unbiased as possible
\nSource: HouseCanary
\nPricing Tier: Basic
\nUpdated: 15 minutes
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| estimate | integer | Estimated value | \n | |
| subject_address | object | \n | ||
| subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| subject_address.city | string | City where property is located | San Francisco | \n|
| subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| subject_address.state | string | 2-character state abbreviation | CA | \n|
| subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| subject_address.address | string | Street address | 123 Main St | \n|
| subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"778b07d4-1102-4373-bdf2-4f3e258d51fc","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicOur Property Value Estimation API gives a rough idea of a property's current worth within a set range of accuracy. It uses a reliable Automated Valuation Model and a special rounding method to ensure fairness and security. This method balances speed and accuracy, providing useful estimates for different property types while aiming to be as unbiased as possible
\nSource: HouseCanary
\nPricing Tier: Refer to Pricing Page
\nUpdated: 15 minutes
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].estimate | integer | Estimated value | \n | |
| [].subject_address | object | \n | ||
| [].subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| [].subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| [].subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| [].subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| [].subject_address.city | string | City where property is located | San Francisco | \n|
| [].subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| [].subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| [].subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| [].subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| [].subject_address.state | string | 2-character state abbreviation | CA | \n|
| [].subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| [].subject_address.address | string | Street address | 123 Main St | \n|
| [].subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| [].subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| [].subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| [].errors | array | \n | ||
| [].errors[] | string | \n |
Acquire details on open FEMA disaster declarations for a property's county, informing risk assessments and insurance needs.
\nSource: FEMA
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum number of items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on declared_date, in ISO 8601 format | 2019-01-01 | \n|
| end | string | Ending date limit for result items, based on declared_date, in ISO 8601 format | 2019-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| data_current_to | string | The most recent date that data was retrieved from the FEMA API (in ISO format) | 2023-08-10 | \n
| in_disaster_area | boolean | Indicates if there is at least one open disaster for the county where the property is located | true | \n
| details | array | List of open disasters in the area | \n |
| details[] | object | \n | |
| details[].declared_date | string | The date the disaster was declared | 2023-07-15 | \n
| details[].end_date | string | The date the incident itself ended | 2023-08-05T12:00:00Z | \n
| details[].fema_disaster_num | integer | Number assigned to designate an event or incident declared as a disaster | 12345 | \n
| details[].fips | string | 5-digit FIPS county code | 12345 | \n
| details[].start_date | string | The date the incident itself began | 2023-06-30T08:00:00Z | \n
| details[].title | string | The proper name or description of the disaster, as provided by FEMA. i.e. HURRICANE MARIA, FLOODING, SEVERE STORMS | Severe Storm and Flood | \n
| details[].type | string | The specific category for the disaster i.e. Coastal Storm, Drought, Flood, Snow, Hurricane, Wildfire | Flood | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum number of items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on declared_date, in ISO 8601 format
\n","type":"text/plain"},"key":"start","value":"2019-01-01"},{"description":{"content":"Ending date limit for result items, based on declared_date, in ISO 8601 format
\n","type":"text/plain"},"key":"end","value":"2019-01-01"}],"variable":[]}},"response":[{"id":"dc72ee0c-afcc-4e12-ae97-f0ef01c5ce9b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicAcquire details on open FEMA disaster declarations for a property's county, informing risk assessments and insurance needs.
\nSource: FEMA
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum number of items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on declared_date, in ISO 8601 format | 2019-01-01 | \n|
| end | string | Ending date limit for result items, based on declared_date, in ISO 8601 format | 2019-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| data_current_to | string | The most recent date that data was retrieved from the FEMA API (in ISO format) | 2023-08-10 | \n
| in_disaster_area | boolean | Indicates if there is at least one open disaster for the county where the property is located | true | \n
| details | array | List of open disasters in the area | \n |
| details[] | object | \n | |
| details[].declared_date | string | The date the disaster was declared | 2023-07-15 | \n
| details[].end_date | string | The date the incident itself ended | 2023-08-05T12:00:00Z | \n
| details[].fema_disaster_num | integer | Number assigned to designate an event or incident declared as a disaster | 12345 | \n
| details[].fips | string | 5-digit FIPS county code | 12345 | \n
| details[].start_date | string | The date the incident itself began | 2023-06-30T08:00:00Z | \n
| details[].title | string | The proper name or description of the disaster, as provided by FEMA. i.e. HURRICANE MARIA, FLOODING, SEVERE STORMS | Severe Storm and Flood | \n
| details[].type | string | The specific category for the disaster i.e. Coastal Storm, Drought, Flood, Snow, Hurricane, Wildfire | Flood | \n
Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum number of items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on declared_date, in ISO 8601 format
\n","type":"text/plain"},"key":"start","value":"2019-01-01"},{"description":{"content":"Ending date limit for result items, based on declared_date, in ISO 8601 format
\n","type":"text/plain"},"key":"end","value":"2019-01-01"}],"variable":[]}},"response":[{"id":"67f364be-183e-44d4-bde7-b12623a3ee52","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicRetrieve FEMA flood risk data for properties, essential for evaluating potential hazards and insurance requirements.
\nSource: FEMA
\nPricing Tier: Basic
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| effective_date | string | Date the flood risk assessment took effect (in ISO format) | 2023-08-10 | \n
| flood_risk | string | Level of flood risk | Moderate | \n
| zone | string | Flood zone the property is in. Zone descriptions | AE | \n
| panel_number | string | Flood map panel number that includes the property | 12345C0123E | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"def36add-75fc-4763-967d-2114f0ac7878","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicRetrieve FEMA flood risk data for properties, essential for evaluating potential hazards and insurance requirements.
\nSource: FEMA
\nPricing Tier: Basic
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| effective_date | string | Date the flood risk assessment took effect (in ISO format) | 2023-08-10 | \n
| flood_risk | string | Level of flood risk | Moderate | \n
| zone | string | Flood zone the property is in. Zone descriptions | AE | \n
| panel_number | string | Flood map panel number that includes the property | 12345C0123E | \n
Obtain a full geocoder response for property addresses, including resolution status and encountered issues. Responses also include the resolved canonical address as recorded in HouseCanary's systems.
\nSource: USPS Cass Certified System
\nPricing Tier: Included with Subscription
\nUpdated: Quarterly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| boolean | \n |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"088dfa43-a3d9-4e68-bbd3-0e75c25df604","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain a full geocoder response for property addresses, including resolution status and encountered issues. Responses also include the resolved canonical address as recorded in HouseCanary's systems.
\nSource: USPS Cass Certified System
\nPricing Tier: Included with Subscription
\nUpdated: Quarterly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| boolean | \n |
This endpoint provides geographic attributes of the property, including backyard exposure angle, backyard slope, backyard view angle, elevation, frontage length, orientation, privacy score by blockgroup and county, and view angle.
\nPricing Tier: Basic
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| backyard_exposure_angle | integer | Measurement of how easily neighbors can see into the property and backyard, thus potentially mitigating privacy. Value is the angle (in degrees) exposed to backyard neighbors. Values range from 0 to 180. | 120 | \n
| backyard_slope | integer | The slope (in degrees) along the centerline of the backyard view angle. Values range from -90 to 90. Negative values indicate downhill views, 0 is horizontal, and positive values indicate uphill views. | -10 | \n
| backyard_view_angle | integer | Measurement of maximum angle (in degrees) that opens up to scenery or nature from the backyard. Values range from 0 to 180. | 150 | \n
| elevation | integer | The height (in meters) of a property in relation to sea level. | 200 | \n
| frontage_length | integer | The length (in feet) of the parcel frontage. | 75 | \n
| orientation | integer | Direction (in degrees) that the front of the house faces. | 180 | \n
| privacy_score_blockgroup | integer | HouseCanary proprietary summary of the geographic attributes of a parcel relative to other parcels in the census blockgroup. Values range from 0 to 100. Higher values indicate greater privacy. | 85 | \n
| privacy_score_county | integer | HouseCanary proprietary summary of the geographic attributes of a parcel relative to other parcels in the county. Values range from 0 to 100. Higher values indicate greater privacy. | 75 | \n
| view_angle | integer | Maximum angle (in degrees) that one can view the surrounding area by standing at the center of a parcel. Values range from 0 to 360. | 270 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"2754e6fc-f5e1-4512-983d-5b671d8d551a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicThis endpoint provides geographic attributes of the property, including backyard exposure angle, backyard slope, backyard view angle, elevation, frontage length, orientation, privacy score by blockgroup and county, and view angle.
\nPricing Tier: Basic
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| backyard_exposure_angle | integer | Measurement of how easily neighbors can see into the property and backyard, thus potentially mitigating privacy. Value is the angle (in degrees) exposed to backyard neighbors. Values range from 0 to 180. | 120 | \n
| backyard_slope | integer | The slope (in degrees) along the centerline of the backyard view angle. Values range from -90 to 90. Negative values indicate downhill views, 0 is horizontal, and positive values indicate uphill views. | -10 | \n
| backyard_view_angle | integer | Measurement of maximum angle (in degrees) that opens up to scenery or nature from the backyard. Values range from 0 to 180. | 150 | \n
| elevation | integer | The height (in meters) of a property in relation to sea level. | 200 | \n
| frontage_length | integer | The length (in feet) of the parcel frontage. | 75 | \n
| orientation | integer | Direction (in degrees) that the front of the house faces. | 180 | \n
| privacy_score_blockgroup | integer | HouseCanary proprietary summary of the geographic attributes of a parcel relative to other parcels in the census blockgroup. Values range from 0 to 100. Higher values indicate greater privacy. | 85 | \n
| privacy_score_county | integer | HouseCanary proprietary summary of the geographic attributes of a parcel relative to other parcels in the county. Values range from 0 to 100. Higher values indicate greater privacy. | 75 | \n
| view_angle | integer | Maximum angle (in degrees) that one can view the surrounding area by standing at the center of a parcel. Values range from 0 to 360. | 270 | \n
Estimate annual HOA fees for properties using HouseCanary's proprietary algorithms, important for budgeting and investment calculations.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Annually
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| subject_address | object | \n | ||
| subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| subject_address.city | string | City where property is located | San Francisco | \n|
| subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| subject_address.state | string | 2-character state abbreviation | CA | \n|
| subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| subject_address.address | string | Street address | 123 Main St | \n|
| subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| association_estimated | object | Object containing estimated HOA data for the subject property | \n | |
| association_estimated.annual_hoa_est | integer | Quantitatively derived value of the property's estimated annual hoa fees | 1200 | \n|
| association_estimated.max_fee | integer | Quantitatively derived value of the property's estimated maximum hoa fees | 1500 | \n|
| association_estimated.min_fee | integer | Quantitatively derived value of the property's estimated minimum hoa fees | 1000 | \n|
| association_estimated.n_samples | integer | Number of reference properties used by our proprietary algorithm to determine estimated hoa fees | 50 | \n|
| association_estimated.subdivision | string | Subdivision name | Oakridge Estates | \n|
| association_estimated.subdivision_id | string | Corresponding subdivision ID | 12345 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"1278da91-ad63-4e0f-bdc6-c21532656863","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEstimate annual HOA fees for properties using HouseCanary's proprietary algorithms, important for budgeting and investment calculations.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Annually
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].subject_address | object | \n | ||
| [].subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| [].subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| [].subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| [].subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| [].subject_address.city | string | City where property is located | San Francisco | \n|
| [].subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| [].subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| [].subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| [].subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| [].subject_address.state | string | 2-character state abbreviation | CA | \n|
| [].subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| [].subject_address.address | string | Street address | 123 Main St | \n|
| [].subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| [].subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| [].subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| [].association_estimated | object | Object containing estimated HOA data for the subject property | \n | |
| [].association_estimated.annual_hoa_est | integer | Quantitatively derived value of the property's estimated annual hoa fees | 1200 | \n|
| [].association_estimated.max_fee | integer | Quantitatively derived value of the property's estimated maximum hoa fees | 1500 | \n|
| [].association_estimated.min_fee | integer | Quantitatively derived value of the property's estimated minimum hoa fees | 1000 | \n|
| [].association_estimated.n_samples | integer | Number of reference properties used by our proprietary algorithm to determine estimated hoa fees | 50 | \n|
| [].association_estimated.subdivision | string | Subdivision name | Oakridge Estates | \n|
| [].association_estimated.subdivision_id | string | Corresponding subdivision ID | 12345 | \n
HouseCanary's flagship historical automated property value estimate.
\nHouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nPricing Tier: Premium
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| date | string | Date (YYYY-MM-DD) or UTC timestamp of historical value | \"2021-06-01\" or \"2022-03-01T12:34:56Z\" | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| historical_value | object | \n | ||
| historical_value.price_mean | integer | HouseCanary automated monthly home value. Created using a robust model ensemble methodology. | 325000 | \n|
| historical_value.price_upr | integer | HouseCanary AVM upper bound. Calculated as price_mean * (1 + fsd) | 340000 | \n|
| historical_value.price_lwr | integer | HouseCanary AVM lower bound. Calculated as price_mean * (1 - fsd) | 310000 | \n|
| historical_value.fsd | integer | HouseCanary forecast standard deviation for the HouseCanary AVM | 0.05 | \n|
| historical_value.date | string | Date (YYYY-MM-DD) or UTC timestamp of historical value | 2021-06-01 | \n|
| subject_address | object | \n | ||
| subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| subject_address.city | string | City where property is located | San Francisco | \n|
| subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| subject_address.state | string | 2-character state abbreviation | CA | \n|
| subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| subject_address.address | string | Street address | 123 Main St | \n|
| subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| errors | array | \n | ||
| errors[] | string | \n |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Date (YYYY-MM-DD) or UTC timestamp of historical value
\n","type":"text/plain"},"key":"date","value":"\"2021-06-01\" or \"2022-03-01T12:34:56Z\""}],"variable":[]}},"response":[{"id":"763d46e5-bb7f-431e-8f73-c7df09885996","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's flagship historical automated property value estimate.
\nHouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nPricing Tier: Premium
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].subject | object | \n | |
| [].subject.slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].subject.address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].subject.unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].subject.city | string | City in which the property is located | San Francisco | \n
| [].subject.state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].subject.zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| [].date | string | Date (YYYY-MM-DD) or UTC timestamp of historical value | \"2021-06-01\" or \"2022-03-01T12:34:56Z\" | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | Object containing estimated historical AVM data for the subject property | \n | |
| [].historical_value | object | \n | ||
| [].historical_value.price_mean | integer | HouseCanary automated monthly home value. Created using a robust model ensemble methodology. | 325000 | \n|
| [].historical_value.price_upr | integer | HouseCanary AVM upper bound. Calculated as price_mean * (1 + fsd) | 340000 | \n|
| [].historical_value.price_lwr | integer | HouseCanary AVM lower bound. Calculated as price_mean * (1 - fsd) | 310000 | \n|
| [].historical_value.fsd | integer | HouseCanary forecast standard deviation for the HouseCanary AVM | 0.05 | \n|
| [].historical_value.date | string | Date (YYYY-MM-DD) or UTC timestamp of historical value | \"2021-06-01\" | \n|
| [].subject_address | object | \n | ||
| [].subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| [].subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| [].subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| [].subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| [].subject_address.city | string | City where property is located | San Francisco | \n|
| [].subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| [].subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| [].subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| [].subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| [].subject_address.state | string | 2-character state abbreviation | CA | \n|
| [].subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| [].subject_address.address | string | Street address | 123 Main St | \n|
| [].subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| [].subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| [].subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| [].errors | array | \n | ||
| [].errors[] | string | \n |
HouseCanary's automated land value estimate, assisting in land pricing and investment analysis.
\nHouseCanary's proprietary Automated Land Valuation Model utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of the land contained on the parcel. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| value_mean | integer | HouseCanary automated monthly land value. Created using a robust model ensemble methodology | 150000 | \n
| value_upr | integer | HouseCanary land AVM upper bound. Calculated as value_mean * (1 + fsd) | 165000 | \n
| value_lwr | integer | HouseCanary land AVM lower bound. Calculated as value_mean * (1 - fsd) | 135000 | \n
| fsd | number | HouseCanary forecast standard deviation for the HouseCanary land AVM | 0.1 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"16ea0794-cc10-4235-9e95-4627becb21bb","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's automated land value estimate, assisting in land pricing and investment analysis.
\nHouseCanary's proprietary Automated Land Valuation Model utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of the land contained on the parcel. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| value_mean | integer | HouseCanary automated monthly land value. Created using a robust model ensemble methodology | 150000 | \n
| value_upr | integer | HouseCanary land AVM upper bound. Calculated as value_mean * (1 + fsd) | 165000 | \n
| value_lwr | integer | HouseCanary land AVM lower bound. Calculated as value_mean * (1 - fsd) | 135000 | \n
| fsd | number | HouseCanary forecast standard deviation for the HouseCanary land AVM | 0.1 | \n
Access comprehensive LTV data for properties, supporting mortgage and refinance decision-making. Access comprehensive data on the estimated loan-to-value ratio (LTV) for properties. Receive granular information on grantors, grantees, monthly payments, current interest rates, original lien amounts, loan duration, progress made, outstanding principal, principal paid, record and due dates, ARM specifics, and more. Additionally, the endpoint delivers summary data covering equity, monthly payments, lien amounts, notice IDs, and property valuations.
\nActive liens' paydown is calculated based on available lien terms, factoring in details such as ARM and interest-only periods when applicable. The response includes a sorted list of notice IDs with corresponding descriptions, which highlight findings during LTV generation and their usual impact on the calculation. This is particularly useful for helping drive refinancing or loan origination analysis.
\nSource: HouseCanary, Public Records, Freddie Mac
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| as_of_month | string | Year and month of the processing date for the loan to value calculation | 2023-07 | \n|
| fsd | number | Forecast standard deviation for the Housecanary AVM as of the as_of_month | 0.08 | \n|
| in_default | boolean | Whether the lien is in default | true | \n|
| last_default_date | string | Date of last default, if one exists | 2022-12-20 | \n|
| ltv_lwr | number | Estimated LTV lower bound. Calculated as total_lien / property_value_upr | 0.8 | \n|
| ltv_mean | number | Estimated LTV. Calculated as total_lien / property_value_upr | 0.75 | \n|
| ltv_upr | number | Estimated LTV upper bound. Calculated as total_lien / property_value_lwr | 0.78 | \n|
| property_value_lwr | integer | HouseCanary lower bound AVM as of the as_of_month | 350000 | \n|
| property_value_mean | integer | HouseCanary automated monthly value AVM as of the as_of_month. Created using a robust model ensemble methodology. | 375000 | \n|
| property_value_upr | integer | HouseCanary upper bound AVM as of the as_of_month | 390000 | \n|
| total_equity_lwr | integer | Lower bound estimated equity as of the as_of_month. Calculated as property_value_lwr - total_lien. | 75000 | \n|
| total_equity_mean | integer | Mean estimated equity as of the as_of_month. Calculated as property_value_mean - total_lien. | 80000 | \n|
| total_equity_upr | integer | Upper bound estimated equity as of the as_of_month. Calculated as property_value_upr - total_lien. | 85000 | \n|
| total_lien | integer | Estimated total lien amount currently on the property | 300000 | \n|
| total_monthly_payments | integer | Estimated total monthly payments. Sum of all monthly_payment values of current_liens. | 1800 | \n|
| total_notice_ids | array | Complete list of all notice_ids on all liens | [\n 101,\n 102,\n 103\n] | \n |
| total_notice_ids[] | integer | \n | ||
| current_liens | array | List of current liens on the property ordered by due date, soonest to furthest in the future | \n | |
| current_liens[] | object | \n | ||
| current_liens[].arm_change_date | string | Date that the ARM will change from fixed rate to adjustable (if applicable) | 2022-03-15T12:00:00Z | \n|
| current_liens[].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| current_liens[].due_date | string | The date the lien is scheduled to be paid-in-full | 2038-12-01 | \n|
| current_liens[].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| current_liens[].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| current_liens[].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| current_liens[].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| current_liens[].grantor_1 | string | Name of the primary financier of the lien | Bank of America | \n|
| current_liens[].grantor_2 | string | Name of the secondary financier of the lien | Wells Fargo | \n|
| current_liens[].heloc | boolean | Whether the loan is a home equity line of credit | \n | |
| current_liens[].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.5 | \n|
| current_liens[].is_arm | boolean | Whether the lien is an adjustable rate mortgage | true | \n|
| current_liens[].lender_type | string | Entity making the loan. | mortgage_company | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| current_liens[].lien_amount | integer | Amount in dollars financed | 250000 | \n|
| current_liens[].lien_length_months | integer | Duration of the lien in months | 360 | \n|
| current_liens[].lien_months_completed_as_of_date | integer | Number of months matured by the lien | 120 | \n|
| current_liens[].lien_type | string | The type of lien acquired. One of [arm, commercial, construction, conventional, fannie_mae_freddie_mac (These entities don't originate anymore; most conventional meet criteria), farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| current_liens[].monthly_payment | integer | Monthly lien payment (not including escrow) | 1500 | \n|
| current_liens[].notice_ids | array | Any notices of default on the lien (if they exist) | [\n 201,\n 202\n] | \n |
| current_liens[].notice_ids[] | integer | \n | ||
| current_liens[].outstanding_principal | integer | Estimated outstanding principal owed on the lien. | 200000 | \n|
| current_liens[].principal_paid_as_of_date | integer | Estimated paid principal. lien_amount - outstanding_principal | 50000 | \n|
| current_liens[].record_date | string | Date the lien originated | 2010-05-15 | \n|
| current_liens[].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | true | \n
| Notice ID | \nDescription | \nTypical Impact | \n
|---|---|---|
| 0 | Due date unavailable | moderate |
| 1 | Record date unavailable | moderate |
| 5 | Estimated interest rate | moderate |
| 6 | ARM rate change year unavailable | moderate ARM assumptions |
| 7 | Not variable from start ARM, missing ARM rate change year, no rate change frequency available | ARM treated as fixed |
| 8 | Not variable from start ARM, deriving missing ARM rate change year from rate change frequency | moderate ARM assumptions |
| 9 | ARM rate change month & day assumed | minor ARM assumptions |
| 10 | ARM rate change day assumed | minor ARM assumptions |
| 11 | Malformed ARM rate change date | ARM treated as fixed |
| 12 | Assuming ARM rate change frequency is annual | moderate ARM assumptions |
| 13 | ARM fixed period duration malformed/errors-in-deriving | ARM treated as fixed |
| 14 | ARM fixed period duration too long, so as to be malformed/errors-in-deriving | ARM treated as fixed |
| 15 | Assuming ARM interest only duration is equal to fixed period duration | minor ARM assumptions |
| 16 | Malformed ARM interest only duration, disregarding interest only period | moderate ARM assumptions |
| 18 | In fixed ARM period but using estimated initial fixed rate | moderate ARM assumptions |
| 19 | Assuming LIBOR_6M as ARM index | moderate ARM assumptions |
| 20 | Unable to retrieve ARM index rates | ARM treated as fixed |
| 21 | Assumptions made in ARM index rate fetch | moderate ARM assumptions |
| 22 | ARM delta from index missing | ARM treated as fixed |
| 24 | No interest only period in ARM and estimating initial fixed rate | moderate ARM assumptions |
| 25 | Unable to retrieve ARM index rate as of required calculation date | ARM treated as fixed |
| 26 | ARM rate index greater than 6 months out of date to required date | moderate ARM assumptions |
| 27 | ARM rate index out of date by at most 6 months to required date | minor ARM assumptions |
| 28 | Last sale transfer date unavailable | minor |
| 29 | Lien length estimated | moderate |
| 30 | Lien determined to be active via heuristic filtering | moderate |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"066ab981-77dc-4b41-ad72-4eb0b078627d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicAccess comprehensive LTV data for properties, supporting mortgage and refinance decision-making. Access comprehensive data on the estimated loan-to-value ratio (LTV) for properties. Receive granular information on grantors, grantees, monthly payments, current interest rates, original lien amounts, loan duration, progress made, outstanding principal, principal paid, record and due dates, ARM specifics, and more. Additionally, the endpoint delivers summary data covering equity, monthly payments, lien amounts, notice IDs, and property valuations.
\nActive liens' paydown is calculated based on available lien terms, factoring in details such as ARM and interest-only periods when applicable. The response includes a sorted list of notice IDs with corresponding descriptions, which highlight findings during LTV generation and their usual impact on the calculation. This is particularly useful for helping drive refinancing or loan origination analysis.
\nSource: HouseCanary, Public Records, Freddie Mac
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| as_of_month | string | Year and month of the processing date for the loan to value calculation | 2023-07 | \n|
| fsd | number | Forecast standard deviation for the Housecanary AVM as of the as_of_month | 0.08 | \n|
| in_default | boolean | Whether the lien is in default | true | \n|
| last_default_date | string | Date of last default, if one exists | 2022-12-20 | \n|
| ltv_lwr | number | Estimated LTV lower bound. Calculated as total_lien / property_value_upr | 0.8 | \n|
| ltv_mean | number | Estimated LTV. Calculated as total_lien / property_value_upr | 0.75 | \n|
| ltv_upr | number | Estimated LTV upper bound. Calculated as total_lien / property_value_lwr | 0.78 | \n|
| property_value_lwr | integer | HouseCanary lower bound AVM as of the as_of_month | 350000 | \n|
| property_value_mean | integer | HouseCanary automated monthly value AVM as of the as_of_month. Created using a robust model ensemble methodology. | 375000 | \n|
| property_value_upr | integer | HouseCanary upper bound AVM as of the as_of_month | 390000 | \n|
| total_equity_lwr | integer | Lower bound estimated equity as of the as_of_month. Calculated as property_value_lwr - total_lien. | 75000 | \n|
| total_equity_mean | integer | Mean estimated equity as of the as_of_month. Calculated as property_value_mean - total_lien. | 80000 | \n|
| total_equity_upr | integer | Upper bound estimated equity as of the as_of_month. Calculated as property_value_upr - total_lien. | 85000 | \n|
| total_lien | integer | Estimated total lien amount currently on the property | 300000 | \n|
| total_monthly_payments | integer | Estimated total monthly payments. Sum of all monthly_payment values of current_liens. | 1800 | \n|
| total_notice_ids | array | Complete list of all notice_ids on all liens | [\n 101,\n 102,\n 103\n] | \n |
| total_notice_ids[] | integer | \n | ||
| current_liens | array | List of current liens on the property ordered by due date, soonest to furthest in the future | \n | |
| current_liens[] | object | \n | ||
| current_liens[].arm_change_date | string | Date that the ARM will change from fixed rate to adjustable (if applicable) | 2022-03-15T12:00:00Z | \n|
| current_liens[].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| current_liens[].due_date | string | The date the lien is scheduled to be paid-in-full | 2038-12-01 | \n|
| current_liens[].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| current_liens[].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| current_liens[].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| current_liens[].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| current_liens[].grantor_1 | string | Name of the primary financier of the lien | Bank of America | \n|
| current_liens[].grantor_2 | string | Name of the secondary financier of the lien | Wells Fargo | \n|
| current_liens[].heloc | boolean | Whether the loan is a home equity line of credit | \n | |
| current_liens[].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.5 | \n|
| current_liens[].is_arm | boolean | Whether the lien is an adjustable rate mortgage | true | \n|
| current_liens[].lender_type | string | Entity making the loan. | mortgage_company | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| current_liens[].lien_amount | integer | Amount in dollars financed | 250000 | \n|
| current_liens[].lien_length_months | integer | Duration of the lien in months | 360 | \n|
| current_liens[].lien_months_completed_as_of_date | integer | Number of months matured by the lien | 120 | \n|
| current_liens[].lien_type | string | The type of lien acquired. One of [arm, commercial, construction, conventional, fannie_mae_freddie_mac (These entities don't originate anymore; most conventional meet criteria), farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| current_liens[].monthly_payment | integer | Monthly lien payment (not including escrow) | 1500 | \n|
| current_liens[].notice_ids | array | Any notices of default on the lien (if they exist) | [\n 201,\n 202\n] | \n |
| current_liens[].notice_ids[] | integer | \n | ||
| current_liens[].outstanding_principal | integer | Estimated outstanding principal owed on the lien. | 200000 | \n|
| current_liens[].principal_paid_as_of_date | integer | Estimated paid principal. lien_amount - outstanding_principal | 50000 | \n|
| current_liens[].record_date | string | Date the lien originated | 2010-05-15 | \n|
| current_liens[].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | true | \n
| Notice ID | \nDescription | \nTypical Impact | \n
|---|---|---|
| 0 | Due date unavailable | moderate |
| 1 | Record date unavailable | moderate |
| 5 | Estimated interest rate | moderate |
| 6 | ARM rate change year unavailable | moderate ARM assumptions |
| 7 | Not variable from start ARM, missing ARM rate change year, no rate change frequency available | ARM treated as fixed |
| 8 | Not variable from start ARM, deriving missing ARM rate change year from rate change frequency | moderate ARM assumptions |
| 9 | ARM rate change month & day assumed | minor ARM assumptions |
| 10 | ARM rate change day assumed | minor ARM assumptions |
| 11 | Malformed ARM rate change date | ARM treated as fixed |
| 12 | Assuming ARM rate change frequency is annual | moderate ARM assumptions |
| 13 | ARM fixed period duration malformed/errors-in-deriving | ARM treated as fixed |
| 14 | ARM fixed period duration too long, so as to be malformed/errors-in-deriving | ARM treated as fixed |
| 15 | Assuming ARM interest only duration is equal to fixed period duration | minor ARM assumptions |
| 16 | Malformed ARM interest only duration, disregarding interest only period | moderate ARM assumptions |
| 18 | In fixed ARM period but using estimated initial fixed rate | moderate ARM assumptions |
| 19 | Assuming LIBOR_6M as ARM index | moderate ARM assumptions |
| 20 | Unable to retrieve ARM index rates | ARM treated as fixed |
| 21 | Assumptions made in ARM index rate fetch | moderate ARM assumptions |
| 22 | ARM delta from index missing | ARM treated as fixed |
| 24 | No interest only period in ARM and estimating initial fixed rate | moderate ARM assumptions |
| 25 | Unable to retrieve ARM index rate as of required calculation date | ARM treated as fixed |
| 26 | ARM rate index greater than 6 months out of date to required date | moderate ARM assumptions |
| 27 | ARM rate index out of date by at most 6 months to required date | minor ARM assumptions |
| 28 | Last sale transfer date unavailable | minor |
| 29 | Lien length estimated | moderate |
| 30 | Lien determined to be active via heuristic filtering | moderate |
Obtain LTV estimates at origination for primary loans, informing loan performance analysis and risk evaluations.
\nSource: HouseCanary, Public Records
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| ltv | number | Estimated loan-to-value ratio (LTV) at time of origination | 0.75 | \n|
| lien | integer | Amount in dollars financed | 200000 | \n|
| value | integer | Dollar value of the property. May be null in cases where no liens are present (leading to a 0 LTV) and a value is unavailable. | 280000 | \n|
| source | string | Source from which value is derived. One of: deed, mls, avm_block, avm_blockgroup, avm_zip, avm_msa, avm_state | mls | \n[deed, mls, avm_block, avm_blockgroup, avm_zip, avm_msa, avm_state] |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"2ca3134a-9823-4c0f-abb1-f3934bf0f999","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain LTV estimates at origination for primary loans, informing loan performance analysis and risk evaluations.
\nSource: HouseCanary, Public Records
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| ltv | number | Estimated loan-to-value ratio (LTV) at time of origination | 0.75 | \n|
| lien | integer | Amount in dollars financed | 200000 | \n|
| value | integer | Dollar value of the property. May be null in cases where no liens are present (leading to a 0 LTV) and a value is unavailable. | 280000 | \n|
| source | string | Source from which value is derived. One of: deed, mls, avm_block, avm_blockgroup, avm_zip, avm_msa, avm_state | mls | \n[deed, mls, avm_block, avm_blockgroup, avm_zip, avm_msa, avm_state] |
View all available liens/mortgages, including those from previous owners, for comprehensive property lien history.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].amount | integer | Amount in dollars financed | 200000 | \n|
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n|
| [].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| [].due_date | string | The date the lien is scheduled to be paid-in-full | 2023-12-31 | \n|
| [].event_type | string | The type of loan acquired | purchase | \n|
| [].fifteen_yr | number | The FRED 15-year mortgage rate at the time of origination | 3.5 | \n|
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n|
| [].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| [].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| [].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| [].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| [].grantor_1 | string | Name of the primary financier of the lien | ABC Bank | \n|
| [].grantor_2 | string | Name of the secondary financier of the lien | XYZ Mortgage | \n|
| [].hc_interest_rate | number | HouseCanary estimated interest rate. Will differ from “interest_rate” if and only if there is a stated interest rate in the recorder's books | 3.75 | \n|
| [].heloc | boolean | Whether the loan is a home equity line of credit | true | \n|
| [].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.25 | \n|
| [].lender_type | string | Entity making the loan | bank | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| [].lien_type | string | The type of lien acquired | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| [].mortgage_years | integer | Estimated mortgage timeframe. Calculated as floor(due_date - record_date) | 30 | \n|
| [].record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n|
| [].record_date | string | Date the lien originated | 2023-01-15 | \n|
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 56789 | \n|
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 123 | \n|
| [].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | \n | |
| [].thirty_yr | number | The FRED 30-year mortgage rate at the time of origination | 4 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"44fba0f6-f29a-4f7b-9158-ce6f421f839e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicView all available liens/mortgages, including those from previous owners, for comprehensive property lien history.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].amount | integer | Amount in dollars financed | 200000 | \n|
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n|
| [].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| [].due_date | string | The date the lien is scheduled to be paid-in-full | 2023-12-31 | \n|
| [].event_type | string | The type of loan acquired | purchase | \n|
| [].fifteen_yr | number | The FRED 15-year mortgage rate at the time of origination | 3.5 | \n|
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n|
| [].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| [].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| [].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| [].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| [].grantor_1 | string | Name of the primary financier of the lien | ABC Bank | \n|
| [].grantor_2 | string | Name of the secondary financier of the lien | XYZ Mortgage | \n|
| [].hc_interest_rate | number | HouseCanary estimated interest rate. Will differ from “interest_rate” if and only if there is a stated interest rate in the recorder's books | 3.75 | \n|
| [].heloc | boolean | Whether the loan is a home equity line of credit | true | \n|
| [].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.25 | \n|
| [].lender_type | string | Entity making the loan | bank | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| [].lien_type | string | The type of lien acquired | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| [].mortgage_years | integer | Estimated mortgage timeframe. Calculated as floor(due_date - record_date) | 30 | \n|
| [].record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n|
| [].record_date | string | Date the lien originated | 2023-01-15 | \n|
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 56789 | \n|
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 123 | \n|
| [].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | \n | |
| [].thirty_yr | number | The FRED 30-year mortgage rate at the time of origination | 4 | \n
Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"2f5685b7-d005-46fc-b266-90edfa584553","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicIdentify liens/mortgages since the last arm's length transaction, crucial for due diligence and property encumbrance checks.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].amount | integer | Amount in dollars financed | 200000 | \n|
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n|
| [].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| [].due_date | string | The date the lien is scheduled to be paid-in-full | 2023-12-31 | \n|
| [].event_type | string | The type of loan acquired | purchase | \n|
| [].fifteen_yr | number | The FRED 15-year mortgage rate at the time of origination | 3.5 | \n|
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n|
| [].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| [].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| [].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| [].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| [].grantor_1 | string | Name of the primary financier of the lien | ABC Bank | \n|
| [].grantor_2 | string | Name of the secondary financier of the lien | XYZ Mortgage | \n|
| [].hc_interest_rate | number | HouseCanary estimated interest rate. Will differ from “interest_rate” if and only if there is a stated interest rate in the recorder's books | 3.75 | \n|
| [].heloc | boolean | Whether the loan is a home equity line of credit | true | \n|
| [].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.25 | \n|
| [].lender_type | string | Entity making the loan | bank | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| [].lien_type | string | The type of lien acquired | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| [].mortgage_years | integer | Estimated mortgage timeframe. Calculated as floor(due_date - record_date) | 30 | \n|
| [].record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n|
| [].record_date | string | Date the lien originated | 2023-01-15 | \n|
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 56789 | \n|
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 123 | \n|
| [].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | \n | |
| [].thirty_yr | number | The FRED 30-year mortgage rate at the time of origination | 4 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"3028b700-bc68-4b38-aea5-1a7934364c1b","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicIdentify liens/mortgages since the last arm's length transaction, crucial for due diligence and property encumbrance checks.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].amount | integer | Amount in dollars financed | 200000 | \n|
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n|
| [].arm_index | string | ARM index followed by the lien | libor_6m | \n[cd_6m, cofi, libor_1m, libor_1y, libor_2m, libor_3m, libor_6m, mta_12m, prime, tbill_10y, tbill_1y, tbill_3y, tbill_5y, tbill_6m] |
| [].due_date | string | The date the lien is scheduled to be paid-in-full | 2023-12-31 | \n|
| [].event_type | string | The type of loan acquired | purchase | \n|
| [].fifteen_yr | number | The FRED 15-year mortgage rate at the time of origination | 3.5 | \n|
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n|
| [].grantee_1 | string | Last name of first person listed on lien | Smith | \n|
| [].grantee_1_forenames | string | First name of first person listed on lien | John | \n|
| [].grantee_2 | string | Last name of second person listed on lien | Johnson | \n|
| [].grantee_2_forenames | string | First name of second person listed on lien | Jane | \n|
| [].grantor_1 | string | Name of the primary financier of the lien | ABC Bank | \n|
| [].grantor_2 | string | Name of the secondary financier of the lien | XYZ Mortgage | \n|
| [].hc_interest_rate | number | HouseCanary estimated interest rate. Will differ from “interest_rate” if and only if there is a stated interest rate in the recorder's books | 3.75 | \n|
| [].heloc | boolean | Whether the loan is a home equity line of credit | true | \n|
| [].interest_rate | number | The estimated interest rate, based on mortgage_years and FRED rates | 4.25 | \n|
| [].lender_type | string | Entity making the loan | bank | \n[bank, credit_union, finance_company, government, individual_private_party, insurance, internet, lending_institution, mortgage_company, other_company, reo_foreclosure_company, seller, subprime_lender] |
| [].lien_type | string | The type of lien acquired | conventional | \n[arm, commercial, construction, conventional, fannie_mae_freddie_mac, farmers_home_administration, fha, land_contract, open_end, revolving_credit_line, second_to_cover_down_payment, seller_take_back, stand_alone_first, stand_alone_refi, stand_alone_second, state_veterans, usda, va] |
| [].mortgage_years | integer | Estimated mortgage timeframe. Calculated as floor(due_date - record_date) | 30 | \n|
| [].record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n|
| [].record_date | string | Date the lien originated | 2023-01-15 | \n|
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 56789 | \n|
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 123 | \n|
| [].stand_alone_refi | boolean | Whether the refinance occurred with no concurrent loans | \n | |
| [].thirty_yr | number | The FRED 30-year mortgage rate at the time of origination | 4 | \n
Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"d72cbe76-28e7-42ad-a412-e0925f999817","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain non-rescinded Notice of Default (NOD) events for properties, useful for assessing potential foreclosure risks and investment viability.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01 | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01 | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n
| event_type | string | Type of notice | foreclosure | \n
| fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n
| record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | RB12345 | \n
| record_date | string | Date the lien originated | 2023-01-15 | \n
| record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | DOC56789 | \n
| record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | PG123 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"e8362de4-b5ac-4ea7-b7ca-b479f896b708","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain non-rescinded Notice of Default (NOD) events for properties, useful for assessing potential foreclosure risks and investment viability.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01 | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01 | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| apn | string | Assessor's Parcel Number or Parcel Identification Number | 1234567890 | \n
| event_type | string | Type of notice | foreclosure | \n
| fips | string | 5-digit Federal Information Processing Standards county code | 06037 | \n
| record_book | string | Record book number for the recorded lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | RB12345 | \n
| record_date | string | Date the lien originated | 2023-01-15 | \n
| record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | DOC56789 | \n
| record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | PG123 | \n
Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"e9592087-ad66-4760-80e8-943a88f1697f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicDetermine owner-occupancy status, informing potential rental opportunities and neighborhood compositions.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Annually
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| owner_occupied | boolean | Whether the property address matches the mailing address for associated property taxes | true | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"075f664c-d355-48af-b02a-e86088763b3f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicDetermine owner-occupancy status, informing potential rental opportunities and neighborhood compositions.
\nSource: HouseCanary, Public Records
\nPricing Tier: Basic
\nUpdated: Annually
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| owner_occupied | boolean | Whether the property address matches the mailing address for associated property taxes | true | \n
HouseCanary's 1-year rental value forecasts, supporting rental market outlooks and investment planning.
\nFields include forecast % growth (decline) at 3, 6, and 12 month intervals into the future.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| month_03 | object | Forecasted rental value information for 3 months with ZIP level Rental Price Index | \n |
| month_03.value | integer | HouseCanary forecasted rental value within the 3 month time-period | 2200 | \n
| month_06 | object | Forecasted rental value information for 6 months with ZIP level Rental Price Index | \n |
| month_06.value | integer | HouseCanary forecasted rental value within the 6 month time-period | 2300 | \n
| month_12 | object | Forecasted rental value information for 12 months with ZIP level Rental Price Index | \n |
| month_12.value | integer | HouseCanary forecasted rental value within the 12 month time-period | 2400 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"875c717b-8f7e-40e9-95df-c9fb30679b47","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's 1-year rental value forecasts, supporting rental market outlooks and investment planning.
\nFields include forecast % growth (decline) at 3, 6, and 12 month intervals into the future.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| month_03 | object | Forecasted rental value information for 3 months with ZIP level Rental Price Index | \n |
| month_03.value | integer | HouseCanary forecasted rental value within the 3 month time-period | 2200 | \n
| month_06 | object | Forecasted rental value information for 6 months with ZIP level Rental Price Index | \n |
| month_06.value | integer | HouseCanary forecasted rental value within the 6 month time-period | 2300 | \n
| month_12 | object | Forecasted rental value information for 12 months with ZIP level Rental Price Index | \n |
| month_12.value | integer | HouseCanary forecasted rental value within the 12 month time-period | 2400 | \n
Compare a property's rental value and value per sq ft within its block, useful for local market positioning.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| client_value | integer | Dollar value supplied by the caller, to position within the distribution of rental property values within the block. | 3500 | \n
| client_value_sqft | integer | Dollar value per sq ft supplied by the caller, to position within the distribution of rental property values per sq ft within the block. | 3 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| property_type | string | Type of property. Defaults to SFD. One of [SFD, TH,CND, INC, MFH] | \n | [SFD, TH, CND, INC, MFH] |
| housecanary_value_percentile_range | object | Percentile range information for the HouseCanary rental value | \n | |
| housecanary_value_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| housecanary_value_percentile_range.high | integer | High percentile of the range | 38 | \n|
| housecanary_value_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| housecanary_value_sqft_percentile_range | object | Percentile range information for the HouseCanary rental value per square foot | \n | |
| housecanary_value_sqft_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| housecanary_value_sqft_percentile_range.high | integer | High percentile of the range | 38 | \n|
| housecanary_value_sqft_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| client_value_percentile_range | object | Percentile range information for the client-provided rental value | \n | |
| client_value_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| client_value_percentile_range.high | integer | High percentile of the range | 38 | \n|
| client_value_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| client_value_sqft_percentile_range | object | Percentile range information for the client-provided rental value per square foot | \n | |
| client_value_sqft_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| client_value_sqft_percentile_range.high | integer | High percentile of the range | 38 | \n|
| client_value_sqft_percentile_range.name | string | Name of the range | housecanary_value_... | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Dollar value supplied by the caller, to position within the distribution of rental property values within the block.
\n","type":"text/plain"},"key":"client_value","value":"3500"},{"description":{"content":"Dollar value per sq ft supplied by the caller, to position within the distribution of rental property values per sq ft within the block.
\n","type":"text/plain"},"key":"client_value_sqft","value":"3"}],"variable":[]}},"response":[{"id":"c960f15f-fcbf-4f05-8c6a-62579a7f737a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicCompare a property's rental value and value per sq ft within its block, useful for local market positioning.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| client_value | integer | Dollar value supplied by the caller, to position within the distribution of rental property values within the block. | 3500 | \n
| client_value_sqft | integer | Dollar value per sq ft supplied by the caller, to position within the distribution of rental property values per sq ft within the block. | 3 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| property_type | string | Type of property. Defaults to SFD. One of [SFD, TH,CND, INC, MFH] | \n | [SFD, TH, CND, INC, MFH] |
| housecanary_value_percentile_range | object | Percentile range information for the HouseCanary rental value | \n | |
| housecanary_value_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| housecanary_value_percentile_range.high | integer | High percentile of the range | 38 | \n|
| housecanary_value_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| housecanary_value_sqft_percentile_range | object | Percentile range information for the HouseCanary rental value per square foot | \n | |
| housecanary_value_sqft_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| housecanary_value_sqft_percentile_range.high | integer | High percentile of the range | 38 | \n|
| housecanary_value_sqft_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| client_value_percentile_range | object | Percentile range information for the client-provided rental value | \n | |
| client_value_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| client_value_percentile_range.high | integer | High percentile of the range | 38 | \n|
| client_value_percentile_range.name | string | Name of the range | housecanary_value_... | \n|
| client_value_sqft_percentile_range | object | Percentile range information for the client-provided rental value per square foot | \n | |
| client_value_sqft_percentile_range.low | integer | Low percentile of the range | 12 | \n|
| client_value_sqft_percentile_range.high | integer | High percentile of the range | 38 | \n|
| client_value_sqft_percentile_range.name | string | Name of the range | housecanary_value_... | \n
Dollar value supplied by the caller, to position within the distribution of rental property values within the block.
\n","type":"text/plain"},"key":"client_value","value":"3500"},{"description":{"content":"Dollar value per sq ft supplied by the caller, to position within the distribution of rental property values per sq ft within the block.
\n","type":"text/plain"},"key":"client_value_sqft","value":"3"}],"variable":[]}},"response":[{"id":"34437ca4-cb61-4b2c-b445-b1cb56dd4026","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's flagship automated rental value estimate, essential for rental pricing strategies and market analysis.
\nHouseCanary's proprietary Automated Rental Valuation Model utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market rent of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| price_mean | integer | HouseCanary automated monthly rental value. Created using a robust model ensemble methodology. | 1800 | \n
| price_upr | integer | HouseCanary rental AVM upper bound. Calculated as price_mean * (1 + fsd) | 1850 | \n
| price_lwr | integer | HouseCanary rental AVM lower bound. Calculated as price_mean * (1 - fsd) | 1750 | \n
| fsd | number | HouseCanary forecast standard deviation for the HouseCanary rental AVM | 0.08 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"92bccde1-5fd9-4b70-90dc-da75d80cbc7e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's flagship automated rental value estimate, essential for rental pricing strategies and market analysis.
\nHouseCanary's proprietary Automated Rental Valuation Model utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market rent of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| price_mean | integer | HouseCanary automated monthly rental value. Created using a robust model ensemble methodology. | 1800 | \n
| price_upr | integer | HouseCanary rental AVM upper bound. Calculated as price_mean * (1 + fsd) | 1850 | \n
| price_lwr | integer | HouseCanary rental AVM lower bound. Calculated as price_mean * (1 - fsd) | 1750 | \n
| fsd | number | HouseCanary forecast standard deviation for the HouseCanary rental AVM | 0.08 | \n
Examine a property's sales and ownership transfer history for trends, transaction patterns, and investment insights.
\nSource: Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].amount | integer | Amount in dollars that the property sold for | 350000 | \n
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 123456789 | \n
| [].event_type | string | Type of sale | Sale | \n
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06001 | \n
| [].grantee_1 | string | Last name of first person listed on deed | Smith | \n
| [].grantee_1_forenames | string | First name of first person listed on deed | John | \n
| [].grantee_2 | string | Last name of second person listed on deed | Johnson | \n
| [].grantee_2_forenames | string | First name of second person listed on deed | Jane | \n
| [].grantor_1 | string | Name of the primary financier of the deed | Bank of Example | \n
| [].grantor_2 | string | Name of the secondary financier of the deed | Mortgage Corp | \n
| [].record_book | string | Record book number for the recorded deed. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n
| [].record_date | string | Date of lien origination | 2023-08-10 | \n
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 987654 | \n
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 789 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"affe18e3-4a38-4f89-a61c-3f2461d83313","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicExamine a property's sales and ownership transfer history for trends, transaction patterns, and investment insights.
\nSource: Public Records
\nPricing Tier: Basic
\nUpdated: Daily
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items. One of [asc or desc]. Defaults to asc. | \n | [asc, desc] |
| limit | integer | Maximum integer number of result items to return. Defaults to null. | 10 | \n|
| start | string | Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].amount | integer | Amount in dollars that the property sold for | 350000 | \n
| [].apn | string | Assessor's Parcel Number or Parcel Identification Number | 123456789 | \n
| [].event_type | string | Type of sale | Sale | \n
| [].fips | string | 5-digit Federal Information Processing Standards county code | 06001 | \n
| [].grantee_1 | string | Last name of first person listed on deed | Smith | \n
| [].grantee_1_forenames | string | First name of first person listed on deed | John | \n
| [].grantee_2 | string | Last name of second person listed on deed | Johnson | \n
| [].grantee_2_forenames | string | First name of second person listed on deed | Jane | \n
| [].grantor_1 | string | Name of the primary financier of the deed | Bank of Example | \n
| [].grantor_2 | string | Name of the secondary financier of the deed | Mortgage Corp | \n
| [].record_book | string | Record book number for the recorded deed. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 12345 | \n
| [].record_date | string | Date of lien origination | 2023-08-10 | \n
| [].record_doc | string | The assessor's document number for this lien. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 987654 | \n
| [].record_page | string | Record page of the lien in the county recorder. A unique transaction in many counties may be defined in the recorder's books by a unique: record_book, record_page, record_doc. | 789 | \n
Chronological order to sort result items. One of [asc or desc]. Defaults to asc.
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum integer number of result items to return. Defaults to null.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on record_date, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"ea47e9d5-8485-4fc3-99dd-57eaf10a3089","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain details on nearby schools for properties, valuable for assessing neighborhood quality.
\nSource: HouseCanary calculation, State standard school testing
\nPricing Tier: Basic
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| school | object | Level of school. One of [`elementary`, `middle`, `high`] | \n | |
| school.elementary | array | \n | ||
| school.elementary[] | object | \n | ||
| school.elementary[].city | string | School city | Springfield | \n|
| school.elementary[].state | string | School state | IL | \n|
| school.elementary[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.elementary[].name | string | School name | Springfield Elementary School | \n|
| school.elementary[].zipcode | string | School ZIP code | 12345 | \n|
| school.elementary[].phone | string | School phone number | 555-123-4567 | \n|
| school.elementary[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.elementary[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.elementary[].education_level[] | string | \n | [elementary, middle, high] | |
| school.elementary[].address | string | School address | 123 Main Street | \n|
| school.elementary[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n|
| school.middle | array | \n | ||
| school.middle[] | object | \n | ||
| school.middle[].city | string | School city | Springfield | \n|
| school.middle[].state | string | School state | IL | \n|
| school.middle[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.middle[].name | string | School name | Springfield Elementary School | \n|
| school.middle[].zipcode | string | School ZIP code | 12345 | \n|
| school.middle[].phone | string | School phone number | 555-123-4567 | \n|
| school.middle[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.middle[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.middle[].education_level[] | string | \n | [elementary, middle, high] | |
| school.middle[].address | string | School address | 123 Main Street | \n|
| school.middle[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n|
| school.high | array | \n | ||
| school.high[] | object | \n | ||
| school.high[].city | string | School city | Springfield | \n|
| school.high[].state | string | School state | IL | \n|
| school.high[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.high[].name | string | School name | Springfield Elementary School | \n|
| school.high[].zipcode | string | School ZIP code | 12345 | \n|
| school.high[].phone | string | School phone number | 555-123-4567 | \n|
| school.high[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.high[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.high[].education_level[] | string | \n | [elementary, middle, high] | |
| school.high[].address | string | School address | 123 Main Street | \n|
| school.high[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"8d98955e-944c-4a6f-9cd5-d027bc662d4d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain details on nearby schools for properties, valuable for assessing neighborhood quality.
\nSource: HouseCanary calculation, State standard school testing
\nPricing Tier: Basic
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| school | object | Level of school. One of [`elementary`, `middle`, `high`] | \n | |
| school.elementary | array | \n | ||
| school.elementary[] | object | \n | ||
| school.elementary[].city | string | School city | Springfield | \n|
| school.elementary[].state | string | School state | IL | \n|
| school.elementary[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.elementary[].name | string | School name | Springfield Elementary School | \n|
| school.elementary[].zipcode | string | School ZIP code | 12345 | \n|
| school.elementary[].phone | string | School phone number | 555-123-4567 | \n|
| school.elementary[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.elementary[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.elementary[].education_level[] | string | \n | [elementary, middle, high] | |
| school.elementary[].address | string | School address | 123 Main Street | \n|
| school.elementary[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n|
| school.middle | array | \n | ||
| school.middle[] | object | \n | ||
| school.middle[].city | string | School city | Springfield | \n|
| school.middle[].state | string | School state | IL | \n|
| school.middle[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.middle[].name | string | School name | Springfield Elementary School | \n|
| school.middle[].zipcode | string | School ZIP code | 12345 | \n|
| school.middle[].phone | string | School phone number | 555-123-4567 | \n|
| school.middle[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.middle[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.middle[].education_level[] | string | \n | [elementary, middle, high] | |
| school.middle[].address | string | School address | 123 Main Street | \n|
| school.middle[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n|
| school.high | array | \n | ||
| school.high[] | object | \n | ||
| school.high[].city | string | School city | Springfield | \n|
| school.high[].state | string | School state | IL | \n|
| school.high[].verified_school_boundaries | boolean | True if school boundaries could be verified, false otherwise | true | \n|
| school.high[].name | string | School name | Springfield Elementary School | \n|
| school.high[].zipcode | string | School ZIP code | 12345 | \n|
| school.high[].phone | string | School phone number | 555-123-4567 | \n|
| school.high[].score | number | Overall school ranking as a percentile within schools in the state | 85.6 | \n|
| school.high[].education_level | array | List of all education levels incorporated by the school. Any combination of [elementary, middle, high] | [\n \"elementary\",\n \"middle\"\n] | \n |
| school.high[].education_level[] | string | \n | [elementary, middle, high] | |
| school.high[].address | string | School address | 123 Main Street | \n|
| school.high[].assessment_year | integer | Year of the school's last assessment by the state. Null if not available | 2022 | \n
Review current and historical tax and assessment values, aiding in property valuation and tax planning.
\nSource: Public Records
\nPricing Tier: Basic
\nUpdated: Annually
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n|
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n|
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n|
| city | string | City in which the property is located | San Francisco | \n|
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n|
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum number of items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| tax_history | array | \n | |
| tax_history[] | object | \n | |
| tax_history[].apn | string | Assessor's Parcel Number or Parcel Identification Number | 123-456-789 | \n
| tax_history[].assessment_year | integer | Year the assessment was conducted | 2022 | \n
| tax_history[].tax_amount | integer | Amount in dollars of tax owed on the property | 2500 | \n
| tax_history[].tax_year | integer | Tax year for which the assessment applies | 2022 | \n
| tax_history[].total_assessed_value | integer | The total assessed value of both land and improvements (before exemptions, if any) as reported on the county tax/assessment roll in the indicated year. | 350000 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum number of items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"bb0fe4dd-f078-4910-bc7d-8ab732d702d4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicReview current and historical tax and assessment values, aiding in property valuation and tax planning.
\nSource: Public Records
\nPricing Tier: Basic
\nUpdated: Annually
\n| Property | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| order | string | Chronological order to sort result items | \n | [asc, desc] |
| limit | integer | Maximum number of items to return | 10 | \n|
| start | string | Beginning date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n|
| end | string | Ending date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null. | 2015-01-01 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| tax_history | array | \n | |
| tax_history[] | object | \n | |
| tax_history[].apn | string | Assessor's Parcel Number or Parcel Identification Number | 123-456-789 | \n
| tax_history[].assessment_year | integer | Year the assessment was conducted | 2022 | \n
| tax_history[].tax_amount | integer | Amount in dollars of tax owed on the property | 2500 | \n
| tax_history[].tax_year | integer | Tax year for which the assessment applies | 2022 | \n
| tax_history[].total_assessed_value | integer | The total assessed value of both land and improvements (before exemptions, if any) as reported on the county tax/assessment roll in the indicated year. | 350000 | \n
Chronological order to sort result items
\n","type":"text/plain"},"key":"order","value":"asc"},{"description":{"content":"Maximum number of items to return
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Beginning date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"start","value":"2015-01-01"},{"description":{"content":"Ending date limit for result items, based on tax_year, in ISO 8601 format, i.e. 2015-01-01. Defaults to null.
\n","type":"text/plain"},"key":"end","value":"2015-01-01"}],"variable":[]}},"response":[{"id":"4dab0c63-6c43-4646-b7cc-b2482599d97d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's flagship automated property value estimate.
\nHouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| value | object | \n | |
| value.price_mean | integer | HouseCanary automated monthly home value. Created using a robust model ensemble methodology. | 325000 | \n
| value.price_upr | integer | HouseCanary AVM upper bound. Calculated as price_mean * (1 + fsd) | 340000 | \n
| value.price_lwr | integer | HouseCanary AVM lower bound. Calculated as price_mean * (1 - fsd) | 310000 | \n
| value.fsd | number | HouseCanary forecast standard deviation for the HouseCanary AVM | 0.05 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"02954a69-7f38-4ac0-891c-b74fc38d6a47","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's flagship automated property value estimate.
\nHouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| value | object | \n | |
| value.price_mean | integer | HouseCanary automated monthly home value. Created using a robust model ensemble methodology. | 325000 | \n
| value.price_upr | integer | HouseCanary AVM upper bound. Calculated as price_mean * (1 + fsd) | 340000 | \n
| value.price_lwr | integer | HouseCanary AVM lower bound. Calculated as price_mean * (1 - fsd) | 310000 | \n
| value.fsd | number | HouseCanary forecast standard deviation for the HouseCanary AVM | 0.05 | \n
Value Analysis provides a set of automated checks to test the feasibility of a property value based on HouseCanary’s data and models. It provides a recommended approach for coming to a high-confidence value for the property.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | A single URL-safe string identifying the address (obtained from HouseCanary) | 1624-E-Dogwood-Ln-Gilbert-AZ-85295 | \n
| street_address | string | Building number, street name and unit number | 123 Main St San Francisco CA 94132 | \n
| zipcode | integer | 5-digit ZIP code | 94132 | \n
| estimated_value | integer | Outside estimate of the property’s value, maybe from a BPO or previous appraised value | 325000 | \n
| gla_sqft | integer | Gross living area of property in square feet | 2750 | \n
| include_comp_based_analysis | boolean | Whether to include comp-based analysis (response may be slower if included) | true | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| checks | object | Preliminary data checks to determine whether HouseCanary can provide an AVM for the property in question | \n | |
| checks.All pre-analysis checks passed | boolean | true if all the other checks are true, false otherwise | true | \n|
| checks.Address is supported | boolean | true if the provided address can be parsed, false otherwise | true | \n|
| checks.Address is complete | boolean | true if the provided address includes all necessary detail to resolve to a specific residence, false otherwise (most commonly a false value indicates a missing unit number for a multi-unit property address) | true | \n|
| checks.Precise geocode is available for address | boolean | true if HouseCanary has a rooftop accurate geocode for the address, false otherwise | true | \n|
| checks.Property at address is of supported type | boolean | Returns true if the property at the specified address is of a supported type; false otherwise. | true | \n|
| checks.Census block group information is available | boolean | true if HouseCanary has blockgroup value distribution data for the blockgroup containing the property,false otherwise | true | \n|
| checks.Enough information on neighborhood characteristics is available | boolean | True if HouseCanary has value per square foot data for at least 70% of properties in the blockgroup, False otherwise | true | \n|
| checks.Gross living area of property is available or provided as input | boolean | True if HouseCanary has data for the gross living area of the property or it was provided in the request as the gla_sqft value, False otherwise | true | \n|
| checks.Comps available for analysis | boolean | True if at least 5 highly similar comparable properties exist, False otherwise | true | \n|
| input_params | object | \n | ||
| input_params.slug | string | A single URL-safe string identifying the address (obtained from HouseCanary) | 1624-E-Dogwood-Ln-Gilbert-AZ-85295 | \n|
| input_params.product_type | string | The product type | value_analysis | \n|
| input_params.include_comp_based_analysis | string | Whether to include comp-based analysis was included in the request | true | \n[true, false] |
| input_params.zipcode | string | The zipcode | 85020 | \n|
| input_params.street_address | string | Building number, street name and unit number | 123 Main St San Francisco CA 94132 | \n|
| input_params.estimated_value | string | Outside estimate of the property’s value, maybe from a BPO or previous appraised value | 320000 | \n|
| input_params.gla_sqft | string | Gross living area of property in square feet | 2750 | \n|
| recommended_approach | string | HouseCanary’s suggested course of action to determine the value of the property with high confidence. One of: [No exceptions - Automate, Minor exceptions - Human review, Major exceptions - Onsite review] | Minor exceptions - Human review | \n|
| hc_avm_value_analysis | object | How HouseCanary’s AVM for the property relates to the area | \n | |
| hc_avm_value_analysis.avm_value | integer | HouseCanary automated value model for the property | 1801218 | \n|
| hc_avm_value_analysis.avm_confidence | string | Confidence of the HouseCanary AVM for the property | high | \n[low, medium, high] |
| hc_avm_value_analysis.avm_fsd | number | Forecast standard deviation (FSD) for the AVM value, representing the model’s confidence. Lower values indicate higher confidence in the AVM estimate. | 0.1414001 | \n|
| hc_avm_value_analysis.neighborhood_analysis | object | Details about housing stock in the census blockgroup containing the property | \n | |
| hc_avm_value_analysis.neighborhood_analysis.avm_value_sqft | integer | Value per square foot | 987 | \n|
| hc_avm_value_analysis.neighborhood_analysis.5th_percentile_value_per_sqft | number | 5th percentile of the range of property values in the area (i.e. low end of value range) | 578.1 | \n|
| hc_avm_value_analysis.neighborhood_analysis.95th_percentile_value_per_sqft | number | 95th percentile of the range of property values in the area (i.e. high end of value range) | 988.7 | \n|
| hc_avm_value_analysis.neighborhood_analysis.within_neighborhood_norms | boolean | true if the value falls between the 5th and 95th percentile of neighborhood values, false otherwise | true | \n|
| hc_avm_value_analysis.comp_based_analysis | object | Feasibility of the property value based on comparable properties (adjusted by GLA) | \n | |
| hc_avm_value_analysis.comp_based_analysis.comp_fsd | number | Forecast standard deviation (FSD) for the comparable-based valuation, indicating the model’s confidence. Lower values suggest higher confidence in the comp-based estimate. | 0.131 | \n|
| hc_avm_value_analysis.comp_based_analysis.number_of_comps | integer | Number of high similarity comparable properties included in the analysis | 15 | \n|
| hc_avm_value_analysis.comp_based_analysis.5th_percentile_adjusted_comp_value | integer | 5th percentile of the range of property values for adjusted comparable properties (i.e. low end of value range) | 1134796 | \n|
| hc_avm_value_analysis.comp_based_analysis.95th_percentile_adjusted_comp_value | integer | 95th percentile of the range of property values for adjusted comparable properties (i.e. high end of value range) | 1734155 | \n|
| hc_avm_value_analysis.comp_based_analysis.avm_value_percentile_in_adjusted_comp_values | number | Where the percentile ranking of the value lies in the distribution of adjusted comp prices | 96.5 | \n|
| hc_avm_value_analysis.comp_based_analysis.within_adjusted_comp_values | boolean | true if the value falls between the 5th and 95th percentile of adjusted comp values, false otherwise | true | \n
A single URL-safe string identifying the address (obtained from HouseCanary)
\n","type":"text/plain"},"key":"slug","value":"1624-E-Dogwood-Ln-Gilbert-AZ-85295"},{"description":{"content":"Building number, street name and unit number
\n","type":"text/plain"},"key":"street_address","value":"123 Main St San Francisco CA 94132"},{"description":{"content":"5-digit ZIP code
\n","type":"text/plain"},"key":"zipcode","value":"94132"},{"description":{"content":"Outside estimate of the property’s value, maybe from a BPO or previous appraised value
\n","type":"text/plain"},"key":"estimated_value","value":"325000"},{"description":{"content":"Gross living area of property in square feet
\n","type":"text/plain"},"key":"gla_sqft","value":"2750"},{"description":{"content":"Whether to include comp-based analysis (response may be slower if included)
\n","type":"text/plain"},"key":"include_comp_based_analysis","value":"true"}],"variable":[]}},"response":[{"id":"d6cb47f0-f71e-477a-b90e-b5f94878dc3d","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicJSON-encoded address object
\n","key":"address","value":"{\"slug\":null,\"city\":\"Gilbert\",\"state\":\"AZ\",\"unit\":\"\",\"address\":\"1624 E Dogwood Ln\",\"zipcode\":\"85295\"}","type":"text"},{"description":"Up to 20 images are accepted per request and a larger set of images will yield more accurate results.
\n","key":"images","value":"file,file","type":"text"}]},"url":"https://api.housecanary.com/v3/property/value_by_image","description":"This set of endpoints returns property value estimates based on submitted property images. Up to 20 images are accepted per request and a larger set of images will yield more accurate results. First, submit property images and an address to the POST value_by_image endpoint to receive a job_id and block_group_id. Then poll the GET value_by_image_job endpoint, passing the returned job_id and block_group_id, until job completion. When the job has finished, the property’s adjusted condition score and conditioned-based AVM (Automated Valuation Model) and FSD will be returned. Note: please do not poll the GET value_by_image_job endpoint more frequently than once per second to avoid interruptions from our firewall.
\nSource: HouseCanary
\nPricing Tier: Premium Plus
\nUpdated: Annually
\n| Field | Type | Description | Example |
|---|---|---|---|
| address | string | JSON-encoded address object | {\"slug\":null,\"city\":\"Gilbert\",\"state\":\"AZ\",\"unit\":\"\",\"address\":\"1624 E Dogwood Ln\",\"zipcode\":\"85295\"} | \n
| images | array | Up to 20 images are accepted per request and a larger set of images will yield more accurate results. | \n |
| images[] | string | Binary image data | file | \n
| Field | Type | Description | Example |
|---|---|---|---|
| message | string | The operation's status message | Job submitted | \n
| job_id | string | The identifier of the job | 11848 | \n
| job_status_url | string | The URL to be used for checking the job status | /property/value_by_image_job/11848?block_group_id=040138155022&slug=1624-E-Dogwood-Ln-Gilbert-AZ-85295 | \n
This set of endpoints returns property value estimates based on submitted property images. Up to 20 images are accepted per request and a larger set of images will yield more accurate results. First, submit property images and an address to the POST value_by_image endpoint to receive a job_id and block_group_id. Then poll the GET value_by_image_job endpoint, passing the returned job_id and block_group_id, until job completion. When the job has finished, the property’s adjusted condition score and conditioned-based AVM (Automated Valuation Model) and FSD will be returned. Note: please do not poll the GET value_by_image_job endpoint more frequently than once per second to avoid interruptions from our firewall.
\nSource: HouseCanary
\nPricing Tier: Included with Subscription
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| block_group_id | string | The identifier of the block group | 040138155022 | \n
| slug | string | The slug of the property | 1624-E-Dogwood-Ln-Gilbert-AZ-85295 | \n
| Property | Type | Description | Example |
|---|---|---|---|
| job_id | string | The identifier of the job | 11848 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| status | string | \n | [QUEUED, DONE, FAILED] | |
| condition_class | string | \n | [C1, C2, C3, C4, C5, C6] | |
| price_mean_at_condition | integer | 519624 | \n||
| price_upr_at_condition | integer | 565351 | \n||
| price_lwr_at_condition | integer | 473896 | \n||
| fsd | number | 0.0880005 | \n
The identifier of the block group
\n","type":"text/plain"},"key":"block_group_id","value":"040138155022"},{"description":{"content":"The slug of the property
\n","type":"text/plain"},"key":"slug","value":"1624-E-Dogwood-Ln-Gilbert-AZ-85295"}],"variable":[{"id":"ca48d903-8a30-48f7-8d9a-cb794c38f74b","description":{"content":"The identifier of the job
\n","type":"text/plain"},"type":"any","value":"11848","key":"job_id"}]}},"response":[{"id":"be185926-b561-4edd-94e7-43e8477561b8","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicThis endpoint allows you to determine the value of the property based on the current condition of the property as determined by HouseCanary's proprietary algorithms. Each condition class corresponds to the standardized C1 through C6 condition rating scale that conforms to Fannie Mae UAD guidelines. Values at each condition level are determined based on local market conditions and are determined through a mix of computer vision and statistical modeling.
\nSource: HouseCanary
\nPricing Tier: Premium Plus
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| value | object | \n | ||
| value.price_mean | integer | Same value that is provided as part of the property/value response | 450000 | \n|
| value.price_upr | integer | Same value that is provided as part of the property/value response | 480000 | \n|
| value.price_lwr | integer | Same value that is provided as part of the property/value response | 420000 | \n|
| value.fsd | number | Same value that is provided as part of the property/value response | 0.1 | \n|
| value.price_at_cond_0 | integer | Quantitatively derived value of the property at the lowest condition rating of C6 | 380000 | \n|
| value.price_at_cond_1 | integer | Quantitatively derived value of the property at the condition rating of C5 | 410000 | \n|
| value.price_at_cond_2 | integer | Quantitatively derived value of the property at the condition rating of C4 | 430000 | \n|
| value.price_at_cond_3 | integer | Quantitatively derived value of the property at the condition rating of C3 | 440000 | \n|
| value.price_at_cond_4 | integer | Quantitatively derived value of the property at the condition rating of C2 | 460000 | \n|
| value.price_at_cond_5 | integer | Quantitatively derived value of the property at the highest condition rating of C1 | 490000 | \n|
| value.condition_class | string | The current condition rating of the property as determined by HouseCanary. The standardized condition rating (C1 through C6) conforms to the UAD guidelines for determining condition. | C4 | \n[C1, C2, C3, C4, C5, C6] |
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"f242f65b-13d3-4514-beae-5acb8fcfa310","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicThis endpoint allows you to determine the value of the property based on the current condition of the property as determined by HouseCanary's proprietary algorithms. Each condition class corresponds to the standardized C1 through C6 condition rating scale that conforms to Fannie Mae UAD guidelines. Values at each condition level are determined based on local market conditions and are determined through a mix of computer vision and statistical modeling.
\nSource: HouseCanary
\nPricing Tier: Premium Plus
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| value | object | \n | ||
| value.price_mean | integer | Same value that is provided as part of the property/value response | 450000 | \n|
| value.price_upr | integer | Same value that is provided as part of the property/value response | 480000 | \n|
| value.price_lwr | integer | Same value that is provided as part of the property/value response | 420000 | \n|
| value.fsd | number | Same value that is provided as part of the property/value response | 0.1 | \n|
| value.price_at_cond_0 | integer | Quantitatively derived value of the property at the lowest condition rating of C6 | 380000 | \n|
| value.price_at_cond_1 | integer | Quantitatively derived value of the property at the condition rating of C5 | 410000 | \n|
| value.price_at_cond_2 | integer | Quantitatively derived value of the property at the condition rating of C4 | 430000 | \n|
| value.price_at_cond_3 | integer | Quantitatively derived value of the property at the condition rating of C3 | 440000 | \n|
| value.price_at_cond_4 | integer | Quantitatively derived value of the property at the condition rating of C2 | 460000 | \n|
| value.price_at_cond_5 | integer | Quantitatively derived value of the property at the highest condition rating of C1 | 490000 | \n|
| value.condition_class | string | The current condition rating of the property as determined by HouseCanary. The standardized condition rating (C1 through C6) conforms to the UAD guidelines for determining condition. | C4 | \n[C1, C2, C3, C4, C5, C6] |
Estimate adjusted property values based on potential modifications, useful for evaluating renovation opportunities and ROI. At least one of the following parameters is required to adjust value: addition of bedrooms, bathrooms, square footage, or pool.
\nIf multiple details are specified in one request, the adjusted_value_to in the response will reflect the combined effect of all adjustments - it will not return separate values for each individual adjustment. To determine the value effects of several different adjustments, multiple queries are required, but can be combined into one POST request.
\nIf we cannot perform the adjustment for any reason, a 204 response will be returned and the call will not be charged.
\nSource: HouseCanary
\nPricing Tier: Basic
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| add_beds | integer | The number of bedrooms to add to calculate an adjusted value for the property. | 2 | \n
| add_baths | number | The number of bathrooms to add to calculate an adjusted value for the property. Only accepts whole and half number values, corresponding to full and half bathrooms. | 1 | \n
| add_sqft | integer | The number of square feet to add to calculate an adjusted value for the property. | 400 | \n
| add_pools | integer | The number of pools to add to calculate an adjusted value for the property. Only accepts a value of \"1\". | 1 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| adjusted_value_to | integer | The adjusted value of the property based on the provided adjustments. | 350000 | \n
| adjustments | object | \n | |
| adjustments.add_beds | integer | The number of bedrooms added to calculate the adjusted value. | 2 | \n
| adjustments.add_baths | number | The number of bathrooms added to calculate the adjusted value. | 1.5 | \n
| adjustments.add_sqft | integer | The number of square feet added to calculate the adjusted value. | 400 | \n
| adjustments.add_pools | integer | The number of pools added to calculate the adjusted value. | 1 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"The number of bedrooms to add to calculate an adjusted value for the property.
\n","type":"text/plain"},"key":"add_beds","value":"2"},{"description":{"content":"The number of bathrooms to add to calculate an adjusted value for the property. Only accepts whole and half number values, corresponding to full and half bathrooms.
\n","type":"text/plain"},"key":"add_baths","value":"1"},{"description":{"content":"The number of square feet to add to calculate an adjusted value for the property.
\n","type":"text/plain"},"key":"add_sqft","value":"400"},{"description":{"content":"The number of pools to add to calculate an adjusted value for the property. Only accepts a value of \"1\".
\n","type":"text/plain"},"key":"add_pools","value":"1"}],"variable":[]}},"response":[{"id":"d592f388-acb0-4247-94cb-0a52e65cc99a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicEstimate adjusted property values based on potential modifications, useful for evaluating renovation opportunities and ROI. At least one of the following parameters is required to adjust value: addition of bedrooms, bathrooms, square footage, or pool.
\nIf multiple details are specified in one request, the adjusted_value_to in the response will reflect the combined effect of all adjustments - it will not return separate values for each individual adjustment. To determine the value effects of several different adjustments, multiple queries are required, but can be combined into one POST request.
\nIf we cannot perform the adjustment for any reason, a 204 response will be returned and the call will not be charged.
\nSource: HouseCanary
\nPricing Tier: Basic
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| add_beds | integer | The number of bedrooms to add to calculate an adjusted value for the property. | 2 | \n
| add_baths | number | The number of bathrooms to add to calculate an adjusted value for the property. Only accepts whole and half number values, corresponding to full and half bathrooms. | 1 | \n
| add_sqft | integer | The number of square feet to add to calculate an adjusted value for the property. | 400 | \n
| add_pools | integer | The number of pools to add to calculate an adjusted value for the property. Only accepts a value of \"1\". | 1 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| adjusted_value_to | integer | The adjusted value of the property based on the provided adjustments. | 350000 | \n
| adjustments | object | \n | |
| adjustments.add_beds | integer | The number of bedrooms added to calculate the adjusted value. | 2 | \n
| adjustments.add_baths | number | The number of bathrooms added to calculate the adjusted value. | 1.5 | \n
| adjustments.add_sqft | integer | The number of square feet added to calculate the adjusted value. | 400 | \n
| adjustments.add_pools | integer | The number of pools added to calculate the adjusted value. | 1 | \n
The number of bedrooms to add to calculate an adjusted value for the property.
\n","type":"text/plain"},"key":"add_beds","value":"2"},{"description":{"content":"The number of bathrooms to add to calculate an adjusted value for the property. Only accepts whole and half number values, corresponding to full and half bathrooms.
\n","type":"text/plain"},"key":"add_baths","value":"1"},{"description":{"content":"The number of square feet to add to calculate an adjusted value for the property.
\n","type":"text/plain"},"key":"add_sqft","value":"400"},{"description":{"content":"The number of pools to add to calculate an adjusted value for the property. Only accepts a value of \"1\".
\n","type":"text/plain"},"key":"add_pools","value":"1"}],"variable":[]}},"response":[{"id":"23cc132c-bd78-49b9-bdc5-ec542df35b62","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's 3-year home price forecasts, essential for understanding market trends and making informed investment decisions.
\nHome values are forecast 3 years into the future using HouseCanary's AVM values and home price index (HPI) at a zip code level. Fields include forecast % growth (decline) at the following monthly intervals into the future: 3, 6, 12, 18, 24, 30 and 36.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| month_03 | object | Forecasted value information for 3 months with ZIP level Home Price Index | \n |
| month_03.value | integer | HouseCanary forecasted value within the 3 month period | 350000 | \n
| month_06 | object | Forecasted value information for 6 months with ZIP level Home Price Index | \n |
| month_06.value | integer | HouseCanary forecasted value within the 6 month period | 365000 | \n
| month_12 | object | Forecasted value information for 12 months with ZIP level Home Price Index | \n |
| month_12.value | integer | HouseCanary forecasted value within the 12 month period | 375000 | \n
| month_18 | object | Forecasted value information for 18 months with ZIP level Home Price Index | \n |
| month_18.value | integer | HouseCanary forecasted value within the 18 month period | 380000 | \n
| month_24 | object | Forecasted value information for 24 months with ZIP level Home Price Index | \n |
| month_24.value | integer | HouseCanary forecasted value within the 24 month period | 390000 | \n
| month_30 | object | Forecasted value information for 30 months with ZIP level Home Price Index | \n |
| month_30.value | integer | HouseCanary forecasted value within the 30 month period | 400000 | \n
| month_36 | object | Forecasted value information for 36 months with ZIP level Home Price Index | \n |
| month_36.value | integer | HouseCanary forecasted value within the 36 month period | 410000 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"}],"variable":[]}},"response":[{"id":"ebd1dfcf-8893-43ef-a9ff-3c8b271e1d04","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's 3-year home price forecasts, essential for understanding market trends and making informed investment decisions.
\nHome values are forecast 3 years into the future using HouseCanary's AVM values and home price index (HPI) at a zip code level. Fields include forecast % growth (decline) at the following monthly intervals into the future: 3, 6, 12, 18, 24, 30 and 36.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example |
|---|---|---|---|
| [] | object | \n | |
| [].slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| [].address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| [].unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| [].city | string | City in which the property is located | San Francisco | \n
| [].state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| [].zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| Field | Type | Description | Example |
|---|---|---|---|
| month_03 | object | Forecasted value information for 3 months with ZIP level Home Price Index | \n |
| month_03.value | integer | HouseCanary forecasted value within the 3 month period | 350000 | \n
| month_06 | object | Forecasted value information for 6 months with ZIP level Home Price Index | \n |
| month_06.value | integer | HouseCanary forecasted value within the 6 month period | 365000 | \n
| month_12 | object | Forecasted value information for 12 months with ZIP level Home Price Index | \n |
| month_12.value | integer | HouseCanary forecasted value within the 12 month period | 375000 | \n
| month_18 | object | Forecasted value information for 18 months with ZIP level Home Price Index | \n |
| month_18.value | integer | HouseCanary forecasted value within the 18 month period | 380000 | \n
| month_24 | object | Forecasted value information for 24 months with ZIP level Home Price Index | \n |
| month_24.value | integer | HouseCanary forecasted value within the 24 month period | 390000 | \n
| month_30 | object | Forecasted value information for 30 months with ZIP level Home Price Index | \n |
| month_30.value | integer | HouseCanary forecasted value within the 30 month period | 400000 | \n
| month_36 | object | Forecasted value information for 36 months with ZIP level Home Price Index | \n |
| month_36.value | integer | HouseCanary forecasted value within the 36 month period | 410000 | \n
HouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence. If the optional FSD threshold is supplied, customers are not billed for responses containing AVMs not meeting the threshold.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| fsd_threshold | number | FSD threshold for the subject avm value | 0.05 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| subject_address | object | \n | ||
| subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| subject_address.city | string | City where property is located | San Francisco | \n|
| subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| subject_address.state | string | 2-character state abbreviation | CA | \n|
| subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| subject_address.address | string | Street address | 123 Main St | \n|
| subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| value | object | \n | ||
| value.price_upper | integer | Upper bound of the avm value | 380000 | \n|
| value.price_lower | integer | Lower bound of the avm value | 350000 | \n|
| value.price_mean | integer | Mean avm value | 365000 | \n|
| value.fsd | number | Fractional standard deviation of the avm value | 0.5 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"FSD threshold for the subject avm value
\n","type":"text/plain"},"key":"fsd_threshold","value":"0.05"}],"variable":[]}},"response":[{"id":"321a6e1e-383e-4072-8b2f-28f7e7ee0620","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicHouseCanary's proprietary Automated Valuation Model (AVM) utilizes a unique machine learning algorithm on top of multiple input data sources to estimate the current market value of a residential property. Responses include upper and lower bounds, as well as a forecast standard deviation (FSD) for transparency into model confidence. If the optional FSD threshold is supplied, customers are not billed for responses containing AVMs not meeting the threshold.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| fsd_threshold | number | FSD threshold for the subject avm value (optional) | 0.05 | \n|
| address_query | array | List of addresses | \n | |
| address_query[] | object | \n | ||
| address_query[].address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| address_query[].address_id | integer | HouseCanary address identifier | 34343343 | \n|
| address_query[].slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| address_query[].block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| address_query[].city | string | City where property is located | San Francisco | \n|
| address_query[].fips | string | 5-digit US census county ID | 06075 | \n|
| address_query[].geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| address_query[].latitude | number | Latitude value, in degrees | 37.789 | \n|
| address_query[].longitude | number | Longitude value, in degrees | -122.401 | \n|
| address_query[].state | string | 2-character state abbreviation | CA | \n|
| address_query[].unit | string | Unit within the building, if any | Apt 1 | \n|
| address_query[].address | string | Street address | 123 Main St | \n|
| address_query[].zipcode | string | 5-character US zipcode | 94132 | \n|
| address_query[].zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| address_query[].msa | string | 5-digit US census MSA ID | 41860 | \n
| Field | Type | Description | Example | Enum Values |
|---|---|---|---|---|
| [] | object | \n | ||
| [].subject_address | object | \n | ||
| [].subject_address.address_full | string | Full address string | 123 Main St San Francisco CA 94132 | \n|
| [].subject_address.address_id | integer | HouseCanary address identifier | 34343343 | \n|
| [].subject_address.slug | string | HouseCanary address slug | 123-Main-St-Apt-1-San-Francisco | \n|
| [].subject_address.block_id | string | 15-digit US census block ID | 060750313013007 | \n|
| [].subject_address.city | string | City where property is located | San Francisco | \n|
| [].subject_address.fips | string | 5-digit US census county ID | 06075 | \n|
| [].subject_address.geo_precision | string | A string describing available geo precision | rooftop | \n[rooftop, parcel, zip9, zip5, unknown] |
| [].subject_address.latitude | number | Latitude value, in degrees | 37.789 | \n|
| [].subject_address.longitude | number | Longitude value, in degrees | -122.401 | \n|
| [].subject_address.state | string | 2-character state abbreviation | CA | \n|
| [].subject_address.unit | string | Unit within the building, if any | Apt 1 | \n|
| [].subject_address.address | string | Street address | 123 Main St | \n|
| [].subject_address.zipcode | string | 5-character US zipcode | 94132 | \n|
| [].subject_address.zipcode_plus4 | string | 4-character zipcode extension | 1234 | \n|
| [].subject_address.msa | string | 5-digit US census MSA ID | 41860 | \n|
| [].value | object | \n | ||
| [].value.price_upper | integer | Upper bound of the avm value | 380000 | \n|
| [].value.price_lower | integer | Lower bound of the avm value | 350000 | \n|
| [].value.price_mean | integer | Mean avm value | 365000 | \n|
| [].value.fsd | number | Fractional standard deviation of the avm value | 0.5 | \n|
| [].errors | array | \n | ||
| [].errors[] | string | \n |
Obtain adjusted property values based on desired dates using HPI, facilitating historical and future value comparisons.
\nThe data shows the dollar value of this property adjusted from its current AVM value to a desired date, either in the past or in the future. Adjustments are done by using HPI for block, block group, zipcode, MSA and state. All five adjustments are returned in the response.
\nIf the optional parameters client_value and client_date are given, the response will also show adjustment from that date and value to the same desired date.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n| Property | Type | Description | Example |
|---|---|---|---|
| slug | string | Unique readable string identifier for the property | 123-Main-St-Apt-1-San-Francisco | \n
| address | string | Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers) | 123 Main St | \n
| unit | string | Unit number for the property, if needed and not already specified in the address string | Apt 1 | \n
| city | string | City in which the property is located | San Francisco | \n
| state | string | 2-letter acronym of the US state in which the property is located | CA | \n
| zipcode | string | 5-digit US zipcode in which the property is located | 94105 | \n
| adjust_to_date | string | Target date to adjust the value to. Must be the first of the month, in the ISO format, e.g. \"2017-01-01\". If not supplied, defaults to the current month. | 2017-01-01 | \n
| client_value | number | Alternative dollar value to adjust, supplied by the caller. | 950000 | \n
| client_date | string | Date corresponding to the client_value. Must be the first of the month, in the ISO format, e.g. \"2017-01-01\" | \n |
| Field | Type | Description | Example |
|---|---|---|---|
| client_value_adjusted | object | \n | |
| client_value_adjusted.from_value | integer | Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request. | 315000 | \n
| client_value_adjusted.from_date | string | Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request. | 2023-01-15 | \n
| client_value_adjusted.to_date | string | Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request. | 2023-06-30 | \n
| client_value_adjusted.adjusted_by | object | The set of HPIs used to adjust the property value in time. | \n |
| client_value_adjusted.adjusted_by.block | integer | Resulting value after adjusting by block HPI | 904022 | \n
| client_value_adjusted.adjusted_by.blockgroup | integer | Resulting value after adjusting by blockgroup HPI | 972028 | \n
| client_value_adjusted.adjusted_by.zip | integer | Resulting value after adjusting by ZIP code HPI | 984655 | \n
| client_value_adjusted.adjusted_by.msa | integer | Resulting value after adjusting by MSA HPI | 994023 | \n
| client_value_adjusted.adjusted_by.state | integer | Resulting value after adjusting by state HPI | 894021 | \n
| housecanary_value_adjusted | object | The result of adjusting HouseCanary’s current AVM to another date using HouseCanary’s HPIs | \n |
| housecanary_value_adjusted.from_value | integer | Property value as of `from_date`. Defaults to the HouseCanary AVM. Will be `client_value` if supplied in the request. | 315000 | \n
| housecanary_value_adjusted.from_date | string | Date from which the value is adjusted. Defaults to the current month. Will be `client_date` if supplied in the request. | 2023-01-15 | \n
| housecanary_value_adjusted.to_date | string | Date from which the value is adjusted. Defaults to the current month. Will be `adjust_to_date` if supplied in the request. | 2023-06-30 | \n
| housecanary_value_adjusted.adjusted_by | object | The set of HPIs used to adjust the property value in time. | \n |
| housecanary_value_adjusted.adjusted_by.block | integer | Resulting value after adjusting by block HPI | 904022 | \n
| housecanary_value_adjusted.adjusted_by.blockgroup | integer | Resulting value after adjusting by blockgroup HPI | 972028 | \n
| housecanary_value_adjusted.adjusted_by.zip | integer | Resulting value after adjusting by ZIP code HPI | 984655 | \n
| housecanary_value_adjusted.adjusted_by.msa | integer | Resulting value after adjusting by MSA HPI | 994023 | \n
| housecanary_value_adjusted.adjusted_by.state | integer | Resulting value after adjusting by state HPI | 894021 | \n
Unique readable string identifier for the property
\n","type":"text/plain"},"key":"slug","value":"123-Main-St-Apt-1-San-Francisco"},{"description":{"content":"Either a single URL-safe string (\"slug\") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)
\n","type":"text/plain"},"key":"address","value":"123 Main St"},{"description":{"content":"Unit number for the property, if needed and not already specified in the address string
\n","type":"text/plain"},"key":"unit","value":"Apt 1"},{"description":{"content":"City in which the property is located
\n","type":"text/plain"},"key":"city","value":"San Francisco"},{"description":{"content":"2-letter acronym of the US state in which the property is located
\n","type":"text/plain"},"key":"state","value":"CA"},{"description":{"content":"5-digit US zipcode in which the property is located
\n","type":"text/plain"},"key":"zipcode","value":"94105"},{"description":{"content":"Target date to adjust the value to. Must be the first of the month, in the ISO format, e.g. \"2017-01-01\". If not supplied, defaults to the current month.
\n","type":"text/plain"},"key":"adjust_to_date","value":"2017-01-01"},{"description":{"content":"Alternative dollar value to adjust, supplied by the caller.
\n","type":"text/plain"},"key":"client_value","value":"950000"},{"description":{"content":"Date corresponding to the client_value. Must be the first of the month, in the ISO format, e.g. \"2017-01-01\"
\n","type":"text/plain"},"key":"client_date","value":"2021-12-08"}],"variable":[]}},"response":[{"id":"b32085a3-d5d7-473a-a5ff-07fb0cfd03a2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicObtain adjusted property values based on desired dates using HPI, facilitating historical and future value comparisons.
\nThe data shows the dollar value of this property adjusted from its current AVM value to a desired date, either in the past or in the future. Adjustments are done by using HPI for block, block group, zipcode, MSA and state. All five adjustments are returned in the response.
\nIf the optional parameters client_value and client_date are given, the response will also show adjustment from that date and value to the same desired date.
\nSource: HouseCanary
\nPricing Tier: Premium
\nUpdated: Monthly
\n