Piloterr

Realtor Search

GET
/v2/realtor/search

Search Realtor.com listings from a search URL and retrieve prices, beds, baths, sqft, photos, and property metadata.

Credit cost: 2 credits per call

Autorização

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parâmetros de consulta

query*string

Full Realtor.com search results URL.

Example 1 (state search):

https://www.realtor.com/realestateandhomes-search/New-York_NY

Example 2 (city search):

https://www.realtor.com/realestateandhomes-search/Brooklyn_NY

Notes:

  • Only Realtor.com search URLs are accepted.
  • Filters and pagination parameters in the URL are respected.
  • Use each result's permalink or property detail URL with the Realtor Property endpoint.
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Corpo da resposta

Successful response

application/json
  1. response
results?array<>
Example Request
curl -X GET 'https://api.piloterr.com/v2/realtor/search?query=string'
Example Response
{  "results": [    {      "photos": [        {          "href": "https://ap.rdcpix.com/67dd84d210896e04e1252c2c8bc52c57l-m3226683124s.jpg"        }      ],      "location": {        "address": {          "city": "Brooklyn",          "line": "299 Troutman St",          "state": "NY",          "postal_code": "11237"        }      },      "permalink": "299-Troutman-St_Brooklyn_NY_11237_M99576-61733",      "list_price": 500000,      "description": {        "beds": 16,        "sqft": 6500,        "type": "SingleFamilyResidence",        "baths": 8,        "lot_size": 2500      },      "property_id": "9957661733"    },    {      "photos": [        {          "href": "https://ap.rdcpix.com/eac307cc2348e0014f42e489f57f5d02l-m3092249856s.jpg"        }      ],      "location": {        "address": {          "city": "Bronx",          "line": "D132 Edgewater Unit D",          "state": "NY",          "postal_code": "10465"        }      },      "permalink": "D132-Edgewater-Unit-D_Bronx_NY_10465_M94332-74355",      "list_price": 255000,      "description": {        "beds": 4,        "sqft": 1200,        "type": "SingleFamilyResidence",        "baths": 1,        "lot_size": null      },      "property_id": "9433274355"    },    {      "photos": [        {          "href": "https://ap.rdcpix.com/77415ad2b4919799a0cb455c54eab3fcl-m2351895655s.jpg"        }      ],      "location": {        "address": {          "city": "New York",          "line": "2573 Frederick Douglass Blvd Apt A",          "state": "NY",          "postal_code": "10030"        }      },      "permalink": "2573-Frederick-Douglass-Blvd-Apt-A_New-York_NY_10030_M92978-65175",      "list_price": 275000,      "description": {        "beds": 2,        "sqft": 1175,        "type": "Apartment",        "baths": 2.5,        "lot_size": null      },      "property_id": "9297865175"    },    {      "photos": [        {          "href": "https://ap.rdcpix.com/e5f2913192e3c223cc21e05ea213844el-m1072321830s.jpg"        }      ],      "location": {        "address": {          "city": "Woodhaven",          "line": "86-34 77th St",          "state": "NY",          "postal_code": "11421"        }      },      "permalink": "8634-77th-St_Woodhaven_NY_11421_M46500-03200",      "list_price": 603200,      "description": {        "beds": 6,        "sqft": null,        "type": "SingleFamilyResidence",        "baths": 2,        "lot_size": 2614      },      "property_id": "4650003200"    }  ]}