DisplacementService

GetDisplacementSummary

Global refugee and IDP statistics from UNHCR. Empty/absent summary with fetched_at=0 or data_available=false means the snapshot is unavailable/degraded, not that global displacement is zero.

get/api/displacement/v1/get-displacement-summary

Request

  • Base URL: https://api.worldmonitor.app
  • URL: https://api.worldmonitor.app/api/displacement/v1/get-displacement-summary
  • Auth: one of:
    • API key in header X-WorldMonitor-Key
    • API key in header X-Api-Key

Query parameters

0
OR
integer

Data year: 1951 through the current year. Zero returns the latest seeded data. An explicit year is available only if it matches the published snapshot.

country_limitinteger

Maximum number of country entries to return.

flow_limitinteger

Maximum number of displacement flows to return.

jmespathstring

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

OK

fetchedAtinteger

Warning: Values > 2^53 may lose precision in JavaScript

dataAvailableboolean

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

Changes

No recorded changes to this operation across all 1 revision of this API.