API Documentation

Propertylens Australia Public API v1 Reference

Jump to section

Base URL

https://app.propertylens.au/api/v1

Authentication

All API requests require an API key passed via the X-API-Key header. Create a free account at Propertylens Australia and generate your API key from the developer dashboard.

shell

curl -H "X-API-Key: pl_your_key_here" \
  https://app.propertylens.au/api/v1/suburbs/

API keys start with pl_. You can create up to 5 keys per account. Keys can be revoked at any time from the developer dashboard.

Rate Limits

requests / minute

1,000

requests / day

Rate limit info is included in response headers:

http

X-RateLimit-Limit-Minute: 60
X-RateLimit-Limit-Daily: 1000
X-RateLimit-Remaining-Minute: 58
X-RateLimit-Remaining-Daily: 947

Exceeding limits returns 429 Too Many Requests with a Retry-After header.

Error Handling

Errors return JSON with an error or detail field.

200Success

401Missing or invalid API key

402Insufficient credits (predictions only)

403API key revoked or expired

404Resource not found

429Rate limit exceeded

500Internal server error

json

{
  "detail": "Rate limit exceeded: 30 requests per minute"
}

Properties

Suburbs

Sales & Auctions

Market

Planning

GeoJSON

Predictions (Credits Required)

Accuracy endpoints are free. Individual property prediction data requires unlocking with 1 credit per property. Once unlocked, access is permanent and shared with the web platform. Purchase credits at propertylens.au/billing.

Deep Research (Partner / OEM)

Partner packaging uses the Enterprise API tier ($99/mo) plus credit overage. Each research run costs a flat 10 credits from the API key owner account. Fresh cached reports are returned without charging. Failed jobs auto-refund. Requires Pro or Enterprise (Free tier cannot call research). Ideal for inspection apps, buyers-agent CRMs, and conveyancing tools that need due-diligence as a callable product.

Embed Widgets

Embed suburb snapshots and map discovery on partner sites. Pass your API key askey=query param. Free-tier keys keep PropertyLens branding. Pro and Enterprise keys can request debranded embeds with debrand=1.

html

<iframe
  src="https://app.propertylens.au/embed/suburb?id=SUBURB_ID&key=pl_YOUR_KEY"
  width="100%" height="420" style="border:0;border-radius:12px;"
  title="PropertyLens suburb embed" loading="lazy"></iframe>

html

<iframe
  src="https://app.propertylens.au/embed/map?key=pl_YOUR_KEY&debrand=1"
  width="100%" height="560" style="border:0;border-radius:12px;"
  title="PropertyLens map embed" loading="lazy"></iframe>

Commercial

Dedicated endpoints for commercial property data including office, retail, industrial, warehouse, and medical assets. Inventory ingest is in progress — when empty, list endpoints returndataset_status.available=falsewith a clear coming-soon message instead of an empty local market.