API Documentation

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.

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 limit info is included in response headers:

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.

Errors return JSON with an error or detail field.

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