> ## Documentation Index > Fetch the complete documentation index at: https://developers.investorlift.com/llms.txt > Use this file to discover all available pages before exploring further. # Resolve a street line to one parcel of the dataset > One parcel of the place index for a street line and a ZIP, a point, or an assessor parcel number and a state. The API folds the line, or the APN, as the index keyed each parcel, and picks the unit the line names. With lat and lng it finds the nearest parcel in 30 metres. Use it to turn an address, a map click or an APN into a parcel id. A building with several units and no unit in the line, or an APN two counties share, answers 422 ambiguous_address. No parcel answers 404. A call costs 0 credits. [The dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/dataset). ## OpenAPI ````yaml /openapi.json get /v3/properties/resolve openapi: 3.1.0 info: title: God Mode API version: 1.44.0 description: >- You have a house to sell, usually a wholesale contract. You want **the investors who buy houses like this one, from county deed records**. This API reads those records for each served state and serves the buyers: the organizations behind the deeds, their people, the agents, the lenders and the listings. On every response, `meta.build.states[]` lists the served states and the publish behind each. **Deals** are the flagged purchases of the deed cut: a sale at arm's length that the rules read as an investment. **Buyers** are the organizations behind them: one organization for the entities of a registry, with the people it files. **Lenders** are the organizations that hold the loans on those deals, keyed through the same registry. The documentation site at https://developers.investorlift.com carries the guides, the walkthroughs, the error catalogue and the connection steps for MCP clients. https://developers.investorlift.com/llms.txt indexes the site for a model. This document is the machine-readable reference behind the API tab of the site. **Start here.** The buyers of one Scottsdale ZIP code since 2024, the most purchases first: ``` GET https://api.investorlift.com/v3/buyers?zip=85251&from=2024-01-01&limit=3 Authorization: Bearer zpka_... ``` **Conventions.** Responses are `{ data, meta }`. Lists add `page` (an opaque cursor). A list parameter takes commas or repeated keys. Dates are YYYY-MM-DD. The ids are the ids of the files. An organization is the state, a colon and its registry number (`AZ:L17142520`). A person is `person:` and 12 hex characters, and an agent is the state, `:agt:` and 12 hex characters. A deal is 32 hex characters. Money is whole dollars. It is null, never 0, when the deed carries no price. Coordinates are WGS84. A place is a ZIP list (`zip`), a point and radius (`lat`, `lng`, `radius_miles`) or a viewport (`bbox=west,south,east,north`). A parcel (`property_id`) and an address with its ZIP are places too. Every operation carries `x-credits`, its price in credits on the public tier. `charge` is null at 0 credits. Otherwise `kind` names the deal, investor or property (a parcel) that costs 1 credit when new to your account. `base` is the credits a call costs before them. `contract: true` marks a route sold by contract. Every operation also carries `x-raises`, the problem codes it can answer, sorted. Each problem response of the operation lists and shows the codes of its status alone. The list includes the codes the gateway answers on its own. This host does not serve the name of a person, a licence, a phone, an email, a website or a mailing address. It serves the organizations, the deals, the buyers, the properties, the places, the listings and the lenders. Errors are RFC 9457 problem+json with a `code` to switch on. The catalogue is https://developers.investorlift.com/problems.json and the Errors page of the site. The header `X-Dataset-Version` changes only when a state is published again. Use it in cache keys, or poll `GET /v3/build`. **MCP.** The API serves the same data to Model Context Protocol clients at `POST https://api.investorlift.com/mcp` with the same key: forty-five read-only tools, five resources, six prompts. The MCP tab of the documentation site has the client setup. The file `mcp-manifest.json` beside this document lists the tools with their inputs. Problem codes: 400 validation_error, 400 unknown_parameter, 400 invalid_cursor, 400 geometry_required, 400 geometry_conflict, 400 sort_requires_point, 400 invalid_id, 400 market_required, 401 unauthorized, 403 quota_exceeded, 403 subscription_required, 403 payment_overdue, 403 plan_limit, 404 not_found, 404 job_not_found, 409 job_not_done, 406 not_acceptable, 410 gone, 413 batch_too_large, 422 outside_coverage, 422 ambiguous_apn, 422 ambiguous_address, 422 csv_cap_exceeded, 422 listings_unavailable, 422 agents_unavailable, 422 lenders_unavailable, 422 wholesale_unavailable, 422 str_unavailable, 422 cash_sale_unavailable, 422 auction_unavailable, 422 parcels_unavailable, 422 addresses_unavailable, 422 dated_refused, 422 history_unavailable, 400 quicklist_unavailable, 400 dataset_unavailable, 429 rate_limited, 500 internal_error, 503 database_unavailable, 503 pool_saturated, 503 ledger_unavailable, 503 jobs_unavailable, 504 statement_timeout. servers: - url: https://api.investorlift.com security: - bearerAuth: [] tags: - name: dataset x-group: Dataset description: >- The served set, under `/v3`: who buys houses, from the state business registry, the deeds, the listings and the loans. The routes serve a name search, the organizations, the people, the agents, the deals and the buyers. They serve the properties, the places, the listings and the lenders too. Two probes serve the coverage and the build of each served state. externalDocs: description: >- The documentation site: the guides, the walkthroughs, the error catalogue and the MCP connection steps. url: https://developers.investorlift.com paths: /v3/properties/resolve: get: tags: - dataset summary: Resolve a street line to one parcel of the dataset description: >- One parcel of the place index for a street line and a ZIP, a point, or an assessor parcel number and a state. The API folds the line, or the APN, as the index keyed each parcel, and picks the unit the line names. With lat and lng it finds the nearest parcel in 30 metres. Use it to turn an address, a map click or an APN into a parcel id. A building with several units and no unit in the line, or an APN two counties share, answers 422 ambiguous_address. No parcel answers 404. A call costs 0 credits. [The dataset of the Investorlift Data API](https://developers.investorlift.com/api-reference/dataset). operationId: resolveProperty parameters: - schema: type: string minLength: 3 maxLength: 200 in: query name: address required: false description: >- A street line, with zip: the house number and the street, the unit inside the line when the building has several. For example 7522 E Cholla St. One of address with zip, lat with lng, or apn with state, is required. - schema: type: string pattern: ^\d{5}$ in: query name: zip required: false description: The 5-digit ZIP of the address, with address. - schema: type: number minimum: -90 maximum: 90 in: query name: lat required: false description: >- Point latitude, with lng: the nearest parcel of the place index inside 30 metres of the point, for a map click. - schema: type: number minimum: -180 maximum: 180 in: query name: lng required: false description: Point longitude, with lat. - schema: type: string minLength: 1 maxLength: 40 in: query name: apn required: false description: >- An assessor parcel number, with state: as the county writes it, with or without its dashes and dots. The API folds it as the index keyed each parcel, so 131-28-253 and 13128253 meet. Not with an address or a point. - schema: type: string pattern: ^[A-Z]{2}$ in: query name: state required: false description: >- The served state of the APN, with apn: an APN is a key of a county, so the state names the partition the API reads. - schema: type: string pattern: ^\d{5}$ in: query name: county required: false description: >- With apn: one county by its 5-digit FIPS, when an APN two counties of the state share answers 422 ambiguous_address. responses: '200': description: One parcel. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Parcel' meta: $ref: '#/components/schemas/DatasetMeta' required: - data - meta additionalProperties: false description: One parcel. example: data: line: null unit: null city: Phoenix zip: '85031' county_fips: '04013' apn: null latitude: 33.499313 longitude: -112.180484 address_held_back: listed_on_investorlift location_radius_m: 1200 property_id: af3af85f9f21671a0c7b7728a6faade3 state: AZ n_deeds: 1 n_flagged: 1 holder: deal_id: d8b68d172db0dcc93487813a77119c03 sale_date: '2026-09-01' price: 185000 doc_class: ECONOMIC flagged: true buyers: - name: ZAK VENTURES LLC org_id: AZ:L09606353 org_name: ZAK VENTURES LLC from_registry: true match_basis: filed company_like: true tags: [] person_id: null owner: n_owners: 1 names: - ZAK VENTURES LLC display_names: - ZAK VENTURES LLC is_company: true is_trust: false is_government: false ownership_rights: Limited Partnership status_type: Company Owned ownership_start_date: '2026-09-14' length_of_residence_months: 0 owner_occupied: false absentee: true mailing: line: 10115 E Bell Rd Ste 107 city: Scottsdale state: AZ zip: '85260' hash: 44367e30f515dae2245939de68d86ff7 mailing_out_of_state: false last_purchase: deal_id: d8b68d172db0dcc93487813a77119c03 sale_date: '2026-09-01' price: 185000 last_deed: position: 1 sale_date: '2026-09-01' document_type: Warranty Deed purchase_match: exact purchase_match_strength: strong deed_match: exact deed_match_strength: strong acquisition_basis: purchase held_since: '2026-09-01' held_since_basis: purchase_deed months_held: 0.7 attributes: property_type_category: Residential property_type_detail: Single Family segment: SFR land_use_code: R2 vacant: false year_built: 1957 effective_year_built: 1957 living_area_sqft: 1293 building_sqft: 1293 bedrooms: 3 bathrooms: 2 full_bathrooms: 2 partial_bathrooms: null stories: 1 garage_spaces: 1 pool: null buildings: 1 units: 1 construction_type: Concrete Block lot_sqft: 6264 lot_acres: 0.144 zoning_code: R-6 assessed_total: 25720 assessed_land: null assessed_improvement: null assessment_year: 2027 market_value_total: 257200 market_value_year: 2027 tax_amount: 827 tax_year: 2025 tax_delinquent_year: 2024 tax_exemptions: null financing: open_lien_count: 0 open_lien_balance: null free_and_clear: true has_heloc: false cash_purchase: null first_lien: null last_mortgage: null avm: value: 269215 low: 215372 high: 323058 sd: 20 confidence: 80 as_of: '2026-04-08' equity: balance: 269215 percent: 100 ltv: 0 involuntary_lien_count: 0 open_liens: [] history: [] liens: [] as_of: '2026-06-25' recordings_through: '2026-06-11' meta: generated_at: '2026-10-18T21:38:34.282Z' coverage: [] terms: >- Data: Investorlift Data Services. Public-record and MLS listing data licensed through BatchData; municipal short-term rental registries; Investorlift marketplace records. Attribution and data-use terms: https://developers.investorlift.com/guides/terms build: states: - state: AZ build_id: 5ca22a59 built_at: '2026-10-18T21:14:14.380Z' published_at: '2026-10-18T21:29:36.244Z' run_id: 1792358069 financing_as_of: '2026-06-25' recordings_through: '2026-06-11' financing_source: replay_887 str_as_of: '2026-10-18' - state: CA build_id: null built_at: '2026-09-24T01:58:30.453Z' published_at: '2026-09-24T03:15:56.838Z' run_id: 1790215190 financing_as_of: null recordings_through: null financing_source: null str_as_of: null - state: FL build_id: 0e5fa9bc built_at: '2026-09-24T15:08:23.506Z' published_at: '2026-09-24T18:59:42.805Z' run_id: 1790262682 financing_as_of: null recordings_through: null financing_source: null str_as_of: null - state: TX build_id: 775ed08d built_at: '2026-09-24T11:08:10.587Z' published_at: '2026-09-24T13:16:03.157Z' run_id: 1790248213 financing_as_of: null recordings_through: null financing_source: null str_as_of: null headers: ETag: $ref: '#/components/headers/ETag' X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-Rows: $ref: '#/components/headers/X-Rows' X-Dataset-Version: $ref: '#/components/headers/X-Dataset-Version' X-Data-End: $ref: '#/components/headers/X-Data-End' '400': description: Bad request (unknown_parameter, validation_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: unknown_parameter: summary: Unknown parameter value: type: >- https://developers.investorlift.com/guides/concepts/errors#unknown_parameter title: Unknown parameter status: 400 code: unknown_parameter detail: >- The query carries a parameter this endpoint does not define: kind[]. Write the list as kind=flip,hold or as repeated keys. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 errors: - param: kind[] message: unknown parameter code: unknown_parameter validation_error: summary: Validation error value: type: >- https://developers.investorlift.com/guides/concepts/errors#validation_error title: Validation error status: 400 code: validation_error detail: radius_miles must be 20 or less. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 errors: - param: radius_miles message: must be 20 or less code: too_big headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '401': description: Unauthorized (unauthorized) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: unauthorized: summary: Unauthorized value: type: >- https://developers.investorlift.com/guides/concepts/errors#unauthorized title: Unauthorized status: 401 code: unauthorized detail: 'Send Authorization: Bearer with a current key.' instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '403': description: Forbidden (payment_overdue, subscription_required) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: payment_overdue: summary: Payment overdue value: type: >- https://developers.investorlift.com/guides/concepts/errors#payment_overdue title: Payment overdue status: 403 code: payment_overdue detail: >- The subscription's payment is overdue and the grace period passed. Update the card under Manage Billing in the developer console. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 subscription_required: summary: Subscription required value: type: >- https://developers.investorlift.com/guides/concepts/errors#subscription_required title: Subscription required status: 403 code: subscription_required detail: >- This key has no active plan subscription. Subscribe in the developer console. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '404': description: Not found (not_found) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: not_found: summary: Not found value: type: >- https://developers.investorlift.com/guides/concepts/errors#not_found title: Not found status: 404 code: not_found detail: No such deal in any loaded market. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '406': description: Not acceptable (not_acceptable) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: not_acceptable: summary: Not acceptable value: type: >- https://developers.investorlift.com/guides/concepts/errors#not_acceptable title: Not acceptable status: 406 code: not_acceptable detail: >- Accept text/html names no representation this endpoint produces (application/json). instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '422': description: Unprocessable (ambiguous_address) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: ambiguous_address: summary: Ambiguous address value: type: >- https://developers.investorlift.com/guides/concepts/errors#ambiguous_address title: Ambiguous address status: 422 code: ambiguous_address detail: >- 7522 E Cholla St in ZIP 85254 names 3 parcels. Pass unit= to pick one. candidates[] lists them. Call GET /v1/properties/{property_id} with the one you mean. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 truncated: false candidates: - id: prop_0a1b2c3d4e5f60718293a4b5c6d7e8f9 unit: '1' n_deals: 2 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '429': description: Rate limited, with Retry-After (rate_limited) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: rate_limited: summary: Rate limited value: type: >- https://developers.investorlift.com/guides/concepts/errors#rate_limited title: Rate limited status: 429 code: rate_limited detail: >- The request exceeded the per-key budget. Retry in 12 seconds. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 retry_after: 12 bucket: key headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '500': description: Internal error (internal_error) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: internal_error: summary: Internal error value: type: >- https://developers.investorlift.com/guides/concepts/errors#internal_error title: Internal error status: 500 code: internal_error detail: The request failed. Quote request_id when you report it. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' '503': description: >- Unavailable, with Retry-After on pool_saturated and ledger_unavailable (database_unavailable, pool_saturated) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: database_unavailable: summary: Database unavailable value: type: >- https://developers.investorlift.com/guides/concepts/errors#database_unavailable title: Database unavailable status: 503 code: database_unavailable detail: >- The service failed to reach the database and did not run the request. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 pool_saturated: summary: Pool saturated value: type: >- https://developers.investorlift.com/guides/concepts/errors#pool_saturated title: Pool saturated status: 503 code: pool_saturated detail: >- No pooled connection was free. The service did not run the request. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: Retry-After: $ref: '#/components/headers/Retry-After' X-Request-Id: $ref: '#/components/headers/X-Request-Id' '504': description: Statement timeout (statement_timeout) content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: statement_timeout: summary: Statement timeout value: type: >- https://developers.investorlift.com/guides/concepts/errors#statement_timeout title: Statement timeout status: 504 code: statement_timeout detail: >- The query exceeded the 10 second statement timeout. Narrow the geometry or filters. instance: /v3/properties/resolve request_id: 6f1c2a8e-3b7d-4f21-9a0c-2e5b81d7a4f3 headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' components: schemas: Parcel: type: object properties: line: description: >- The street line of the parcel. Null when the parcel has no street line, and while the property is listed on the Investorlift marketplace: see address_held_back. type: - string - 'null' unit: description: >- The unit. Null when the parcel has none, and while the property is listed on the Investorlift marketplace. type: - string - 'null' city: description: The city. Null when the file carries none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the file carries none. type: - string - 'null' county_fips: description: The county, 5 digits. Null when the file carries none. type: - string - 'null' apn: description: >- The assessor parcel number. Null while the property is listed on the Investorlift marketplace: see address_held_back. type: - string - 'null' latitude: anyOf: - type: number minimum: -90 maximum: 90 description: WGS84 latitude. - type: 'null' description: >- WGS84 latitude of the parcel. An approximate value while the property is listed on the Investorlift marketplace: see location_radius_m. Null when the parcel has no point. longitude: anyOf: - type: number minimum: -180 maximum: 180 description: WGS84 longitude. - type: 'null' description: >- WGS84 longitude of the parcel. An approximate value while the property is listed on the Investorlift marketplace: see location_radius_m. Null when the parcel has no point. address_held_back: description: >- The reason that the API holds the address of the property back. The value listed_on_investorlift means that a wholesaler lists the property on Investorlift now, and the deed records show no transfer after the listing. Then the street line, the unit and the APN are null, and the point is approximate. Null for each other property. type: - string - 'null' location_radius_m: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The radius in metres of the circle to draw around latitude and longitude: 1200 while the property is listed on Investorlift. The circle always contains the true point. Null when the point is exact, and when the row has no point. property_id: type: string description: 'The parcel, 32 hex characters: the key of every parcel route.' state: type: string description: The 2-letter state of the parcel. n_deeds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The deeds of the parcel in the deed cut, flagged or not. n_flagged: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The deeds the build flagged as investor purchases. holder: anyOf: - $ref: '#/components/schemas/Holder' - type: 'null' description: >- The buyers of the last deed of the parcel. Null when the deed cut holds no deed of the parcel. owner: anyOf: - $ref: '#/components/schemas/Owner' - type: 'null' description: >- The owner of the parcel on the county roll beside its last deed. Null when the roll names no owner, and while the state has no owner table. attributes: anyOf: - $ref: '#/components/schemas/ParcelAttributes' - type: 'null' description: >- The attributes of the parcel as the roll gives them. Null when the cut holds no roll row of the parcel, and while the state has no parcel table. financing: anyOf: - $ref: '#/components/schemas/ParcelFinancing' - type: 'null' description: >- The financing of the parcel at the date of the slice: the open positions, the recorded instruments, the involuntary liens, the valuation and the equity. Null while the state has no financing slice, and when the slice has no row for the parcel. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. required: - line - unit - city - zip - county_fips - apn - latitude - longitude - address_held_back - location_radius_m - property_id - state - n_deeds - n_flagged - holder - owner - attributes - financing description: >- One parcel of the place index with its current holder, its owner of the roll and its attributes, under the listed-address rule. DatasetMeta: type: object properties: generated_at: type: string format: date-time description: >- When the API produced this response, ISO 8601. It does not change the ETag. weights: description: >- The effective match weights of a route that scores a match, one per factor, rounded to 4 decimals. Absent on every route of the served set. type: object propertyNames: type: string additionalProperties: type: number reference_point: description: >- The point the API measures every distance in the response from: lat + lng, or the centre of the property_id parcel. Absent with a bare bbox. type: object properties: lat: type: number minimum: -90 maximum: 90 description: Latitude of the reference point. lng: type: number minimum: -180 maximum: 180 description: Longitude of the reference point. required: - lat - lng additionalProperties: false geometry: $ref: '#/components/schemas/MetaGeometry' description: >- The place that ran, defaults filled and keyed as the query is (see MetaGeometry). Present on every route that takes a place: the deals, the pins, the cells, the summary, the buyers and the listings. Copy it back as the query to repeat the request. resolved_from: description: >- Present when the id in the path was an old id of an earlier build: the ids the API followed through the alias table, in order. Store the id the response carries. type: array items: type: string coverage: type: array items: $ref: '#/components/schemas/Coverage' description: >- Empty on every route: the served set carries states, not markets, and meta.build.states[] lists them. dated: description: >- Absent on every route of the served set: no block of it is a dated snapshot. type: array items: $ref: '#/components/schemas/Dated' terms: type: string description: Attribution and data-use terms for the data in this response. build: type: object properties: states: type: array items: $ref: '#/components/schemas/BuildState' description: Every served state, in state order. required: - states additionalProperties: false description: >- The publishes behind the response. The ETag and each cursor follow the newest publish, so a publish ends every cursor. The rows belong to no market of the deed registry, so meta.coverage is empty. required: - generated_at - coverage - terms - build additionalProperties: false description: >- Response metadata of the /v3 family: when the API produced it, and the publishes behind the rows. Problem: type: object properties: type: type: string description: >- URI of the problem: the Errors page of the documentation site, anchored at the code. title: type: string description: Short human-readable summary of the problem code. status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status. code: type: string description: >- Stable machine-readable code from the catalogue at https://developers.investorlift.com/problems.json. detail: type: string description: Human-readable explanation specific to this occurrence. instance: type: string description: Request path. request_id: type: string description: Request id to quote when you report a problem. errors: description: Per-parameter validation failures (400 only). type: array items: type: object properties: param: description: >- The offending parameter. Null when the problem is not about one parameter. type: - string - 'null' message: type: string description: What is wrong with it. code: type: string description: Machine-readable reason, for example invalid_enum_value. required: - param - message - code additionalProperties: false description: One validation failure. required: - type - title - status - code - detail - instance - request_id additionalProperties: {} description: >- RFC 9457 problem details (application/problem+json). Some codes add extra fields beside these: superseded_by, candidates, n_deals, cap, suggestion, markets, retry_after. Holder: type: object properties: deal_id: type: string description: >- The last deed of the parcel in the deed cut, 32 hex characters: the key to `GET /v3/deals/{id}`. sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of that deed, YYYY-MM-DD. Null when the deed carries none. price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The price of that deed, whole US dollars. Null when the deed carries none. doc_class: description: The class of that deed. Null when the file carries none. type: - string - 'null' flagged: type: boolean description: True when the build flagged that purchase as an investor purchase. buyers: type: array items: $ref: '#/components/schemas/DealParty' description: >- The buyer names on that deed, each with the organization it matched: the holders of record. This host does not name a person. required: - deal_id - sale_date - price - doc_class - flagged - buyers additionalProperties: false description: >- The current holder of a parcel: the buyers of its last deed in the deed cut. Owner: type: object properties: n_owners: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The owner names on the roll, one or two. names: type: array items: type: string description: >- The owner names as the roll writes them, a person as FIRST MIDDLE LAST. Served to every key when the one name reads as a company or a public body. A name of a person is not served here: the list is empty without it. display_names: type: array items: type: string description: >- The owner names in their display form (upper case, no period, the entity suffix as one token), in the order of names. Served under the same rule as names: empty when names is empty. is_company: description: >- True when a name has a word of an entity, the vendor cut it, or the rights name a company. Null when the roll carries none. type: - boolean - 'null' is_trust: description: >- True when a name has a word of a trust, or the rights name a trust. Null when the roll carries none. type: - boolean - 'null' is_government: description: True when a name is a public body. Null when the roll carries none. type: - boolean - 'null' ownership_rights: description: >- The ownership rights as the roll writes them, for example Husband and Wife. Null when the roll carries none. type: - string - 'null' status_type: description: >- The owner status type as the roll writes it, for example Company Owned. Null when the roll carries none. type: - string - 'null' ownership_start_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The start of the ownership on the roll, YYYY-MM-DD. Null when the roll carries none. length_of_residence_months: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The months of residence as the roll gives them. Null when the roll carries none. owner_occupied: description: >- True when the roll marks the owner as the occupant, or the mailing address is the parcel. Null when neither is known. type: - boolean - 'null' absentee: description: True when the owner is not the occupant. Null when neither is known. type: - boolean - 'null' mailing: anyOf: - $ref: '#/components/schemas/OwnerMailing' - type: 'null' description: >- The mailing address of the owner. Served with the names, under the same rule. Null when the roll carries none, and when the key does not read the names. mailing_out_of_state: description: >- True when the mailing address is in another state. Null when the roll carries no mailing state. type: - boolean - 'null' last_purchase: anyOf: - type: object properties: deal_id: type: string description: >- The last purchase at arm's length of the parcel, 32 hex characters: the key to `GET /v3/deals/{id}`. sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of that purchase, YYYY-MM-DD. Null when the deed carries none. price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The price of that purchase, whole US dollars. Null when the deed carries none. required: - deal_id - sale_date - price additionalProperties: false - type: 'null' description: >- The last purchase at arm's length of the parcel, the acquisition deed. Null when the deed cut holds none. last_deed: anyOf: - type: object properties: position: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The slot of the deed in the deed cut, 1 the newest. sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of that deed, YYYY-MM-DD. Null when the deed carries none. document_type: description: >- The document type as the county writes it. Null when the file carries none. type: - string - 'null' required: - position - sale_date - document_type additionalProperties: false - type: 'null' description: >- The last deed of any kind of the parcel with a date and a buyer: a quit claim, a transfer into a trust, a re-recording. Null when the deed cut holds none. purchase_match: type: string enum: - exact - prefix - subset - trust_surname - surname_only - none description: >- How the owner names meet the buyer names of the last purchase. Prefix: a name the vendor cut. Subset: every word of the shorter key is in the other, so a couple meets one spouse. Trust surname: the surname of a person is a word of a trust name. Surname only: equal one-word keys. None: no rule met. purchase_match_strength: type: string enum: - strong - family - none description: >- The strength of that match of the last purchase: strong for exact, prefix and subset, family for trust_surname and surname_only, else none. deed_match: type: string enum: - exact - prefix - subset - trust_surname - surname_only - none description: >- How the owner names meet the buyer names of the last deed. Prefix: a name the vendor cut. Subset: every word of the shorter key is in the other, so a couple meets one spouse. Trust surname: the surname of a person is a word of a trust name. Surname only: equal one-word keys. None: no rule met. deed_match_strength: type: string enum: - strong - family - none description: >- The strength of that match of the last deed: strong for exact, prefix and subset, family for trust_surname and surname_only, else none. acquisition_basis: type: string enum: - purchase - transfer - no_deed - unmatched description: >- How the owner holds. Purchase: the names meet the buyers of the last purchase. Transfer: they meet the buyers of the last deed of any kind alone. No deed: the parcel has no dated deed with a buyer. Unmatched otherwise. held_since: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- Since when the owner holds, YYYY-MM-DD: the date of the deed of the basis, else the start date of the roll. Null when no dated source exists. held_since_basis: type: string enum: - purchase_deed - transfer_deed - ownership_record - none description: >- Where held_since comes from: purchase_deed, transfer_deed, ownership_record, or none. months_held: description: >- The months from held_since to the data end of the state, one decimal. Null without held_since. type: - number - 'null' required: - n_owners - names - display_names - is_company - is_trust - is_government - ownership_rights - status_type - ownership_start_date - length_of_residence_months - owner_occupied - absentee - mailing - mailing_out_of_state - last_purchase - last_deed - purchase_match - purchase_match_strength - deed_match - deed_match_strength - acquisition_basis - held_since - held_since_basis - months_held additionalProperties: false description: >- The owner of the parcel on the county roll beside its last deed, with the basis of the hold. Every key reads the facts. The names and the mailing address of a person are not served here. ParcelAttributes: type: object properties: property_type_category: description: >- The property type category of the roll. Null when the roll carries none. type: - string - 'null' property_type_detail: description: >- The property type detail of the roll. Null when the roll carries none. type: - string - 'null' segment: description: >- The segment of the parcel from the type detail: SFR, CONDO_TH or OTHER. Null when the roll carries none. type: - string - 'null' land_use_code: description: The land use code of the roll. Null when the roll carries none. type: - string - 'null' vacant: description: >- True when the roll marks the parcel vacant. Null when the roll carries none. type: - boolean - 'null' year_built: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The year built. Null when the roll carries none. effective_year_built: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The effective year built. Null when the roll carries none. living_area_sqft: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The living area in square feet. Null when the roll carries none. building_sqft: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The building area in square feet. Null when the roll carries none. bedrooms: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The bedrooms. Null when the roll carries none. bathrooms: description: The bathrooms, halves allowed. Null when the roll carries none. type: - number - 'null' full_bathrooms: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The full bathrooms. Null when the roll carries none. partial_bathrooms: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The partial bathrooms. Null when the roll carries none. stories: description: The stories. Null when the roll carries none. type: - number - 'null' garage_spaces: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The garage spaces. Null when the roll carries none. pool: description: True when the roll marks a pool. Null when the roll carries none. type: - boolean - 'null' buildings: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The buildings on the parcel. Null when the roll carries none. units: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The units on the parcel. Null when the roll carries none. construction_type: description: The construction type of the roll. Null when the roll carries none. type: - string - 'null' lot_sqft: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The lot in square feet. Null when the roll carries none. lot_acres: description: The lot in acres. Null when the roll carries none. type: - number - 'null' zoning_code: description: The zoning code of the roll. Null when the roll carries none. type: - string - 'null' assessed_total: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The assessed value, whole US dollars. Null when the roll carries none. assessed_land: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The assessed value of the land, whole US dollars. Null when the roll carries none. assessed_improvement: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The assessed value of the improvements, whole US dollars. Null when the roll carries none. assessment_year: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The year of the assessment. Null when the roll carries none. market_value_total: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The market value of the roll, whole US dollars. Null when the roll carries none. market_value_year: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The year of that market value. Null when the roll carries none. tax_amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The tax, whole US dollars. Null when the roll carries none. tax_year: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The year of that tax. Null when the roll carries none. tax_delinquent_year: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: The first year of a delinquent tax. Null when the roll marks none. tax_exemptions: description: >- The tax exemptions as the roll writes them. Null when the roll carries none. type: - string - 'null' required: - property_type_category - property_type_detail - segment - land_use_code - vacant - year_built - effective_year_built - living_area_sqft - building_sqft - bedrooms - bathrooms - full_bathrooms - partial_bathrooms - stories - garage_spaces - pool - buildings - units - construction_type - lot_sqft - lot_acres - zoning_code - assessed_total - assessed_land - assessed_improvement - assessment_year - market_value_total - market_value_year - tax_amount - tax_year - tax_delinquent_year - tax_exemptions additionalProperties: false description: >- The attributes of the parcel as the county roll gives them, typed: the classification, the building, the lot, the assessment and the tax. Every key reads them. ParcelFinancing: type: object properties: open_lien_count: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The open positions of the parcel as the county counts them. Null when the file carries none. open_lien_balance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The sum of the open balances as the county gives it, whole US dollars. Null when the county carries none. free_and_clear: description: >- True when the county counts no open position. Null when the county carries no count. type: - boolean - 'null' has_heloc: type: boolean description: True when an open position carries the credit-line flag or the type. cash_purchase: description: >- The cash-purchase flag of the first open position. Null when the parcel has no first open position. type: - boolean - 'null' first_lien: anyOf: - $ref: '#/components/schemas/ParcelFirstLien' - type: 'null' description: The first open position. Null when the parcel has none. last_mortgage: anyOf: - $ref: '#/components/schemas/ParcelLastMortgage' - type: 'null' description: The newest recorded instrument. Null when the parcel has none dated. avm: type: object properties: value: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated value of the county feed, whole US dollars. Null when the feed carries no estimate. low: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The low of its range, whole US dollars. Null when the feed carries no estimate. high: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The high of its range, whole US dollars. Null when the feed carries no estimate. sd: description: >- Its standard deviation as the feed gives it. Null when the feed carries no estimate. type: - number - 'null' confidence: description: >- Its confidence score as the feed gives it. Null when the feed carries no estimate. type: - number - 'null' as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the estimate, YYYY-MM-DD. Null when the feed carries no estimate. required: - value - low - high - sd - confidence - as_of additionalProperties: false description: >- The valuation of the feed at the date of the slice. Each field is null when the feed carries none. equity: type: object properties: balance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated equity, whole US dollars. Null when the feed carries no value or no balance. percent: description: >- The equity as a percent of the value. Null when the feed carries no value or no balance. type: - number - 'null' ltv: description: >- The loan-to-value of the parcel, percent. Null when the feed carries no value or no balance. type: - number - 'null' required: - balance - percent - ltv additionalProperties: false description: >- The equity of the feed at the date of the slice. Each field is null when the feed carries none. involuntary_lien_count: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The involuntary liens of the parcel in the slice. open_liens: type: array items: $ref: '#/components/schemas/LoanCore' description: The open positions, by position. history: type: array items: $ref: '#/components/schemas/LoanCore' description: The recorded instruments, the newest first. liens: type: array items: $ref: '#/components/schemas/ParcelLien' description: The involuntary liens, by position. as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, YYYY-MM-DD. Null while the state has no financing slice. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date of the slice, YYYY-MM-DD. Null while the state has no financing slice. required: - open_lien_count - open_lien_balance - free_and_clear - has_heloc - cash_purchase - first_lien - last_mortgage - avm - equity - involuntary_lien_count - open_liens - history - liens - as_of - recordings_through description: >- The financing of a parcel at the date of the slice: the open positions, the recorded instruments, the involuntary liens, the valuation and the equity. The loans are a dated slice. meta.build.states[].financing_as_of and recordings_through give the dates. MetaGeometry: type: object properties: kind: type: string enum: - radius - bbox - place description: >- Which location ran: radius, bbox or place. A radius uses a point, a parcel ID, or a resolved address. A bbox is a viewport. A place is a ZIP list or a postal city. lat: anyOf: - type: number minimum: -90 maximum: 90 description: WGS84 latitude. - type: 'null' description: >- The centre of the radius, or the reference point you gave beside a bbox or a place. For a property_id request the centre is the parcel centroid. Null when a bbox or a place had no reference point. lng: anyOf: - type: number minimum: -180 maximum: 180 description: WGS84 longitude. - type: 'null' description: The longitude beside lat. Null when lat is null. radius_miles: description: >- The radius that ran, in miles: the value you sent, or the default when you sent none. Null for a bbox or a place. type: - number - 'null' bbox: anyOf: - type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: '[west, south, east, north] in WGS84 degrees.' - type: 'null' description: >- The viewport as [west, south, east, north] in WGS84 degrees. Null unless kind is bbox. property_id: anyOf: - type: string pattern: ^prop_[0-9a-f]{32}$ description: >- Parcel id: prop_ followed by 32 hex characters, for example prop_e93c776c53354a88de4e58448a6bf21b. The prefix is part of the id. - type: 'null' description: >- The parcel at the centre of the radius. Null unless the request named property_id. address: description: >- Resolved situs line for an address search. Null for other location forms. This field describes the resolved parcel. type: - string - 'null' zip: anyOf: - type: array items: type: string pattern: ^\d{5}$ - type: 'null' description: >- The ZIP list as you sent it, for example ["85251", "85257"]. Null unless kind is place and the request named ZIPs. city: description: >- The postal city as the API compared it: trimmed and folded to upper case ("Scottsdale" ran as "SCOTTSDALE"). Null unless kind is place and the request named a city. type: - string - 'null' location_radius_m: description: >- Present when the property at the centre is listed on Investorlift. Then lat and lng are an approximate point, address is null, and this value is the radius in metres of the circle that contains the true point. The API measures each distance from the true point. anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' required: - kind - lat - lng - radius_miles - bbox - property_id - address - zip - city additionalProperties: false description: >- The location the API computed the response over, as it ran: defaults filled, a parcel resolved to its centroid, a city folded. Copy it back as the query to repeat the request. Coverage: type: object properties: market: type: string description: Market code, for example phx. One entry per loaded market. state: type: string description: >- 2-letter state of the market. The loaded markets and their states are in meta.coverage[]. counties: type: array items: type: object properties: fips: type: string description: The 5-digit county FIPS code, for example 04013. name: type: string description: County name, for example Maricopa. data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last deed date on file for this county, YYYY-MM-DD. Null when the county carries no dated deed. required: - fips - name - data_end additionalProperties: false description: One county the loaded area lies in. description: >- The counties the loaded area lies in, each with its own data end date. For a zip market the list names the county, but the loaded area is only the ZIP (see universe_kind). bbox: type: array prefixItems: - type: number minimum: -180 maximum: 180 description: West edge (longitude). - type: number minimum: -90 maximum: 90 description: South edge (latitude). - type: number minimum: -180 maximum: 180 description: East edge (longitude). - type: number minimum: -90 maximum: 90 description: North edge (latitude). items: false minItems: 4 maxItems: 4 description: >- The rectangle (west, south, east, north) that encloses every deal in the market: the initial map viewport and, with point_tolerance_miles, the limit for outside_coverage. data_end: type: string format: date description: >- The last deed date in the data, YYYY-MM-DD. The API measures every "days since" value from this data_end, never from the request time. build_run_id: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which pipeline build produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_run: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Which investor registry run produced the data. Informational: use dataset_version for caching. Null when the data does not record it. registry_version: description: >- Which registry code version produced the data. Informational: use dataset_version for caching. Null when the data does not record it. type: - string - 'null' dataset_version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Version of the loaded data, an integer that grows with every refresh. It is the cache key and the ETag, and every cursor binds to it. loaded_at: type: string format: date-time description: When this data version went live, ISO 8601. metro_buy_to_resale_ratio: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The median of purchase price divided by resale price over the market's priced flips since 2021. For example, 0.72 means flippers pay about 72% of the resale price. The price_fit factor uses it when an investor has too few flips of their own. Null when no priced flips exist. universe_kind: anyOf: - type: string enum: - zip - county - metro description: >- The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. - type: 'null' description: >- Null when the market row does not record it, a seed older than the column. The area every count in this market covers: metro, county or zip. A metro market covers whole counties. A county market covers one county. The market cannot see what an investor did in the neighbouring counties. A zip market covers one or more ZIP codes. The market cannot see what an investor did outside them, a larger gap. In a county or zip market every investor count, price band, scale tier and confidence is a floor. universe_zips: anyOf: - type: array items: type: string description: A 5-digit ZIP. - type: 'null' description: >- The ZIP codes of a zip universe, for example ["77088"]. Null for county and metro markets. point_tolerance_miles: type: number description: >- How far outside bbox a point can lie and get an answer, in miles: 20 for a metro, 2 for a county market. The point is lat + lng, or the centre of a property_id parcel. Farther out, the API answers 422 outside_coverage. A bbox must intersect the coverage bbox. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the loaded area, the universe every count covers. Null when the data does not record it. listings_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the MLS listing feed for this market, YYYY-MM-DD: the newest status update among its listing rows, later than data_end. The deeds and the listings arrive in one delivery, each with its own end. The API measures every listing window (days_on_market, n_listed_12m) against this date. Null when this market has no published listing tables. Every listing block and listings rollup is null then, and the correct reading is "no listing data". agents_data_end: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The as-of date of the listing set behind the agent registry of this market, YYYY-MM-DD. It equals listings_data_end when the registry is current. It is earlier when a refresh moved the listings but left the agents on the older set. Null when this market has no published agent tables. Then every agent_id, identity_basis and agent_is_holder_member on the listing agents is null, and the investor profile carries has_licensed_member and agent_links null. The /v1/agents routes then answer 422 agents_unavailable. wholesale_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the Investorlift export behind the market's wholesale transactions, YYYY-MM-DD. Every Investorlift listing published up to this date is on file. The API measures every wholesale window (n_listed_12m, n_bought_via_investorlift_12m) against the deed data_end. Null when this market has no published wholesale tables. Then every wholesale_listing block on deal rows, wholesale_purchases block on investor rows and wholesale_listings[] on a parcel is null. Then /v1/wholesale-listings, /v1/wholesalers, `/v1/investors/{id}/wholesale-purchases` and the source=investorlift and bought_on_investorlift filters answer 422 wholesale_unavailable. str_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The short-term rental snapshot of this market, YYYY-MM-DD: the oldest snapshot date over the places the API serves. Null when this market has no short-term rental tables. This block belongs to the first build, whose routes left on 2026-10-09, so no route reads it. meta.build.states[].str_as_of is the stamp of the dataset. str: anyOf: - type: object properties: jurisdictions: type: array items: $ref: '#/components/schemas/StrCoverageJurisdiction' description: >- Every city of the market the short-term rental build knows, served or not. This list, not the parcel, explains a null block on a parcel: read the city's coverage_reason. required: - jurisdictions additionalProperties: false - type: 'null' description: >- The short-term rental jurisdiction table of this market. Null when this market has no published short-term rental tables. auction_counted: type: boolean description: >- True when this market measures the foreclosure-auction and REO purchase counts. Then every investor row carries the auction block (investor.auction) and deal rows carry bought_auction_kind. False when the market's registry build came before the counts existed. Then the block is null on every investor of the market, and bought_auction_kind is null on every deal. The buys_at_auction, buys_reo and bought_auction_kind filters then answer 422 auction_unavailable. parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the build of the parcel product layer used, YYYY-MM-DD. The layer serves POST /v1/properties/search and the financing, permit and history routes. Null when this market has no published parcel product tables: those routes then answer 422 parcels_unavailable. address_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end of the address table behind GET /v1/properties/resolve?address, YYYY-MM-DD. Null when this market has no published address table. The address lookup answers 422 addresses_unavailable while no market carries the table. parcel: anyOf: - $ref: '#/components/schemas/ParcelCoverage' - type: 'null' description: >- What the parcel products cover in this market. The parts are the layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake with its ZIP set. Null when this market has no published parcel product tables. lenders: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The slice date behind the lender registry, YYYY-MM-DD. It equals parcel.financing.as_of. Null when the registry row does not record it. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date in either source table, YYYY-MM-DD. The API measures every recency on a lender against this date. Null when the registry row does not record it. counties: type: array items: type: string description: A 5-digit county FIPS. description: >- The counties the lender registry covers. A ZIP, city or county outside them answers 422 outside_coverage. history_capture_share: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of open lien positions recorded since 2022 that the recorded history also carries within 3 days, 0 to 1. It says how much of the open table the history sees. Null when the registry did not measure it. n_lender_ids: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Lender ids served in the market: the identities with a profile, after the person gate. parcel.financing.n_lenders counts raw spellings, several per id. Null when the registry row does not record it. purchase_measured: type: boolean description: >- True when the market has the deed link. Then the API serves purpose and the deed block on the loan rows, and the purchase-money counts and ranks on the lenders. It also serves the lender list's purpose, investor_only and purchase_desc parameters. False on a registry built before the deed link: every such value is null, and those parameters answer 422 lenders_unavailable. investor_lending_measured: type: boolean description: >- True when the market has the deal link and the borrower match. Then the API serves the deal block, outcome and investor ids on the loan rows, and the investor_lending block on the profiles. It also serves the financing block on deal rows and the financing sidecar on investor profiles. False otherwise: every one of those is null. flips_measured: type: boolean description: >- True when the market measures the flips each lender financed, the flips_financed block on the profiles. False otherwise: the block is null. borrowers_measured: type: boolean description: >- True when the market has the borrower fold. Then the API serves borrower keys on the loan rows, the borrowers block on the profiles, GET `/v1/lenders/{id}/borrowers` and the financed_by and uses_private_lender filters. False otherwise: the block is null, and the route and the filters answer 422 lenders_unavailable. takebacks_measured: type: boolean description: >- True when the registry of this market includes the foreclosure take-backs. That needs the auction deed tables built and the lender members present. Then the API serves the takebacks block on the profiles, the foreclosed block on the loan rows and the FORECLOSED outcome. False otherwise: the block is null on every profile, and foreclosed is null on every loan row. counties_measured: type: boolean description: >- True when the market has more than one loaded county, so a county ranking means something: rankings.n_counties_ranked_first_24m on the profiles. False while the slice covers one county: that count is null. dated: description: >- True when the registry is a snapshot valued at as_of, like the financing slice behind it. The API stamps every value from it in meta.dated[] as the lenders block. Null on a registry row that does not record it, a row older than the column. type: - boolean - 'null' n_parcels_uncovered: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels of the market outside the counties the registry covers. Such a county is one the financing slice does not reach. Null when the row does not record it. required: - as_of - recordings_through - counties - history_capture_share - n_lender_ids - purchase_measured - investor_lending_measured - flips_measured - borrowers_measured - takebacks_measured - counties_measured - dated - n_parcels_uncovered additionalProperties: false - type: 'null' description: >- The lender registry of this market. Null when this market has no published lender tables: every /v1/lenders route then answers 422 lenders_unavailable. required: - market - state - counties - bbox - data_end - build_run_id - registry_run - registry_version - dataset_version - loaded_at - metro_buy_to_resale_ratio - universe_kind - universe_zips - point_tolerance_miles - n_parcels - listings_data_end - agents_data_end - wholesale_as_of - str_as_of - str - auction_counted - parcel_as_of - address_as_of - parcel - lenders additionalProperties: false description: >- One market of the first build. No route of the served set carries one: meta.coverage is empty. Dated: type: object properties: block: type: string enum: - valuation - financing - liens - lenders description: >- The block of the response that is a snapshot at as_of, not current data. The values are valuation (the AVM, equity and LTV), financing (open liens and mortgage history), liens (involuntary liens) and lenders. The lenders block is the lender registry and every count on it, built from the same slice. as_of: type: string format: date description: >- The date of the delivery that valued the snapshot, YYYY-MM-DD: the same date as meta.coverage[].parcel.financing.as_of for the market. reason: type: string description: >- Why the block is dated, in one sentence: the dataset is not in the current delivery. required: - block - as_of - reason additionalProperties: false description: >- One block of the response that is a dated snapshot. Every response that carries a value from a dated block lists it here. A caller that cannot use dated data passes require_current: true. The API then answers 422 dated_refused instead. BuildState: type: object properties: state: type: string pattern: ^[A-Z]{2}$ description: The 2-letter state code of a served state, for example AZ. build_id: description: >- The id of the build of the files, a hash of the recorded steps. Null while the files of the state are a trial and no build id exists. type: - string - 'null' built_at: anyOf: - type: string format: date-time description: Timestamp, ISO 8601. - type: 'null' description: >- When the last step of the build finished, ISO 8601. Null while the files carry no record. published_at: type: string format: date-time description: When the publish of the state wrote the served tables, ISO 8601. run_id: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The id of the publish that serves the rows of the state. It moves with each publish. financing_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, the newest applied drop of the county records: the clock of every lender window, YYYY-MM-DD. Null while the state has no financing slice. recordings_through: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest recording date of a loan of the slice, YYYY-MM-DD. Null while the state has no financing slice. financing_source: description: >- Where the financing slice came from: replay_887 for the replay of the archive of the feed, weekly when the weekly delivery carries the domains again. Null while the state has no financing slice. type: - string - 'null' str_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The short-term rental snapshot of the state, YYYY-MM-DD: the oldest snapshot date over the places this API serves, so no served status is older than it. Each place carries its own date on GET /v3/coverage. Null while the state has no short-term rental tables. required: - state - build_id - built_at - published_at - run_id - financing_as_of - recordings_through - financing_source - str_as_of additionalProperties: false description: >- One served state: its build, its publish and the dates of its financing slice. DealParty: type: object properties: name: description: >- The name on the deed in its display form: upper case, no period, the entity suffix as one token, a person given name first. This host serves null here for a person when the name reads as a person. A company name is served to every key. type: - string - 'null' org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The organization the name matched: the key to `GET /v3/orgs/{id}`. Null when the build matched none. org_name: description: The display name of that organization. Null when org_id is null. type: - string - 'null' from_registry: description: >- True when the organization is one of the business registry. Null when org_id is null. type: - boolean - 'null' match_basis: description: >- How the name matched: filed, former, variant (a form of one registry key with no space or with the S form of its last word), address (the buyer mailing address is the address of one organization, and the first two words of the names agree), principal or none. Null when the build matched none. type: - string - 'null' company_like: description: >- True when the name reads as a company. Null when the file carries none. type: - boolean - 'null' tags: type: array items: type: string description: >- The tags of the name: a bank, a builder, a government body, a trust, an iBuyer. Empty when none. person_id: anyOf: - type: string pattern: >- ^([A-Z]{2}:person:[0-9a-f]{12}|person:[0-9a-f]{12}|buyer:[0-9a-f]{12}|[A-Z]{2}:agt:[0-9a-f]{12}|[A-Z]{2}:name:.{1,200})$ description: >- The person id: the state, a colon, person, a colon and 12 hex characters. The build keeps it across rebuilds. An id of an earlier build (person: or buyer: and 12 hex characters) answers through the alias rows, and the agent id (the state, a colon, agt, a colon and 12 hex characters) answers the person of that agent. The id of a sighting answers the person that holds it: a deed name, a borrower or a lender (the state, a colon, name, a colon and the name key), which is not served here because it carries a name. The body carries the person id, and meta.resolved_from names the id of the path when the two differ. - type: 'null' description: >- The person behind a name that reads as a person: the key to `GET /v3/people/{id}`. The id carries no name, so every key reads it. Null for a company, and for a name the build has not clustered. required: - name - org_id - org_name - from_registry - match_basis - company_like - tags - person_id additionalProperties: false description: >- One name on one side of the deed, the organization it matched, and the person behind it. OwnerMailing: type: object properties: line: description: >- The street line of the mailing address. Null when the roll carries none. type: - string - 'null' city: description: The city. Null when the roll carries none. type: - string - 'null' state: description: The 2-letter state. Null when the roll carries none. type: - string - 'null' zip: description: The 5-digit ZIP. Null when the roll carries none. type: - string - 'null' hash: description: >- The hash of the address as the vendor keys it: equal for two parcels with one mailing address. Null when the roll carries none. type: - string - 'null' required: - line - city - state - zip - hash additionalProperties: false description: The mailing address of the owner on the roll. ParcelFirstLien: type: object properties: lender: $ref: '#/components/schemas/LenderRef' lender_name: description: >- The lender as the county spelled it. Null when the spelling reads as a person. type: - string - 'null' balance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated balance, whole US dollars. Null when the county carries none. rate: description: The rate, percent. Null when the county carries none. type: - number - 'null' recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The recording date, YYYY-MM-DD. Null when the county carries none. required: - lender - lender_name - balance - rate - recording_date additionalProperties: false description: The first open position of a parcel with its lender. ParcelLastMortgage: type: object properties: lender: $ref: '#/components/schemas/LenderRef' lender_name: description: >- The lender as the county spelled it. Null when the spelling reads as a person. type: - string - 'null' recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The recording date of the newest recorded instrument, YYYY-MM-DD. Null when the county carries none. amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: Its amount, whole US dollars. Null when the county carries none. required: - lender - lender_name - recording_date - amount additionalProperties: false description: The newest recorded instrument of a parcel with its lender. LoanCore: type: object properties: loan_key: type: string description: >- The key of the loan: a hash of the parcel, the recording date and the amount. One key for a paired open and recorded row. property_id: type: string pattern: ^[0-9a-f]{32}$ description: 'The parcel: the key to `GET /v3/properties/{id}`.' source: type: string enum: - open - recorded description: >- open: an open position of the parcel. recorded: a recorded instrument of the history. position: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- The position of the row in its source: 1 to 4 for an open position, 1 to 5 for a recorded instrument, the newest first. is_instrument: type: boolean description: >- True on the one row of a loan key and lender: the open row of a paired loan, the recorded row otherwise. in_both: type: boolean description: >- True when the row has a twin in the other source: the same parcel, date and amount. lender: $ref: '#/components/schemas/LenderRef' description: >- The lender of record: the recorded instrument's lender when the loan has one, else the open position's. lender_name_as_recorded: description: >- The lender as the county spelled it on this row. Null when the spelling reads as a person. type: - string - 'null' assigned_lender_name: description: >- The assignee of an open position as the county spelled it. Null when none, and when the spelling reads as a person. type: - string - 'null' lender_open: anyOf: - $ref: '#/components/schemas/LenderRef' - type: 'null' description: >- The open-table lender when it differs from the lender of record. Null when they agree, or when the loan has no open position. lender_disagrees: type: boolean description: >- True when the open position and the recorded instrument of one loan name two lenders. recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The recording date, YYYY-MM-DD. Null when the county carries none. document_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The document date of a recorded instrument, YYYY-MM-DD. Null on an open position, and when the county carries none. due_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The due date, YYYY-MM-DD. Null when the county carries none. loan_amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The amount of the loan, whole US dollars. Null when the county carries none. amount_outlier: description: >- True when the amount is above 5,000,000: out of every sum, never out of a count. Null when the amount is null. type: - boolean - 'null' current_balance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated balance of an open position, whole US dollars. Null on a recorded instrument, and when the county carries none. balance_outlier: description: >- True when the balance is above 5,000,000. Null when the balance is null. type: - boolean - 'null' interest_rate: description: The rate, percent. Null when the county carries none. type: - number - 'null' interest_rate_type: description: >- The rate type of a recorded instrument as the county wrote it. Null when the file carries none. type: - string - 'null' estimated_payment: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The estimated payment of an open position, whole US dollars. Null when the county carries none. term_months: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The term of the loan in months as the county wrote it. Null when the file carries none. months: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The term in months: term_months when the county gave one, else the months from the recording to the due date. Null when the file carries none. term_band: type: string enum: - unknown - le_24m - 25_to_120m - 121_to_359m - ge_360m description: >- The term of the loan in months, banded: unknown, le_24m, 25_to_120m, 121_to_359m, ge_360m. loan_type: description: >- The loan type as the county wrote it. Null when the county carries none or wrote Unknown. type: - string - 'null' loan_type_code: description: The code of the loan type. Null when the file carries none. type: - string - 'null' financing_type: description: >- The financing type of an open position as the county wrote it. Null when the file carries none. type: - string - 'null' label: anyOf: - type: string enum: - refi_or_second - heloc - resale_purchase_money - new_purchase_money - construction - non_residential description: >- The label of the county for the transaction, mapped to a closed list. A label never sets a purpose: the county stopped labelling purchases in 2022. - type: 'null' description: >- The label of the county, mapped. Null when the county wrote none, or a word outside the list. label_as_recorded: description: >- The label of the county as it wrote it. Null when the file carries none. type: - string - 'null' product: type: string enum: - construction - heloc - other description: >- The product of the loan, a reading of two flags of the county and the loan type: construction, heloc or other. product_basis: anyOf: - type: string enum: - file - term - type: 'null' description: >- file: the county gave the term. term: the due date gave the months. Null when the months are unknown. product_proxy: anyOf: - type: string enum: - bridge - rental_term - retail - type: 'null' description: >- A reading of the product other by its term. bridge: 24 months or under. rental_term: 360 months or over with a hard-money lender of record. retail: the rest. Null when the months are unknown. purpose_of_loan: description: >- The purpose of an open position as the county wrote it. Null when the file carries none. type: - string - 'null' heloc: description: >- The credit-line flag of an open position. Null on a recorded instrument. type: - boolean - 'null' construction_loan: description: >- The construction flag of an open position. Null on a recorded instrument. type: - boolean - 'null' standalone_refi: description: >- The standalone-refinance flag of an open position. Null on a recorded instrument. type: - boolean - 'null' cash_purchase: description: >- The cash-purchase flag of an open position as the county carries it. Null on a recorded instrument. type: - boolean - 'null' adjustable_rate_rider: description: >- The adjustable-rate flag of an open position. Null on a recorded instrument. type: - boolean - 'null' ltv: description: >- The loan-to-value of an open position, percent. Null on a recorded instrument, and when the county carries none. type: - number - 'null' blanket: anyOf: - $ref: '#/components/schemas/LoanBlanket' - type: 'null' description: The blanket group of the loan. Null when the loan is on one parcel. link: anyOf: - $ref: '#/components/schemas/LoanLink' - type: 'null' description: >- The links of the loan to the deeds of its parcel: its purpose, the purchase it financed and its outcome. Null while the state has no loan links. borrowers: type: array items: $ref: '#/components/schemas/LoanBorrower' description: >- The borrowers of the loan: the names of the recorded instrument, or the owner of record on an open position with none. A name that reads as a person is not served here. Empty while the state has no linkage table. as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the financing slice of the state, YYYY-MM-DD. Null while the state has no financing slice. required: - loan_key - property_id - source - position - is_instrument - in_both - lender - lender_name_as_recorded - assigned_lender_name - lender_open - lender_disagrees - recording_date - document_date - due_date - loan_amount - amount_outlier - current_balance - balance_outlier - interest_rate - interest_rate_type - estimated_payment - term_months - months - term_band - loan_type - loan_type_code - financing_type - label - label_as_recorded - product - product_basis - product_proxy - purpose_of_loan - heloc - construction_loan - standalone_refi - cash_purchase - adjustable_rate_rider - ltv - blanket - link - borrowers - as_of description: >- One loan row of the county records, an open position or a recorded instrument. It carries its lender of record, its amounts, its dates and its terms. ParcelLien: type: object properties: position: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The position of the lien on the parcel, 1 or 2. lien_type: description: >- The type of the lien as the county wrote it. Null when the file carries none. type: - string - 'null' document_type: description: >- The document type as the county wrote it. Null when the file carries none. type: - string - 'null' document_number: description: The document number. Null when the file carries none. type: - string - 'null' recording_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The recording date, YYYY-MM-DD. Null when the county carries none. filing_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The filing date, YYYY-MM-DD. Null when the county carries none. lien_amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The amount of the lien, whole US dollars. Null when the county carries none. judgement_amount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: >- The judgement amount, whole US dollars. Null when the county carries none. tax_period_end_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The end of the tax period of a tax lien, YYYY-MM-DD. Null when the county carries none. parties: type: array items: type: object properties: name: description: >- The party as the county wrote it. Null when the party reads as a person. type: - string - 'null' role: description: >- The role of the party as the county wrote it. Null when the county carries none. type: - string - 'null' required: - name - role additionalProperties: false description: The parties of the lien, in the order of the county. attorney: type: object properties: company: description: >- The attorney company as the county wrote it. Null when the file carries none. type: - string - 'null' phone: description: The attorney phone. Null on this host. type: - string - 'null' required: - company - phone additionalProperties: false description: The attorney of the lien. required: - position - lien_type - document_type - document_number - recording_date - filing_date - lien_amount - judgement_amount - tax_period_end_date - parties - attorney additionalProperties: false description: One involuntary lien of a parcel as the county records it. StrCoverageJurisdiction: type: object properties: name: type: string description: >- The jurisdiction, upper case, for example SCOTTSDALE, PHOENIX or HOUSTON: the city-limit polygon the parcel falls in, never the postal city. The same value as short_term_rental.coverage.jurisdiction on the parcels inside it. regime: anyOf: - type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN description: >- The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. The city's rule on a short-term rental licence or permit. REQUIRED: an ordinance requires one. NOT_REQUIRED: the city has no requirement, so no roll exists. UNKNOWN: the survey did not cover the city. Null when the market row does not record it. coverage_reason: anyOf: - type: string enum: - LOADED_SERVED - LOADED_UNVALIDATED - LOADED_COUNTS_ONLY - REQUIRED_NOT_PUBLISHED - NO_REQUIREMENT - NOT_SURVEYED description: >- Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. - type: 'null' description: >- Null when the market row does not record it. Why parcels of this jurisdiction carry, or do not carry, a short-term rental block. LOADED_SERVED: the city's roll is on file, matched to parcels and served, so every parcel inside carries a block, NONE when it has no record. LOADED_UNVALIDATED: the roll is on file and matched, but without a spot check, so the block is present with status null and coverage.served false. LOADED_COUNTS_ONLY: the roll is on file for counts only, because no parcel match is possible for the file, so no block. No block for REQUIRED_NOT_PUBLISHED (licence required, no roll published), NO_REQUIREMENT (no licence required) or NOT_SURVEYED (outside the survey). Null when the market row does not record it. served: type: boolean description: >- True when parcels inside this jurisdiction carry a measured status (LICENSED, PENDING, EXPIRED or NONE). False when they carry a block with status null, or no block at all: coverage_reason says why. snapshot_only: type: boolean description: >- True when the roll came from a single pull and has no weekly feed (Fountain Hills, Cave Creek). Its dates are the pull date, and the API never sets feed_stale. licence_start: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The earliest possible date of a licence in this jurisdiction, the day its ordinance took effect, YYYY-MM-DD, for example 2025-10-01 for Houston. Null when unknown, or when the city requires no licence. snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The snapshot the served blocks read, YYYY-MM-DD: short_term_rental.data_as_of on every parcel inside. Null when no roll is on file. feed_stale: type: boolean description: >- True when this week's feed failed the freshness rule and the API serves the last good snapshot instead. Every block inside then carries coverage.feed_stale true. False otherwise. sources: type: array items: $ref: '#/components/schemas/StrCoverageSource' description: >- The city files behind this jurisdiction, each with its newest load date and its stale flag. Empty when no roll is on file. n_licensed: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels inside with status LICENSED on this snapshot. Null when no roll is on file. n_pending: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status PENDING. Null when no roll is on file. n_expired: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Parcels inside with status EXPIRED. Null when no roll is on file. n_advertised: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels the city lists as advertised without a licence, Scottsdale only. The API counts them and never serves them as a status. Null when the city publishes no such list. share_unmatched: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of the city's records that matched no parcel, 0 to 1, for example 0.04. Null when no roll is on file. share_assumed: anyOf: - type: number description: Decimal ratio, never a percentage (0.53 = +53%). - type: 'null' description: >- The share of attributed parcels with attribution_basis ASSUMED, 0 to 1. ASSUMED means the attribution has no date, no name and no regime bound. Null when no roll is on file. required: - name - regime - coverage_reason - served - snapshot_only - licence_start - snapshot_date - feed_stale - sources - n_licensed - n_pending - n_expired - n_advertised - share_unmatched - share_assumed additionalProperties: false description: >- One city of the market in the short-term rental build. It says if the licence roll is on file and served, how fresh it is, and what it counts. It explains a null short_term_rental block on a parcel: the block is null where the API does not serve the jurisdiction. ParcelCoverage: type: object properties: parcel_as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The deed data end that the parcel layer build used, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels in the layer for this market. Null when the coverage row does not record it. sale_mortgage_measured: type: boolean description: >- True when the delivery records a purchase mortgage on at least one priced last sale in five of the market. Then cash_sale_proxy, the sale.cash_sale filter and the cash-buyer quicklist are measured. False below that bar, as in the 2026 deliveries, which carry the column empty. Then cash_sale_proxy is null on every parcel, and the filter and the quicklist answer 422 cash_sale_unavailable. financing: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery that valued the financing, lien and valuation slice, YYYY-MM-DD. Null when the coverage row does not record it. dated: type: boolean description: >- True while the Recorder & Mortgage and AVM datasets are not in the current delivery, so the slice stays at as_of. The API then stamps every value from the slice in meta.dated[]. dated_reason: description: Why the slice is dated. Null when dated is false. type: - string - 'null' n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with a row in the slice. Null when the coverage row does not record it. n_with_open_lien: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one open lien at as_of. Null when the coverage row does not record it. n_free_and_clear: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with zero open liens at as_of. Null when the coverage row does not record it. n_avm: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an AVM at as_of. Null when the coverage row does not record it. n_involuntary: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with an involuntary lien at as_of. Null when the coverage row does not record it. n_lenders: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Distinct raw lender spellings over the two lien tables, not registry ids. For registry ids, read meta.coverage[].lenders.n_lender_ids. Null when the coverage row does not record it. required: - as_of - dated - dated_reason - n_parcels - n_with_open_lien - n_free_and_clear - n_avm - n_involuntary - n_lenders additionalProperties: false - type: 'null' description: The financing slice. Null when this market has none. permits: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The effective date of the loaded permit snapshot, YYYY-MM-DD. Null when the coverage row does not record it. n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits served for this market. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels with at least one permit. Null when the coverage row does not record it. n_unmatched: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits in the county file that landed on no parcel of the market, so the API does not serve them. Null when the coverage row does not record it. jurisdictions: anyOf: - type: array items: type: object properties: jurisdiction: description: >- The issuing city or county, upper case. Null when the file names none. type: - string - 'null' n_permits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Permits the jurisdiction issued, all time. Null when the coverage row does not record it. last_issue_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The newest issue date of the jurisdiction, YYYY-MM-DD. Null when no permit of the jurisdiction carries an issue date. windows_measured: description: >- True when the jurisdiction issued a permit in the 12 months before as_of. False when it did not: its feed is stale, so its parcels carry null 24-month and 36-month windows. The rule applies in every market. Read those null windows (n_permits_24m, n_open_permits_12m, major_work_36m, tags_24m, job_value_24m) as unmeasured, not as permit-free. The negative permit filters of the search leave such parcels out. Null only on a coverage row built before the flag existed. type: - boolean - 'null' required: - jurisdiction - n_permits - last_issue_date - windows_measured additionalProperties: false - type: 'null' description: >- The issuing jurisdictions, largest first, each with its permit count, its newest issue date and its windows_measured flag. Null when the coverage row does not record them. required: - as_of - n_permits - n_parcels - n_unmatched - jurisdictions additionalProperties: false - type: 'null' description: The permit snapshot. Null when this market has none. owner_profile: anyOf: - type: object properties: as_of: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the delivery the Owner Profile block comes from, YYYY-MM-DD. Null when the coverage row does not record it. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels carrying a profile. Null when the coverage row does not record it. n_multi: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds two or more properties. Null when the coverage row does not record it. n_portfolio_5: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels whose owner holds five or more. Null when the coverage row does not record it. required: - as_of - n_parcels - n_multi - n_portfolio_5 additionalProperties: false - type: 'null' description: The Owner Profile block. Null when this market has none. history: anyOf: - type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file the history lake replayed (the baseline FULL), YYYY-MM-DD. Null when the lake has no file. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file replayed, YYYY-MM-DD. Null when the lake has no file. zips: anyOf: - type: array items: type: string - type: 'null' description: >- The ZIP codes the history lake covers. A parcel outside them has no history: `GET /v1/properties/{id}/history` answers 422 history_unavailable and the history block is null. n_parcels: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Parcels observed in the ZIP set. Null when the coverage row does not record it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events on record. Null when the coverage row does not record it. n_weeks: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Weekly files replayed. Null when the coverage row does not record it. domains: anyOf: - type: object propertyNames: type: string additionalProperties: type: object properties: first_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The first weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. last_week: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The last weekly file with the domain, YYYY-MM-DD. Null when the lake has no file for it. n_events: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- Typed events of the domain on record. Null when the coverage row does not record it. required: - first_week - last_week - n_events additionalProperties: false - type: 'null' description: >- Per domain, the weeks the lake covers it. Valuation and financing end at the financing slice date, financing.as_of. The rest run to last_week. Null when the coverage row does not record them. required: - first_week - last_week - zips - n_parcels - n_events - n_weeks - domains additionalProperties: false - type: 'null' description: The history lake. Null when this market has none. required: - parcel_as_of - n_parcels - sale_mortgage_measured - financing - permits - owner_profile - history additionalProperties: false description: >- What the parcel products cover in one market. The parts are the parcel layer, the dated financing slice, the permit snapshot, the Owner Profile block and the history lake. Each part carries its as-of date and its counts, and is null where the market has none of it. The block itself is null where the market has no parcel product tables. LenderRef: type: object properties: org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The lender organization: the key to `GET /v3/lenders/{id}` and `GET /v3/orgs/{id}`. Null when the loan names no lender, or when the name reads as a person. org_name: description: The display name of the lender. Null when withheld with the id. type: - string - 'null' from_registry: description: >- True for an organization of the business registry, false for a deed name. Null when withheld. type: - boolean - 'null' tags: type: array items: type: string enum: - government - bank - credit_union - trust - person - hard_money - institution description: >- A reading of the name of the lender, each by its rule in the build. government: a public body. bank: the bank, thrift and charter words. credit_union: a credit union. trust: a trust, an IRA, an estate or a seller carry-back. person: a name that reads as a person. hard_money: the hard-money vocabulary and brands. institution: the party-wide reading of an institutional word, by the rule tag_institution of the build. It reads a bank, mortgage, loan, lending, funding, finance or servicing word. It also reads a credit union, a GSE or HUD form, a public body, a title or escrow company and an association. It also reads a school, a hospital, a church, a club, an insurer, a pension or retirement plan, a securitization or loan trust and a REIT brand. It excludes FBO, custodian, IRA, seller financing, insurance trust and the iBuyer brands. A bank, a credit union, a public body and a hard-money REIT carry it beside their own tag. It never means a bank: a mortgage company and an investor lender carry it alike. A tag decides no row: a lender keeps its loans and gets a tag. The tags of an organization are the union of the tags of its spellings, less person when the organization reads as a company. The list can grow with the rules of the build: a client keeps an unknown tag. description: >- The tags of the lender, in the order of the enum. Empty when withheld. required: - org_id - org_name - from_registry - tags additionalProperties: false description: >- A lender organization as a loan row, a ranking row or a parcel block names it, under the name rule of the set. LoanBlanket: type: object properties: group_id: type: string description: >- The id of the blanket group: one lender, one recording date and one amount on five parcels or more. n_parcels: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The parcels of the group. required: - group_id - n_parcels additionalProperties: false description: >- The blanket group of a loan, when the same instrument covers several parcels. LoanLink: type: object properties: purpose: type: string enum: - purchase - not_purchase - unknown description: >- purchase: a priced arm's-length purchase of the parcel is dated inside the 45 days up to the recording. not_purchase: the parcel has a priced deed and its first deed is older than that window. unknown: the loan has no date, or the parcel no deed to read. deed_deal_id: description: >- The purchase deed of a purchase loan: the key to `GET /v3/deals/{id}`. Null on another purpose, and when that deed is no flagged purchase. type: - string - 'null' deed_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of that deed, YYYY-MM-DD. Null on another purpose. deed_price: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Whole US dollars. - type: 'null' description: The price of that deed, whole US dollars. Null on another purpose. loan_to_price: description: >- The amount of the loan over the price of the deed, to four decimals. Null on another purpose, when the loan has no amount, and above three on a loan of one parcel. A blanket group keeps a ratio above three. type: - number - 'null' sale_mtg_match: description: >- True when the last-sale mortgage of the county record carries the date and the amount of this loan. Null when the loan has no date or no amount. type: - boolean - 'null' deal: anyOf: - $ref: '#/components/schemas/LoanLinkDeal' - type: 'null' description: >- The flagged purchase the loan financed. Null when the build linked none. outcome: anyOf: - type: string enum: - foreclosed - resolved_by_resale - refinanced - open - unknown description: >- The outcome of a loan linked to a deal. foreclosed: a take-back deed more than 90 days after the recording, before any resale or refinance. resolved_by_resale: a priced resale of the parcel. refinanced: another loan on the parcel more than 45 days after. open: an open position and no later event. unknown: a recorded instrument alone and no later event. - type: 'null' description: The outcome of the loan. Null when the loan is linked to no deal. resolved_on: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the resolution, YYYY-MM-DD. Null while open or unknown, and when unlinked. months_to_resolution: description: >- The months from the recording to the resolution, one decimal. Null as resolved_on. type: - number - 'null' foreclosed: anyOf: - $ref: '#/components/schemas/LoanForeclosure' - type: 'null' description: >- The take-back deed that followed the loan on its parcel, past the 90-day floor and before any resale or refinance, on every dated loan. Null when none. required: - purpose - deed_deal_id - deed_date - deed_price - loan_to_price - sale_mtg_match - deal - outcome - resolved_on - months_to_resolution - foreclosed additionalProperties: false description: >- The links of a loan to the deeds of its parcel: its purpose, the purchase it financed and its outcome. LoanBorrower: type: object properties: name: description: >- The name of the borrower in its display form, a person given name first: the name on the instrument, or the owner of record on an open position. This host serves null here for a person when the name reads as a person. A company name is served to every key. type: - string - 'null' org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The organization the name matched: the key to `GET /v3/orgs/{id}`. Null when the build matched none. org_name: description: The display name of that organization. Null when org_id is null. type: - string - 'null' from_registry: description: >- True when the organization is one of the business registry. Null when org_id is null. type: - boolean - 'null' match_basis: description: >- How the name matched: filed, former, variant (a form of one registry key with no space or with the S form of its last word), address (the buyer mailing address is the address of one organization, and the first two words of the names agree), principal or none. Null when the build matched none. type: - string - 'null' company_like: description: >- True when the name reads as a company. Null when the file carries none. type: - boolean - 'null' tags: type: array items: type: string description: >- The tags of the name: a bank, a builder, a government body, a trust, an iBuyer. Empty when none. person_id: anyOf: - type: string pattern: >- ^([A-Z]{2}:person:[0-9a-f]{12}|person:[0-9a-f]{12}|buyer:[0-9a-f]{12}|[A-Z]{2}:agt:[0-9a-f]{12}|[A-Z]{2}:name:.{1,200})$ description: >- The person id: the state, a colon, person, a colon and 12 hex characters. The build keeps it across rebuilds. An id of an earlier build (person: or buyer: and 12 hex characters) answers through the alias rows, and the agent id (the state, a colon, agt, a colon and 12 hex characters) answers the person of that agent. The id of a sighting answers the person that holds it: a deed name, a borrower or a lender (the state, a colon, name, a colon and the name key), which is not served here because it carries a name. The body carries the person id, and meta.resolved_from names the id of the path when the two differ. - type: 'null' description: >- The person behind a name that reads as a person: the key to `GET /v3/people/{id}`. The id carries no name, so every key reads it. Null for a company, and for a name the build has not clustered. borrower_basis: type: string enum: - owner_of_record - deed - registry - party - mortgage_only description: >- Where the build saw the borrower key, the first that holds. owner_of_record: the owner of the parcel on the recording date, on an open position with no instrument. deed: a buyer of the financed deal. registry: an entity or a principal matched. party: a name on some deed of the state. mortgage_only: the instrument alone. required: - name - org_id - org_name - from_registry - match_basis - company_like - tags - person_id - borrower_basis additionalProperties: false description: >- One borrower of a loan: the name under the party rule of the set, the organization it matched and where the build saw the key. StrCoverageSource: type: object properties: source: type: string description: >- The source code of one city file, for example S1 (the Scottsdale licensed roll), P1 (the Phoenix active permits layer) or COH (the Houston registry). snapshot_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the newest load of this source, YYYY-MM-DD. Null before the first load of this source. stale: type: boolean description: >- True when the newest load failed the freshness rule and the API still serves the previous snapshot. A load fails the rule when the count moved more than 30 percent, or when its newest date is more than 14 days old. required: - source - snapshot_date - stale additionalProperties: false description: >- One city file behind a jurisdiction's short-term rental data: the date of its newest load, and if that load is stale. LoanLinkDeal: type: object properties: deal_id: type: string description: 'The financed deal: the key to `GET /v3/deals/{id}`.' sale_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: The date of its deed, YYYY-MM-DD. Null when the deed carries none. link_window: type: string enum: - strict - loose description: >- strict: the loan is recorded inside 45 days after the sale of the deal. loose: inside 15 days before to 90 days after, on a deal that is no pair and no marketplace closing. is_purchase_loan: type: boolean description: >- True when this loan is the purchase loan of the deal: the strict one first, then the largest. secondary_loans_n: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: >- The other strict loans of the deal, on the purchase loan alone. Null on another loan. buyer: $ref: '#/components/schemas/LinkBuyerRef' description: >- The buyer organization of the deal as the deed names it, under the party rule of the set. required: - deal_id - sale_date - link_window - is_purchase_loan - secondary_loans_n - buyer additionalProperties: false description: >- The flagged purchase a loan financed, and the place of the loan among the loans of that purchase. LoanForeclosure: type: object properties: instrument: type: string enum: - trustees_deed - sheriffs_deed - deed_in_lieu - certificate_of_title description: >- The take-back deed: a trustee's deed, a sheriff's deed (Arizona and Washington), a deed in lieu of foreclosure, or the Florida certificate of title. deed_date: anyOf: - type: string format: date description: Calendar date, YYYY-MM-DD. - type: 'null' description: >- The date of the take-back deed, YYYY-MM-DD. Null when the deed carries none. buyer_is_lender: description: >- True when a grantee of the take-back deed is a spelling of the lender of record: a performance proxy, never delinquency. Null when the file carries none. type: - boolean - 'null' required: - instrument - deed_date - buyer_is_lender additionalProperties: false description: The take-back deed that followed a loan on its parcel. LinkBuyerRef: type: object properties: org_id: anyOf: - type: string pattern: ^[A-Z]{2}:(name:.{1,200}|[A-Z0-9-]{1,40})$ description: >- The organization id: the state, a colon and the anchor entity number for a registry organization, for example AZ:L16090024. For a deed name that no entity matched: the state, a colon, the word name, a colon and the name key, for example AZ:name:ACME HOLDINGS. The id is stable across builds while the anchor entity stays. - type: 'null' description: >- The buyer organization: the key to `GET /v3/orgs/{id}`. Null when the name reads as a person. org_name: description: The display name of the buyer. Null when withheld with the id. type: - string - 'null' from_registry: description: >- True for an organization of the business registry, false for a deed name. Null when withheld. type: - boolean - 'null' tags: type: array items: type: string description: >- The tags of the organization as a buyer: investor, ibuyer, builder, bank or another tag of the build. Empty when none, and when withheld. required: - org_id - org_name - from_registry - tags additionalProperties: false description: >- The buyer organization of a financed deal, under the party rule of the set. headers: ETag: description: >- The entity tag of the answer, derived from the build of the served set and from the representation, not from the body. It moves only when a state is published again. On a JSON route, send it back as If-None-Match, and an unchanged set answers 304 with no body. GET /v3/build runs no query, so it is the lowest-cost place to send the tag. On every 2xx and the 304, never on an error. schema: type: string X-Request-Id: description: >- The id of this call. The edge mints it and also sends it as zp-rid, the gateway's own name for it. The API keys its log line for the call on it, and every error body repeats it as request_id. Log it on every response, not only on errors. A refusal the gateway answers itself carries zp-rid and request_id alone. Those refusals are a 401, a 403 quota_exceeded and a 429 at the limit of the plan. schema: type: string X-Rows: description: >- How many rows the body carries: data.length on a list, 1 on a single record. The size of the body, not a charge. Absent on a streamed export, whose count the API knows only when the stream ends, and on a 304. schema: type: integer minimum: 0 X-Dataset-Version: description: >- The build token of the served set: one pair per served state in state order, each the state and its run id, joined by a dash (AZ1790123752-TX1790248213 for two states). The run ids are the same as meta.build.states[].run_id, and you can read them without parsing the body. The token moves only when a state is published again, so fold it into cache keys. On every 2xx and the 304, never on an error. schema: type: string X-Data-End: description: >- The newest deed date across the served states, YYYY-MM-DD. GET /v3/coverage carries the date of each state. On every 2xx and the 304, never on an error. Absent while no served state carries a deed date. schema: type: string Retry-After: description: >- Whole seconds to wait before you retry, never below 1. On a 429, the seconds until the spent bucket refills. On a 503, 1 for pool_saturated and 5 for ledger_unavailable, and none for database_unavailable. On a 403 plan_limit for the name-search day cap, the seconds to the next UTC midnight, when the cap resets. The other plan limits carry none. The body repeats it as retry_after on the 429, the ledger refusal and the day cap. schema: type: integer minimum: 1 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key from the developer console (starts with zpka_). Create one at https://developers.investorlift.com/get-a-key. The same key works on POST /mcp. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.