Documentation / Pay breakdowns
The gender pay gap | Salary Data API
The gender pay gapHow much less women are paid than men, in per cent of men's pay, by period, for everyone or each occupation and age band.
GEThttps://api.salarydataapi.com/v1/pay/gender-gap
Try it
No key in this browser yet. Get a free key: it is filled in here once made.
Runs against the live API with your key.
curl "https://api.salarydataapi.com/v1/pay/gender-gap" \ -H "Authorization: Bearer YOUR_KEY"
Parameters
| Name | Type | What it is |
|---|---|---|
| country | country | required Two-letter country code |
| series | string | The figure wanted, as pay.<statistic>.<period>: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly.... Default pay.median.monthly. |
| by | string | Everyone, or by occupation or age band. Default all. alloccupationage |
| page | integer | The page, from 1. Default 1. |
| per_page | integer | Items a page, at most 200. Default 50. |
| cursor | string | From next_cursor in the last answer; page wins when both are sent |
Returns
A list in data, each item with these fields, and the paging in meta.
| Field | Type | What it holds |
|---|---|---|
| period | period | The period |
| female | number | Women |
| male | number | Men |
| gap_pct | number | Men's pay less women's, in per cent of men's |
| occupation | id | The occupation, when by occupation |
| age | string | The age band, when by age |
Example answer
Run it with your key for a real answer.