> ## Documentation Index
> Fetch the complete documentation index at: https://docs.realtycrawl.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Explore the contract and verify live availability before execution.

Base URL: `https://realtycrawl.dev`. [Download OpenAPI](/openapi.json).

The contract includes operations that are not enabled. Check [coverage](/coverage) and the live capability response first.

<a id="listPlatforms" />

### List platform research and availability states

[GET /v1/meta/platforms ](/api-reference/listPlatforms)

<a id="listCapabilities" />

### Describe source and country capabilities

[GET /v1/meta/capabilities ](/api-reference/listCapabilities)

<a id="listSchemas" />

### List schema versions

[GET /v1/meta/schemas ](/api-reference/listSchemas)

<a id="searchListings" />

### Search selected listing platforms

[POST /v1/listings/search ](/api-reference/searchListings)

<a id="searchPlatformListings" />

### Search one platform

[POST /v1/\{platform}/listings/search ](/api-reference/searchPlatformListings)

<a id="getPlatformListing" />

### Get listing by platform native ID

[GET /v1/\{platform}/listings/\{native\_id} ](/api-reference/getPlatformListing)

<a id="resolveListing" />

### Resolve a listing URL or source ID

[POST /v1/listings/resolve ](/api-reference/resolveListing)

<a id="getListing" />

### Get Listing

[GET /v1/listings/\{listing\_id} ](/api-reference/getListing)

<a id="getListingMedia" />

### Get Listing Media

[GET /v1/listings/\{listing\_id}/media ](/api-reference/getListingMedia)

<a id="getListingHistory" />

### Get Listing History

[GET /v1/listings/\{listing\_id}/history ](/api-reference/getListingHistory)

<a id="getListingOpenHouses" />

### Get Listing Open Houses

[GET /v1/listings/\{listing\_id}/open-houses ](/api-reference/getListingOpenHouses)

<a id="getSimilarListings" />

### Get Similar Listings

[GET /v1/listings/\{listing\_id}/similar ](/api-reference/getSimilarListings)

<a id="resolveProperty" />

### Resolve physical property identity

[POST /v1/properties/resolve ](/api-reference/resolveProperty)

<a id="getProperty" />

### Get Property

[GET /v1/properties/\{property\_id} ](/api-reference/getProperty)

<a id="getPropertyListings" />

### Get Property Listings

[GET /v1/properties/\{property\_id}/listings ](/api-reference/getPropertyListings)

<a id="getPropertyRecords" />

### Get Property Records

[GET /v1/properties/\{property\_id}/records ](/api-reference/getPropertyRecords)

<a id="getPropertyTransactions" />

### Get Property Transactions

[GET /v1/properties/\{property\_id}/transactions ](/api-reference/getPropertyTransactions)

<a id="getPropertyTaxAssessments" />

### Get Property Tax Assessments

[GET /v1/properties/\{property\_id}/tax-assessments ](/api-reference/getPropertyTaxAssessments)

<a id="getPropertyValuations" />

### Get Property Valuations

[GET /v1/properties/\{property\_id}/valuations ](/api-reference/getPropertyValuations)

<a id="getPropertyComparables" />

### Get Property Comparables

[GET /v1/properties/\{property\_id}/comparables ](/api-reference/getPropertyComparables)

<a id="getBuilding" />

### Get a building

[GET /v1/buildings/\{building\_id} ](/api-reference/getBuilding)

<a id="getBuildingUnits" />

### Get advertised units and floor plans

[GET /v1/buildings/\{building\_id}/units ](/api-reference/getBuildingUnits)

<a id="searchDevelopments" />

### Search developments

[POST /v1/developments/search ](/api-reference/searchDevelopments)

<a id="getDevelopment" />

### Get development

[GET /v1/developments/\{development\_id} ](/api-reference/getDevelopment)

<a id="searchAgents" />

### Search agents

[POST /v1/agents/search ](/api-reference/searchAgents)

<a id="getAgent" />

### Get agent

[GET /v1/agents/\{agent\_id} ](/api-reference/getAgent)

<a id="getAgentListings" />

### Get professional listing portfolio

[GET /v1/agents/\{agent\_id}/listings ](/api-reference/getAgentListings)

<a id="searchAgencies" />

### Search agencies

[POST /v1/agencies/search ](/api-reference/searchAgencies)

<a id="getAgency" />

### Get agency

[GET /v1/agencies/\{agency\_id} ](/api-reference/getAgency)

<a id="getAgencyListings" />

### Get professional listing portfolio

[GET /v1/agencies/\{agency\_id}/listings ](/api-reference/getAgencyListings)

<a id="searchAuctions" />

### Search auctions

[POST /v1/auctions/search ](/api-reference/searchAuctions)

<a id="getAuction" />

### Get auction

[GET /v1/auctions/\{auction\_id} ](/api-reference/getAuction)

<a id="searchMarkets" />

### Search markets

[POST /v1/markets/search ](/api-reference/searchMarkets)

<a id="searchStays" />

### Search property-focused accommodation

[POST /v1/stays/search ](/api-reference/searchStays)

<a id="getStay" />

### Get accommodation details

[GET /v1/stays/\{stay\_id} ](/api-reference/getStay)

<a id="getStayQuote" />

### Get a dated guest-specific price quote

[POST /v1/stays/\{stay\_id}/quote ](/api-reference/getStayQuote)

<a id="getStayAvailability" />

### Read calendar observations

[GET /v1/stays/\{stay\_id}/availability ](/api-reference/getStayAvailability)

<a id="getStayReviews" />

### Read paginated accommodation reviews

[GET /v1/stays/\{stay\_id}/reviews ](/api-reference/getStayReviews)

<a id="getMarketSeries" />

### Read a named source market series

[GET /v1/markets/\{market\_id}/series ](/api-reference/getMarketSeries)

<a id="searchLocations" />

### Find source-compatible locations

[POST /v1/locations/search ](/api-reference/searchLocations)

<a id="createReadJob" />

### Request asynchronous read collection

[POST /v1/jobs ](/api-reference/createReadJob)

<a id="getReadJob" />

### Get read collection status

[GET /v1/jobs/\{job\_id} ](/api-reference/getReadJob)

<a id="getReadJobResults" />

### Read completed collection results

[GET /v1/jobs/\{job\_id}/results ](/api-reference/getReadJobResults)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.