> ## Documentation Index > Fetch the complete documentation index at: https://www.worldmonitor.app/docs/llms.txt > Use this file to discover all available pages before exploring further. # GetDisplacementSummary > GetDisplacementSummary retrieves 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. ## OpenAPI ````yaml /api/DisplacementService.openapi.yaml get /api/displacement/v1/get-displacement-summary openapi: 3.1.0 info: title: DisplacementService API version: 1.0.0 servers: - url: https://api.worldmonitor.app security: - WorldMonitorKey: [] - ApiKeyHeader: [] paths: /api/displacement/v1/get-displacement-summary: get: tags: - DisplacementService summary: GetDisplacementSummary description: >- GetDisplacementSummary retrieves 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. operationId: GetDisplacementSummary parameters: - name: year in: query description: Data year to retrieve (e.g., 2023). Uses latest available if zero. required: false example: 1 schema: type: integer format: int32 - name: country_limit in: query description: Maximum number of country entries to return. required: false example: 25 schema: type: integer format: int32 - name: flow_limit in: query description: Maximum number of displacement flows to return. required: false example: 25 schema: type: integer format: int32 - name: jmespath in: query description: >- 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. required: false example: keys(@) schema: type: string responses: '200': description: Successful response content: application/json: example: dataAvailable: true fetchedAt: 1717200000000 summary: countries: - asylumSeekers: 1 code: US hostAsylumSeekers: 1 hostRefugees: 1 hostTotal: 1 idps: 1 globalTotals: asylumSeekers: 1 idps: 1 refugees: 1 stateless: 1 total: 1 topFlows: - asylumCode: US asylumLocation: latitude: 40.7128 longitude: -74.006 asylumName: WorldMonitor Analyst originCode: US originLocation: latitude: 40.7128 longitude: -74.006 originName: WorldMonitor Analyst refugees: 1 year: 1 schema: $ref: '#/components/schemas/GetDisplacementSummaryResponse' '400': description: Validation error content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationError' - $ref: '#/components/schemas/JmespathProjectionError' '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- API access requires an active subscription (the API key's subscription is inactive or expired). content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '429': description: Rate limit exceeded. headers: X-RateLimit-Limit: description: Maximum requests allowed in the active rate-limit window. schema: type: string X-RateLimit-Remaining: description: Requests remaining in the active rate-limit window. schema: type: string X-RateLimit-Reset: description: >- Unix epoch milliseconds when the active rate-limit window resets. schema: type: string Retry-After: description: Seconds to wait before retrying the request. schema: type: string content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/RateLimitError' default: description: Gateway or handler error response. content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/GatewayError' components: schemas: GetDisplacementSummaryResponse: type: object properties: summary: $ref: '#/components/schemas/DisplacementSummary' fetchedAt: type: integer format: int64 description: |- 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: type: boolean description: >- 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. description: GetDisplacementSummaryResponse contains the global displacement summary. ValidationError: type: object properties: violations: type: array items: $ref: '#/components/schemas/FieldViolation' description: List of validation violations required: - violations description: >- ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong. JmespathProjectionError: description: >- Returned when a REST jmespath projection is invalid or exceeds the expression/output byte limits. properties: _jmespath_error: description: Projection error discriminator and details. type: string original_keys: description: Top-level keys or shape of the unprojected response. items: type: string type: array required: - _jmespath_error - original_keys type: object UnauthorizedError: type: object properties: error: type: string description: Human-readable error message. required: - error description: >- Returned when the API key is missing, malformed, or lacks current API access. ForbiddenError: type: object properties: error: type: string description: Human-readable entitlement failure reason. requiredTier: type: integer format: int32 description: Minimum entitlement tier required for this endpoint. currentTier: type: integer format: int32 description: Caller entitlement tier when known. planKey: type: string description: Caller plan key when known. required: - error description: >- Returned when a PRO-gated endpoint denies access because the caller has no resolved authenticated user, entitlements cannot be verified, or the caller lacks the required entitlement tier. Error: type: object properties: message: type: string description: Error message (e.g., 'user not found', 'database connection failed') description: >- Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize. RateLimitError: type: object description: Returned when a gateway or handler rate limit rejects the request. properties: error: type: string description: Human-readable rate-limit failure reason. required: - error GatewayError: type: object description: >- Returned by gateway infrastructure errors before an RPC handler runs, such as origin, routing, method, authentication, or quota checks. properties: error: oneOf: - type: string - type: object additionalProperties: true description: Gateway error reason or structured gateway failure details. required: - error DisplacementSummary: type: object properties: year: type: integer format: int32 description: Data year. globalTotals: $ref: '#/components/schemas/GlobalDisplacementTotals' countries: type: array items: $ref: '#/components/schemas/CountryDisplacement' topFlows: type: array items: $ref: '#/components/schemas/DisplacementFlow' description: >- DisplacementSummary represents a global overview of displacement data from UNHCR. FieldViolation: type: object properties: field: type: string description: >- The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key') description: type: string description: >- Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing') required: - field - description description: FieldViolation describes a single validation error for a specific field. GlobalDisplacementTotals: type: object properties: refugees: type: integer minimum: 0 format: int64 description: >- Total recognized refugees worldwide.. Warning: Values > 2^53 may lose precision in JavaScript asylumSeekers: type: integer minimum: 0 format: int64 description: >- Total asylum seekers worldwide.. Warning: Values > 2^53 may lose precision in JavaScript idps: type: integer minimum: 0 format: int64 description: >- Total internally displaced persons worldwide.. Warning: Values > 2^53 may lose precision in JavaScript stateless: type: integer minimum: 0 format: int64 description: >- Total stateless persons worldwide.. Warning: Values > 2^53 may lose precision in JavaScript total: type: integer minimum: 0 format: int64 description: >- Grand total of displaced persons.. Warning: Values > 2^53 may lose precision in JavaScript description: GlobalDisplacementTotals represents worldwide displacement figures. CountryDisplacement: type: object properties: code: type: string minLength: 1 description: ISO 3166-1 alpha-2 country code. name: type: string description: Country name. refugees: type: integer format: int64 description: >- Refugees originating from this country.. Warning: Values > 2^53 may lose precision in JavaScript asylumSeekers: type: integer format: int64 description: >- Asylum seekers from this country.. Warning: Values > 2^53 may lose precision in JavaScript idps: type: integer format: int64 description: >- Internally displaced persons within this country.. Warning: Values > 2^53 may lose precision in JavaScript stateless: type: integer format: int64 description: >- Stateless persons associated with this country.. Warning: Values > 2^53 may lose precision in JavaScript totalDisplaced: type: integer format: int64 description: >- Total displaced from this country.. Warning: Values > 2^53 may lose precision in JavaScript hostRefugees: type: integer format: int64 description: >- Refugees hosted by this country.. Warning: Values > 2^53 may lose precision in JavaScript hostAsylumSeekers: type: integer format: int64 description: >- Asylum seekers hosted by this country.. Warning: Values > 2^53 may lose precision in JavaScript hostTotal: type: integer format: int64 description: >- Total persons hosted by this country.. Warning: Values > 2^53 may lose precision in JavaScript location: $ref: '#/components/schemas/GeoCoordinates' required: - code description: >- CountryDisplacement represents displacement metrics for a single country. DisplacementFlow: type: object properties: originCode: type: string minLength: 1 description: ISO 3166-1 alpha-2 code of the origin country. originName: type: string description: Origin country name. asylumCode: type: string minLength: 1 description: ISO 3166-1 alpha-2 code of the asylum country. asylumName: type: string description: Asylum country name. refugees: type: integer format: int64 description: >- Number of refugees in this flow.. Warning: Values > 2^53 may lose precision in JavaScript originLocation: $ref: '#/components/schemas/GeoCoordinates' asylumLocation: $ref: '#/components/schemas/GeoCoordinates' required: - originCode - asylumCode description: >- DisplacementFlow represents a refugee movement corridor between two countries. GeoCoordinates: type: object properties: latitude: type: number maximum: 90 minimum: -90 format: double description: Latitude in decimal degrees (-90 to 90). longitude: type: number maximum: 180 minimum: -180 format: double description: Longitude in decimal degrees (-180 to 180). description: GeoCoordinates represents a geographic location using WGS84 coordinates. securitySchemes: WorldMonitorKey: type: apiKey in: header name: X-WorldMonitor-Key description: User-issued WorldMonitor API key. ApiKeyHeader: type: apiKey in: header name: X-Api-Key description: Alias header for the WorldMonitor API key (X-WorldMonitor-Key). ````