Your usageFree

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

Needs an API key. Never billed.

Calls made this month by every key on your account, and what they will cost. Free to call.

Query parameters

stringoptional

Calendar month, Sydney time. Defaults to the current month.

Responses

200Success
dataobject
ShowHide 9 fields
monthstring
callsinteger

Billable calls this month across every key on the account.

refusedinteger

Calls answered with a 4xx. Never billed.

included_callsinteger

Calls included in the API plan each month.

billable_callsinteger

Calls beyond the included ones this month, each charged at the overage price.

plan_audnumber

The API plan's monthly price, including GST, charged in advance on the 1st.

price_per_1000_calls_audnumber

The price of 1,000 calls beyond the included ones.

estimated_charge_audnumber

What this month's extra calls would cost at today's count, including GST. The plan is charged separately.

by_endpointarray of object
ShowHide 2 fields of each item
endpointstring
callsinteger
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.