e-Stat API

Access all Japanese government statistics through the e-Stat API v3.0.

Setup

Set the application ID as an environment variable:

export ESTAT_APP_ID="your_app_id_here"

Or pass --app-id to each command.

Quick Start

# Search for statistics tables
uv run scripts/estat.py search "人口" --limit 5 --summary

# Get metadata for a table (dimensions, codes)
uv run scripts/estat.py meta 0003411595 --summary

# Get statistical data by statsDataId
uv run scripts/estat.py data 0003411595 --cd-cat01 01000 --summary

# Get statistical data by registered dataSetId
uv run scripts/estat.py data --dataset-id MY_DATASET --summary

# Get data in CSV format
uv run scripts/estat.py data 0003411595 --format csv

Common Workflow

1. Search tables by keyword to find the statsDataId
2. Meta to understand dimensions (tab, cat01-15, area, time) and their codes
3. Data with filters to retrieve the specific data needed

Subcommands

Command	API Endpoint	Purpose
search	getStatsList	Search statistics tables by keyword
meta	getMetaInfo	Get table metadata (dimensions, codes)
data	getStatsData	Retrieve statistical data values
catalog	getDataCatalog	Browse data catalog
dataset-register	postDataset	Register/delete a dataset
dataset-ref	refDataset	Reference registered datasets
batch	getStatsDatas	Batch data retrieval

Key Options

• --summary Human-readable output (resolves codes to names)
• --format json|csv Output format (default: json)
• --all Auto-paginate to fetch all results
• --lang J|E Language (default: J for Japanese)
• --limit N Max rows (default: 100000)

Filtering Data

Filter data and dataset-register commands with:

# By category code
--cd-cat01 01000 --cd-cat02 A

# By category range
--cd-cat01-from 01000 --cd-cat01-to 05000

# By tab, time, area range
--cd-tab-from 001 --cd-tab-to 003
--cd-time-from 2023000101 --cd-time-to 2024001212
--cd-area-from 01000 --cd-area-to 13000

# By hierarchy level
--lv-cat01 1-2

# By area and time
--cd-area 13000 --cd-time 2024001001

API Reference

Detailed endpoint documentation in references/:

• overview.md - Base URL, auth, pagination, error codes
• getStatsList.md - Table search parameters
• getMetaInfo.md - Metadata structure (CLASS_INF)
• getStatsData.md - Data retrieval and filtering
• postDataset.md - Dataset registration
• refDataset.md - Dataset reference
• getDataCatalog.md - Catalog browsing
• getStatsDatas.md - Batch retrieval