Retrieve an outage
https://api.aussieoutagetracker.com.au/v1/outages/{id}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.
One outage, with its shape and the suburbs it is attributed to.
Path parameters
The outage id.
Responses
200Success
dataobjectShowHide 22 fields
idintegerAussie Outage Tracker's id for this outage. Stable for its whole life.
networkobjectShowHide 3 fields
idstringStable network id, e.g. ausnet. Use it in network= filters.
namestringThe network's name, e.g. AusNet Services.
brandstringnullableSub-brand where one feed covers two, e.g. Powercor within CitiPower / Powercor. Otherwise null.
utilityenumelectricitywatergastelecommunicationsstateenumAustralian state or territory, lower case.
nswvicqldsawatasntacttypeenumplanned work or an unplanned fault.
plannedunplannedstatusenumLifecycle. active: supply is affected now. scheduled: planned work not yet started. restored: supply is back. cancelled: called off without happening — never summed with restored. unknown: the network gave no status signal at all (vanishingly rare).
scheduledactiverestoredcancelledunknownstatus_detailstringnullableThe network's own status words, verbatim, where it publishes any.
causeobjectShowHide 2 fields
categoryenumnullableNull where the network published no cause at all.
planned_workweathervegetationanimalvehiclethird_partyfireequipmentcustomersafetyupstreamunspecifiedotherdescriptionstringnullableThe network's own words, verbatim.
customers_affectedintegernullableBest figure for how many customers this outage affected: the highest count the network reported, or the sum across its localities, whichever is larger. Null where the network publishes no counts.
customers_off_nowintegernullableCustomers off supply at the latest observation, while active. Null once closed, or where not published.
starts_atstring (date-time)nullableWhen the outage began (or is scheduled to), as the network reported it. Null where the network publishes no start.
estimated_restoration_atstring (date-time)nullableThe network's latest estimate of restoration, or its scheduled finish for planned work. Null when it gave none.
restored_atstring (date-time)nullableWhen supply came back. Null until restored.
restored_at_basisenumnullablereported: the network published the restoration time. observed: it did not, and this is when the outage left the network's feed.
reportedobservedduration_minutesintegernullablestarts_at to restored_at, where both are known.
first_seen_atstring (date-time)When Aussie Outage Tracker first recorded this outage.
last_seen_atstring (date-time)The latest poll in which the network still published it.
updated_atstring (date-time)The last time this record changed. What changed_since compares against.
locationobjectShowHide 4 fields
kindenumnullablearea: the network published a footprint. point: a single location only. Null: no location published.
areapointapproximatebooleanTrue when the location is a point, which is approximate — never treat it as the edge of the outage.
centroidobjectnullableA point inside the outage area, or the published point.
ShowHide 2 fields
latnumberlngnumberlocalitiesarray of objectAffected localities as the network listed them. Empty where it lists none.
ShowHide 3 fields of each item
namestringLocality name, title-cased where the network writes capitals.
postcodestringnullableFour-digit postcode, or null where the network gives none.
customersintegernullableCustomers affected in this locality, where the network breaks it down.
geometryobjectnullableoptionalThe outage's shape. Present on GET /v1/outages/{id}, and on lists with include=geometry.
ShowHide 2 fields
typestringcoordinatesanyoptionalsourceobjectShowHide 1 fields
referencestringThe network's own reference for this outage, for quoting to the network.
suburbsarray of objectSuburbs this outage is attributed to — by the network's named localities where it gives them, by its shape where it does not.
ShowHide 5 fields of each item
idintegernamestringpostcodestringstateenumAustralian state or territory, lower case.
nswvicqldsawatasntacturlstringThe suburb's public page on aussieoutagetracker.com.au.
metaobjectShowHide 1 fields
data_as_ofstring (date-time)nullableWhen 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:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
401No API key, or one that is not valid.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe 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:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
404No such resource among published data.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
429Over 60 requests a minute on this key. Not billed.
Every error has the same envelope:
errorobjectShowHide 3 fields
codeenumunauthorizedpayment_requiredforbiddennot_foundinvalid_parameterrate_limitedinternal_errormessagestringparamstringoptionalThe query parameter at fault, for invalid_parameter.
Errors lists every error code and what to do about it.