/compass/agents

POST /api/compass/agents

Price: 20 credits

Get a Compass agent profile by slug or profile URL: name, title, email, phone, photo, bio, education, active listings and closed deal counts, plus a sample of their recent closed deals.

How to use it

Fetch a single Compass agent by slug or profile URL (e.g. an Agents item from the locations search endpoint). Returns one item with id, name, job_title, email, phone, office_phone, image, about, education, alias, profile_url, active/closed sales and rentals counts, and closed_deals (address, price, page_link).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agent string required — Compass agent profile URL, path or slug (e.g. from the locations search endpoint) (examples: "https://www.compass.com/agents/howard-aaron/", "howard-aaron"; minLength: 1)

Response

• @type string (default: "CompassAgent")
• id string required
• name string nullable
• first_name string nullable
• last_name string nullable
• job_title string nullable
• email string nullable
• phone string nullable
• office_phone string nullable
• image string nullable
• about string nullable
• education string nullable
• geo string nullable
• alias string nullable
• is_team boolean nullable
• profile_url string nullable
• active_sales_count integer nullable
• active_rentals_count integer nullable
• closed_sales_count integer nullable
• closed_rentals_count integer nullable
• closed_deals array (default: [])
  • @type string (default: "CompassAgentDeal")
  • listing_id string nullable
  • address string nullable
  • neighborhood string nullable
  • price number nullable
  • closed_at integer nullable
  • image string nullable
  • page_link 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 — Agent not found (well-formed slug but no agent profile 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.