/crexi/properties/similar

POST /api/crexi/properties/similar

Price: 10 credits

Get properties similar to a given Crexi property: listing cards with id, name, status, property type, asking price, square footage, brokerage, image, latitude/longitude and property_url.

How to use it

Fetch properties similar to a given Crexi property by id or detail URL. Each item is a listing card with id (use it with the properties details endpoint), name, asking_price, square_footage, property_types, brokerage_name, location and property_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Crexi property id (numeric) or a property detail URL/path (examples: "2540397", "https://www.crexi.com/properties/2540397/wisconsin-140-west-garfield-avenue"; minLength: 1)
• count integer required — Max number of similar properties to return (min: 1; max: 50)

Response

• @type string (default: "CrexiPropertyCard")
• id integer required
• name string nullable
• description string nullable
• status string nullable
• platform string nullable
• property_types array (default: [])
• asking_price number nullable
• price_per_sqft number nullable
• square_footage integer nullable
• net_operating_income number nullable
• lease_term_years number nullable
• remaining_term_years number nullable
• investment_type string nullable
• lot_size_acres number nullable
• price_per_acre number nullable
• brokerage_name string nullable
• broker_logo string nullable
• is_in_opportunity_zone boolean nullable
• is_new boolean nullable
• has_video boolean nullable
• has_virtual_tour boolean nullable
• has_om boolean nullable
• has_flyer boolean nullable
• image_count integer nullable
• gallery_item_count integer nullable
• offers_due_at integer nullable
• activated_at integer nullable
• updated_at integer nullable
• image string nullable
• alias string nullable
• property_url string nullable
• location object nullable
  • @type string (default: "CrexiLocation")
  • address string nullable
  • city string nullable
  • county string nullable
  • state_code string nullable
  • state_name string nullable
  • zip string nullable
  • latitude number nullable
  • longitude number nullable
  • full_address 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 — Property not found (well-formed id but no active listing for it) 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.