Skip to main content
GET
GetCapitalFlows

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

country
string

Optional ISO 3166-1 alpha-2 filter. When set, only that country is returned (and the counterpart, if given).

include_series
boolean

When true, include each returned country's period-by-period BOP series. Defaults to false.

counterpart
string

Optional ISO 3166-1 alpha-2 partner. With country, the response adds pair (both directions) and the counterpart's own view. Ignored without country, and when equal to country.

jmespath
string

Optional JMESPath expression applied server-side to project or reduce the JSON response before it is returned (mirrors the MCP jmespath argument). Invalid expressions, expressions larger than 1024 UTF-8 bytes, or projections that exceed the 256 KB output cap return HTTP 400 with a {_jmespath_error, original_keys} envelope. Grammar and worked examples: https://www.worldmonitor.app/docs/mcp-jmespath.

Response

Successful response

GetCapitalFlowsResponse is cross-country capital-flow data from IMF and BIS official statistics. Amounts are USD billions.

countries
object[]
latest
object

CapitalFlowLatest names the newest period of each source.

seededAt
integer<int64>

When the dataset was built, Unix epoch milliseconds. 0 when unavailable.. Warning: Values > 2^53 may lose precision in JavaScript

unavailable
boolean

True when the seeded dataset is unavailable. An empty country list is not zero flow.

sources
string[]

Source URLs.

method
object

Short method notes keyed by view: bop, episodes, bank, portfolio, fdi, pairs, caveat.

pair
object

CapitalFlowPair carries a country (a) and a counterpart (b) in both directions across bank, portfolio and direct-investment channels.