/trulia/properties/search

POST /api/trulia/properties/search

Price: 20 credits

Search Trulia real-estate listings by location (city and state) with optional deal type (for sale, for rent, sold), property type, price range and minimum bedrooms. Returns properties with address, location and coordinates, status, price, bedrooms, bathrooms, floor space, property type, description, image, listing agent and broker, and list date.

How to use it

Search Trulia listings in a city (e.g. location='Austin, TX'). Optional filters: deal_type (for_sale/for_rent/sold), home_type, price_min, price_max, beds_min. Each item has id, url, address, city/state/zip, latitude/longitude, status, price/formatted_price/price_type, bedroom_count, bathroom_count, floor_space_sqft, property_type, description, image, listing_agent, listing_broker and listed_at.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — City and two-letter state, e.g. 'Austin, TX' (examples: "Austin, TX"; minLength: 1)
• deal_type string — Listing deal type (default: "for_sale"; one of: "for_sale", "for_rent", "sold")
• home_type string nullable — Property type filter (one of: "house", "condo", "townhome", "multi_family", "land")
• price_min integer nullable — Minimum price filter (min: 0)
• price_max integer nullable — Maximum price filter (min: 0)
• beds_min integer nullable — Minimum number of bedrooms (min: 0; max: 10)
• count integer required — Max number of properties to return (min: 1)

Response

• @type string (default: "TruliaSearchProperty")
• id string required
• url string required
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• latitude number nullable
• longitude number nullable
• is_active_for_sale boolean nullable
• is_active_for_rent boolean nullable
• is_foreclosure boolean nullable
• property_type string nullable
• price number nullable
• formatted_price string nullable
• price_type string nullable
• bedroom_count number nullable
• bathroom_count number nullable
• floor_space_sqft number nullable
• lot_size string nullable
• description string nullable
• image string nullable
• listing_agent string nullable
• listing_broker string nullable
• listed_at string nullable
• tag string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.