Developers ( 001 )

blipton API reference

A REST API for the on/off-market status and planning envelope of every NSW residential address. Base URL https://www.blipton.com/api. Every new account starts with A$2 of free credit — 100 calls, no card required.

Get an API key Pricing

Authentication

Pass your key as a bearer token. Generate and rotate keys in your dashboard. Keys are secret — never ship them in client-side code or public repositories.

Authorization: Bearer YOUR_KEY

Rate limits & metering

· 120 requests/minute per token (token bucket). Excess returns 429.
· Per-address lookups (gnaf_pid and address) are metered at A$0.02 each (incl. GST), deducted from prepaid credit. The suburb sweep and CSV exports are not metered.
· Exhausted credit returns 402 before the query runs. Metered responses include a billed object with the remaining balance.

Endpoints

Method	Path	Auth	Metered	Purpose
GET	/v1/status?gnaf_pid=	token	yes	Full record for one address by G-NAF id.
GET	/v1/status?address=&postcode=	token	yes	Fuzzy address match (pg_trgm), top 5.
GET	/v1/status?suburb=&postcode=	token	—	All on-market addresses in a suburb (≤500).
GET	/v1/exports/suburb?suburb=&postcode=	token · csv	—	One suburb’s daily CSV (gzip).
GET	/v1/exports/latest	token · csv	—	Newest full-NSW daily CSV (gzip).
GET	/v1/suburbs?q=	none	—	Suburb autocomplete (postcode + suburb).
GET	/status	none	—	Crawl health — 200 healthy, 503 stale/failed.
GET	/public/stats	none	—	Live headline stats (on-market count, heating).
GET	/config	none	—	Publishable key, currency, rate, plans.
GET	/healthz	none	—	Liveness — { "ok": true }.

Address status

Look up one address by its G-NAF id (metered), or fuzzy-match by address + postcode.

curl -H "Authorization: Bearer YOUR_KEY" \
  "https://www.blipton.com/api/v1/status?gnaf_pid=GANSW705423559"

{
  "results": [
    {
      "gnaf_pid": "GANSW705423559",
      "address_full": "187 Spit Road",
      "suburb": "Mosman",
      "postcode": "2088",
      "lat": -33.82891, "lon": 151.24106,
      "on_market": false,
      "on_market_date": null,
      "zone_code": "R3",
      "zone_class": "Medium Density Residential",
      "fsr": 0.7, "height_m": 8.5, "min_lot_m2": 700,
      "lga_name": "MOSMAN"
    }
  ],
  "billed": { "rate_aud": 0.02, "credit_remaining_aud": 1.98 }
}

Suburb sweep

# All on-market addresses in a suburb (unmetered)
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://www.blipton.com/api/v1/status?suburb=Mosman&postcode=2088"

CSV exports

Gzipped CSV with columns: address, suburb, postcode, on_market, on_market_date, zone_code, zone_class, fsr, height_m, min_lot_m2.

# Newest full-NSW CSV (gzip) — needs a CSV-enabled plan
curl -H "Authorization: Bearer YOUR_KEY" \
  "https://www.blipton.com/api/v1/exports/latest" -o nsw.csv.gz

Response fields

gnaf_pid	string	G-NAF persistent identifier (stable primary key).
address_full	string	Full street address.
suburb / postcode	string	Suburb (Title Case) and 4-digit postcode.
lat / lon	number	GDA2020 geocode (≈ WGS84).
on_market	boolean	true if currently advertised for sale.
on_market_date	string \| null	ISO date the current on-market episode began.
zone_code	string \| null	NSW land-zone code, e.g. R2, R3, E1.
zone_class	string \| null	Zone name, e.g. "Medium Density Residential".
fsr	number \| null	Floor-space ratio (n:1) where mapped.
height_m	number \| null	Maximum building height, metres, where mapped.
min_lot_m2	number \| null	Minimum lot size, m², where mapped.
lga_name	string \| null	Local government area.

Planning fields are null where a control is not mapped; null means not-yet-enriched, not unzoned. They are indicative and not a section 10.7 planning certificate.

Errors

401	invalid or missing token — check the Authorization header.
402	API credit exhausted — top up in the dashboard.
403	plan has no CSV access, or suburb outside your plan scope.
429	rate limited — 120 requests/minute per token.

Errors return JSON { "error": "…" } with the status above.

Address data incorporates G-NAF © Geoscape Australia (Open G-NAF EULA). Planning attributes © State of New South Wales (Department of Planning, Housing and Infrastructure), CC BY 4.0. If you redistribute planning fields, retain that attribution. Full terms at /terms.