U.S. Bureau of Labor Statistics · Schema

MultipleSeriesRequest

Request body for fetching multiple time series.

Federal GovernmentLaborStatisticsEmploymentEconomic Data

Properties

Name Type Description
seriesid array Array of BLS series IDs to retrieve. Version 2 supports up to 50 series; Version 1 supports up to 25 series.
startyear string First year of data to retrieve in YYYY format.
endyear string Last year of data to retrieve in YYYY format.
registrationkey string BLS API Version 2 registration key.
catalog boolean Include series catalog metadata in the response.
calculations boolean Include net change and percent change calculations.
annualaverage boolean Include annual average values.
aspects boolean Include aspects metadata.
View JSON Schema on GitHub

JSON Schema

bls-multiple-series-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/u-s-bureau-of-labor-statistics/refs/heads/main/json-schema/bls-multiple-series-request-schema.json",
  "title": "MultipleSeriesRequest",
  "description": "Request body for fetching multiple time series.",
  "type": "object",
  "properties": {
    "seriesid": {
      "type": "array",
      "description": "Array of BLS series IDs to retrieve. Version 2 supports up to 50 series; Version 1 supports up to 25 series.",
      "items": {
        "type": "string"
      },
      "example": [
        "LNS14000000",
        "CUUR0000SA0"
      ]
    },
    "startyear": {
      "type": "string",
      "description": "First year of data to retrieve in YYYY format.",
      "example": "2020"
    },
    "endyear": {
      "type": "string",
      "description": "Last year of data to retrieve in YYYY format.",
      "example": "2025"
    },
    "registrationkey": {
      "type": "string",
      "description": "BLS API Version 2 registration key.",
      "example": "abc123def456"
    },
    "catalog": {
      "type": "boolean",
      "description": "Include series catalog metadata in the response.",
      "example": false
    },
    "calculations": {
      "type": "boolean",
      "description": "Include net change and percent change calculations.",
      "example": true
    },
    "annualaverage": {
      "type": "boolean",
      "description": "Include annual average values.",
      "example": false
    },
    "aspects": {
      "type": "boolean",
      "description": "Include aspects metadata.",
      "example": false
    }
  },
  "required": [
    "seriesid"
  ]
}