/domain/agents

POST /api/domain/agents

Price: 1 credit

Get a Domain.com.au real estate agency profile by agency id (or agency profile URL): name, address, contact details, branding, social links, sale/rent statistics and the agency's agents.

How to use it

Fetch a single Domain.com.au agency by numeric agency id or an agency profile URL. Returns one item with id, name, alias, url, description, website, profile_tier, is_archived, image (logo), cover, phone, email, mobile, address, suburb, state, postcode, facebook_url, twitter_url, instagram_url, linkedin_url, youtube_url, for_sale_count, sold_count (total), private_treaty_count, auctioned_count, for_rent_count, leased_count and agents (id, name, job_title, phone, mobile, image, profile_url).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• agent string required — Domain agency id or agency profile URL containing it (examples: "37188", "https://www.domain.com.au/real-estate-agencies/ljhookerbondibeach-37188/"; minLength: 1)

Response

• @type string (default: "DomainAgency")
• id string required
• name string nullable
• alias string nullable
• url string nullable
• description string nullable
• website string nullable
• profile_tier string nullable
• is_archived boolean nullable
• image string nullable
• cover string nullable
• phone string nullable
• email string nullable
• mobile string nullable
• address string nullable
• suburb string nullable
• state string nullable
• postcode string nullable
• facebook_url string nullable
• twitter_url string nullable
• instagram_url string nullable
• linkedin_url string nullable
• youtube_url string nullable
• for_sale_count integer nullable
• sold_count integer nullable
• private_treaty_count integer nullable
• auctioned_count integer nullable
• for_rent_count integer nullable
• leased_count integer nullable
• agents array (default: [])
  • @type string (default: "DomainAgencyContact")
  • id string nullable
  • name string nullable
  • job_title string nullable
  • phone string nullable
  • mobile string nullable
  • image string nullable
  • profile_url 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 — Agency not found or removed (well-formed but nonexistent agency id) 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.