/realtorca/agents

POST /api/realtorca/agents

Price: 5 credits

Get a Canadian REALTOR®'s public profile from REALTOR.ca by agent ID or profile URL: name, position, photo, phone numbers, personal website, social profiles, languages spoken, specialties, professional designations and the brokerage they work for.

How to use it

Fetch one REALTOR® profile from Canada's national MLS® directory by numeric agent ID or profile URL. Returns one item with id, name, position, credentials, address, image, profile_url, phones, websites, social_links, languages, specialties, designations, bio and office (the brokerage with its own id, name, designation, address, profile_url, phones and websites).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agent string required — REALTOR.ca REALTOR® ID or an agent profile URL (examples: "1424606", "https://www.realtor.ca/agent/1424606/x"; minLength: 1)

Response

• @type string (default: "RealtorcaAgent")
• id string required
• name string nullable
• position string nullable
• credentials string nullable
• address string nullable
• image string nullable
• profile_url string nullable
• phones array (default: [])
• websites array (default: [])
• social_links array (default: [])
• languages array (default: [])
• specialties array (default: [])
• designations array (default: [])
• bio string nullable
• office object nullable
  • @type string (default: "RealtorcaAgentOffice")
  • id string nullable
  • name string nullable
  • designation string nullable
  • address string nullable
  • profile_url string nullable
  • image string nullable
  • phones array (default: [])
  • websites array (default: [])

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 — REALTOR® not found (well-formed but nonexistent or retired agent) 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.