Aussie Outage Tracker
Get a key

1.0.0

MajorStable

Aussie Outage Tracker 1.0

New7

The first version of the Aussie Outage Tracker API: every Australian electricity network's outages in one normalised shape, live and archived, behind an API key on one monthly plan. Everything below is covered by the /v1 promise: from here on it only grows.

New: Endpoints

  • GET /v1/outages searches the archive by place, time, type, status and cause, paged with a cursor.
  • GET /v1/outages/{id} returns one outage with its shape and the suburbs it is attributed to.
  • GET /v1/outages/{id}/history returns every change recorded for one outage, oldest first.
  • GET /v1/networks and GET /v1/networks/{id} describe each network: where it operates, its feed health, when recording began and how completely it fills each field.
  • GET /v1/suburbs looks up suburbs by name, postcode, state or network, for the suburb filter.
  • GET /v1/stats/outages totals outages, customers affected and median duration by network, state, cause, day or month.
  • GET /v1/usage reports your account's calls this month, how many the plan includes, how many are past it and what they will cost. Free to call.
  • GET /v1/status says whether the API is up, how fresh the data is, and whether each network's feed passes our checks. No key needed, never billed.
  • GET /v1/openapi.json publishes the contract as OpenAPI 3.1, with no key needed.

New: The outage object

One shape for every network, with the network's own words kept beside our normalisation: a lifecycle status with status_detail verbatim, a cause.category from one vocabulary with cause.description verbatim, customer counts, start, estimate and restoration times with restored_at_basis, and a location that says whether it is an area or an approximate point. Anything a network does not publish is null. Outages goes through it field by field.

New: Reading the archive

  • GET /v1/outages returns up to 500 outages a page (limit, default 100).
  • One query reads at most 31 days of outage start times: from and to at most 31 days apart; from alone reads the 31 days after it, to alone the 31 days before; neither, the last 31 days. active_at, live-only status (active, scheduled) and changed_since need no window; changed_since reaches back at most 31 days. A wider window is 400 naming the parameter.
  • No date is out of reach: step through the archive a month at a time. See Pagination.

New: The API plan

  • $49.00 AUD a month including GST, with 2,000 calls included, then $0.01 a call ($10.00 per 1,000). See Billing and usage.
  • The plan is started by the account owner in Settings › API. The first month is charged at once, pro-rated to the month's end; then $49 is charged on the 1st for the month ahead, with the previous month's extra calls, on the same card and charge as any advertising.
  • Keys work while the plan is active. Without it every call is answered 402 with no_plan, and plan_starting while the first payment is being confirmed (usually seconds).
  • Refusals and our own failures are never billed.
  • Cancel any time: the plan runs to the end of the month already paid, and starting again within that month costs nothing.

New: Keys and limits

  • Keys are issued in the dashboard under Settings › API, prefixed aot_live_ or aot_test_, and shown once.
  • A key is sent as Authorization: Bearer … or X-API-Key, never in a URL.
  • Each key may make 60 requests a minute, across every endpoint together. See Rate limits.
  • Errors share one envelope with a stable code. See Errors.

New: Bulk exports

  • For years of the archive at once, request a bulk export from Settings › API: which states, which dates, and what it is for. We reply with a quote and send the file.

New: Invoices, and customers outside Australia

  • Every paid charge is issued a tax invoice by MODLL PTY LTD, trading as Aussie Outage Tracker, emailed to the account owner with a PDF copy, and listed in Settings › Billing.
  • Cards are saved with a billing address inside the dashboard, and never leave it. If the address is outside Australia, the price is the same and contains no GST: the invoice is marked GST-free.
  • A refund appears on the charge's invoice as an adjustment.