bojapi-package: bojapi: Bank of Japan time-series data for R

In bojapi: Access the Bank of Japan Time-Series Data API

bojapi: Bank of Japan time-series data for R

Description

bojapi is an unofficial, independently developed client for the official Bank of Japan (BOJ) Time-Series Data Search API. It is not affiliated with, endorsed by, or maintained by the Bank of Japan. It provides a small workflow:

Details

1. List databases with boj_databases().

2. Discover series with boj_search() or boj_metadata().

3. Retrieve observations with boj_data() or boj_layer().

The BOJ API requires no API key. To respect the BOJ prohibition on high-frequency access, automatic multi-request operations wait at least one second between requests. Increase this per call with wait, or globally with options(bojapi.wait = 2); values below one are treated as one.

Package options

• bojapi.lang: default response language, "en" or "jp".

• bojapi.wait: requested seconds between automatic requests; default and enforced minimum 1.

• bojapi.timeout: request timeout in seconds; default 30.

• bojapi.retries: retries for transient failures; default 3.

• bojapi.cache_dir: metadata cache directory.

Terms of use

Public services using the API must follow the BOJ's current API notice, including its requested credit and release notification. Use boj_api_credit() to retrieve the credit and official links. The package's MIT license applies to original bojapi code and documentation; it does not relicense BOJ-originated or other third-party content.

Author(s)

Maintainer: Kenji Miyazaki [e-mail]

Authors:

• Kenji Miyazaki [e-mail]

See Also

BOJ API manual, BOJ API notice

bojapi documentation built on July 24, 2026, 5:07 p.m.