Skip to main content
GET
/
api
/
displacement
/
v1
/
get-population-exposure
GetPopulationExposure
curl --request GET \
  --url https://api.example.com/api/displacement/v1/get-population-exposure
{
  "success": true,
  "countries": [
    {
      "code": "<string>",
      "name": "<string>",
      "population": 123,
      "densityPerKm2": 123
    }
  ],
  "exposure": {
    "exposedPopulation": 123,
    "exposureRadiusKm": 123,
    "nearestCountry": "<string>",
    "densityPerKm2": 123
  }
}

Query Parameters

mode
string

Mode: "countries" (default) or "exposure".

lat
number<double>

Latitude (required for exposure mode).

lon
number<double>

Longitude (required for exposure mode).

radius
number<double>

Radius in km (required for exposure mode, defaults to 50).

Response

Successful response

GetPopulationExposureResponse returns either a countries list or an exposure estimate.

success
boolean

True if the request succeeded.

countries
object[]
exposure
object

ExposureResult contains the population exposure estimate.