Skip to main contentSkip to main content

List macro regions (Growth+ tier)

GET/v1/regions1 credit

Lists the regions we publish macro indicators for: 8 capital cities, 8 states/territories, and a national row. Call /v1/regions/{slug} for detail. Below Growth, returns 403 plan_upgrade_required (credits refunded).

Example request

curl "https://api.propradar.com.au/v1/regions" \
  -H "X-API-Key: pr_live_..."

Example response

{ "regions": [{ "region_type": "city", "slug": "sydney", "name": "Sydney", "state": "NSW", "suburb_count": 642 }, ...],
  "count": 17 }

Get an API key

Every endpoint takes an X-API-Key header. The free tier needs no credit card.

Other endpoints