API reference

Disaster declarations

Which local government areas sit inside a declared disaster area, by postcode, point or AGRN. Base URL https://dataquoll.io/api/v1.

GET/declarations/postcode/{postcode}

Disaster declaration status for a postcode

Returns the declaration STATUS for a postcode: declared, partial, activation_only, not_declared, uncertain, or unknown_postcode, with per-LGA detail and official source links. Reports declared-area status only; the billing/eligibility decision rests with the practitioner. Built for Medicare disaster telehealth checks.

Parameters

Name	In	Required	Type	Description
`postcode`	path	Yes	`string`
`as_at`	query	No	`string`	Point-in-time check (YYYY-MM-DD). Defaults to today.
`include_expired`	query	No	`boolean`	Include expired records in the per-LGA lists. Never changes matchStatus.
`instrument_type`	query	No	`string`	Trim the returned record lists to one instrument type. Never changes matchStatus.
`suburb`	query	No	`string`	Optional suburb/locality name (ABS SAL) to narrow the result to the local government areas that suburb falls in, within this postcode only. Matching is exact after normalisation; there is no fuzzy matching. An unmatched suburb never fails the lookup: the full-postcode result is returned with narrowing.applied=false, a reason, and the postcode's known suburbs. Narrowing can legitimately change matchStatus (for example partial to declared); a suburb that itself spans two LGAs stays partial, and a bare name that denotes suburbs on both sides of a border (Mingoola in 4380) matches all of them.

Responses

Status	Description
`200`	Declaration status (including unknown_postcode for an absent postcode)
`400`	Malformed postcode or as_at
`401`	Missing or invalid API key
`403`	The declarations API is not on this account (it comes with the Organisation licence)
`429`	Rate limit exceeded

Request

curl "https://dataquoll.io/api/v1/declarations/postcode/4380?suburb=Stanthorpe" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/declarations/point

Disaster declaration status for an exact point

Returns the declaration STATUS for the local government area containing a lat/lng point, resolved against ABS LGA 2022 (ASGS Edition 3) boundary polygons at full resolution. POST with a JSON body is used deliberately so coordinates never appear in URLs or request logs; the request is read-only and safe to retry. Coordinates are never stored, logged, or echoed back, and the response is Cache-Control: no-store. Reports declared-area status only; the billing decision rests with the practitioner. A point outside every Australian LGA returns unknown_location. A point exactly on a shared LGA boundary returns every covering area with onBoundary=true. LGA matching is at ABS code level; some ABS codes aggregate multiple administrative areas (for example Unincorporated NSW covers both Far West and Lord Howe Island).

Responses

Status	Description
`200`	Declaration status for the covering LGA (including unknown_location when no LGA covers the point)
`400`	Invalid body, lat, lng, or as_at. Error detail never repeats submitted values.
`401`	Missing or invalid API key
`403`	The declarations API is not on this account (it comes with the Organisation licence)
`429`	Rate limit exceeded

Request

curl "https://dataquoll.io/api/v1/declarations/point" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/declarations

List/filter declarations

Browse and historically report on declaration records. Filters and keyset (cursor) pagination. Record status is derived at query time.

Parameters

Name	In	Required	Type	Description
`jurisdiction`	query	No	`string`
`status`	query	No	`string`
`instrument_type`	query	No	`string`
`disaster_type`	query	No	`string`
`active_on`	query	No	`string`
`limit`	query	No	`integer`
`cursor`	query	No	`string`	Opaque pagination cursor from links.next.

Responses

Status	Description
`200`	A page of declaration records
`400`	Invalid active_on date, status, limit, or cursor
`401`	Missing or invalid API key
`403`	The declarations API is not on this account (it comes with the Organisation licence)
`429`	Rate limit exceeded

Request

curl "https://dataquoll.io/api/v1/declarations" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/declarations/agrn/{agrn}

One disaster event by AGRN (across sources)

The declaration/activation for an Australian Government Reference Number, merged across sources with the full affected-LGA list.

Parameters

Name	In	Required	Type	Description
`agrn`	path	Yes	`string`

Responses

Status	Description
`200`	The merged declaration record
`400`	Malformed AGRN (must be numeric)
`401`	Missing or invalid API key
`403`	The declarations API is not on this account (it comes with the Organisation licence)
`404`	No declaration found for the AGRN
`429`	Rate limit exceeded

Request

curl "https://dataquoll.io/api/v1/declarations/agrn/1284" \
  -H "Authorization: Bearer YOUR_API_KEY"