v1

latestOpenAPI 3.1.02026-07-265018.6 KB
Property

Property Search

Search and paginate through properties across states, counties, or cities. The "state" field is required. For best performance and lowest latency, include "state", "county", and "address" — ZIP codes and city names vary across data sources. By default, broad searches exclude parcels without assigned addresses; set "includeUnassignedAddress=true" to include them. Pagination: use the "cursor" parameter for efficient pagination at any depth — see the Pagination guide for full details. The legacy "offset" parameter still works but is deprecated.

get/public/property/search/

Query parameters

statestring required

Two-letter state (required field) (e.g., "CA")

zipCodestring

ZIP code of the property (optional field).

countystring

County where the property is located (optional field).

citystring

City where the property is located (optional field).

transferedSincestring

Days to look back for transfers (e.g., "30") (optional field).

useCodeinteger

Numerical use code (e.g., 1002, 1001) (optional field).

addressstring

The street address line 1 only (e.g. “123 Main Street”). Do not include city, state, or ZIP in this field. (optional field)

unitNumberStrippedstring

The unit number of the property (optional field). Do not include the type of unit. (e.g. “APT 2B” would just be “2B”)

includeUnassignedAddressboolean

If true, include parcels that do not yet have an assigned address. By default, broad searches exclude null or blank addresses.

limitinteger

Maximum number of results to return. Defaults to 10, maximum is 100.

cursorstring

Opaque pagination token. Pass the value from a previous response's "metadata.nextCursor" to retrieve the next page. Omit on the first request. Constant-time per page regardless of pagination depth — preferred over "offset" for paginating through more than a few hundred results.

offsetinteger

Deprecated. Number of records to skip. Defaults to 0. Use "cursor" instead — "offset" does not scale beyond a few thousand records and may produce timeout errors on deep pagination. Responses that include the "offset" parameter will return a "Deprecation: true" header along with a "metadata.deprecationNotice" field.

residentialboolean

If true, only residential properties; if false, only non-residential (optional field).

Response

Properties found successfully

propertiesobject[]

Array of property features found.