Skip to main content
GET
/
api
/
displacement
/
v1
/
get-displacement-summary
GetDisplacementSummary
curl --request GET \
  --url https://api.example.com/api/displacement/v1/get-displacement-summary
{
  "summary": {
    "year": 123,
    "globalTotals": {
      "refugees": 1,
      "asylumSeekers": 1,
      "idps": 1,
      "stateless": 1,
      "total": 1
    },
    "countries": [
      {
        "code": "<string>",
        "name": "<string>",
        "refugees": 123,
        "asylumSeekers": 123,
        "idps": 123,
        "stateless": 123,
        "totalDisplaced": 123,
        "hostRefugees": 123,
        "hostAsylumSeekers": 123,
        "hostTotal": 123,
        "location": {
          "latitude": 0,
          "longitude": 0
        }
      }
    ],
    "topFlows": [
      {
        "originCode": "<string>",
        "asylumCode": "<string>",
        "originName": "<string>",
        "asylumName": "<string>",
        "refugees": 123,
        "originLocation": {
          "latitude": 0,
          "longitude": 0
        },
        "asylumLocation": {
          "latitude": 0,
          "longitude": 0
        }
      }
    ]
  }
}

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.

Response

Successful response

GetDisplacementSummaryResponse contains the global displacement summary.

summary
object

DisplacementSummary represents a global overview of displacement data from UNHCR.