Documentation / Series

Find series | Salary Data API

Find series

Every pay series that matches what you ask for: a country, a statistic, a period of pay and any breakdown.

GEThttps://api.salarydataapi.com/v1/series?series=pay.mean

Try it

Runs against the live API with your key.
curl "https://api.salarydataapi.com/v1/series?series=pay.mean" \
  -H "Authorization: Bearer YOUR_KEY"

Parameters

NameTypeWhat it is
countrycountryrequired Two-letter country code
seriesstringpay.<statistic>.<period>, or part of it: pay.median, pay.mean.yearly
occupationidAn occupation id (oc_...) or its slug, such as software-developers
iscostringAn ISCO-08 occupation code (1 to 4 digits), where the country publishes by ISCO
sexstringSex. Default all.
allfemalemale
agestringAn age band as /v1/countries/{cc}/breakdowns lists it, such as 25-34
educationstringA level of schooling as /v1/countries/{cc}/breakdowns lists it
hoursstringFull-time, part-time or everyone. Default all.
allfull_timepart_time
tableidOnly one table (tb_...)
pageintegerThe page, from 1. Default 1.
per_pageintegerItems a page, at most 200. Default 50.
cursorstringFrom 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.

FieldTypeWhat it holds
ididThe series (se_...)
namestringpay.<statistic>.<period>[.net]
statisticstringmedian, mean, p10 to p90, minimum, starting, bonus or reported
perstringhour, day, week, month or year
netbooleanTrue for pay after tax
countrystringTwo-letter country code
currencystringISO 4217 currency
occupationidThe occupation (oc_...), or null
sexstringall, female or male
agestringAge band, or null
educationstringLevel of schooling, or null
hoursstringall, full_time or part_time
tableidThe table it belongs to (tb_...)
first_periodperiodIts first period
last_periodperiodIts latest period
areasintegerHow many areas it is published for

Example answer

Run it with your key for a real answer.

Errors