First inspect capabilities for your platform and country. Set REALTYCRAWL_IDEMPOTENCY_KEY to a new unique value for a new logical search; keep it for a deliberate retry. The sample Zillow sale search has limit=1 and X-Max-Credits=50. Stored listing reads cost 1 credit. Run examples individually.
Read data together with meta.completeness, meta.sources, warnings and pagination. Keep price currency, period, area units, source URL and observation time. Never replace unknown values with zero.
Read collected stay context
Replace STAY_ID with your account-owned Booking.com, Agoda or Trip.com observation ID. Read context or replace context with media for the collected photos. Each request costs 1 credit and preserves the original search dates; it does not refresh availability or create a booking quote.
Check the Booking.com capability first. This illustrative search keeps its Paris region, USD currency and two-adult context, adds a source nightly price band and source star class, and reserves 50 credits. The returned price can still be a total-stay observation; preserve its period. Airbnb, VRBO and Trip.com accept different filter sets.
Use the listing ID returned by your own supported source search or detail request. This read costs 1 credit and does not refresh the source. Missing energy observations remain unavailable; an unknown unit is never supplied by inference.
Use a listing_id returned by your own supported commercial search. This one-credit read returns the ranges and labeled rates already collected; it does not refresh the source or confirm availability.
The source URL contract accepts equal min/max for 1, 2 or 3 bedrooms, apartment type and native price ordering in the existing Sydney NSW 2000 rental window. This is a documentation-backed beta request, not a fresh live sample.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"RealtyCrawl","description":"Source-linked real estate observations through REST, MCP, and agent skills.","colors":{"primary":"#447B39","light":"#8AB54C","dark":"#336B36"},"logo":{"light":"https://mintcdn.com/realtycrawl/XaXlyjms747zxiaV/wordmark-light.svg?fit=max\u0026auto=format\u0026n=XaXlyjms747zxiaV\u0026q=85\u0026s=06b63fc8b659978facf89e4e1c4df754","dark":"https://mintcdn.com/realtycrawl/XaXlyjms747zxiaV/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=XaXlyjms747zxiaV\u0026q=85\u0026s=af0a0e3658dab4b20093b250eceadff5","href":"https://realtycrawl.dev"},"favicon":"https://mintcdn.com/realtycrawl/7x0QZuGIyzGuI4aL/logo.svg?fit=max\u0026auto=format\u0026n=7x0QZuGIyzGuI4aL\u0026q=85\u0026s=87b8c42c30c174b04eb9bf56ee3375a5","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true,"autogenerate":true}},"background":{"color":{"light":"#FCFDF8","dark":"#102D1C"}},"navbar":{"links":[{"href":"https://realtycrawl.dev/status","label":"Status"},{"href":"https://realtycrawl.dev/contact","label":"Support"}],"primary":{"type":"button","label":"Get API key","href":"https://realtycrawl.dev/dashboard/api-keys"}},"footer":{"socials":{"website":"https://realtycrawl.dev","github":"https://github.com/realtycrawl"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"realtycrawl","hasAudioNarration":false,"actualSubdomain":"realtycrawl","customDomains":["realtycrawl.dev"],"gitSource":{"type":"github","owner":"realtycrawl","repo":"realtycrawl-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aeeac162bd96e503d9ea75c","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API reference","count":68},{"language":"default","tag":"Listings","count":16},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Properties","count":10},{"language":"default","tag":"Stays","count":8},{"language":"default","tag":"Markets","count":5},{"language":"default","tag":"Core concepts","count":5},{"language":"default","tag":"Platform listings","count":4},{"language":"default","tag":"Build with RealtyCrawl","count":3},{"language":"default","tag":"Jobs","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#navbar .nav-logo{height:32px;width:auto}"}],"page":{"pagePath":"examples","slug":"/examples","pageMetadata":{"title":"API examples","description":null,"href":"/examples"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Runnable examples in cURL, Node.js, Python and Go. Each example makes one bounded request; no automatic retries or pagination.`}),`\n`,_jsx(Heading,{level:`2`,id:`get-the-examples`,children:`Get the examples`}),`\n`,_jsxs(_components.p,{children:[`Clone the public examples repository: `,_jsx(_components.a,{href:`https://github.com/realtycrawl/realtycrawl-api-examples`,children:`https://github.com/realtycrawl/realtycrawl-api-examples`}),`. Use Node.js 22+, Python 3.9+, or Go 1.22+. Set REALTYCRAWL_API_KEY in your environment for authenticated operations.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`git`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` clone`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/realtycrawl/realtycrawl-api-examples.git`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`cd`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` realtycrawl-api-examples`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`node`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` examples/node/01-capabilities.mjs`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`run-a-bounded-search`,children:`Run a bounded search`}),`\n`,_jsx(_components.p,{children:`First inspect capabilities for your platform and country. Set REALTYCRAWL_IDEMPOTENCY_KEY to a new unique value for a new logical search; keep it for a deliberate retry. The sample Zillow sale search has limit=1 and X-Max-Credits=50. Stored listing reads cost 1 credit. Run examples individually.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`export`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` REALTYCRAWL_IDEMPOTENCY_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"my-search-unique-id\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`node`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` examples/node/02-search.mjs`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`keep-the-evidence`,children:`Keep the evidence`}),`\n`,_jsx(_components.p,{children:`Read data together with meta.completeness, meta.sources, warnings and pagination. Keep price currency, period, area units, source URL and observation time. Never replace unknown values with zero.`}),`\n`,_jsx(Heading,{level:`2`,id:`read-collected-stay-context`,children:`Read collected stay context`}),`\n`,_jsx(_components.p,{children:`Replace STAY_ID with your account-owned Booking.com, Agoda or Trip.com observation ID. Read context or replace context with media for the collected photos. Each request costs 1 credit and preserves the original search dates; it does not refresh availability or create a booking quote.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://realtycrawl.dev/v1/stays/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$STAY_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/context\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REALTYCRAWL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Max-Credits: 1\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`filter-a-dated-source-search`,children:`Filter a dated source search`}),`\n`,_jsx(_components.p,{children:`Check the Booking.com capability first. This illustrative search keeps its Paris region, USD currency and two-adult context, adds a source nightly price band and source star class, and reserves 50 credits. The returned price can still be a total-stay observation; preserve its period. Airbnb, VRBO and Trip.com accept different filter sets.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://realtycrawl.dev/v1/stays/search\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REALTYCRAWL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Max-Credits: 50\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: booking-filter-example\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"platforms\":[\"booking\"],\"location\":{\"kind\":\"source_region\",\"platform\":\"booking\",\"country\":\"FR\",\"region_id\":\"paris\"},\"check_in\":\"2026-12-01\",\"check_out\":\"2026-12-03\",\"guests\":{\"adults\":2},\"currency\":\"USD\",\"limit\":1,\"price\":{\"min\":80,\"max\":400,\"currency\":\"USD\",\"period\":\"night\"},\"source_filters\":{\"booking\":{\"star_ratings\":[4]}}}'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`read-retained-energy-observations`,children:`Read retained energy observations`}),`\n`,_jsx(_components.p,{children:`Use the listing ID returned by your own supported source search or detail request. This read costs 1 credit and does not refresh the source. Missing energy observations remain unavailable; an unknown unit is never supplied by inference.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://realtycrawl.dev/v1/listings/`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$LISTING_ID`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/energy\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REALTYCRAWL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Max-Credits: 1\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`read-advertised-commercial-lease-terms`,children:`Read advertised commercial lease terms`}),`\n`,_jsx(_components.p,{children:`Use a listing_id returned by your own supported commercial search. This one-credit read returns the ranges and labeled rates already collected; it does not refresh the source or confirm availability.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://realtycrawl.dev/v1/listings/YOUR_LISTING_ID/lease-terms'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REALTYCRAWL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-Max-Credits: 1'`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`filter-an-exact-domain-bedroom-count`,children:`Filter an exact Domain bedroom count`}),`\n`,_jsx(_components.p,{children:`The source URL contract accepts equal min/max for 1, 2 or 3 bedrooms, apartment type and native price ordering in the existing Sydney NSW 2000 rental window. This is a documentation-backed beta request, not a fresh live sample.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://realtycrawl.dev/v1/domain/listings/search'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$REALTYCRAWL_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Idempotency-Key: domain-exact-bedrooms-example'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-Max-Credits: 50'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"location\":{\"kind\":\"source_region\",\"platform\":\"domain\",\"country\":\"AU\",\"region_id\":\"sydney-nsw-2000\"},\"transaction\":\"rent\",\"property_types\":[\"apartment\"],\"bedrooms\":{\"min\":2,\"max\":2},\"sort\":\"price_asc\",\"limit\":1}'`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API examples","description":null,"href":"/examples"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get the examples","slug":"get-the-examples","depth":2,"children":[]},{"title":"Run a bounded search","slug":"run-a-bounded-search","depth":2,"children":[]},{"title":"Keep the evidence","slug":"keep-the-evidence","depth":2,"children":[]},{"title":"Read collected stay context","slug":"read-collected-stay-context","depth":2,"children":[]},{"title":"Filter a dated source search","slug":"filter-a-dated-source-search","depth":2,"children":[]},{"title":"Read retained energy observations","slug":"read-retained-energy-observations","depth":2,"children":[]},{"title":"Read advertised commercial lease terms","slug":"read-advertised-commercial-lease-terms","depth":2,"children":[]},{"title":"Filter an exact Domain bedroom count","slug":"filter-an-exact-domain-bedroom-count","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"realtycrawl","siteName":"RealtyCrawl","title":"API examples - RealtyCrawl","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T04:42:05.066Z","originalFileLocation":"examples.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"RealtyCrawl\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API examples - RealtyCrawl\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"RealtyCrawl\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://realtycrawl.dev/docs/examples\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://realtycrawl.mintlify.site/docs/_mintlify/api/og/v2?division=Build+with+RealtyCrawl\u0026amp;title=API+examples\u0026amp;theme=26f6f391ae6285eec965c86a\u0026amp;signature=0bf9c3030e8ed4cb93f7c49542869db29d453aa82cdb7c39bd5a8a87f1c2ee21\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API examples - RealtyCrawl\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://realtycrawl.mintlify.site/docs/_mintlify/api/og/v2?division=Build+with+RealtyCrawl\u0026amp;title=API+examples\u0026amp;theme=26f6f391ae6285eec965c86a\u0026amp;signature=0bf9c3030e8ed4cb93f7c49542869db29d453aa82cdb7c39bd5a8a87f1c2ee21\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/realtycrawl/VaGEQ5skuDJ9ChqI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"RealtyCrawl\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#447B39\">\u003clink data-mint-head rel=\"canonical\" href=\"https://realtycrawl.dev/docs/examples\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/examples.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://realtycrawl.dev/#organization\",\"name\":\"RealtyCrawl\",\"url\":\"https://realtycrawl.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/realtycrawl/XaXlyjms747zxiaV/wordmark-light.svg?fit=max\u0026auto=format\u0026n=XaXlyjms747zxiaV\u0026q=85\u0026s=06b63fc8b659978facf89e4e1c4df754\"}},{\"@type\":\"WebSite\",\"@id\":\"https://realtycrawl.dev/docs#website\",\"name\":\"RealtyCrawl\",\"url\":\"https://realtycrawl.dev/docs\",\"publisher\":{\"@id\":\"https://realtycrawl.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://realtycrawl.dev/docs/examples#webpage\",\"url\":\"https://realtycrawl.dev/docs/examples\",\"name\":\"API examples\",\"dateModified\":\"2026-11-07T04:42:05.066Z\",\"isPartOf\":{\"@id\":\"https://realtycrawl.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://realtycrawl.dev/docs/examples#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://realtycrawl.dev/docs/examples#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Build with RealtyCrawl\",\"item\":\"https://realtycrawl.dev/docs/mcp-guide\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API examples\",\"item\":\"https://realtycrawl.dev/docs/examples\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://realtycrawl.dev/docs/examples#article\",\"headline\":\"API examples\",\"name\":\"API examples\",\"url\":\"https://realtycrawl.dev/docs/examples\",\"mainEntityOfPage\":{\"@id\":\"https://realtycrawl.dev/docs/examples#webpage\"},\"dateModified\":\"2026-11-07T04:42:05.066Z\",\"publisher\":{\"@id\":\"https://realtycrawl.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://realtycrawl.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"RealtyCrawl\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"RealtyCrawl\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/examples.md","siteName":"RealtyCrawl","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","groups":[{"group":"Get started","pages":[{"title":"Build with RealtyCrawl","href":"/introduction"},{"title":"Your first request","href":"/quickstart"},{"title":"Authentication and credits","href":"/authentication"}]},{"group":"Core concepts","pages":[{"title":"Subscriptions and credit usage","href":"/billing"},{"title":"Coverage and evidence","href":"/coverage"},{"title":"Response schema","href":"/response-schema"},{"title":"Pagination","href":"/pagination"},{"title":"Errors and retries","href":"/errors"}]},{"group":"Build with RealtyCrawl","pages":[{"title":"Connect with MCP","href":"/mcp-guide"},{"title":"Agent skills","description":null,"href":"/agent-skills"},{"title":"API examples","href":"/examples"}]}]},{"tab":"API reference","icon":"code","pages":[{"title":"API reference","href":"/api-reference"}]}]},"basePath":"","title":"API examples - RealtyCrawl","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":[],"chunks":[]}