`boj_series`

Pack: boj · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/boj_series for the schema, then POST the same URL with its arguments for the data.

Any Bank of Japan statistics time series by database id and series code: money stock and monetary base, TANKAN, corporate goods price index, flow of funds, loans and deposits, balance of payments. Returns name, unit, frequency, last update date, observations and a computed YoY percentage for monthly, quarterly and annual series. A period the BOJ has not published yet returns reason not_yet_published with the latest available value. Find codes with boj_series_list.

Parameters

Name	Type	Required	Description
`db`	string	yes	BOJ database id, e.g. ‘MD02’ (money stock), ‘MD01’ (monetary base).
`code`	string	yes	Series code, e.g. ‘MAM1NAM2M2MO’ (M2 average amounts outstanding).
`start`	string	no	First period: ‘2026-01’, ‘2026Q1’ or ‘2026’ depending on frequency.
`end`	string	no	Last period, same format.
`limit`	number	no	Max observations returned (default 24, max 240).

Example call

Arguments

{
  "db": "MD02",
  "code": "MAM1NAM2M2MO",
  "start": "2026-07"
}

curl

curl -X POST https://gateway.pipeworx.io/boj/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"boj_series","arguments":{"db":"MD02","code":"MAM1NAM2M2MO","start":"2026-07"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('boj_series', {
  "db": "MD02",
  "code": "MAM1NAM2M2MO",
  "start": "2026-07"
});

More examples

{
  "db": "BP01",
  "code": "BPBP6QCB",
  "start": "2026Q1"
}

Response shape

Field	Type	Description
`found`	boolean \| null	Whether data was found
`reason`	string \| null	not_yet_published, series_not_found, no_observations, no_observations_in_range, database_not_found, no_matching_series, database_too_large_to_list
`db`	string \| null	BOJ database id
`code`	string \| null	Series code
`name`	string \| null	Series name
`message`	string \| null	Explanation when found is false
`source`	string \| null	Publisher and dataset
`category`	string \| null	Series category
`unit`	string \| null	Unit as published
`frequency`	string \| null	monthly, quarterly or annual
`last_update`	string \| null	Date the BOJ last updated the series (YYYYMMDD)
`data_as_of`	string \| null	Newest period in the series
`series_range`	object	First and last period
`latest`	object	One observation
`observation_count`	number \| null	Observations returned
`observations`	array
`measure`	string \| null	Money stock measure label
`notes`	array
`requested`	string \| null	Requested period (not_yet_published)
`latest_available_period`	string \| null	Newest published period (not_yet_published)
`latest_available_value`	number \| null	Newest published value (not_yet_published)
`hint`	string \| null	Next step

Full JSON Schema

{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "found": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether data was found"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "not_yet_published, series_not_found, no_observations, no_observations_in_range, database_not_found, no_matching_series, database_too_large_to_list"
    },
    "db": {
      "type": [
        "string",
        "null"
      ],
      "description": "BOJ database id"
    },
    "code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Series code"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Series name"
    },
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Explanation when found is false"
    },
    "source": {
      "type": [
        "string",
        "null"
      ],
      "description": "Publisher and dataset"
    },
    "category": {
      "type": [
        "string",
        "null"
      ],
      "description": "Series category"
    },
    "unit": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unit as published"
    },
    "frequency": {
      "type": [
        "string",
        "null"
      ],
      "description": "monthly, quarterly or annual"
    },
    "last_update": {
      "type": [
        "string",
        "null"
      ],
      "description": "Date the BOJ last updated the series (YYYYMMDD)"
    },
    "data_as_of": {
      "type": [
        "string",
        "null"
      ],
      "description": "Newest period in the series"
    },
    "series_range": {
      "type": "object",
      "description": "First and last period",
      "properties": {
        "first": {
          "type": [
            "string",
            "null"
          ],
          "description": "First period"
        },
        "last": {
          "type": [
            "string",
            "null"
          ],
          "description": "Last period"
        }
      },
      "additionalProperties": true
    },
    "latest": {
      "type": "object",
      "description": "One observation",
      "properties": {
        "period": {
          "type": [
            "string",
            "null"
          ],
          "description": "Period, e.g. 2026-10, 2026-Q2 or 2026"
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "Value in the series unit"
        },
        "yoy_pct": {
          "type": [
            "number",
            "null"
          ],
          "description": "Percent change vs the same period a year earlier; null when the prior-year value is not in the series"
        }
      },
      "additionalProperties": true
    },
    "observation_count": {
      "type": [
        "number",
        "null"
      ],
      "description": "Observations returned"
    },
    "observations": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "One observation",
        "properties": {
          "period": {
            "type": [
              "string",
              "null"
            ],
            "description": "Period, e.g. 2026-10, 2026-Q2 or 2026"
          },
          "value": {
            "type": [
              "number",
              "null"
            ],
            "description": "Value in the series unit"
          },
          "yoy_pct": {
            "type": [
              "number",
              "null"
            ],
            "description": "Percent change vs the same period a year earlier; null when the prior-year value is not in the series"
          }
        },
        "additionalProperties": true
      }
    },
    "measure": {
      "type": [
        "string",
        "null"
      ],
      "description": "Money stock measure label"
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "requested": {
      "type": [
        "string",
        "null"
      ],
      "description": "Requested period (not_yet_published)"
    },
    "latest_available_period": {
      "type": [
        "string",
        "null"
      ],
      "description": "Newest published period (not_yet_published)"
    },
    "latest_available_value": {
      "type": [
        "number",
        "null"
      ],
      "description": "Newest published value (not_yet_published)"
    },
    "hint": {
      "type": [
        "string",
        "null"
      ],
      "description": "Next step"
    }
  }
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

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

Connect to just the boj pack

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

See Getting Started for client-specific install steps.

boj_series