Skip to main content
GET
GetDisplacementSummary

Authorizations

X-WorldMonitor-Key
string
header
required

User-issued WorldMonitor API key.

Query Parameters

year
integer<int32>

Data year to retrieve (e.g., 2023). Uses latest available if zero.

country_limit
integer<int32>

Maximum number of country entries to return.

flow_limit
integer<int32>

Maximum number of displacement flows to return.

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

GetDisplacementSummaryResponse contains the global displacement summary.

summary
object

DisplacementSummary represents a global overview of displacement data from UNHCR.

fetchedAt
integer<int64>

Time the seed or live fallback snapshot was fetched, as Unix epoch milliseconds. A value of 0 means the snapshot is unavailable/degraded, not that global displacement is zero.. Warning: Values > 2^53 may lose precision in JavaScript

dataAvailable
boolean

True when summary came from a seed snapshot or live fallback. False means an absent/empty summary is graceful degradation because the snapshot is unavailable.