DisplacementService

GetInternalDisplacement

IDPs by region from IOM DTM, latest survey round per operation.

get/api/displacement/v1/get-internal-displacement

Request

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

Query parameters

country_codestring

ISO 3166-1 alpha-3, such as SDN. Empty returns all.

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

False when the snapshot is unavailable; an empty list then is not zero displacement.

Changes

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