get_series

Pack: econdata · Endpoint: https://gateway.pipeworx.io/econdata/mcp

One named US economic indicator series over time, by its Bureau of Labor Statistics series ID.

Tool description as the model sees it

Fetch any economic time series by ID (e.g., “CPUR0000SA0” for CPI, “LNS14000000” for unemployment). Returns historical data points with dates and values.

Parameters

NameTypeRequiredDescription
series_idstringyesBLS series ID (e.g. “CUUR0000SA0” for CPI)
start_yearstringnoStart year as 4-digit string (e.g. “2020”). Optional.
end_yearstringnoEnd year as 4-digit string (e.g. “2024”). Optional.
_apiKeystringnoOptional BLS registration key (free, raises the daily cap from ~25 to 500). The gateway supplies a platform key; pass your own only to override.

Example call

Arguments

{
  "series_id": "CUUR0000SA0"
}

curl

curl -X POST https://gateway.pipeworx.io/econdata/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_series","arguments":{"series_id":"CUUR0000SA0"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('get_series', {
  "series_id": "CUUR0000SA0"
});

More examples

{
  "series_id": "LNS14000000",
  "start_year": "2020",
  "end_year": "2024"
}

Response shape

Always returns: series_id, start_year, end_year, total, data

FieldTypeDescription
series_idstringBLS series ID requested
start_yearstring | nullStart year filter if provided, null otherwise
end_yearstring | nullEnd year filter if provided, null otherwise
totalintegerNumber of data points returned. Equal to returned — BLS returns every point in the requested year range.
returnedintegerHow many data points are in data. Always equal to total here; stated so a caller need not assume it.
observation_orderstringOrder of the data array. BLS returns each series newest-first.
dataarrayTime series data points
Full JSON Schema
{
  "type": "object",
  "properties": {
    "series_id": {
      "type": "string",
      "description": "BLS series ID requested"
    },
    "start_year": {
      "type": [
        "string",
        "null"
      ],
      "description": "Start year filter if provided, null otherwise"
    },
    "end_year": {
      "type": [
        "string",
        "null"
      ],
      "description": "End year filter if provided, null otherwise"
    },
    "total": {
      "type": "integer",
      "description": "Number of data points returned. Equal to `returned` — BLS returns every point in the requested year range."
    },
    "returned": {
      "type": "integer",
      "description": "How many data points are in `data`. Always equal to `total` here; stated so a caller need not assume it."
    },
    "observation_order": {
      "type": "string",
      "enum": [
        "newest_first"
      ],
      "description": "Order of the `data` array. BLS returns each series newest-first."
    },
    "data": {
      "type": "array",
      "description": "Time series data points",
      "items": {
        "type": "object",
        "properties": {
          "year": {
            "type": "string",
            "description": "Year of the data point"
          },
          "period": {
            "type": "string",
            "description": "Period code (e.g., M01 for January)"
          },
          "period_name": {
            "type": "string",
            "description": "Human-readable period name (e.g., January)"
          },
          "value": {
            "type": [
              "number",
              "null"
            ],
            "description": "Numeric value for the period"
          }
        },
        "required": [
          "year",
          "period",
          "period_name",
          "value"
        ]
      }
    }
  },
  "required": [
    "series_id",
    "start_year",
    "end_year",
    "total",
    "data"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "econdata": {
      "url": "https://gateway.pipeworx.io/econdata/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build September 15, 2026