Retrieve a network
https://api.aussieoutagetracker.com.au/v1/networks/{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 network, as in the list.
Path parameters
The network id, e.g. ausnet.
Responses
200Success
dataobjectShowHide 8 fields
idstringnamestringutilityenumelectricitywatergastelecommunicationsstatesarray of enumEvery state the network has territory in.
nswvicqldsawatasntactlocation_kindenumWhat the network mostly publishes: footprints or points.
areapointfeedobjectShowHide 3 fields
statusenumok, 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).
okdegradedstalefailingunknownlast_success_atstring (date-time)nullableISO 8601 instant, UTC.
poll_interval_secondsintegerarchiveobjectShowHide 2 fields
sincestring (date-time)nullableWhen recording began for this network. Nothing earlier exists — networks publish no history.
outages_recordedintegerpublishesobjectHow completely the network fills each field, across everything recorded. A 0 is the network, not us.
ShowHide 6 fields
start_timenumberShare of this network's outages carrying a start time, 0–1.
customersnumberShare carrying a customer count.
restoration_estimatenumberShare that ever carried a restoration estimate.
causenumberShare carrying a cause.
areanumberShare with a footprint rather than a point.
postcodenumberShare naming at least one postcode.
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.