Skip to main content
GET
Japan FDI flows

Authorizations

X-API-Key
string
header
required

Your HayInsights API key (prefixed apk_). Create and manage keys in the HayInsights dashboard (Account → API keys).

Send it in the X-API-Key header on every request to /openapi/v1/*. Which data domains you may access and your request quota are both governed by the subscription plan attached to the key — see the Plans & features and Rate limits guides.

Query Parameters

country
enum<string>
required

Country. Only jp is available; Vietnam is under /macro/fdi/vn/*.

Available options:
jp
Example:

"jp"

quarters
integer
default:12

Number of most recent quarters (1–40).

Required range: 1 <= x <= 40
from
string

First quarter (inclusive), e.g. 2023-Q3.

Pattern: ^\d{4}-Q[1-4]$
Example:

"2023-Q3"

to
string

Last quarter (inclusive). Defaults to the latest quarter with data.

Pattern: ^\d{4}-Q[1-4]$
Example:

"2026-Q2"

asOf
string<date>

Backtest: return exactly what the system knew at the end of that day (UTC), not later revisions by the source. Omit for the latest data.

Example:

"2026-09-01"

Response

Quarterly FDI flows.

Standard success envelope shared by every endpoint. Each operation's response wrapper extends this (via allOf) and adds a typed data property.

success
boolean
required

Always true for a successful response.

Example:

true

statusCode
integer
required

Mirrors the HTTP status code.

Example:

200

data
object
required
meta
object

Response metadata. Always present; timestamp is the server time the response was generated.