Skip to content
Docs
Domain

Find Domain location slugs by place name

Domain.com.au suburbs, areas and regions for a place name, from the site's own search box, with the slug POST /v1/domain/search takes as location. A trailing state or postcode narrows the match (Surry Hills NSW); a bare postcode lists its suburbs. No match is free.

POST/v1/domain/locations
1 creditTry it1 per lookup (no match and failed requests are free)

Request

POSThttps://api.scrapercompany.com/v1/domain/locations

Authenticate with your API key in the x-api-key header (see Authentication).

Run this request on your own API key from this page, with the values you type. Signed out? Sign in or get an API key.

Body

JSON object. Unknown fields are rejected with 422.

  • querystringrequiredmin length 2, max length 100

    Suburb, area, region or postcode, e.g. Bondi Beach, Surry Hills NSW, 3000.

  • limitintegerdefault 10min 1, max 50

    Most results returned.

Example request

curl -X POST "https://api.scrapercompany.com/v1/domain/locations" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Bondi Beach"
  }'

Response

200 — Domain location slugs for a place name. Metered responses carry x-credits-charged and x-credits-remaining headers (see credit headers).

200 response
{
  "query": "Surry Hills",
  "locations": [
    {
      "slug": "surry-hills-nsw-2010",
      "name": "Surry Hills",
      "state": "NSW",
      "postcode": "2010",
      "type": "suburb"
    },
    {
      "slug": "surrey-hills-vic-3127",
      "name": "Surrey Hills",
      "state": "VIC",
      "postcode": "3127",
      "type": "suburb"
    }
  ]
}
Arrays are shortened to their first items.

Errors

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

StatusMeaningRetry?
401Unauthorized

Missing or invalid API key.

{"detail":"missing or invalid API key"}		No, fix the request
402Payment Required

Not enough credits for this request: the account's credits mode is enforce (mode in GET /v1/billing) and the request costs more than the available credits. Nothing is run or charged.

{"detail":"insufficient credits: this request costs 5, 0 available. Credits renew 2026-11-01."}		No, fix the request
422Unprocessable Content

Request validation failed. detail is a list of problems for schema errors, or a string for semantic checks performed by the endpoint.

{"detail":[{"loc":["body","name"],"msg":"Field required","type":"missing"}]}		No, fix the request
429Too Many Requests

Too many requests: the key's requests-per-minute limit was exceeded, or (in enforce credits mode) the plan's concurrent-request limit. No rate-limit or Retry-After headers are sent; back off and retry.

{"detail":"rate limit 60/min exceeded"}		Yes, with backoff
503Service Unavailable

Temporarily unavailable: a dependency of this endpoint is down, or the upstream source changed its contract. Retry later.

{"detail":"database unavailable: OperationalError"}		Yes, with backoff

Try it

Press Try it above to run this request on your own key, with the values you type (sign in first). For a no-code walkthrough, use the workspace’s guided Try it.

  1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? start a free trial).
  2. Copy the cURL example above and run it in a terminal.

Credits

1 credit per successful call (1 per lookup (no match and failed requests are free)). Failed, blocked and empty results are free.

Questions about this page?

Send the page link and your question, and the team will answer.

Email support