Enrich

Enrich locations with boundary and datapack data

Batch-enrich locations with boundary resolution and datapack data.

For each location, resolves the containing boundaries and attaches enrichment data from the requested datapacks.

Datapacks available: demographics, fundraising.

Limits: Up to 100 locations per request.

Example request body:

{
  "locations": [
    {"id": "loc1", "location": {"lng": 151.2093, "lat": -33.8688}}
  ],
  "resolve": ["sa2", "lga"],
  "enrich": [{"datapack": "demographics", "fields": "population.total"}],
  "output_boundary": "sa2"
}
post/v1/data/enrich

Request

  • Base URL: https://api.mapulus.com
  • URL: https://api.mapulus.com/v1/data/enrich
  • Auth: HTTP bearer

Request body

resolveBoundaryType[]

Boundary types to resolve for each location.

output_boundary'sa1' | 'sa2' | 'sa3' | 'sa4' | 'lga' | 'poa' | 'sal' | 'ced' | 'sed' | 'gccsa' | 'ste' | 'sua' | 'ucl' | 'ra' | 'sos' | 'sosr' | 'iloc' | 'iare' | 'ireg' | 'flood' | 'us_state' | 'us_county' | 'us_tract' | 'us_bg' | 'us_place' | 'us_cousub' | 'us_cd' | 'us_sldu' | 'us_sldl' | 'us_cbsa' | 'us_csa' | 'us_unsd' | 'us_elsd' | 'us_scsd' | 'us_aiannh' | 'us_region' | 'us_division' | 'us_zcta' | 'us_ua' | 'us_puma'

Statistical and administrative boundary types (AU + US).

Example request

{
  "enrich": [
    {
      "datapack": "demographics",
      "fields": "population.total"
    }
  ],
  "locations": [
    {
      "id": "loc1",
      "location": {
        "lat": -33.8688,
        "lng": 151.2093
      }
    }
  ],
  "output_boundary": "sa2",
  "resolve": [
    "sa2",
    "lga"
  ]
}

Response

Enriched location results with resolved boundaries and attached datapack data.

Changes

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