List suburbs
https://api.aussieoutagetracker.com.au/v1/suburbsNeeds 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.
Look up a suburb's id for the suburb filter, by name, postcode, state or network. Every suburb in a covered state is here, with the networks that serve it where known.
Query parameters
Name search, prefix match, case-insensitive: cranb finds Cranbourne.
Max length 80
Only these states.
Up to 20 values
Only this postcode.
Pattern ^\d{4}$
Only suburbs served by these networks.
Up to 20 values
Page size, 1–200.
Default 50Range 1 to 200
The next_cursor from the previous page.
Max length 200
Responses
200Success
dataarray of objectShowHide 6 fields of each item
idintegernamestringpostcodestringstateenumAustralian state or territory, lower case.
nswvicqldsawatasntacturlstringThe suburb's public page on aussieoutagetracker.com.au.
networksarray of stringNetwork ids serving this suburb, where known.
paginationobjectShowHide 3 fields
has_morebooleannext_cursorstringnullablePass as cursor for the next page. Null on the last page.
limitintegermetaobjectShowHide 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.
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.