Bank of Korea ECOS CLI
v0.1.0Command-line client for Bank of Korea ECOS API to list statistic tables and fetch time series data in JSON by code and frequency.
Bank of Korea ECOS CLI
Minimal command-line client for the Bank of Korea Economic Statistics System (ECOS) Open API.
- List available statistic tables
- Fetch time series by statistic code and frequency (A,S,Q,M,D)
- JSON output, suitable for piping to jq or saving to files
Installation
Clone and run in a virtualenv (or install once on your host/agent image):
python -m venv .venv && source .venv/bin/activate
pip install -e .
Usage
Environment variables:
- BOK_API_KEY (required) — your ECOS API key
- BOK_LANG (optional) —
kroren(default:kr)
Examples:
# Help
ecos-cli -h
# List statistic tables (first 1000)
ecos-cli table-list | jq '.[] | .[]? // .'
# Fetch a monthly time series for a statistic code between start/end dates
ecos-cli series 722Y001 M 202001 202412 | jq .
Notes:
- Date formats depend on the cycle:
YYYYfor A/S,YYYYQQfor Q (ECOS acceptsYYYYQ#in some cases),YYYYMMfor M,YYYYMMDDfor D. - Output structure is a direct passthrough of the ECOS JSON response.
API references
- ECOS API portal: https://ecos.bok.or.kr/api/
- StatisticTableList:
/StatisticTableList/{API_KEY}/json/{lang}/{start}/{end}/ - StatisticSearch:
/StatisticSearch/{API_KEY}/json/{lang}/{start}/{end}/{STAT_CODE}/{CYCLE}/{START}/{END}/
Version tags
latest
Runtime requirements
EnvBOK_API_KEY
Primary envBOK_API_KEY
