{ "openapi": "3.1.0", "info": { "title": "Salary Data API", "version": "1", "description": "Official pay figures from national statistics offices." }, "servers": [ { "url": "https://api.salarydataapi.com" } ], "paths": { "/": { "get": { "operationId": "index", "summary": "The API", "description": "The API's name, its base address and where its documentation and status are. Plan: Free key.", "tags": [ "Basics" ], "parameters": [], "security": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "The API" }, "base": { "type": "string", "description": "Base address" }, "documentation": { "type": "string", "description": "Documentation" }, "status": { "type": "string", "description": "Status page" }, "endpoints": { "type": "integer", "description": "Endpoints" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/usage": { "get": { "operationId": "usage", "summary": "Your usage", "description": "Your plan, the calls made today and this month, your limits and when they reset. Free to call: it never counts. Plan: Free key.", "tags": [ "Basics" ], "parameters": [], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "plan": { "type": "string", "description": "free, starter, pro or analyst" }, "allowance": { "type": "integer", "description": "Calls in the allowance" }, "per": { "type": "string", "description": "day or month" }, "used": { "type": "integer", "description": "Calls made in this day or month" }, "remaining": { "type": "integer", "description": "Calls left" }, "resets_at": { "type": "string", "format": "date", "description": "When the allowance starts again (UTC)" }, "per_second": { "type": "integer", "description": "Calls a second" }, "calls_today": { "type": "integer", "description": "Calls today" }, "calls_this_month": { "type": "integer", "description": "Calls this month" }, "periods": { "type": "string", "description": "How far back the figures reach on this plan" }, "features": { "type": "object", "description": "What the plan includes" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/status": { "get": { "operationId": "status", "summary": "Status", "description": "Whether the API is answering, and how current its figures are. Plan: Free key.", "tags": [ "Basics" ], "parameters": [], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "state": { "type": "string", "description": "ok or degraded" }, "countries": { "type": "integer", "description": "Countries" }, "tables": { "type": "integer", "description": "Tables" }, "figures": { "type": "integer", "description": "Figures" }, "last_release_at": { "type": "string", "format": "date", "description": "When the latest release reached the API" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/changelog": { "get": { "operationId": "changelog", "summary": "Changelog", "description": "Every change to the API, newest first. v1 only ever gains fields. Plan: Free key.", "tags": [ "Basics" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "The day" }, "change": { "type": "string", "description": "What changed" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/coverage": { "get": { "operationId": "coverage", "summary": "Coverage", "description": "For each country: its tables, series and figures, the years they reach and the breakdowns it publishes. Plan: Free key.", "tags": [ "Basics" ], "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Only one region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code, lower case" }, "name": { "type": "string", "description": "The country in English" }, "region": { "type": "string", "description": "Europe, Asia, Americas, Middle East, Africa or Oceania" }, "currency": { "type": "string", "description": "The currency its figures are in today (ISO 4217)" }, "tables": { "type": "integer", "description": "Tables" }, "series": { "type": "integer", "description": "Pay series" }, "figures": { "type": "integer", "description": "Figures" }, "first_year": { "type": "integer", "description": "First year" }, "last_period": { "type": "string", "description": "Latest period" }, "breakdowns": { "type": "array", "items": {}, "description": "occupation, sex, age, education, area, industry: the ones it publishes" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/glossary": { "get": { "operationId": "glossary", "summary": "Glossary", "description": "Every statistic, pay period and word the API uses, in plain words. Plan: Free key.", "tags": [ "Basics" ], "parameters": [], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "term": { "type": "string", "description": "The word" }, "kind": { "type": "string", "description": "statistic, per, field or value" }, "means": { "type": "string", "description": "What it means" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay": { "get": { "operationId": "pay", "summary": "Pay", "description": "The pay figure you ask for: a country, a statistic and period of pay, and any breakdown. The latest period unless you ask for others. Plan: Free key.", "tags": [ "Pay" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "occupation", "in": "query", "required": false, "description": "An occupation id (oc_...) or its slug, such as software-developers", "schema": { "type": "string" } }, { "name": "isco", "in": "query", "required": false, "description": "An ISCO-08 occupation code (1 to 4 digits), where the country publishes by ISCO", "schema": { "type": "string" } }, { "name": "sex", "in": "query", "required": false, "description": "Sex", "schema": { "type": "string", "enum": [ "all", "female", "male" ], "default": "all" } }, { "name": "age", "in": "query", "required": false, "description": "An age band as /v1/countries/{cc}/breakdowns lists it, such as 25-34", "schema": { "type": "string" } }, { "name": "education", "in": "query", "required": false, "description": "A level of schooling as /v1/countries/{cc}/breakdowns lists it", "schema": { "type": "string" } }, { "name": "hours", "in": "query", "required": false, "description": "Full-time, part-time or everyone", "schema": { "type": "string", "enum": [ "all", "full_time", "part_time" ], "default": "all" } }, { "name": "area", "in": "query", "required": false, "description": "An area (ar_...); the whole country when left out", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "One period; the latest when left out", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries": { "get": { "operationId": "countries", "summary": "Every country", "description": "Every country with figures, its region, its currency and how much it publishes. Plan: Free key.", "tags": [ "Countries" ], "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Only one region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } }, { "name": "sort", "in": "query", "required": false, "description": "The order", "schema": { "type": "string", "enum": [ "name", "figures", "latest" ], "default": "name" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code, lower case" }, "name": { "type": "string", "description": "The country in English" }, "region": { "type": "string", "description": "Europe, Asia, Americas, Middle East, Africa or Oceania" }, "currency": { "type": "string", "description": "The currency its figures are in today (ISO 4217)" }, "tables": { "type": "integer", "description": "Tables" }, "figures": { "type": "integer", "description": "Figures" }, "last_period": { "type": "string", "description": "Its latest period" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}": { "get": { "operationId": "country", "summary": "One country", "description": "A country: its region, currency, tables, the years its figures reach and the breakdowns it publishes. Plan: Free key.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code, lower case" }, "name": { "type": "string", "description": "The country in English" }, "region": { "type": "string", "description": "Europe, Asia, Americas, Middle East, Africa or Oceania" }, "currency": { "type": "string", "description": "The currency its figures are in today (ISO 4217)" }, "tables": { "type": "integer", "description": "Tables" }, "series": { "type": "integer", "description": "Pay series" }, "figures": { "type": "integer", "description": "Figures" }, "first_year": { "type": "integer", "description": "First year" }, "last_period": { "type": "string", "description": "Latest period" }, "breakdowns": { "type": "array", "items": {}, "description": "The breakdowns it publishes" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/headline": { "get": { "operationId": "country_headline", "summary": "Headline pay", "description": "A country's headline pay figure: everyone, every occupation, the median where it publishes one, else the mean. Plan: Free key.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/tables": { "get": { "operationId": "country_tables", "summary": "A country's tables", "description": "The pay tables a country publishes, each with its series, figures and the periods it covers. Plan: Starter.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The table (tb_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "title": { "type": "string", "description": "What it holds" }, "series": { "type": "integer", "description": "Pay series in it" }, "figures": { "type": "integer", "description": "Figures in it" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "updated_at": { "type": "string", "format": "date", "description": "When it last changed (UTC)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/occupations": { "get": { "operationId": "country_occupations", "summary": "A country's occupations", "description": "The occupations a country publishes pay for, with their latest headline figure. Plan: Starter.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "q", "in": "query", "required": false, "description": "Words in the occupation's name", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The occupation (oc_...)" }, "slug": { "type": "string", "description": "Its name for addresses" }, "name": { "type": "string", "description": "The occupation as published, in English where the office gives it" }, "classification": { "type": "string", "description": "The classification its code belongs to: ISCO-08, SOC, a national one" }, "code": { "type": "string", "description": "Its code in that classification" }, "countries": { "type": "integer", "description": "How many countries publish pay for it" }, "series": { "type": "integer", "description": "How many series carry it" }, "latest": { "type": "object", "description": "The latest figure: period, value, currency" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/breakdowns": { "get": { "operationId": "country_breakdowns", "summary": "A country's breakdowns", "description": "Every value a country publishes pay by: its sexes, age bands, levels of schooling, hours and statistics. Plan: Starter.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sex": { "type": "array", "items": {}, "description": "Sexes" }, "age": { "type": "array", "items": {}, "description": "Age bands" }, "education": { "type": "array", "items": {}, "description": "Levels of schooling" }, "hours": { "type": "array", "items": {}, "description": "Hours" }, "series": { "type": "array", "items": {}, "description": "The figures it publishes, as pay.." }, "occupations": { "type": "integer", "description": "Occupations" }, "areas": { "type": "integer", "description": "Areas" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/history": { "get": { "operationId": "country_history", "summary": "Headline history", "description": "A country's headline pay over every period it has, oldest first. Plan: Starter.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure in its own currency" }, "value_usd": { "type": "number", "description": "In US dollars at that period's rate (Pro and Analyst)" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/releases": { "get": { "operationId": "country_releases", "summary": "A country's releases", "description": "The releases from one country, newest first. Plan: Starter.", "tags": [ "Countries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The release (rl_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "table": { "type": "string", "description": "The table (tb_...)" }, "title": { "type": "string", "description": "What it holds" }, "period": { "type": "string", "description": "The latest period it brought" }, "published_at": { "type": "string", "format": "date", "description": "When it reached the API (UTC)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/regions": { "get": { "operationId": "regions", "summary": "Regions", "description": "The six regions and how many countries each has. Plan: Free key.", "tags": [ "Regions" ], "parameters": [], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "region": { "type": "string", "description": "Its name for addresses" }, "name": { "type": "string", "description": "The region" }, "countries": { "type": "integer", "description": "Countries" }, "figures": { "type": "integer", "description": "Figures" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/regions/{region}": { "get": { "operationId": "region", "summary": "One region", "description": "A region's countries, each with its headline pay figure. Plan: Starter.", "tags": [ "Regions" ], "parameters": [ { "name": "region", "in": "path", "required": true, "description": "The region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code, lower case" }, "name": { "type": "string", "description": "The country in English" }, "region": { "type": "string", "description": "Europe, Asia, Americas, Middle East, Africa or Oceania" }, "currency": { "type": "string", "description": "The currency its figures are in today (ISO 4217)" }, "headline": { "type": "object", "description": "The headline figure" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/regions/{region}/compare": { "get": { "operationId": "region_compare", "summary": "Compare a region", "description": "A region's countries side by side in US dollars, highest first, on one figure. Plan: Pro.", "tags": [ "Regions" ], "parameters": [ { "name": "region", "in": "path", "required": true, "description": "The region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" }, "rank": { "type": "integer", "description": "Its place" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series": { "get": { "operationId": "series_search", "summary": "Find series", "description": "Every pay series that matches what you ask for: a country, a statistic, a period of pay and any breakdown. Plan: Starter.", "tags": [ "Series" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "pay.., or part of it: pay.median, pay.mean.yearly", "schema": { "type": "string" } }, { "name": "occupation", "in": "query", "required": false, "description": "An occupation id (oc_...) or its slug, such as software-developers", "schema": { "type": "string" } }, { "name": "isco", "in": "query", "required": false, "description": "An ISCO-08 occupation code (1 to 4 digits), where the country publishes by ISCO", "schema": { "type": "string" } }, { "name": "sex", "in": "query", "required": false, "description": "Sex", "schema": { "type": "string", "enum": [ "all", "female", "male" ], "default": "all" } }, { "name": "age", "in": "query", "required": false, "description": "An age band as /v1/countries/{cc}/breakdowns lists it, such as 25-34", "schema": { "type": "string" } }, { "name": "education", "in": "query", "required": false, "description": "A level of schooling as /v1/countries/{cc}/breakdowns lists it", "schema": { "type": "string" } }, { "name": "hours", "in": "query", "required": false, "description": "Full-time, part-time or everyone", "schema": { "type": "string", "enum": [ "all", "full_time", "part_time" ], "default": "all" } }, { "name": "table", "in": "query", "required": false, "description": "Only one table (tb_...)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "pay..[.net]" }, "statistic": { "type": "string", "description": "median, mean, p10 to p90, minimum, starting, bonus or reported" }, "per": { "type": "string", "description": "hour, day, week, month or year" }, "net": { "type": "boolean", "description": "True for pay after tax" }, "country": { "type": "string", "description": "Two-letter country code" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "Age band, or null" }, "education": { "type": "string", "description": "Level of schooling, or null" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "table": { "type": "string", "description": "The table it belongs to (tb_...)" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "areas": { "type": "integer", "description": "How many areas it is published for" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}": { "get": { "operationId": "series_one", "summary": "One series", "description": "A series: what it measures, who it covers, its table and the periods it has. Plan: Free key.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "pay..[.net]" }, "statistic": { "type": "string", "description": "median, mean, p10 to p90, minimum, starting, bonus or reported" }, "per": { "type": "string", "description": "hour, day, week, month or year" }, "net": { "type": "boolean", "description": "True for pay after tax" }, "country": { "type": "string", "description": "Two-letter country code" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "Age band, or null" }, "education": { "type": "string", "description": "Level of schooling, or null" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "table": { "type": "string", "description": "The table it belongs to (tb_...)" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "areas": { "type": "integer", "description": "How many areas it is published for" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/observations": { "get": { "operationId": "series_observations", "summary": "A series over time", "description": "Every figure of a series, oldest first, for the whole country or one area. Plan: Starter.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } }, { "name": "area", "in": "query", "required": false, "description": "An area (ar_...); the whole country when left out", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure in its own currency" }, "value_usd": { "type": "number", "description": "In US dollars at that period's rate (Pro and Analyst)" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/latest": { "get": { "operationId": "series_latest", "summary": "A series' latest figure", "description": "The latest figure of a series for the whole country. Plan: Free key.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/change": { "get": { "operationId": "series_change", "summary": "Change over time", "description": "How a series moved: each period against the one a year before, in money and per cent. Plan: Starter.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure" }, "year_before": { "type": "number", "description": "The figure a year before" }, "change": { "type": "number", "description": "The difference" }, "change_pct": { "type": "number", "description": "The difference in per cent" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/real": { "get": { "operationId": "series_real", "summary": "In today's prices", "description": "A series in the prices of the latest period, from the country's own consumer price index, so the years compare. Plan: Starter.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure as published" }, "value_real": { "type": "number", "description": "In the prices of price_period" }, "price_period": { "type": "string", "description": "The prices it is given in" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/converted": { "get": { "operationId": "series_converted", "summary": "In another currency", "description": "A series in US dollars or euros at each period's rate, or at purchasing power parity. Plan: Pro.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "What to convert to", "schema": { "type": "string", "enum": [ "usd", "eur", "ppp" ], "default": "usd" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "As published" }, "converted": { "type": "number", "description": "Converted" }, "to": { "type": "string", "description": "usd, eur or ppp (international dollars)" }, "rate": { "type": "number", "description": "Units of the currency to one" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/series/{id}/areas": { "get": { "operationId": "series_areas", "summary": "A series by area", "description": "A series' latest figure in every area it is published for. Plan: Starter.", "tags": [ "Series" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (se_...)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "area": { "type": "string", "description": "The area (ar_...)" }, "name": { "type": "string", "description": "The area" }, "national": { "type": "boolean", "description": "The whole country" }, "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tables": { "get": { "operationId": "tables", "summary": "Every table", "description": "Every pay table, newest changes first. Plan: Starter.", "tags": [ "Tables" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Only one country", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The table (tb_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "title": { "type": "string", "description": "What it holds" }, "series": { "type": "integer", "description": "Pay series in it" }, "figures": { "type": "integer", "description": "Figures in it" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "updated_at": { "type": "string", "format": "date", "description": "When it last changed (UTC)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tables/{id}": { "get": { "operationId": "table", "summary": "One table", "description": "A table: what it holds, its periods and what it is broken down by. Plan: Starter.", "tags": [ "Tables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (tb_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The table (tb_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "title": { "type": "string", "description": "What it holds" }, "series": { "type": "integer", "description": "Pay series in it" }, "figures": { "type": "integer", "description": "Figures in it" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "updated_at": { "type": "string", "format": "date", "description": "When it last changed (UTC)" }, "breakdowns": { "type": "array", "items": {}, "description": "What it is broken down by" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tables/{id}/series": { "get": { "operationId": "table_series", "summary": "A table's series", "description": "The pay series in a table. Plan: Starter.", "tags": [ "Tables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (tb_...)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "pay..[.net]" }, "statistic": { "type": "string", "description": "median, mean, p10 to p90, minimum, starting, bonus or reported" }, "per": { "type": "string", "description": "hour, day, week, month or year" }, "net": { "type": "boolean", "description": "True for pay after tax" }, "country": { "type": "string", "description": "Two-letter country code" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "Age band, or null" }, "education": { "type": "string", "description": "Level of schooling, or null" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "table": { "type": "string", "description": "The table it belongs to (tb_...)" }, "first_period": { "type": "string", "description": "Its first period" }, "last_period": { "type": "string", "description": "Its latest period" }, "areas": { "type": "integer", "description": "How many areas it is published for" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/tables/{id}/observations": { "get": { "operationId": "table_observations", "summary": "A table's figures", "description": "Every figure in a table for one period, the latest when left out, each with its series. Plan: Starter.", "tags": [ "Tables" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (tb_...)", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "One period; the latest when left out", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations": { "get": { "operationId": "occupations", "summary": "Every occupation", "description": "Every occupation with pay, in every classification, the most widely published first. Plan: Free key.", "tags": [ "Occupations" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Only those one country publishes", "schema": { "type": "string" } }, { "name": "classification", "in": "query", "required": false, "description": "Only one classification, such as ISCO-08", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The occupation (oc_...)" }, "slug": { "type": "string", "description": "Its name for addresses" }, "name": { "type": "string", "description": "The occupation as published, in English where the office gives it" }, "classification": { "type": "string", "description": "The classification its code belongs to: ISCO-08, SOC, a national one" }, "code": { "type": "string", "description": "Its code in that classification" }, "countries": { "type": "integer", "description": "How many countries publish pay for it" }, "series": { "type": "integer", "description": "How many series carry it" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/search": { "get": { "operationId": "occupations_search", "summary": "Find an occupation", "description": "Occupations whose name or code matches what you type. Plan: Free key.", "tags": [ "Occupations" ], "parameters": [ { "name": "q", "in": "query", "required": true, "description": "Words or a code, such as nurse, software or 2221", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "Only those one country publishes", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The occupation (oc_...)" }, "slug": { "type": "string", "description": "Its name for addresses" }, "name": { "type": "string", "description": "The occupation as published, in English where the office gives it" }, "classification": { "type": "string", "description": "The classification its code belongs to: ISCO-08, SOC, a national one" }, "code": { "type": "string", "description": "Its code in that classification" }, "countries": { "type": "integer", "description": "How many countries publish pay for it" }, "series": { "type": "integer", "description": "How many series carry it" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}": { "get": { "operationId": "occupation", "summary": "One occupation", "description": "An occupation: its classification and code, and the countries that publish pay for it. Plan: Free key.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The occupation (oc_...)" }, "slug": { "type": "string", "description": "Its name for addresses" }, "name": { "type": "string", "description": "The occupation as published, in English where the office gives it" }, "classification": { "type": "string", "description": "The classification its code belongs to: ISCO-08, SOC, a national one" }, "code": { "type": "string", "description": "Its code in that classification" }, "countries": { "type": "integer", "description": "How many countries publish pay for it" }, "series": { "type": "integer", "description": "How many series carry it" }, "in": { "type": "array", "items": {}, "description": "The countries that publish it" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/pay": { "get": { "operationId": "occupation_pay", "summary": "One role across countries", "description": "An occupation's latest pay in every country that publishes it, in one call, with US dollars to compare. Plan: Analyst.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/countries": { "get": { "operationId": "occupation_countries", "summary": "Where it is published", "description": "The countries that publish an occupation, with the series and periods each has. Plan: Analyst.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "description": "Two-letter country code, lower case" }, "name": { "type": "string", "description": "The country in English" }, "region": { "type": "string", "description": "Europe, Asia, Americas, Middle East, Africa or Oceania" }, "currency": { "type": "string", "description": "The currency its figures are in today (ISO 4217)" }, "series": { "type": "integer", "description": "Series" }, "first_period": { "type": "string", "description": "First period" }, "last_period": { "type": "string", "description": "Latest period" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/history": { "get": { "operationId": "occupation_history", "summary": "An occupation over time", "description": "An occupation's pay in one country over every period it has. Plan: Starter.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure in its own currency" }, "value_usd": { "type": "number", "description": "In US dollars at that period's rate (Pro and Analyst)" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/distribution": { "get": { "operationId": "occupation_distribution", "summary": "The spread of pay", "description": "An occupation's pay from the 10th to the 90th percentile, where the country publishes them. Plan: Starter.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "per", "in": "query", "required": false, "description": "Pay per", "schema": { "type": "string", "enum": [ "hour", "week", "month", "year" ], "default": "year" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "currency": { "type": "string", "description": "Currency" }, "per": { "type": "string", "description": "Pay per" }, "p10": { "type": "number", "description": "10th percentile" }, "p25": { "type": "number", "description": "25th percentile" }, "median": { "type": "number", "description": "Median" }, "p75": { "type": "number", "description": "75th percentile" }, "p90": { "type": "number", "description": "90th percentile" }, "mean": { "type": "number", "description": "Mean" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/compare": { "get": { "operationId": "occupation_compare", "summary": "Compare a role", "description": "An occupation in the countries you name, side by side in US dollars. Plan: Analyst.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "required": true, "description": "Two to ten country codes, comma separated: gb,fi,jp", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/occupations/{id}/areas": { "get": { "operationId": "occupation_areas", "summary": "A role by area", "description": "An occupation's latest pay in each area of one country. Plan: Starter.", "tags": [ "Occupations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (oc_...)", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "area": { "type": "string", "description": "The area (ar_...)" }, "name": { "type": "string", "description": "The area" }, "period": { "type": "string", "description": "Period" }, "value": { "type": "number", "description": "The figure" }, "currency": { "type": "string", "description": "Currency" }, "name_of_figure": { "type": "string", "description": "pay.." } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay/headline": { "get": { "operationId": "pay_headline", "summary": "Every headline", "description": "Every country's headline pay figure in one call. Plan: Free key.", "tags": [ "Pay breakdowns" ], "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Only one region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay/by-sex": { "get": { "operationId": "pay_by_sex", "summary": "Pay by sex", "description": "Women's and men's pay in a country, side by side, for everyone or one occupation. Plan: Starter.", "tags": [ "Pay breakdowns" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "occupation", "in": "query", "required": false, "description": "An occupation (oc_...) or its slug", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "female": { "type": "number", "description": "Women" }, "male": { "type": "number", "description": "Men" }, "all": { "type": "number", "description": "Everyone" }, "currency": { "type": "string", "description": "Currency" }, "occupation": { "type": "string", "description": "The occupation, or null" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay/by-age": { "get": { "operationId": "pay_by_age", "summary": "Pay by age", "description": "Pay in each age band of a country, youngest first. Plan: Starter.", "tags": [ "Pay breakdowns" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "sex", "in": "query", "required": false, "description": "Sex", "schema": { "type": "string", "enum": [ "all", "female", "male" ], "default": "all" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "age": { "type": "string", "description": "The age band" }, "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure" }, "currency": { "type": "string", "description": "Currency" }, "series": { "type": "string", "description": "The series" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay/by-education": { "get": { "operationId": "pay_by_education", "summary": "Pay by schooling", "description": "Pay at each level of schooling in a country. Plan: Starter.", "tags": [ "Pay breakdowns" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "education": { "type": "string", "description": "The level" }, "period": { "type": "string", "description": "The period" }, "value": { "type": "number", "description": "The figure" }, "currency": { "type": "string", "description": "Currency" }, "series": { "type": "string", "description": "The series" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/pay/gender-gap": { "get": { "operationId": "pay_gender_gap", "summary": "The gender pay gap", "description": "How much less women are paid than men, in per cent of men's pay, by period, for everyone or each occupation and age band. Plan: Analyst.", "tags": [ "Pay breakdowns" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } }, { "name": "by", "in": "query", "required": false, "description": "Everyone, or by occupation or age band", "schema": { "type": "string", "enum": [ "all", "occupation", "age" ], "default": "all" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "female": { "type": "number", "description": "Women" }, "male": { "type": "number", "description": "Men" }, "gap_pct": { "type": "number", "description": "Men's pay less women's, in per cent of men's" }, "occupation": { "type": "string", "description": "The occupation, when by occupation" }, "age": { "type": "string", "description": "The age band, when by age" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/countries/{cc}/areas": { "get": { "operationId": "country_areas", "summary": "A country's areas", "description": "The areas a country publishes pay for: its regions, states, counties or cities. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The area (ar_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "name": { "type": "string", "description": "The area as published" }, "national": { "type": "boolean", "description": "True for the whole country" }, "series": { "type": "integer", "description": "Pay series published for it" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/areas/{id}": { "get": { "operationId": "area", "summary": "One area", "description": "An area: its country and how many pay series it has. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (ar_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The area (ar_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "name": { "type": "string", "description": "The area as published" }, "national": { "type": "boolean", "description": "True for the whole country" }, "series": { "type": "integer", "description": "Pay series published for it" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/areas/{id}/occupations": { "get": { "operationId": "area_occupations", "summary": "Occupations in an area", "description": "The latest pay of each occupation published for an area. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (ar_...)", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Words in the occupation's name", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "occupation": { "type": "string", "description": "The occupation" }, "name": { "type": "string", "description": "Its name" }, "period": { "type": "string", "description": "Period" }, "value": { "type": "number", "description": "The figure" }, "currency": { "type": "string", "description": "Currency" }, "name_of_figure": { "type": "string", "description": "pay.." } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/industries": { "get": { "operationId": "industries", "summary": "Industries", "description": "The industries pay is published by, where a country publishes pay by industry. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Only one country", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Words in the industry's name", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The industry (in_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "code": { "type": "string", "description": "Its code in the country's industry classification" }, "name": { "type": "string", "description": "The industry" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/industries/{id}": { "get": { "operationId": "industry", "summary": "One industry", "description": "An industry, with its pay for every occupation together. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (in_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The industry (in_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "code": { "type": "string", "description": "Its code in the country's industry classification" }, "name": { "type": "string", "description": "The industry" }, "employment": { "type": "integer", "description": "People employed" }, "mean": { "type": "number", "description": "Mean yearly pay" }, "median": { "type": "number", "description": "Median yearly pay" }, "period": { "type": "string", "description": "The period" }, "currency": { "type": "string", "description": "Currency" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/industries/{id}/occupations": { "get": { "operationId": "industry_occupations", "summary": "Occupations in an industry", "description": "Pay for each occupation in an industry, the best paid first. Plan: Starter.", "tags": [ "Areas and industries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (in_...)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "occupation": { "type": "string", "description": "The occupation" }, "name": { "type": "string", "description": "Its name" }, "employment": { "type": "integer", "description": "People employed" }, "period": { "type": "string", "description": "Period" }, "currency": { "type": "string", "description": "Currency" }, "p10": { "type": "number", "description": "10th percentile" }, "p25": { "type": "number", "description": "25th percentile" }, "median": { "type": "number", "description": "Median" }, "p75": { "type": "number", "description": "75th percentile" }, "p90": { "type": "number", "description": "90th percentile" }, "mean": { "type": "number", "description": "Mean" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/compare/countries": { "get": { "operationId": "compare_countries", "summary": "Compare countries", "description": "The countries you name side by side on one figure, in their own currency and in US dollars. Plan: Pro.", "tags": [ "Compare" ], "parameters": [ { "name": "countries", "in": "query", "required": true, "description": "Two to ten country codes, comma separated: gb,fi,jp", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/compare/occupations": { "get": { "operationId": "compare_occupations", "summary": "Compare occupations", "description": "The occupations you name side by side in one country. Plan: Starter.", "tags": [ "Compare" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "occupations", "in": "query", "required": true, "description": "Two to ten occupations (oc_...), comma separated", "schema": { "type": "string" } }, { "name": "series", "in": "query", "required": false, "description": "The figure wanted, as pay..: pay.median.monthly, pay.mean.yearly, pay.median.hourly, pay.p90.yearly...", "schema": { "type": "string", "default": "pay.median.monthly" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/compare/periods": { "get": { "operationId": "compare_periods", "summary": "Compare two periods", "description": "A series in two periods, with the change between them as published and in today's prices. Plan: Starter.", "tags": [ "Compare" ], "parameters": [ { "name": "series", "in": "query", "required": true, "description": "The series (se_...)", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "description": "The earlier period", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The later period; the latest when left out", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "from": { "type": "object", "description": "The earlier figure" }, "to": { "type": "object", "description": "The later figure" }, "change": { "type": "number", "description": "The difference" }, "change_pct": { "type": "number", "description": "In per cent" }, "real_change_pct": { "type": "number", "description": "In per cent, after prices" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/rank": { "get": { "operationId": "rank", "summary": "Rank countries", "description": "Every country ranked on its headline pay in US dollars, a year's pay, highest first. Plan: Pro.", "tags": [ "Compare" ], "parameters": [ { "name": "region", "in": "query", "required": false, "description": "Only one region", "schema": { "type": "string", "enum": [ "europe", "asia", "americas", "middle-east", "africa", "oceania" ] } }, { "name": "by", "in": "query", "required": false, "description": "In US dollars or at purchasing power", "schema": { "type": "string", "enum": [ "usd", "ppp" ], "default": "usd" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "series": { "type": "string", "description": "The series (se_...)" }, "name": { "type": "string", "description": "What the figure is, as pay.., for example pay.median.monthly" }, "country": { "type": "string", "description": "Two-letter country code" }, "period": { "type": "string", "description": "The period the figure covers: 2025, 2025-Q2 or 2025-06" }, "value": { "type": "number", "description": "The figure in its own currency, in whole units of money" }, "currency": { "type": "string", "description": "ISO 4217 currency" }, "value_usd": { "type": "number", "description": "The figure in US dollars at that period's rate (Pro and Analyst; null on other plans)" }, "occupation": { "type": "string", "description": "The occupation (oc_...), or null for all occupations" }, "sex": { "type": "string", "description": "all, female or male" }, "age": { "type": "string", "description": "The age band, or null for all ages" }, "education": { "type": "string", "description": "The level of schooling, or null for all levels" }, "hours": { "type": "string", "description": "all, full_time or part_time" }, "area": { "type": "string", "description": "The area, or null for the whole country" }, "rank": { "type": "integer", "description": "Its place" }, "yearly_usd": { "type": "number", "description": "A year's pay in US dollars (or international dollars with by=ppp)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/context/prices/{cc}": { "get": { "operationId": "context_prices", "summary": "Consumer prices", "description": "A country's consumer price index from its own statistics office, by period. Plan: Starter.", "tags": [ "Prices and money" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "index": { "type": "number", "description": "The index" }, "base": { "type": "string", "description": "Its base, such as 2015=100" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/context/exchange/{currency}": { "get": { "operationId": "context_exchange", "summary": "Exchange rates", "description": "A currency against the US dollar and the euro, by month, quarter and year: the average of each period's official daily rates. Plan: Starter.", "tags": [ "Prices and money" ], "parameters": [ { "name": "currency", "in": "path", "required": true, "description": "ISO 4217 currency, such as jpy", "schema": { "type": "string" } }, { "name": "freq", "in": "query", "required": false, "description": "By month, quarter or year", "schema": { "type": "string", "enum": [ "month", "quarter", "year" ], "default": "year" } }, { "name": "from", "in": "query", "required": false, "description": "The first period wanted (2019, 2019-Q1 or 2019-01)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The last period wanted", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "description": "The period" }, "per_usd": { "type": "number", "description": "Units to one US dollar" }, "per_eur": { "type": "number", "description": "Units to one euro" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/context/ppp/{cc}": { "get": { "operationId": "context_ppp", "summary": "Purchasing power", "description": "A country's purchasing power parity for private consumption: units of its currency to one international dollar, by year. Plan: Starter.", "tags": [ "Prices and money" ], "parameters": [ { "name": "cc", "in": "path", "required": true, "description": "Two-letter country code, such as jp or gb", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer", "description": "The year" }, "per_intl_dollar": { "type": "number", "description": "Units of its currency to one international dollar" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/currencies": { "get": { "operationId": "currencies", "summary": "Currencies", "description": "Every currency the figures are in, with the latest rate to the US dollar. Plan: Free key.", "tags": [ "Prices and money" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217" }, "per_usd": { "type": "number", "description": "Units to one US dollar" }, "period": { "type": "string", "description": "The rate's period" }, "countries": { "type": "array", "items": {}, "description": "Countries with figures in it" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/convert": { "get": { "operationId": "convert", "summary": "Convert money", "description": "An amount from one currency to another at a period's average rate. Plan: Pro.", "tags": [ "Prices and money" ], "parameters": [ { "name": "amount", "in": "query", "required": true, "description": "The amount", "schema": { "type": "number" } }, { "name": "from", "in": "query", "required": true, "description": "Its currency (ISO 4217)", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": true, "description": "The currency wanted", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "The period's rate; the latest when left out", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount" }, "from": { "type": "string", "description": "From" }, "to": { "type": "string", "description": "To" }, "converted": { "type": "number", "description": "The result" }, "rate": { "type": "number", "description": "Units of to for one of from" }, "period": { "type": "string", "description": "The rate used" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/adjust": { "get": { "operationId": "adjust", "summary": "Adjust for prices", "description": "An amount of a country's money in one year, in the prices of another year, from its consumer price index. Plan: Starter.", "tags": [ "Prices and money" ], "parameters": [ { "name": "country", "in": "query", "required": true, "description": "Two-letter country code", "schema": { "type": "string" } }, { "name": "amount", "in": "query", "required": true, "description": "The amount", "schema": { "type": "number" } }, { "name": "from", "in": "query", "required": true, "description": "The year (or month) of the amount", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": false, "description": "The prices wanted; the latest when left out", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount" }, "from": { "type": "string", "description": "Its period" }, "to": { "type": "string", "description": "The prices given" }, "adjusted": { "type": "number", "description": "The result" }, "factor": { "type": "number", "description": "Prices at to over prices at from" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/releases": { "get": { "operationId": "releases", "summary": "Releases", "description": "New and changed pay tables as they reach the API, newest first. Plan: Free key.", "tags": [ "Releases" ], "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Only one country", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "description": "Only since a day, YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The release (rl_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "table": { "type": "string", "description": "The table (tb_...)" }, "title": { "type": "string", "description": "What it holds" }, "period": { "type": "string", "description": "The latest period it brought" }, "published_at": { "type": "string", "format": "date", "description": "When it reached the API (UTC)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/releases/latest": { "get": { "operationId": "releases_latest", "summary": "The latest from each country", "description": "Each country's latest release. Plan: Free key.", "tags": [ "Releases" ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "The page, from 1", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "required": false, "description": "Items a page, at most 200", "schema": { "type": "integer", "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "From next_cursor in the last answer; page wins when both are sent", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The release (rl_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "table": { "type": "string", "description": "The table (tb_...)" }, "title": { "type": "string", "description": "What it holds" }, "period": { "type": "string", "description": "The latest period it brought" }, "published_at": { "type": "string", "format": "date", "description": "When it reached the API (UTC)" } } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/releases/{id}": { "get": { "operationId": "release", "summary": "One release", "description": "A release: its table, the periods it brought and its headline figures. Plan: Free key.", "tags": [ "Releases" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The id (rl_...)", "schema": { "type": "string" } } ], "security": [ { "bearer": [] }, { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The release (rl_...)" }, "country": { "type": "string", "description": "Two-letter country code" }, "table": { "type": "string", "description": "The table (tb_...)" }, "title": { "type": "string", "description": "What it holds" }, "period": { "type": "string", "description": "The latest period it brought" }, "published_at": { "type": "string", "format": "date", "description": "When it reached the API (UTC)" }, "first_period": { "type": "string", "description": "The table's first period" }, "series": { "type": "integer", "description": "Series" }, "figures": { "type": "integer", "description": "Figures" } } }, "meta": { "type": "object" } } } } } }, "default": { "description": "An error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" }, "apiKey": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "plan": { "type": "string" }, "docs": { "type": "string" } } } } } } } }