API reference

Events

Nearby incidents clustered into a single event with a boundary polygon and affected suburbs. Base URL https://dataquoll.io/api/v1.

GET/events

List clustered events (incident intelligence)

Returns spatially clustered emergency events as a GeoJSON FeatureCollection. Events group related incidents using PostGIS ST_ClusterDBSCAN spatial clustering. Each event has a boundary polygon, centroid, affected suburbs, contributing agencies, and auto-generated title and summary. Only active events are returned by default.

Parameters

Name	In	Required	Type	Description
`limit`	query	No	`integer`	Maximum events to return (default 50, max 200)
`state`	query	No	`string`	Comma-separated state codes to filter by (e.g. nsw,vic). Uses array overlap matching.
`eventType`	query	No	`string`	Comma-separated event types (e.g. bushfire,flood)
`severity`	query	No	`string`	Comma-separated max severity levels, matched against maxSeverity as published: the highest severity any member's agency states, Unknown where none states one.
`warningLevel`	query	No	`string`	Comma-separated max warning levels, matched against maxWarningLevel as published: the highest level any member's agency states, none where none states one. An event whose maximum cannot be confirmed matches nothing.

Responses

Status	Description
`200`	A GeoJSON FeatureCollection of clustered events
`401`	Missing or invalid API key. While pay per request is on, a request with no Authorization header gets 402 instead.
`402`	Pay per request: no key was sent, so the answer is a price. The WWW-Authenticate header carries an MPP Payment challenge; pay it and send the request again with Authorization: Payment. Also sent, with a fresh price, when a payment fails its checks or its price has expired. Only while pay per request is on; otherwise a request without a key gets 401.
`429`	Rate limit exceeded

Request

curl "https://dataquoll.io/api/v1/events?state=nsw%2Cvic&eventType=bushfire%2Cflood" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/events/{id}

Get a single event with optional linked incidents

Returns a single clustered event by ID. Use `include_incidents=true` to also retrieve all incidents that belong to this event cluster.

Parameters

Name	In	Required	Type	Description
`id`	path	Yes	`string`	Event UUID
`include_incidents`	query	No	`boolean`	Include linked incidents in the response

Responses

Status	Description
`200`	A single event as a GeoJSON Feature
`401`	Missing or invalid API key. While pay per request is on, a request with no Authorization header gets 402 instead.
`402`	Pay per request: no key was sent, so the answer is a price. The WWW-Authenticate header carries an MPP Payment challenge; pay it and send the request again with Authorization: Payment. Also sent, with a fresh price, when a payment fails its checks or its price has expired. Only while pay per request is on; otherwise a request without a key gets 401.
`404`	Event not found

Request

curl "https://dataquoll.io/api/v1/events/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY"