boj-api 0.1.0__tar.gz

boj_api-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

boj_api-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,54 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: |
+          ruff check src/ tests/
+
+      - name: Format check with ruff
+        run: |
+          ruff format --check src/ tests/
+
+      - name: Type check with mypy
+        run: |
+          mypy src/
+
+      - name: Run tests with pytest
+        run: |
+          pytest --cov=boj_api --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage
+        if: matrix.python-version == '3.12'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml

boj_api-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+src/*.egg-info/
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE / editor
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Type checker
+.mypy_cache/
+.pytype/
+
+# Testing
+.pytest_cache/
+htmlcov/
+.coverage
+.coverage.*
+coverage.xml
+
+# Ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Jupyter
+.ipynb_checkpoints/

boj_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kenta Aratani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

boj_api-0.1.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: boj-api
+Version: 0.1.0
+Summary: A production-ready Python client for the Bank of Japan (BOJ) Time-Series Statistics Search Site API.
+Author: Kenta Aratani
+License: MIT
+Project-URL: Homepage, https://github.com/YenAle-FT-Gmail/BOJ_API_Python
+Project-URL: Repository, https://github.com/YenAle-FT-Gmail/BOJ_API_Python
+Project-URL: Issues, https://github.com/YenAle-FT-Gmail/BOJ_API_Python/issues
+Keywords: boj,bank-of-japan,statistics,api,time-series,economics,finance
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.4.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: types-requests>=2.28.0; extra == "dev"
+Dynamic: license-file
+
+# boj-api
+
+A production-ready Python client for the **Bank of Japan (BOJ) Time-Series Statistics Search Site API**.
+
+This library provides a clean, typed, and well-documented interface to all three BOJ statistical data APIs:
+
+| API | Method | Description |
+|-----|--------|-------------|
+| Code API | `get_data_by_code()` | Fetch time-series data by series codes |
+| Layer API | `get_data_by_layer()` | Fetch time-series data by hierarchy/layer |
+| Metadata API | `get_metadata()` | Fetch database metadata (series names, units, layers, etc.) |
+
+> **Credit:** This library uses the Bank of Japan Time-Series Statistics Search Site API.
+> The content is not guaranteed by the Bank of Japan.
+>
+> 「このサービスは、日本銀行時系列統計データ検索サイトのAPI機能を使用しています。
+> サービスの内容は日本銀行によって保証されたものではありません。」
+
+## Installation
+
+```bash
+pip install boj-api
+```
+
+## Quick Start
+
+```python
+from boj_api import BOJClient, Database, Frequency
+
+client = BOJClient()
+
+# Fetch exchange rate data (Code API)
+response = client.get_data_by_code(
+    db=Database.FM08,
+    code=["FXERD09", "FXERD02"],
+    start_date="202401",
+    end_date="202412",
+)
+
+for series in response.series:
+    print(f"{series.name_jp}: {len(series.observations)} observations")
+
+# Fetch data by layer hierarchy (Layer API)
+response = client.get_data_by_layer(
+    db=Database.BP01,
+    frequency=Frequency.MONTHLY,
+    layer=[1, 1, 1],
+    start_date="202504",
+    end_date="202509",
+)
+
+# Fetch metadata for a database (Metadata API)
+metadata = client.get_metadata(db=Database.FM08)
+for entry in metadata.entries:
+    print(f"{entry.series_code}: {entry.name_jp}")
+```
+
+## Auto-Pagination
+
+The BOJ API limits results to 250 series / 60,000 data points per request.
+`BOJClient` handles pagination automatically:
+
+```python
+# Automatically follows NEXTPOSITION until all data is fetched
+all_data = client.get_data_by_code(
+    db=Database.CO,
+    code=series_codes,  # can exceed 250
+    auto_paginate=True,
+)
+```
+
+## Databases
+
+All BOJ database identifiers are available as the `Database` enum:
+
+| Enum | DB Name | Description |
+|------|---------|-------------|
+| `Database.IR01` | IR01 | Base discount/loan rates |
+| `Database.FM01` | FM01 | Uncollateralized overnight call rate |
+| `Database.FM08` | FM08 | Foreign exchange rates |
+| `Database.CO` | CO | Tankan survey |
+| `Database.FF` | FF | Flow of funds |
+| ... | ... | See `boj_api.enums.Database` for full list |
+
+## Frequency Types
+
+| Enum | Code | Description |
+|------|------|-------------|
+| `Frequency.CALENDAR_YEAR` | CY | Calendar year |
+| `Frequency.FISCAL_YEAR` | FY | Fiscal year |
+| `Frequency.SEMI_ANNUAL_CY` | CH | Semi-annual (calendar) |
+| `Frequency.SEMI_ANNUAL_FY` | FH | Semi-annual (fiscal) |
+| `Frequency.QUARTERLY` | Q | Quarterly |
+| `Frequency.MONTHLY` | M | Monthly |
+| `Frequency.WEEKLY` | W | Weekly |
+| `Frequency.DAILY` | D | Daily |
+
+## API Reference
+
+### `BOJClient`
+
+```python
+BOJClient(
+    lang: Language = Language.JP,
+    format: Format = Format.JSON,
+    timeout: float = 30.0,
+    max_retries: int = 3,
+    retry_delay: float = 1.0,
+)
+```
+
+### Error Handling
+
+```python
+from boj_api import BOJClient, BOJAPIError, InvalidParameterError
+
+client = BOJClient()
+try:
+    data = client.get_data_by_code(db="INVALID", code=["X"])
+except InvalidParameterError as e:
+    print(f"Bad request: {e.message_id} - {e.message}")
+except BOJAPIError as e:
+    print(f"API error: {e}")
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/YenAle-FT-Gmail/BOJ_API_Python.git
+cd BOJ_API_Python
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint & format
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Links
+
+- [BOJ API Announcement (2026-02-18)](https://www.boj.or.jp/statistics/outline/notice_2026/not260218a.htm)
+- [API Manual (PDF)](https://www.stat-search.boj.or.jp/info/api_manual.pdf)
+- [API Usage Notice (PDF)](https://www.stat-search.boj.or.jp/info/api_notice.pdf)
+- [BOJ Time-Series Statistics Search Site](https://www.stat-search.boj.or.jp/index.html)

boj_api-0.1.0/README.md

@@ -0,0 +1,156 @@
+# boj-api
+
+A production-ready Python client for the **Bank of Japan (BOJ) Time-Series Statistics Search Site API**.
+
+This library provides a clean, typed, and well-documented interface to all three BOJ statistical data APIs:
+
+| API | Method | Description |
+|-----|--------|-------------|
+| Code API | `get_data_by_code()` | Fetch time-series data by series codes |
+| Layer API | `get_data_by_layer()` | Fetch time-series data by hierarchy/layer |
+| Metadata API | `get_metadata()` | Fetch database metadata (series names, units, layers, etc.) |
+
+> **Credit:** This library uses the Bank of Japan Time-Series Statistics Search Site API.
+> The content is not guaranteed by the Bank of Japan.
+>
+> 「このサービスは、日本銀行時系列統計データ検索サイトのAPI機能を使用しています。
+> サービスの内容は日本銀行によって保証されたものではありません。」
+
+## Installation
+
+```bash
+pip install boj-api
+```
+
+## Quick Start
+
+```python
+from boj_api import BOJClient, Database, Frequency
+
+client = BOJClient()
+
+# Fetch exchange rate data (Code API)
+response = client.get_data_by_code(
+    db=Database.FM08,
+    code=["FXERD09", "FXERD02"],
+    start_date="202401",
+    end_date="202412",
+)
+
+for series in response.series:
+    print(f"{series.name_jp}: {len(series.observations)} observations")
+
+# Fetch data by layer hierarchy (Layer API)
+response = client.get_data_by_layer(
+    db=Database.BP01,
+    frequency=Frequency.MONTHLY,
+    layer=[1, 1, 1],
+    start_date="202504",
+    end_date="202509",
+)
+
+# Fetch metadata for a database (Metadata API)
+metadata = client.get_metadata(db=Database.FM08)
+for entry in metadata.entries:
+    print(f"{entry.series_code}: {entry.name_jp}")
+```
+
+## Auto-Pagination
+
+The BOJ API limits results to 250 series / 60,000 data points per request.
+`BOJClient` handles pagination automatically:
+
+```python
+# Automatically follows NEXTPOSITION until all data is fetched
+all_data = client.get_data_by_code(
+    db=Database.CO,
+    code=series_codes,  # can exceed 250
+    auto_paginate=True,
+)
+```
+
+## Databases
+
+All BOJ database identifiers are available as the `Database` enum:
+
+| Enum | DB Name | Description |
+|------|---------|-------------|
+| `Database.IR01` | IR01 | Base discount/loan rates |
+| `Database.FM01` | FM01 | Uncollateralized overnight call rate |
+| `Database.FM08` | FM08 | Foreign exchange rates |
+| `Database.CO` | CO | Tankan survey |
+| `Database.FF` | FF | Flow of funds |
+| ... | ... | See `boj_api.enums.Database` for full list |
+
+## Frequency Types
+
+| Enum | Code | Description |
+|------|------|-------------|
+| `Frequency.CALENDAR_YEAR` | CY | Calendar year |
+| `Frequency.FISCAL_YEAR` | FY | Fiscal year |
+| `Frequency.SEMI_ANNUAL_CY` | CH | Semi-annual (calendar) |
+| `Frequency.SEMI_ANNUAL_FY` | FH | Semi-annual (fiscal) |
+| `Frequency.QUARTERLY` | Q | Quarterly |
+| `Frequency.MONTHLY` | M | Monthly |
+| `Frequency.WEEKLY` | W | Weekly |
+| `Frequency.DAILY` | D | Daily |
+
+## API Reference
+
+### `BOJClient`
+
+```python
+BOJClient(
+    lang: Language = Language.JP,
+    format: Format = Format.JSON,
+    timeout: float = 30.0,
+    max_retries: int = 3,
+    retry_delay: float = 1.0,
+)
+```
+
+### Error Handling
+
+```python
+from boj_api import BOJClient, BOJAPIError, InvalidParameterError
+
+client = BOJClient()
+try:
+    data = client.get_data_by_code(db="INVALID", code=["X"])
+except InvalidParameterError as e:
+    print(f"Bad request: {e.message_id} - {e.message}")
+except BOJAPIError as e:
+    print(f"API error: {e}")
+```
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/YenAle-FT-Gmail/BOJ_API_Python.git
+cd BOJ_API_Python
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint & format
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type check
+mypy src/
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+## Links
+
+- [BOJ API Announcement (2026-02-18)](https://www.boj.or.jp/statistics/outline/notice_2026/not260218a.htm)
+- [API Manual (PDF)](https://www.stat-search.boj.or.jp/info/api_manual.pdf)
+- [API Usage Notice (PDF)](https://www.stat-search.boj.or.jp/info/api_notice.pdf)
+- [BOJ Time-Series Statistics Search Site](https://www.stat-search.boj.or.jp/index.html)

boj_api-0.1.0/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["setuptools>=68.0", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "boj-api"
+version = "0.1.0"
+description = "A production-ready Python client for the Bank of Japan (BOJ) Time-Series Statistics Search Site API."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+authors = [{ name = "Kenta Aratani" }]
+keywords = [
+    "boj",
+    "bank-of-japan",
+    "statistics",
+    "api",
+    "time-series",
+    "economics",
+    "finance",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Typing :: Typed",
+]
+dependencies = ["requests>=2.28.0"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.4.0",
+    "mypy>=1.0",
+    "build>=1.0",
+    "types-requests>=2.28.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/YenAle-FT-Gmail/BOJ_API_Python"
+Repository = "https://github.com/YenAle-FT-Gmail/BOJ_API_Python"
+Issues = "https://github.com/YenAle-FT-Gmail/BOJ_API_Python/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+target-version = "py38"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "SIM", # flake8-simplify
+    "TCH", # flake8-type-checking
+    "RUF", # ruff-specific rules
+]
+ignore = [
+    "UP007", # Use X | Y for union types (not available in 3.8/3.9)
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Japanese text legitimately uses fullwidth characters
+"src/boj_api/constants.py" = ["RUF001"]
+"tests/conftest.py" = ["RUF001"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["boj_api"]
+
+[tool.mypy]
+python_version = "3.8"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = [
+    "--strict-markers",
+    "--tb=short",
+    "-v",
+    "--cov=boj_api",
+    "--cov-report=term-missing",
+]