Demographics

Query demographics for a polygon

Query demographic data for boundaries intersecting a GeoJSON polygon.

Draw a polygon on a map and get demographics for the area. Returns either individual boundary results (with overlap_fraction) or area-weighted aggregated statistics (aggregate: true).

Accepts the same field/topic/output-control parameters as the GET endpoint for schema parity. Segment filters (sex, age_min, age_max) are not supported for polygon queries and will return 400 if set.

Use topics or fields to control which data is returned. Use limit/offset to paginate non-aggregate boundary results.

post/v1/data/demographics

Request

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

Request body

boundary_type'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).

fieldsstring[] nullable

API field paths to return.

topicsstring nullable

Comma-separated topic IDs (e.g. age,income).

census_yearinteger

Census year.

sex'male' | 'female' | 'persons'

Sex filter: male, female, or persons.

age_mininteger nullable

Minimum age (inclusive).

age_maxinteger nullable

Maximum age (inclusive).

aggregateboolean

If true, return area-weighted aggregated stats.

limitinteger

Max boundaries to return (non-aggregate).

offsetinteger

Pagination offset for boundary results.

Response

Demographic data for boundaries intersecting the polygon.

unknown required

Changes

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