The following sections of the docs will help you navigate the Property Search API.
There's a ton of filter options to choose from and it can be overwhelming to start. But some things never change - namely knowing the different Search API setting modes and how to set locations (Step 2).
As you look through how each mode is billed, note that it'll primarily be driven by grabbing actual records vs other things like counts or list of IDs as well as what type of plan you are on. The Pay-as-you-go doesn't have any unlimited or 0 credit calls to prevent abuse in our system.
The focus of this section is to highlight the 4 main modes that are supported on Property Search API:
- Default Mode (Variable Credits / API call): returns fuller property records with a defined schema of assessor & recorder data fields. However many records you request with "size" or are returned ("recordCount"), is the number of credits consumed by that API call.
- Count Mode (0 credits / API call for paid plans; 1 credit / API call on pay-as-you-go plans): only returns a "resultCount" that is the total number of property records that match your specified search criteria aside from the count: true
- IDs Only Mode (0 credits / API call on paid plans; 1 credit / API call on pay-as-you-go plans): only returns a list of the unique property IDs for each search result matching your specified search criteria. Save them to make lookups later, or immediately feed them to Property Detail / Property Detail Bulk API for full enrichment of the county assessor / tax recorder record or any of the other APIs that accept unique property IDs as an input field
- Summary Mode (0 credits / API call if used with count: true; 1 credit / API call on pay-as-you-go plans): only returns a report with a dozen or so key metrics for a given geo