Account usage and credit allowance

GET/v1/usageFree

Current-month credit consumption plus daily and per-endpoint breakdowns over a trailing window: the dashboard's usage panel as JSON. Calls to this endpoint are free: they cost no credits, don't consume burst tokens, and don't appear in the usage numbers, so it's safe to poll from monitoring. It also keeps working once your credits are exhausted. Anyone holding the API key can call it, which makes it the easiest way to give teammates usage visibility without a dashboard login.

Parameters

Name	In	Required	Description
days	query	no	Trailing window in days for the daily/endpoint breakdowns (default 30, max 90).

Example request

curl "https://api.propradar.com.au/v1/usage?days=30" \
  -H "X-API-Key: pr_live_..."

Example response

{
  "plan": "pro",
  "quota": { "limit": 80000, "used": 12480, "remaining": 67520,
             "resets_at_unix": 1754006400, "unit": "credits" },
  "window_days": 30,
  "daily": [
    { "date": "2026-07-01", "request_count": 512,
      "served_count": 512, "rejected_count": 0 },
    { "date": "2026-07-02", "request_count": 488,
      "served_count": 486, "rejected_count": 2 }
  ],
  "endpoints": [
    { "endpoint": "/v1/properties/{id}", "request_count": 8210,
      "client_error_count": 14, "rate_limited_count": 0,
      "server_error_count": 0, "p50_ms": 62 }
  ],
  "timestamp": "2026-07-07T08:42:00.000Z"
}

Get an API key

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

Get a free API key Full API documentation

Other endpoints

Many suburbs in one call: statistics and recent sales POST /v1/suburbs/batch
List every suburb in the dataset (coverage index) GET /v1/suburbs
Authenticated health probe GET /v1/health
Resolve an address to a property_id GET /v1/properties/search
Look up a single property GET /v1/properties/{property_id}
Recent sold comparables (Hobby+; lat/lng mode Pro+) GET /v1/comparables
Suburb statistics GET /v1/suburbs/{state}/{suburb}
Trust-gated suburb rankings (Pro+ tier) GET /v1/suburbs/rankings
Multi-criteria suburb screener (Pro+ tier) GET /v1/suburbs/screen
Recent sold properties in a suburb GET /v1/suburbs/{state}/{suburb}/sold
Current active listings in a suburb GET /v1/suburbs/{state}/{suburb}/listings
Search current listings across a whole state (Pro+ tier) GET /v1/properties/listings
Property event history GET /v1/properties/{property_id}/history
Most recent sold record (Hobby+ tier) GET /v1/properties/{property_id}/sold_summary
Potential sell price confidence band GET /v1/properties/{property_id}/psp_with_confidence
Similar active listings GET /v1/properties/{property_id}/similar
Nearby active listings GET /v1/properties/{property_id}/nearby
Batch property lookup (Starter+ tier) POST /v1/properties/bulk
Value an off-market address: instant estimate or enhanced valuation (Hobby+ tier) POST /v1/valuations
Poll an off-market valuation job GET /v1/valuations/{id}
Valuation range for a locality, no address needed (Pro+ tier) POST /v1/valuations/estimate
12-month outlook for house/unit price and rent (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/forecast
Development applications near a point (Pro+ tier) GET /v1/developments/nearby
Properties currently advertised for rent in a suburb (Hobby+ tier) GET /v1/suburbs/{state}/{suburb}/rentals
Weekly rent estimate for a locality, no address needed (Pro+ tier) POST /v1/rent/estimate
Recently-modified event feed (Starter+ tier) GET /v1/properties/recently-modified
Investment score + cashflow (Pro+ tier) GET /v1/properties/{property_id}/investment_analysis
Market cycle classification (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/market_cycle
Annual price/rent/yield time-series (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/price_history
Market-heat time-series (Pro+ tier) GET /v1/suburbs/{state}/{suburb}/heat_history
List macro regions (Growth+ tier) GET /v1/regions
Region macro indicators (Growth+ tier) GET /v1/regions/{slug}
Suggest addresses as the user types GET /v1/addresses/suggest
Turn free text into suburbs GET /v1/suburbs/resolve