ausdata.io

Home / Endpoints / Gender pay context

Gender pay context

WGEA headline pay gap with the industry baseline and rank.

snapshot WGEA

What it answers

How does a given gender pay gap compare to its industry and to the national picture? This returns the WGEA headline pay gap with the industry baseline and a rank for context, so a single figure becomes a comparison. It places one number against the benchmark it should be read with.

Call it

curl -H 'Authorization: Bearer ak_your_key' \
  https://api.ausdata.io/v1/gender-pay-context

Returns

Every response uses the same envelope, {data, meta, links}. The data field carries the answer (an object for a single snapshot, a list when there is one row per entity). The meta field carries the trust contract: the reference periods, retrieved_at, the per-source attribution you reproduce on publish, and the stale flag. The links field offers a csv alternative when one is available.

{
  "data": { ... },
  "meta": {
    "endpoint": "/v1/gender-pay-context",
    "query": { ... },
    "period": { "start": "...", "end": "..." },
    "row_count": 1,
    "retrieved_at": "<ISO-8601 UTC>",
    "sources": [
      { "name": "...", "url": "...", "attribution": "..." }
    ],
    "stale": false,
    "stale_reason": null,
    "server_version": "..."
  },
  "links": { "csv": null }
}

Draws from

This signal joins data from one source. Each source page lists the underlying datasets and canonical series.

Cross-source signals join multiple sources into one response. Reliability: a signal returns current data or a clear 503; it never serves an older vintage as the current answer.

Related signals

All endpoints