List networks

GEThttps://api.aussieoutagetracker.com.au/v1/networks

Needs an API key on the API plan. Each call answered 2xx counts against the plan’s included calls, then is billed beyond them; refusals and our failures never are.

Every network the archive covers: where it operates, whether its feed is healthy right now, when recording began, and how completely it fills each field. Use it to read a gap correctly — a network that publishes no cause has publishes.cause near 0.

Query parameters

comma-separated list of valuesoptional

Only networks with territory in these states.

Up to 20 values

comma-separated list of valuesoptional

Only these utilities.

Up to 20 values

Responses

200Success
dataarray of object
ShowHide 8 fields of each item
idstring
namestring
utilityenum
electricitywatergastelecommunications
statesarray of enum

Every state the network has territory in.

nswvicqldsawatasntact
location_kindenum

What the network mostly publishes: footprints or points.

areapoint
feedobject
ShowHide 3 fields
statusenum

ok, degraded (reporting, but at least one poll in ten failed over the last three hours, so changes can arrive late), stale (no successful poll for three cadences), failing (three of the last five polls failed), unknown (never polled).

okdegradedstalefailingunknown
last_success_atstring (date-time)nullable

ISO 8601 instant, UTC.

poll_interval_secondsinteger
archiveobject
ShowHide 2 fields
sincestring (date-time)nullable

When recording began for this network. Nothing earlier exists — networks publish no history.

outages_recordedinteger
publishesobject

How completely the network fills each field, across everything recorded. A 0 is the network, not us.

ShowHide 6 fields
start_timenumber

Share of this network's outages carrying a start time, 0–1.

customersnumber

Share carrying a customer count.

restoration_estimatenumber

Share that ever carried a restoration estimate.

causenumber

Share carrying a cause.

areanumber

Share with a footprint rather than a point.

postcodenumber

Share naming at least one postcode.

metaobject
ShowHide 1 fields
data_as_ofstring (date-time)nullable

When the most recent successful poll of any network finished. A stale value means the feeds, not this response, are behind.

400A parameter is invalid or unknown — error.param names it.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

401No API key, or one that is not valid.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

402The key's account cannot be billed: no card, or billing past due.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

429Over 60 requests a minute on this key. Not billed.

Every error has the same envelope:

errorobject
ShowHide 3 fields
codeenum
unauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_error
messagestring
paramstringoptional

The query parameter at fault, for invalid_parameter.

Errors lists every error code and what to do about it.