{"openapi":"3.1.0","info":{"title":"Realtor API — RealtyAPI","version":"1.0.0","description":"Realtor API endpoints All endpoints require an API key sent in the `x-realtyapi-key` header. Get a key and try every endpoint interactively at https://www.realtyapi.io/api/realtor.","contact":{"name":"RealtyAPI","url":"https://www.realtyapi.io","email":"support@realtyapi.io"}},"externalDocs":{"description":"Interactive API playground and docs","url":"https://www.realtyapi.io/api/realtor"},"servers":[{"url":"https://realtor.realtyapi.io"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Property Details","description":"Property Details endpoints"},{"name":"Search Realtor","description":"Search Realtor endpoints"},{"name":"Tools","description":"Tools endpoints"},{"name":"Agents","description":"Agents endpoints"}],"paths":{"/details/byaddress":{"get":{"operationId":"get_details_byaddress","summary":"details/byaddress","tags":["Property Details"],"parameters":[{"name":"address","in":"query","required":true,"schema":{"type":"string"},"description":"Full property address.\n\n**Format**: `street, city, state, zip`\n- Example 1: `9504 Quail Village Ln, Austin, TX 78758`\n- Example 2: `1875 AVONDALE Circle, Jacksonville, FL 32205`\n- Example 3: `166 W 22nd St Unit 1D, New York, NY 10011`\n\nThe street line is matched against Realtor.com's address index; the rest is used to disambiguate when several listings share the same street line.","example":"9504 Quail Village Ln, Austin, TX 78758"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"INPUT: Property Address (`9504 Quail Village Ln, Austin, TX 78758`)\n\nGet **full property details** by a Realtor.com street address. The API resolves the address to a `property_id` internally — split into street line + city/state/zip — and disambiguates by city/state/zip when multiple matches come back.\n\n##### Note:\n- This endpoint costs `2 credits/call` and is slightly slower than `/details_byid`.\n- If you already know the `property_id` (from any `/search_*` response or from a Realtor.com listing URL), use the [/details_byid endpoint](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=detailsbyid) — it is `1 credit/call` and ~2× faster."}},"/autocomplete":{"get":{"operationId":"get_autocomplete","summary":"autocomplete","tags":["Search Realtor"],"parameters":[{"name":"input","in":"query","required":true,"schema":{"type":"string"},"description":"Search query — partial city / ZIP / neighborhood / address.\n\nExamples: `Austin`, `Brook`, `78758`, `9504 Qu`, `Westlake`.","example":"Austin"},{"name":"limit","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum number of suggestions to return.\n\n- **Default**: `10`\n- Realtor.com typically returns up to ~20.","example":10}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Realtor.com **search-box autocomplete** (`/parser/suggest`).\n\nReturns ranked suggestions across cities, ZIPs, neighborhoods, counties, addresses, schools, school districts, parks, universities and streets — each with geo metadata (`centroid`, `slug_id`, `geo_id`, `state_code`, etc.) ready to feed into a `/search_*` call."}},"/mortgage":{"get":{"operationId":"get_mortgage","summary":"mortgage","tags":["Tools"],"parameters":[{"name":"price","in":"query","required":true,"schema":{"type":"number"},"description":"Home price in **dollars** (integer or float — coerced to int).\n\nExamples: `525000`, `1200000`, `350000`.","example":525000},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number"},"description":"Down payment in **dollars** (integer).\n\n- **Default**: 20% of `price` (e.g. `105000` for a `525000` home)."},{"name":"rate","in":"query","required":false,"schema":{"type":"number"},"description":"Annual interest rate as a **decimal** (NOT a percentage).\n\n- **Default**: `0.065` (= 6.5%)\n- Examples: `0.065`, `0.07`, `0.0575`.","example":0.065},{"name":"term","in":"query","required":false,"schema":{"type":"number"},"description":"Loan term in **years**.\n\n- **Default**: `30`\n- Common values: `15`, `20`, `30`.","example":30},{"name":"propertyTaxRate","in":"query","required":false,"schema":{"type":"number"},"description":"Annual property tax rate as a **decimal** of home value (NOT a percentage).\n\n- **Default**: `0.013` (= 1.3%, US national average)\n- Texas typical: `0.018`–`0.022`; California typical: `0.0073`.","example":0.013},{"name":"hoaFees","in":"query","required":false,"schema":{"type":"number"},"description":"Monthly HOA fees in **dollars**.\n\n- **Default**: `0`\n- Examples: `150`, `400`, `750`."},{"name":"homeInsurance","in":"query","required":false,"schema":{"type":"number"},"description":"Monthly home insurance cost in **dollars**.\n\n- **Default**: `130` (US national average ≈ $1,560/yr).","example":130},{"name":"applyVeteransBenefits","in":"query","required":false,"schema":{"type":"boolean"},"description":"Apply VA-loan benefits (no PMI, VA funding fee model).\n\n- **Default**: `false`\n- Set `true` for an active-duty / veteran scenario."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Estimate the **monthly mortgage payment** for a home price using Realtor.com's mortgage calculator.\n\nReturns:\n- `loan_amount` — price minus down payment\n- `monthly_payment` — total $/mo\n- `total_payment` — total over the loan term\n- `breakdown` — per-component split: principal & interest, property tax, home insurance, HOA, mortgage insurance\n\nUseful for affordability widgets, listing detail pages, and matching the [\"Monthly payment\" filter](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=searchbylocation) on Realtor.com searches."}},"/agent/search":{"get":{"operationId":"get_agent_search","summary":"agent/search","tags":["Agents"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"City, neighborhood, or ZIP to find agents in. A free-text location is resolved to a postal code internally.\n\n**Examples**: `Austin, TX` · `Miami, FL` · `78701`","example":"Austin, TX"},{"name":"agentName","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Filter results to agents whose name matches this text (works with or alongside `location`).\n\nExample: `Watters`"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. Increase to page through the agent's listings.","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page (default 20, max 100).","example":20}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**Search Realtor.com agents** by location and/or name (the realtor.com/realestateagents \"Find a Realtor\" data).\n\nReturns a ranked list of agents — each with name, brokerage/office, ratings & review counts, listing stats (active/sold counts, price range), served areas, specializations, languages, phone, avatar, and `fulfillment_id`.\n\nProvide a `location` (city/ZIP) and/or an `agentName`. Use the returned `fulfillment_id` with [/agent/details](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-details), [/agent/reviews](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-reviews), and the `/agent/for_sale|for_rent|sold` endpoints."}},"/details/byid":{"get":{"operationId":"get_details_byid","summary":"details/byid","tags":["Property Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com property id (digits only — strip any hyphens from a URL's `_M` segment).\n\nExamples: `8955838462`, `2092046099`, `1925898832`","example":"8955838462"},{"name":"listing_id","in":"query","required":false,"schema":{"type":"string"},"description":"Optional `listing_id` to disambiguate when a property has **multiple active listings** (e.g. relisted, multi-MLS). When omitted, the primary/active listing is used. Returned alongside `property_id` in every `/search_*` response."},{"name":"listing_type","in":"query","required":false,"schema":{"type":"string"},"description":"Optional listing type hint passed through to Realtor.com's GraphQL. Leave empty unless you know the exact value (rarely needed)."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"INPUT: `property_id` (e.g. `8955838462`)\n\nGet **full property details** using Realtor.com's internal `property_id`. The fastest details endpoint — `1 credit/call`.\n\n##### Where to find a property_id:\n- Returned in every `/search_*` response (each result includes `property_id` and `listing_id`).\n- Embedded in a Realtor.com listing URL: the trailing `_M<digits>-<digits>` chunk is the `property_id` (hyphens are display separators, strip them).\n  - Example URL: `https://www.realtor.com/realestateandhomes-detail/9504-Quail-Village-Ln_Austin_TX_78758_M89558-38462`\n  - `M89558-38462` → `property_id = 8955838462`\n\nIf you only have an address, use [/details_byaddress](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=detailsbyaddress) instead."}},"/search/bylocation":{"get":{"operationId":"get_search_bylocation","summary":"search/bylocation","tags":["Search Realtor"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"City, ZIP, neighborhood, county, or state.\n\n**Examples**:\n- `New York, NY`\n- `Brooklyn, NY`\n- `78758`\n- `Westlake, Austin, TX`\n- `Travis County, TX`","example":"New York, NY"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`.","example":1},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page.\n\n- **Default**: `50`\n- **Min**: `1`\n- **Max**: `200`","example":50},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Beds","Baths","Most_Recently_Sold","Open_House_Date"]},"description":"Sort order for the result list. **Default**: `Recommended`.\n\n- `Recommended` — Realtor.com's default relevance bucket\n- `Newest` — most recently listed first\n- `Oldest` — least recently listed first\n- `Price_High_to_Low`\n- `Price_Low_to_High`\n- `Square_Feet` — largest first\n- `Lot_Size` — largest lot first\n- `Beds` — most beds first\n- `Baths` — most baths first\n- `Most_Recently_Sold` — only meaningful with `searchType` = `Sold`\n- `Open_House_Date` — soonest open house first"},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Listing status.\n\n- **Default**: `For_Sale`\n- **Multi-value supported** (comma-separated): e.g. `For_Sale,Sold` to combine on-market + sold comps.\n\n`Ready_to_Build` returns spec / new-build inventory; `For_Sale` already includes ready-to-build under the hood, so passing both is redundant."},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated property types. Leave empty to include all.\n\n**Allowed values**: `House, Condo, Townhome, Multi_Family, Mobile, Farm, Land, Co-op`\n\n**Aliases accepted**: `Single_Family` → House; `Manufactured` → Mobile; `Ranch` → Farm; `Townhouse` → Townhome.","example":"House,Condo,Townhome,Multi_Family,Mobile,Farm,Land,Co-op"},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs**:\n- For Minimum Price: `min:500000`\n- For Maximum Price: `max:1500000`\n- For a Price Range: `min:500000,max:1500000`"},{"name":"bedsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bedroom range. Studio = `min:0`.\n\n**Possible Inputs**:\n- For Minimum Beds: `min:3`\n- For Maximum Beds: `max:5`\n- For an Exact Match: `min:3,max:3`\n- For a Range: `min:3,max:5`"},{"name":"bathsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bathroom range — **decimals supported** (`2.5` = 2 full + 1 half).\n\n**Possible Inputs**:\n- For Minimum Baths: `min:2`\n- For Maximum Baths: `max:3.5`\n- For a Range: `min:2,max:3.5`"},{"name":"sqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Living area range, in **square feet**.\n\n**Possible Inputs**:\n- For Minimum Sqft: `min:1000`\n- For Maximum Sqft: `max:3000`\n- For a Range: `min:1000,max:3000`"},{"name":"lotSqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Lot size range, in **square feet**. For acre-sqft conversion: `1 acre` = `43560 sqft`.\n\n**Possible Inputs**:\n- For Minimum Lot Sqft: `min:5000`\n- For Maximum Lot Sqft: `max:30000`\n- For a Range: `min:5000,max:30000`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"Year-built range.\n\n**Possible Inputs**:\n- For Minimum Year: `min:2000`\n- For Maximum Year: `max:2024`\n- For a Range: `min:2000,max:2024`"},{"name":"hoaFeeMax","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum HOA fee per month, in dollars (integer).\n\nExamples: `200`, `500`, `1000`. Listings without HOA data are still included."},{"name":"newConstruction","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** new construction listings, or `false` to **exclude** them. Omit to include both."},{"name":"foreclosure","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** foreclosures, or `false` to **exclude** them. Omit to include both."},{"name":"pending","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** pending / under-contract listings, or `false` to **exclude** them. Omit to include both."},{"name":"seniorCommunity","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** 55+ / senior communities, or `false` to **exclude** them. Omit to include both."},{"name":"openHouse","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with an **upcoming open house**. Used for `searchType` = `For_Sale`."},{"name":"hasTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with a **3D / virtual tour**."},{"name":"hasPhotos","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings that have at least one photo."},{"name":"hasSpecials","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with **deals / incentives** (rent specials, builder incentives, closing-cost help). Most common on `For_Rent` and `Ready_to_Build`."},{"name":"petsAllowed","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated pet allowance. Used for `searchType` = `For_Rent`.\n\n**Available values**: `dog`, `cat`\n\n**Examples**: `dog`, `cat`, `dog,cat`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Free-text amenity keywords matched against listing descriptions, comma-separated.\n\n**Examples**: `pool`, `fireplace`, `granite countertops`, `pool,fireplace`"},{"name":"daysOnMarketMax","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose `list_date` is within the **last N days**. Integer.\n\nExamples: `7`, `14`, `30`, `90`."},{"name":"priceReducedDays","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose **price was reduced** within the last N days. Integer.\n\nExamples: `7`, `14`, `30`."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Realtor.com listings by **free-text location** — city, ZIP, neighborhood, county, or state.\n\nReturns paginated listings with `property_id`, `listing_id`, address, photos, price, beds/baths/sqft, status, days on market, listing date, and the listing-advertiser block (use `fulfillment_id` with [/agent](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent)).\n\nSupports the **full filter set** below (status, price/beds/baths ranges, property types, new-construction toggle, open-house, tours, pets, keywords, sort, pagination)."}},"/mapLayer":{"get":{"operationId":"get_mapLayer","summary":"mapLayer","tags":["Tools"],"parameters":[{"name":"layer","in":"query","required":true,"schema":{"type":"string","enum":["Estimate","EstimatePpsqft","LotAcres","LotSlope","Sqft","YearBuilt","Noise","MarketHotness","SoldPriceVsListPrice","SoldSqft","DaysOnMarket","HousingForecast","Flood","Wildfire","Heat","Wind","Air","Schools","Neighborhoods"]},"description":"Which Realtor map-layer to fetch. **Default**: `Estimate`.\n\nThree families share this endpoint — the response shape is determined by the layer you pick:\n\n**TopHap vector layers** (return cell arrays with `lat`/`lng` + per-layer attributes):\n- `Estimate` — RealEstimate℠ valuation per hex cell\n- `EstimatePpsqft` — Valuation $/sqft per cell\n- `LotAcres` — Lot size in acres\n- `LotSlope` — Lot slope %\n- `Sqft` — Home size (sqft)\n- `YearBuilt` — Year built\n- `Noise` — Noise score\n- `MarketHotness` — RDC Hotness Score per ZIP (also returns a `us_hotness_score_label`)\n- `SoldPriceVsListPrice` — Sold-vs-list % over the last 365d\n- `SoldSqft` — Sold $/sqft over the last 365d\n- `DaysOnMarket` — Median Days On Market over the last 365d\n- `HousingForecast` — RDC 12-month forecast % change per ZIP\n- `Neighborhoods` — Neighborhood centroids + IDs (`slug_id`, `geo_id`, `neighborhood`)\n\n**Raster layers** (return base64 PNG tiles in `data.tiles[]`):\n- `Flood` — First Street® flood-risk overlay\n- `Wildfire` — First Street® wildfire-risk overlay\n- `Heat` — Max-temperature overlay (hottest month °F)\n- `Wind` — Wind-risk overlay\n- `Air` — Air-quality (bad-air days) overlay\n\n**GraphQL records**:\n- `Schools` — All schools + districts inside the region's bbox."},{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Region to fetch the map layer for. Accepts anything Realtor.com's autocomplete handles — ZIP, city, neighborhood, county, state, or full address.\n\n- Example 1: `10027` (ZIP)\n- Example 2: `New York, NY` (city)\n- Example 3: `Harlem, New York, NY` (neighborhood)\n- Example 4: `9504 Quail Village Ln, Austin, TX 78758` (address)\n\nThe input is resolved internally to a centroid + bbox; tiles are fetched around that centroid at the requested `zoom`.","example":"10027"},{"name":"zoom","in":"query","required":false,"schema":{"type":"number"},"description":"Web-Mercator tile zoom level for the fetched tiles. Typical range `10–16`. Leave blank to use the per-layer default:\n\n- TopHap hex-cell layers (Estimate, Sqft, Noise, etc.): `12`\n- TopHap per-ZIP layers (MarketHotness, HousingForecast): `9`\n- Neighborhoods / Schools: `12`\n- Raster layers (Flood, Wildfire, Heat, Wind, Air): `11`\n- Parcel-resolution data (per-property): set zoom to `16` and the endpoint switches to the parcel tile source."},{"name":"relativeYear","in":"query","required":false,"schema":{"type":"number"},"description":"Forecast horizon for **raster** layers only (Flood, Wildfire, Heat, Wind, Air). Accepted values: `0` (current year, default), `15`, `30`.\n\nIgnored for non-raster layers — there's no time dimension on TopHap vector cells."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Returns Realtor.com map-overlay data for any region. Pick one of 19 layers (Estimate, MarketHotness, Schools, Flood, etc.) via the `layer` enum and pass a free-text `location` (zip / city / neighborhood / address). Response shape varies by layer family — vector cells, base64 PNG tiles, or GraphQL records — and always echoes the resolved bbox + center so you can render the overlay on your own map."}},"/agent/details":{"get":{"operationId":"get_agent_details","summary":"agent/details","tags":["Agents"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com agent `fulfillment_id` — the join key for all agent endpoints. Get it from any [/agent/search](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-search) result (`searchResults[].fulfillment_id`), or from a listing's `advertisers[].fulfillment_id`.\n\nExample: `725142`","example":"725142"},{"name":"listings","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `false` to skip the embedded listing previews (faster). Defaults to `true` (includes for-sale, for-rent, and recently-sold previews).","example":true}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**Full Realtor.com agent profile** by `fulfillment_id`.\n\nReturns the agent's bio, contact (phones, website), brokerage/office + broker, ratings rollup, license number, designations, languages, served areas, and specializations — plus a preview of the agent's `for_sale_listings`, `for_rent_listings`, and `recently_sold_listings`.\n\nFor full paginated listing lists use [/agent/for_sale](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-for-sale), `/agent/for_rent`, and `/agent/sold`. For ratings & written reviews use [/agent/reviews](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-reviews)."}},"/details/byurl":{"get":{"operationId":"get_details_byurl","summary":"details/byurl","tags":["Property Details"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com listing URL.\n\nExample: `https://www.realtor.com/realestateandhomes-detail/9504-Quail-Village-Ln_Austin_TX_78758_M89558-38462`","example":"https://www.realtor.com/realestateandhomes-detail/9504-Quail-Village-Ln_Austin_TX_78758_M89558-38462"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"INPUT: Realtor.com listing URL\n\nGet **full property details** from a Realtor.com listing URL. The trailing `_M<digits>-<digits>` chunk is parsed to extract the `property_id`. If the URL has no `_M` segment, the address slug is treated as a free-text address and resolved via the search index.\n\n##### Supported URL shapes:\n- `https://www.realtor.com/realestateandhomes-detail/<address-slug>_M<property_id>` ✅ fastest\n- `https://www.realtor.com/realestateandhomes-detail/<address-slug>_<city>_<ST>_<zip>_M<property_id>-<listing_id>` ✅ fastest\n- `https://www.realtor.com/realestateandhomes-detail/<address-slug>` ✅ falls back to address resolution"}},"/search/byzip":{"get":{"operationId":"get_search_byzip","summary":"search/byzip","tags":["Search Realtor"],"parameters":[{"name":"zipCode","in":"query","required":true,"schema":{"type":"string"},"description":"5-digit US ZIP code.\n\n**Examples**: `78758`, `10001`, `90210`.","example":"78758"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`.","example":1},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page.\n\n- **Default**: `50`\n- **Min**: `1`\n- **Max**: `200`","example":50},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Beds","Baths","Most_Recently_Sold","Open_House_Date"]},"description":"Sort order for the result list. **Default**: `Recommended`.\n\n- `Recommended` — Realtor.com's default relevance bucket\n- `Newest` — most recently listed first\n- `Oldest` — least recently listed first\n- `Price_High_to_Low`\n- `Price_Low_to_High`\n- `Square_Feet` — largest first\n- `Lot_Size` — largest lot first\n- `Beds` — most beds first\n- `Baths` — most baths first\n- `Most_Recently_Sold` — only meaningful with `searchType` = `Sold`\n- `Open_House_Date` — soonest open house first"},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Listing status.\n\n- **Default**: `For_Sale`\n- **Multi-value supported** (comma-separated): e.g. `For_Sale,Sold` to combine on-market + sold comps.\n\n`Ready_to_Build` returns spec / new-build inventory; `For_Sale` already includes ready-to-build under the hood, so passing both is redundant."},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated property types. Leave empty to include all.\n\n**Allowed values**: `House, Condo, Townhome, Multi_Family, Mobile, Farm, Land, Co-op`\n\n**Aliases accepted**: `Single_Family` → House; `Manufactured` → Mobile; `Ranch` → Farm; `Townhouse` → Townhome.","example":"House,Condo,Townhome,Multi_Family,Mobile,Farm,Land,Co-op"},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs**:\n- For Minimum Price: `min:500000`\n- For Maximum Price: `max:1500000`\n- For a Price Range: `min:500000,max:1500000`"},{"name":"bedsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bedroom range. Studio = `min:0`.\n\n**Possible Inputs**:\n- For Minimum Beds: `min:3`\n- For Maximum Beds: `max:5`\n- For an Exact Match: `min:3,max:3`\n- For a Range: `min:3,max:5`"},{"name":"bathsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bathroom range — **decimals supported** (`2.5` = 2 full + 1 half).\n\n**Possible Inputs**:\n- For Minimum Baths: `min:2`\n- For Maximum Baths: `max:3.5`\n- For a Range: `min:2,max:3.5`"},{"name":"sqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Living area range, in **square feet**.\n\n**Possible Inputs**:\n- For Minimum Sqft: `min:1000`\n- For Maximum Sqft: `max:3000`\n- For a Range: `min:1000,max:3000`"},{"name":"lotSqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Lot size range, in **square feet**. For acre-sqft conversion: `1 acre` = `43560 sqft`.\n\n**Possible Inputs**:\n- For Minimum Lot Sqft: `min:5000`\n- For Maximum Lot Sqft: `max:30000`\n- For a Range: `min:5000,max:30000`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"Year-built range.\n\n**Possible Inputs**:\n- For Minimum Year: `min:2000`\n- For Maximum Year: `max:2024`\n- For a Range: `min:2000,max:2024`"},{"name":"hoaFeeMax","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum HOA fee per month, in dollars (integer).\n\nExamples: `200`, `500`, `1000`. Listings without HOA data are still included."},{"name":"newConstruction","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** new construction listings, or `false` to **exclude** them. Omit to include both."},{"name":"foreclosure","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** foreclosures, or `false` to **exclude** them. Omit to include both."},{"name":"pending","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** pending / under-contract listings, or `false` to **exclude** them. Omit to include both."},{"name":"seniorCommunity","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** 55+ / senior communities, or `false` to **exclude** them. Omit to include both."},{"name":"openHouse","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with an **upcoming open house**. Used for `searchType` = `For_Sale`."},{"name":"hasTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with a **3D / virtual tour**."},{"name":"hasPhotos","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings that have at least one photo."},{"name":"hasSpecials","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with **deals / incentives** (rent specials, builder incentives, closing-cost help). Most common on `For_Rent` and `Ready_to_Build`."},{"name":"petsAllowed","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated pet allowance. Used for `searchType` = `For_Rent`.\n\n**Available values**: `dog`, `cat`\n\n**Examples**: `dog`, `cat`, `dog,cat`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Free-text amenity keywords matched against listing descriptions, comma-separated.\n\n**Examples**: `pool`, `fireplace`, `granite countertops`, `pool,fireplace`"},{"name":"daysOnMarketMax","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose `list_date` is within the **last N days**. Integer.\n\nExamples: `7`, `14`, `30`, `90`."},{"name":"priceReducedDays","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose **price was reduced** within the last N days. Integer.\n\nExamples: `7`, `14`, `30`."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Realtor.com listings by **US ZIP code**. Cleaner than `/search_bylocation` when you specifically want a postal-code search (no fuzzy matching).\n\nSupports the **full filter set** below."}},"/agent/reviews":{"get":{"operationId":"get_agent_reviews","summary":"agent/reviews","tags":["Agents"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com agent `fulfillment_id` — the join key for all agent endpoints. Get it from any [/agent/search](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-search) result (`searchResults[].fulfillment_id`), or from a listing's `advertisers[].fulfillment_id`.\n\nExample: `725142`","example":"725142"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**Ratings, reviews, and recommendations** for a Realtor.com agent by `fulfillment_id`.\n\nReturns the ratings rollup (average rating, review & recommendation counts) plus the full list of written `reviews` (overall star rating + sub-scores for responsiveness, market expertise, negotiation, and professionalism/communication, the reviewer's role, and any agent reply) and free-text `recommendations`."}},"/search/bycoordinates":{"get":{"operationId":"get_search_bycoordinates","summary":"search/bycoordinates","tags":["Search Realtor"],"parameters":[{"name":"latitude","in":"query","required":true,"schema":{"type":"number"},"description":"Center **latitude** in decimal degrees.\n\nExample: `30.4108` (Austin, TX area).","example":30.4108},{"name":"longitude","in":"query","required":true,"schema":{"type":"number"},"description":"Center **longitude** in decimal degrees.\n\nExample: `-97.7177` (Austin, TX area).","example":-97.7177},{"name":"radius","in":"query","required":false,"schema":{"type":"number"},"description":"Radius in **miles**. Float supported.\n\n- **Default**: `1.5`\n- Larger values widen the bounding box; very large radii will hit Realtor.com's 200-result page cap — narrow with filters or paginate.","example":1.5},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`.","example":1},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page.\n\n- **Default**: `50`\n- **Min**: `1`\n- **Max**: `200`","example":50},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Beds","Baths","Most_Recently_Sold","Open_House_Date"]},"description":"Sort order for the result list. **Default**: `Recommended`.\n\n- `Recommended` — Realtor.com's default relevance bucket\n- `Newest` — most recently listed first\n- `Oldest` — least recently listed first\n- `Price_High_to_Low`\n- `Price_Low_to_High`\n- `Square_Feet` — largest first\n- `Lot_Size` — largest lot first\n- `Beds` — most beds first\n- `Baths` — most baths first\n- `Most_Recently_Sold` — only meaningful with `searchType` = `Sold`\n- `Open_House_Date` — soonest open house first"},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Listing status.\n\n- **Default**: `For_Sale`\n- **Multi-value supported** (comma-separated): e.g. `For_Sale,Sold` to combine on-market + sold comps.\n\n`Ready_to_Build` returns spec / new-build inventory; `For_Sale` already includes ready-to-build under the hood, so passing both is redundant."},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated property types. Leave empty to include all.\n\n**Allowed values**: `House, Condo, Townhome, Multi_Family, Mobile, Farm, Land, Co-op`\n\n**Aliases accepted**: `Single_Family` → House; `Manufactured` → Mobile; `Ranch` → Farm; `Townhouse` → Townhome.","example":"House,Condo,Townhome,Multi_Family,Mobile,Farm,Land,Co-op"},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs**:\n- For Minimum Price: `min:500000`\n- For Maximum Price: `max:1500000`\n- For a Price Range: `min:500000,max:1500000`"},{"name":"bedsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bedroom range. Studio = `min:0`.\n\n**Possible Inputs**:\n- For Minimum Beds: `min:3`\n- For Maximum Beds: `max:5`\n- For an Exact Match: `min:3,max:3`\n- For a Range: `min:3,max:5`"},{"name":"bathsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bathroom range — **decimals supported** (`2.5` = 2 full + 1 half).\n\n**Possible Inputs**:\n- For Minimum Baths: `min:2`\n- For Maximum Baths: `max:3.5`\n- For a Range: `min:2,max:3.5`"},{"name":"sqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Living area range, in **square feet**.\n\n**Possible Inputs**:\n- For Minimum Sqft: `min:1000`\n- For Maximum Sqft: `max:3000`\n- For a Range: `min:1000,max:3000`"},{"name":"lotSqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Lot size range, in **square feet**. For acre-sqft conversion: `1 acre` = `43560 sqft`.\n\n**Possible Inputs**:\n- For Minimum Lot Sqft: `min:5000`\n- For Maximum Lot Sqft: `max:30000`\n- For a Range: `min:5000,max:30000`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"Year-built range.\n\n**Possible Inputs**:\n- For Minimum Year: `min:2000`\n- For Maximum Year: `max:2024`\n- For a Range: `min:2000,max:2024`"},{"name":"hoaFeeMax","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum HOA fee per month, in dollars (integer).\n\nExamples: `200`, `500`, `1000`. Listings without HOA data are still included."},{"name":"newConstruction","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** new construction listings, or `false` to **exclude** them. Omit to include both."},{"name":"foreclosure","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** foreclosures, or `false` to **exclude** them. Omit to include both."},{"name":"pending","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** pending / under-contract listings, or `false` to **exclude** them. Omit to include both."},{"name":"seniorCommunity","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** 55+ / senior communities, or `false` to **exclude** them. Omit to include both."},{"name":"openHouse","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with an **upcoming open house**. Used for `searchType` = `For_Sale`."},{"name":"hasTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with a **3D / virtual tour**."},{"name":"hasPhotos","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings that have at least one photo."},{"name":"hasSpecials","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with **deals / incentives** (rent specials, builder incentives, closing-cost help). Most common on `For_Rent` and `Ready_to_Build`."},{"name":"petsAllowed","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated pet allowance. Used for `searchType` = `For_Rent`.\n\n**Available values**: `dog`, `cat`\n\n**Examples**: `dog`, `cat`, `dog,cat`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Free-text amenity keywords matched against listing descriptions, comma-separated.\n\n**Examples**: `pool`, `fireplace`, `granite countertops`, `pool,fireplace`"},{"name":"daysOnMarketMax","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose `list_date` is within the **last N days**. Integer.\n\nExamples: `7`, `14`, `30`, `90`."},{"name":"priceReducedDays","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose **price was reduced** within the last N days. Integer.\n\nExamples: `7`, `14`, `30`."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Realtor.com listings inside a **circular area** defined by `latitude` + `longitude` + `radius` (miles).\n\nThe circle is converted internally to an axis-aligned bounding-box polygon (4-corner ring). For arbitrary shapes use [/search_bypolygon](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=searchbypolygon).\n\nSupports the **full filter set** below."}},"/agent/for_sale":{"get":{"operationId":"get_agent_for_sale","summary":"agent/for_sale","tags":["Agents"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com agent `fulfillment_id` — the join key for all agent endpoints. Get it from any [/agent/search](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-search) result (`searchResults[].fulfillment_id`), or from a listing's `advertisers[].fulfillment_id`.\n\nExample: `725142`","example":"725142"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. Increase to page through the agent's listings.","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page (default 50, max 200).","example":50}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**An agent's active for-sale listings** by `fulfillment_id` (paginated).\n\nEach result includes price, address, beds/baths/sqft, property type, photo, and the listing URL. See also `/agent/for_rent` and `/agent/sold`."}},"/search/bypolygon":{"get":{"operationId":"get_search_bypolygon","summary":"search/bypolygon","tags":["Search Realtor"],"parameters":[{"name":"polygon","in":"query","required":true,"schema":{"type":"string"},"description":"Polygon ring as `lon lat,lon lat,lon lat,...` (whitespace between lon and lat, comma between points). Closing the loop is optional — the API auto-closes if needed.\n\n**Example** (a small box around Austin, TX):\n`-97.74 30.40,-97.70 30.40,-97.70 30.43,-97.74 30.43`","example":"-97.74 30.40,-97.70 30.40,-97.70 30.43,-97.74 30.43"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`.","example":1},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page.\n\n- **Default**: `50`\n- **Min**: `1`\n- **Max**: `200`","example":50},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Beds","Baths","Most_Recently_Sold","Open_House_Date"]},"description":"Sort order for the result list. **Default**: `Recommended`.\n\n- `Recommended` — Realtor.com's default relevance bucket\n- `Newest` — most recently listed first\n- `Oldest` — least recently listed first\n- `Price_High_to_Low`\n- `Price_Low_to_High`\n- `Square_Feet` — largest first\n- `Lot_Size` — largest lot first\n- `Beds` — most beds first\n- `Baths` — most baths first\n- `Most_Recently_Sold` — only meaningful with `searchType` = `Sold`\n- `Open_House_Date` — soonest open house first"},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Listing status.\n\n- **Default**: `For_Sale`\n- **Multi-value supported** (comma-separated): e.g. `For_Sale,Sold` to combine on-market + sold comps.\n\n`Ready_to_Build` returns spec / new-build inventory; `For_Sale` already includes ready-to-build under the hood, so passing both is redundant."},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated property types. Leave empty to include all.\n\n**Allowed values**: `House, Condo, Townhome, Multi_Family, Mobile, Farm, Land, Co-op`\n\n**Aliases accepted**: `Single_Family` → House; `Manufactured` → Mobile; `Ranch` → Farm; `Townhouse` → Townhome.","example":"House,Condo,Townhome,Multi_Family,Mobile,Farm,Land,Co-op"},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs**:\n- For Minimum Price: `min:500000`\n- For Maximum Price: `max:1500000`\n- For a Price Range: `min:500000,max:1500000`"},{"name":"bedsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bedroom range. Studio = `min:0`.\n\n**Possible Inputs**:\n- For Minimum Beds: `min:3`\n- For Maximum Beds: `max:5`\n- For an Exact Match: `min:3,max:3`\n- For a Range: `min:3,max:5`"},{"name":"bathsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bathroom range — **decimals supported** (`2.5` = 2 full + 1 half).\n\n**Possible Inputs**:\n- For Minimum Baths: `min:2`\n- For Maximum Baths: `max:3.5`\n- For a Range: `min:2,max:3.5`"},{"name":"sqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Living area range, in **square feet**.\n\n**Possible Inputs**:\n- For Minimum Sqft: `min:1000`\n- For Maximum Sqft: `max:3000`\n- For a Range: `min:1000,max:3000`"},{"name":"lotSqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Lot size range, in **square feet**. For acre-sqft conversion: `1 acre` = `43560 sqft`.\n\n**Possible Inputs**:\n- For Minimum Lot Sqft: `min:5000`\n- For Maximum Lot Sqft: `max:30000`\n- For a Range: `min:5000,max:30000`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"Year-built range.\n\n**Possible Inputs**:\n- For Minimum Year: `min:2000`\n- For Maximum Year: `max:2024`\n- For a Range: `min:2000,max:2024`"},{"name":"hoaFeeMax","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum HOA fee per month, in dollars (integer).\n\nExamples: `200`, `500`, `1000`. Listings without HOA data are still included."},{"name":"newConstruction","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** new construction listings, or `false` to **exclude** them. Omit to include both."},{"name":"foreclosure","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** foreclosures, or `false` to **exclude** them. Omit to include both."},{"name":"pending","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** pending / under-contract listings, or `false` to **exclude** them. Omit to include both."},{"name":"seniorCommunity","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** 55+ / senior communities, or `false` to **exclude** them. Omit to include both."},{"name":"openHouse","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with an **upcoming open house**. Used for `searchType` = `For_Sale`."},{"name":"hasTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with a **3D / virtual tour**."},{"name":"hasPhotos","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings that have at least one photo."},{"name":"hasSpecials","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with **deals / incentives** (rent specials, builder incentives, closing-cost help). Most common on `For_Rent` and `Ready_to_Build`."},{"name":"petsAllowed","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated pet allowance. Used for `searchType` = `For_Rent`.\n\n**Available values**: `dog`, `cat`\n\n**Examples**: `dog`, `cat`, `dog,cat`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Free-text amenity keywords matched against listing descriptions, comma-separated.\n\n**Examples**: `pool`, `fireplace`, `granite countertops`, `pool,fireplace`"},{"name":"daysOnMarketMax","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose `list_date` is within the **last N days**. Integer.\n\nExamples: `7`, `14`, `30`, `90`."},{"name":"priceReducedDays","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose **price was reduced** within the last N days. Integer.\n\nExamples: `7`, `14`, `30`."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search Realtor.com listings inside an **arbitrary polygon**.\n\nUseful for irregular boundaries — neighborhoods, school catchment areas, drawn map regions. The polygon is sent to Realtor.com as a GeoJSON `Polygon` boundary.\n\n**Polygon format**: a comma-separated list of `lon lat` pairs (note: longitude first, then latitude — GeoJSON convention). The ring will be auto-closed if the first/last vertex differ.\n\nSupports the **full filter set** below."}},"/agent/for_rent":{"get":{"operationId":"get_agent_for_rent","summary":"agent/for_rent","tags":["Agents"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com agent `fulfillment_id` — the join key for all agent endpoints. Get it from any [/agent/search](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-search) result (`searchResults[].fulfillment_id`), or from a listing's `advertisers[].fulfillment_id`.\n\nExample: `725142`","example":"725142"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. Increase to page through the agent's listings.","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page (default 50, max 200).","example":50}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**An agent's active rental listings** by `fulfillment_id` (paginated).\n\nEach result includes price, address, beds/baths/sqft, property type, photo, and the listing URL. See also `/agent/for_sale` and `/agent/sold`."}},"/search/byurl":{"get":{"operationId":"get_search_byurl","summary":"search/byurl","tags":["Search Realtor"],"parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com search URL.\n\n**Example**: `https://www.realtor.com/realestateandhomes-search/Austin_TX/type-single-family-home/price-na-1500000/beds-3`\n\nSupported URL shapes:\n- `/realestateandhomes-search/<City>_<ST>/...`\n- `/realestateandhomes-search/<ZIP>/...`\n- `/realestateandhomes-search/<Neighborhood>_<City>_<ST>/...`","example":"https://www.realtor.com/realestateandhomes-search/Austin_TX/type-single-family-home/price-na-1500000/beds-3"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. The response includes a `nextPage` boolean — keep paging until `nextPage = false`.","example":1},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page.\n\n- **Default**: `50`\n- **Min**: `1`\n- **Max**: `200`","example":50},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Beds","Baths","Most_Recently_Sold","Open_House_Date"]},"description":"Sort order for the result list. **Default**: `Recommended`.\n\n- `Recommended` — Realtor.com's default relevance bucket\n- `Newest` — most recently listed first\n- `Oldest` — least recently listed first\n- `Price_High_to_Low`\n- `Price_Low_to_High`\n- `Square_Feet` — largest first\n- `Lot_Size` — largest lot first\n- `Beds` — most beds first\n- `Baths` — most baths first\n- `Most_Recently_Sold` — only meaningful with `searchType` = `Sold`\n- `Open_House_Date` — soonest open house first"},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"Listing status.\n\n- **Default**: `For_Sale`\n- **Multi-value supported** (comma-separated): e.g. `For_Sale,Sold` to combine on-market + sold comps.\n\n`Ready_to_Build` returns spec / new-build inventory; `For_Sale` already includes ready-to-build under the hood, so passing both is redundant."},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated property types. Leave empty to include all.\n\n**Allowed values**: `House, Condo, Townhome, Multi_Family, Mobile, Farm, Land, Co-op`\n\n**Aliases accepted**: `Single_Family` → House; `Manufactured` → Mobile; `Ranch` → Farm; `Townhouse` → Townhome.","example":"House,Condo,Townhome,Multi_Family,Mobile,Farm,Land,Co-op"},{"name":"priceRange","in":"query","required":false,"schema":{"type":"string"},"description":"**Possible Inputs**:\n- For Minimum Price: `min:500000`\n- For Maximum Price: `max:1500000`\n- For a Price Range: `min:500000,max:1500000`"},{"name":"bedsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bedroom range. Studio = `min:0`.\n\n**Possible Inputs**:\n- For Minimum Beds: `min:3`\n- For Maximum Beds: `max:5`\n- For an Exact Match: `min:3,max:3`\n- For a Range: `min:3,max:5`"},{"name":"bathsRange","in":"query","required":false,"schema":{"type":"string"},"description":"Bathroom range — **decimals supported** (`2.5` = 2 full + 1 half).\n\n**Possible Inputs**:\n- For Minimum Baths: `min:2`\n- For Maximum Baths: `max:3.5`\n- For a Range: `min:2,max:3.5`"},{"name":"sqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Living area range, in **square feet**.\n\n**Possible Inputs**:\n- For Minimum Sqft: `min:1000`\n- For Maximum Sqft: `max:3000`\n- For a Range: `min:1000,max:3000`"},{"name":"lotSqftRange","in":"query","required":false,"schema":{"type":"string"},"description":"Lot size range, in **square feet**. For acre-sqft conversion: `1 acre` = `43560 sqft`.\n\n**Possible Inputs**:\n- For Minimum Lot Sqft: `min:5000`\n- For Maximum Lot Sqft: `max:30000`\n- For a Range: `min:5000,max:30000`"},{"name":"yearBuiltRange","in":"query","required":false,"schema":{"type":"string"},"description":"Year-built range.\n\n**Possible Inputs**:\n- For Minimum Year: `min:2000`\n- For Maximum Year: `max:2024`\n- For a Range: `min:2000,max:2024`"},{"name":"hoaFeeMax","in":"query","required":false,"schema":{"type":"number"},"description":"Maximum HOA fee per month, in dollars (integer).\n\nExamples: `200`, `500`, `1000`. Listings without HOA data are still included."},{"name":"newConstruction","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** new construction listings, or `false` to **exclude** them. Omit to include both."},{"name":"foreclosure","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** foreclosures, or `false` to **exclude** them. Omit to include both."},{"name":"pending","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** pending / under-contract listings, or `false` to **exclude** them. Omit to include both."},{"name":"seniorCommunity","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return **only** 55+ / senior communities, or `false` to **exclude** them. Omit to include both."},{"name":"openHouse","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with an **upcoming open house**. Used for `searchType` = `For_Sale`."},{"name":"hasTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with a **3D / virtual tour**."},{"name":"hasPhotos","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings that have at least one photo."},{"name":"hasSpecials","in":"query","required":false,"schema":{"type":"boolean"},"description":"Set to `true` to return only listings with **deals / incentives** (rent specials, builder incentives, closing-cost help). Most common on `For_Rent` and `Ready_to_Build`."},{"name":"petsAllowed","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated pet allowance. Used for `searchType` = `For_Rent`.\n\n**Available values**: `dog`, `cat`\n\n**Examples**: `dog`, `cat`, `dog,cat`"},{"name":"keywords","in":"query","required":false,"schema":{"type":"string"},"description":"Free-text amenity keywords matched against listing descriptions, comma-separated.\n\n**Examples**: `pool`, `fireplace`, `granite countertops`, `pool,fireplace`"},{"name":"daysOnMarketMax","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose `list_date` is within the **last N days**. Integer.\n\nExamples: `7`, `14`, `30`, `90`."},{"name":"priceReducedDays","in":"query","required":false,"schema":{"type":"number"},"description":"Only listings whose **price was reduced** within the last N days. Integer.\n\nExamples: `7`, `14`, `30`."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Run the search that a Realtor.com **search URL** represents.\n\nThe location slug + filter segments (`price-`, `beds-`, `baths-`, `sqft-`, `lot-sqft-`, `type-`, `shw-nc`, `nc-hide`, `shw-oh`, `show-price-reduced`, `shw-pr`) are parsed into the friendly query-builder vocabulary, then routed through the matching `/search_by*` endpoint (postal / city / neighborhood) under the hood.\n\nAdditional query-string filters you pass alongside `url` will be **layered on top** of whatever the URL encodes (filters from extra params override the URL's parsed filters)."}},"/agent/sold":{"get":{"operationId":"get_agent_sold","summary":"agent/sold","tags":["Agents"],"parameters":[{"name":"fulfillmentId","in":"query","required":true,"schema":{"type":"string"},"description":"Realtor.com agent `fulfillment_id` — the join key for all agent endpoints. Get it from any [/agent/search](https://realtyapi.io/dashboard?tab=playground&api=realtor&endpoint=agent-search) result (`searchResults[].fulfillment_id`), or from a listing's `advertisers[].fulfillment_id`.\n\nExample: `725142`","example":"725142"},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"1-based page number. Increase to page through the agent's listings.","example":1},{"name":"limit","in":"query","required":false,"schema":{"type":"number"},"description":"Results per page (default 50, max 200).","example":50}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"**An agent's recently sold listings** by `fulfillment_id` (paginated).\n\nEach result includes the last sold price & date, address, beds/baths/sqft, property type, photo, and the listing URL. See also `/agent/for_sale` and `/agent/for_rent`."}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-realtyapi-key","description":"RealtyAPI key from your dashboard at https://www.realtyapi.io."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PaymentRequired":{"description":"No credits remaining on the API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}