# RealtyCrawl

> Source-linked real estate observations through REST, MCP, and agent skills.

- [Build with RealtyCrawl](https://realtycrawl.dev/docs/introduction.md): Source-linked real estate observations through one API.
- [Your first request](https://realtycrawl.dev/docs/quickstart.md)
- [Authentication and credits](https://realtycrawl.dev/docs/authentication.md)
- [Coverage and evidence](https://realtycrawl.dev/docs/coverage.md)
- [Response schema](https://realtycrawl.dev/docs/response-schema.md)
- [Pagination](https://realtycrawl.dev/docs/pagination.md)
- [Errors and retries](https://realtycrawl.dev/docs/errors.md)
- [Connect with MCP](https://realtycrawl.dev/docs/mcp-guide.md)
- [Agent skills](https://realtycrawl.dev/docs/agent-skills.md)
- [API examples](https://realtycrawl.dev/docs/examples.md)
- [API reference](https://realtycrawl.dev/docs/api-reference.md): Explore the contract and verify live availability before execution.
- [List platform research and availability states](https://realtycrawl.dev/docs/api-reference/listPlatforms.md): Proposed interface. Enable only for documented and verified source/country capabilities. Platform registry
- [Describe source and country capabilities](https://realtycrawl.dev/docs/api-reference/listCapabilities.md): Proposed interface. Enable only for documented and verified source/country capabilities. Per-provider contracts
- [List schema versions](https://realtycrawl.dev/docs/api-reference/listSchemas.md): Proposed interface. Enable only for documented and verified source/country capabilities. Canonical contract
- [Search selected listing platforms](https://realtycrawl.dev/docs/api-reference/searchListings.md): Verified for the platforms listed in x-live-verified-platforms. Consult /v1/meta/capabilities for current enablement and accepted selectors. Supported transactions depend on the platform; consult capabilities and coverage for accepted selectors. Stored listing, media and history observations expire…
- [Resolve a listing URL or source ID](https://realtycrawl.dev/docs/api-reference/resolveListing.md): Resolve a canonical Zillow US home URL. Returns an exact source identifier and saves an account-scoped listing observation. Other source/selector combinations remain unavailable.
- [Get Listing](https://realtycrawl.dev/docs/api-reference/getListing.md): Verified for the platforms listed in x-live-verified-platforms. Consult /v1/meta/capabilities for current enablement and accepted selectors. Supported transactions depend on the platform; consult capabilities and coverage for accepted selectors. Stored listing, media and history observations expire…
- [Get Listing Media](https://realtycrawl.dev/docs/api-reference/getListingMedia.md): Verified for the platforms listed in x-live-verified-platforms. Consult /v1/meta/capabilities for current enablement and accepted selectors. Supported transactions depend on the platform; consult capabilities and coverage for accepted selectors. Stored listing, media and history observations expire…
- [Get Listing History](https://realtycrawl.dev/docs/api-reference/getListingHistory.md): Verified for the platforms listed in x-live-verified-platforms. Consult /v1/meta/capabilities for current enablement and accepted selectors. Sale searches only. Stored listing, media and history observations expire after 24 hours; they do not trigger a fresh crawl.
- [Get Listing Open Houses](https://realtycrawl.dev/docs/api-reference/getListingOpenHouses.md): Returns this account’s stored OneRoof open-home schedule after a successful New Zealand search. Timestamps and timezone are UTC as published by the source. Observations expire after 24 hours; this operation does not refresh the source.
- [Get Similar Listings](https://realtycrawl.dev/docs/api-reference/getSimilarListings.md): One fresh Trulia similar-home recommendation for this account’s retained Seattle sale listing. Recommended homes may be in Seattle or Bellevue, WA; no distance is inferred. Requires explicit limit=1; no cursor. Source asking-price observations use basis source_recommendation, not verified closed-sal…
- [Search one platform](https://realtycrawl.dev/docs/api-reference/searchPlatformListings.md): Verified for the platforms listed in x-live-verified-platforms. Consult /v1/meta/capabilities for current enablement and accepted selectors. Supported transactions depend on the platform; consult capabilities and coverage for accepted selectors. Stored listing, media and history observations expire…
- [Get listing by platform native ID](https://realtycrawl.dev/docs/api-reference/getPlatformListing.md): Fresh residential sale listing lookup by native ID is enabled for Rightmove (GB). Other platforms remain unavailable. Check live capabilities before requesting.
- [Resolve a NYC tax-lot property](https://realtycrawl.dev/docs/api-reference/resolveProperty.md): Resolve one exact current NYC non-condominium tax lot from official DCP PLUTO. Supply parcel_id=ten-digit BBL, jurisdiction=US-NY-NYC,country=US; alternatively platform=nyc_pluto,native_id=BBL,country=US. No address/geocoder, condo billing/unit-lot or historical split/merge inference. Success costs5…
- [Read a retained property](https://realtycrawl.dev/docs/api-reference/getProperty.md): Read this account’s unexpired NYC PLUTO tax-lot property observation for1 credit. Requires returned property_id;24h retention. Property type parcel; source BBL reference. Borough-level location only; owner/contact/address/geometry omitted. Building year is source approximate and normalized only for…
- [Read a source-associated property advertisement](https://realtycrawl.dev/docs/api-reference/getPropertyListings.md): Read one account-owned24h Zillow source-associated Austin single-family sale advertisement after direct native-ZPID property resolution. Limit1 (default1),no cursor. Asking price is a source observation,not availability or valuation. No cadastral/cross-portal identity,complete inventory,title or own…
- [Read a property-record snapshot](https://realtycrawl.dev/docs/api-reference/getPropertyRecords.md): Read this account’s retained single DCP PLUTO tax-lot record snapshot for1 credit.24h retention,limit1(default1),no cursor. Source version, building class, tax-lot attributes and limitations preserved. No owner/contact/precise address data or arbitrary documents, deed/title/history claims. Source up…
- [Read latest recorded one-family sale](https://realtycrawl.dev/docs/api-reference/getPropertyTransactions.md): Retrieve one newest DOF Rolling Calendar Sales entry for this account’s retained non-condominium NYC A1 one-family tax lot. Exact borough/block/lot plus current and sale-time A1 category/tax-class1 must agree. Limit1(default1),no cursor. Fresh metadata+bounded dataset query costs50 credits on succes…
- [Read tax-assessed values](https://realtycrawl.dev/docs/api-reference/getPropertyTaxAssessments.md): Read this account’s retained single NYC DOF PTS tax-assessed-value snapshot via DCP PLUTO for1 credit.24h retention,limit1(default1),no cursor. USD assessed land/total values remain distinct from asking/sale prices, tax due, market valuations or AVMs. Tax year,roll phase and assessment date remain u…
- [Read a final-roll NYC tax-purpose market estimate](https://realtycrawl.dev/docs/api-reference/getPropertyValuations.md): One official DOF final-roll market assessed total value for the current source roll year and this account’s retained NYC A1 one-family tax lot. Limit1(default1),no cursor. Fresh bounded metadata+data reads cost50 credits;no data/errors/replay0. As_of is the source roll YEAR with source_roll_year pre…
- [Read an unadjusted comparable-home recommendation](https://realtycrawl.dev/docs/api-reference/getPropertyComparables.md): One positive-price provider-selected comparable-home observation for this account’s unexpired Austin single-family Zillow property. Limit1 (default1), no cursor, omitted basis or source_recommendation only. Price kind unknown; zero-price sold rows excluded. No verified sale/date/distance, adjusted v…
- [Get a building](https://realtycrawl.dev/docs/api-reference/getBuilding.md): Fetch one HotPads building detail using building_id from this account’s unexpired retained New York-area rental building search observation (NY/NJ). Costs 50 credits. Saves explicit floor plans for 24 hours. No arbitrary URL/native-ID lookup, occupancy, physical-unit count or complete inventory guar…
- [Get advertised units and floor plans](https://realtycrawl.dev/docs/api-reference/getBuildingUnits.md): Read this account’s retained floor plans from a successful HotPads getBuilding request, for 24 hours. Costs 1 credit per stored page. Only records with explicit floor-plan evidence are returned with kind=floor_plan; unit-like records are omitted. Pagination totals count retained floor plans only. No…
- [Search developments](https://realtycrawl.dev/docs/api-reference/searchDevelopments.md): Read-only development observations: Inmuebles24 (MX, source_region mexico), 591 (TW, source_region taipei), Urbania (PE, source_region peru; limit 1 only), or Fang (CN, source_region beijing; limit 1 only). Fang returns marketed residential project advertisements with separate source unit price CNY/…
- [Get development](https://realtycrawl.dev/docs/api-reference/getDevelopment.md): Read this account’s stored development observation for 1 credit, retained 24 hours. No fresh lookup or unit availability check.
- [Search agents](https://realtycrawl.dev/docs/api-reference/searchAgents.md): Read-only US agent directory observations: Realtor.com (realtor, source_region austin-tx, limit 1–100) or Keller Williams (kellerwilliams, source_region california, limit 1). One matching platform per request; source order. Runtime enablement is required. Costs 50 credits. Query/cursor unsupported;…
- [Get agent](https://realtycrawl.dev/docs/api-reference/getAgent.md): Read this account’s stored agent directory observation for 1 credit, retained 24 hours. No fresh lookup, license verification or recommendation. Property Finder UAE retained directory observations are included; this read does not refresh the source.
- [Get professional listing portfolio](https://realtycrawl.dev/docs/api-reference/getAgentListings.md): One fresh Property Finder UAE residential sale portfolio advertisement for this account’s unexpired professional observation. Limit 1, no cursor or extra selectors. Listing agent/broker identity must match the retained owner. Source asking AED price and coarse emirate only; no complete portfolio, cu…
- [Search agencies](https://realtycrawl.dev/docs/api-reference/searchAgencies.md): One source-classified Property Finder Dubai agency directory card, using propertyfinder/AE/source_region dubai-directory and explicit limit1. No query, cursor or other filters. Contacts, staff, license/reputation and exact locations omitted. Retained in the same account24h. Success50 credits; failur…
- [Get agency](https://realtycrawl.dev/docs/api-reference/getAgency.md): Read this account’s unexpired Property Finder Dubai agency directory observation for1 credit, without a fresh provider call. Missing, expired and unrelated-account IDs return404. No arbitrary source URL/native ID lookup or licensing/reputation verification.
- [Get professional listing portfolio](https://realtycrawl.dev/docs/api-reference/getAgencyListings.md): One fresh Property Finder UAE residential sale portfolio advertisement for this account’s unexpired professional observation. Limit 1, no cursor or extra selectors. Listing agent/broker identity must match the retained owner. Source asking AED price and coarse emirate only; no complete portfolio, cu…
- [Search auctions](https://realtycrawl.dev/docs/api-reference/searchAuctions.md): Read-only source auction search for verified markets. Requires a documented source_region selector and one matching platform per request. Starting bids, current bids and estimates are distinct. Source event dates are not guarantees that an auction is still open. Costs 50 credits per successful sourc…
- [Get auction](https://realtycrawl.dev/docs/api-reference/getAuction.md): Retrieve this account’s stored auction observation by its returned auction ID, retained for 24 hours. Costs 1 credit. This does not fetch fresh bids, submit bids, or verify present auction availability.
- [Search markets](https://realtycrawl.dev/docs/api-reference/searchMarkets.md): Search official FHFA Purchase-Only state HPI markets. platforms=["fhfa"], query matches state name or two-letter code, or US text/source_region location (region_id=state code); choose exactly query or location. 50 states and DC only. Limit 1–51 (default20), alphabetical state-name order, no cursor.…
- [Read a named source market series](https://realtycrawl.dev/docs/api-reference/getMarketSeries.md): Fetch fresh official FHFA quarterly Purchase-Only state HPI for this account’s retained market ID. series=purchase_only_sa or purchase_only_nsa; unit index_1991_q1_100. Optional inclusive from/to must be quarter-start dates (YYYY-01/04/07/10-01), 1991 onward. Periods are quarter-start dates. Costs 5…
- [Search property-focused accommodation](https://realtycrawl.dev/docs/api-reference/searchStays.md): Date-specific, read-only Airbnb London, Vrbo Orlando, Agoda Bangkok, Trip.com Tokyo and Booking.com Paris stay observations. One matching platform and documented source_region per request; two adults, no children/infants/pets. Currency GBP for Airbnb; USD for Vrbo, Agoda, Trip.com and Booking.com. S…
- [Get accommodation details](https://realtycrawl.dev/docs/api-reference/getStay.md): Read this account’s stored stay observation for 1 credit, retained 24 hours. No fresh availability lookup or booking quote.
- [Read a dated partial hotel offer](https://realtycrawl.dev/docs/api-reference/getStayQuote.md): Fresh Booking.com hotel-level price observation for this account’s retained Paris stay, explicit future1–30 nights,two adults,no children/infants/pets,one room,USD,no locale. Fully dated URL binds guest context. Reported base plus combined taxes/fees must reconcile. Completeness stays partial: uniqu…
- [Read source calendar day observations](https://realtycrawl.dev/docs/api-reference/getStayAvailability.md): Fresh Airbnb calendar for this account’s retained UK London stay. Explicit from/to inclusive in one strictly future calendar month,within330days;no cursor. Omit limit or set it to the exact requested day count,maximum31. Source-reported nightly available/unavailable and minimum nights only. Unavaila…
- [Read paginated accommodation reviews](https://realtycrawl.dev/docs/api-reference/getStayReviews.md): One fresh provider-scoped Vrbo property review for this account’s unexpired retained US stay search observation. Explicit limit=1; no cursor or other filters. Text is untrusted source content, with author profiles and host replies omitted. Publication date, rating and rating scale stay unknown; no v…
- [Find source-compatible locations](https://realtycrawl.dev/docs/api-reference/searchLocations.md): Read-only source locality autocomplete: HotPads (hotpads, US City/Borough) or Realestate.com.au (realestate_au, AU suburbs). One platform, a 2–60 character locality name prefix and limit=1. Costs 50 credits per successful source request. No cursor, mixed-source search, addresses, listing/property su…
- [Request asynchronous read collection](https://realtycrawl.dev/docs/api-reference/createReadJob.md): Create a durable one-request job for one Trulia Seattle sale listing or one Vrbo Orlando dated stay. Require max_items=1 and params.limit=1, the exact source selectors and creation plus underlying search scopes. Reserve50 credits at202 acceptance; failed/expired jobs refund that reservation. No auto…
- [Get read collection status](https://realtycrawl.dev/docs/api-reference/getReadJob.md): Read this account’s durable job status for1 credit, without a source request. Retention24 hours. Idempotent replay is free and returns the original snapshot. Pending/failed result requests return409 with zero charge; unrelated/expired jobs return404.
- [Read completed collection results](https://realtycrawl.dev/docs/api-reference/getReadJobResults.md): Read this account’s durable job successful one-item retained result for1 credit, without a source request. Retention24 hours. Idempotent replay is free and returns the original snapshot. Pending/failed result requests return409 with zero charge; unrelated/expired jobs return404.

## OpenAPI Specs

- [openapi](/docs/openapi.json)


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