← Docs

Population

Population by place.

Need a population estimate? Look up the place. Country, state, district, city and postal profiles include a deep.population field with ?deep=true on paid plans. Continent population stays in core on every plan.

Where it lives

GET
api.parseapi.com/country/{code}?deep=true
Country, includes population
Explore
Parameters 4
formatstring · query · optional

json by default. geojson returns simplified country land outlines for map display as Polygon/MultiPolygon Features with stable ISO2 IDs. Very small islands and holes may be omitted. Missing outlines retain null geometry; unavailable geometry storage returns 503. Selected country facts and existing Deep access are preserved. API 2.0.0.

Default: json

Values: json, geojson

codestring · path · required

ISO 3166-1 alpha-2 or alpha-3, or a country name (germany)

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

deepboolean · query · optional

Country profiles, physical geography, statistics, regional conventions, tax references and alternate identifiers. Included on paid plans.

GET
api.parseapi.com/state/{code}?country={iso2}&deep=true
State or province, includes population
Explore
Parameters 5
formatstring · query · optional

json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 only.

Default: json

Values: json, geojson

codestring · path · required

State or province code or name (NC, colorado, ontario)

countrystring · query · optional

ISO2, ISO3, or a country name. Optional when the code or name is globally unique. A collision 404s asking for it.

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

deepboolean · query · optional

Population, area and tax references. Core includes State identifiers, area codes and capital. Included on paid plans.

GET
api.parseapi.com/district/{code}?deep=true
District, includes population
Explore
Parameters 6
formatstring · query · optional

json by default. geojson returns simplified administrative Polygon/MultiPolygon outlines with country-qualified IDs and selected facts in properties. Coordinates are longitude first. Missing or ambiguous outlines retain null geometry. Unavailable boundary storage returns 503. Collections retain parent context. Existing Deep access and pooled allowance apply. API 2.0.0 only.

Default: json

Values: json, geojson

codestring · path · required

District code or name (08031, guilford county, E09000033)

countrystring · query · optional

ISO2, ISO3, or a country name. Optional when the code or name is unique.

statestring · query · optional

ADM1 code or name. Narrows name lookups. Prefer louisiana over LA, which collides across countries, or include country=US.

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

deepboolean · query · optional

Population, area, the seat of government and US county property-tax medians. Included on paid plans.

GET
api.parseapi.com/city/{name}?deep=true
City, includes population
Explore
Parameters 13
typestring · query · optional

Filter the recorded place type, such as city or ward.

Length: 1 to 60 characters

grainstring · query · optional

Filter a reviewed geographic layer. Unreviewed records do not match.

Values: municipality, subdivision, locality, metropolitan_area

hierarchyboolean · query · optional

Include the reviewed grain and immediate parent on each City. Unknown relationships are null.

Value: true

aliasesboolean · query · optional

Also match reviewed official name forms. Applies to name lookup and search, without spelling correction.

Value: true

ambiguitystring · query · optional

Require a unique eligible exact name match; otherwise return HTTP 409 ambiguous_city with up to two safe City candidates.

Values: error

formatstring · query · optional

resource for one City, list for a collection, or geojson for stored-center Features. Omit to retain the classic envelope.

Values: resource, geojson

namestring · path · required

City name

countrystring · query · optional

ISO country code to disambiguate

statestring · query · optional

State code such as FL or US-FL. Get codes from /country/{country}/states. State names return 400. A country prefix must match the country filter.

Length: 1 to 6 characters

Pattern: ^(?:[A-Za-z]{2}-)?[A-Za-z0-9]{1,3}$

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

deepboolean · query · optional

Population, its known observation date and basis, area, elevation and capital status. Included on paid plans.

If-None-Matchstring · header · optional

Validate a cached canonical response or relationship list. Matching validators return 304 without a body; ordinary request billing and rate limits still apply.

romanizedboolean · query · optional

Include reviewed official romanized name_romanized and romanization_language. Missing or conflicting forms remain null; no ASCII-folding substitute. Available reviewed forms currently cover 20 Japanese whole-city aliases.

Value: true

GET
api.parseapi.com/postal/{code}?country={iso2}&deep=true
Postal / ZIP, includes population
Explore
Parameters 4
codestring · path · required

Postal or ZIP code. Unique codes resolve bare (SW1A 1AA). Use ?country=JP for 100-0001, whose digits also occur in Portugal.

countrystring · query · optional

ISO2, ISO3, or a country name. Optional when the code exists in exactly one covered country. Both five-digit and seven-digit codes can collide.

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

deepboolean · query · optional

Population, area, elevation, tax references, nearby postal codes and metropolitan areas. Included on paid plans.

GET
api.parseapi.com/continent/{code}
Continent, includes population
Explore
Parameters 2
codestring · path · required

Two-letter continent code

Values: NA, EU, AF, AS, OC, SA, AN

langstring · query · optional

Display language as one BCP 47 tag, such as fr or zh-Hant. Changes supported display labels only; IDs, codes, native names, facts, parsing and deep access stay unchanged. Omit for the original response. Unsupported regions use the supported language base; unsupported languages or scripts use English. Missing labels retain their source value. Accept-Language is not read automatically. Available on the current API contract; frozen 1.0.0 is unchanged.

Length: 2 to 64 characters

Run uses the free demo on API 2.0.0. Copied code uses your API key when signed in, or YOUR_API_KEY when signed out.

Run this Deep example with a paid-plan key. Deep is included in the pooled request, with no separate lookup charge.

import { parseAPI } from '@parseapi/sdk';

const parse = parseAPI("YOUR_API_KEY");
const result = await parse.country("ca", { deep: true });
console.log(result);

Run on your server with a secret key. Calling from a browser or app?

Example response
{
  "country": "CA",
  "iso_alpha3": "CAN",
  "iso_numeric": 124,
  "name": "Canada",
  "name_full": "Canada",
  "name_local": null,
  "demonym": "Canadian",
  "continent": "NA",
  "region": "Americas",
  "subregion": "Northern America",
  "currency": "CAD",
  "currency_name": "Canadian Dollar",
  "currency_symbol": "C$",
  "calling_code": "+1",
  "flag": "🇨🇦",
  "languages": [
    "en"
  ],
  "timezones": [
    "America/Cambridge_Bay",
    "America/Dawson",
    "America/Dawson_Creek",
    "America/Edmonton",
    "America/Fort_Nelson",
    "America/Glace_Bay",
    "America/Goose_Bay",
    "America/Halifax",
    "America/Inuvik",
    "America/Iqaluit",
    "America/Moncton",
    "America/Panama",
    "America/Phoenix",
    "America/Puerto_Rico",
    "America/Rankin_Inlet",
    "America/Regina",
    "America/Resolute",
    "America/St_Johns",
    "America/Swift_Current",
    "America/Toronto",
    "America/Vancouver",
    "America/Whitehorse",
    "America/Winnipeg"
  ],
  "borders": [
    "US"
  ],
  "blocs": [
    "G7",
    "NATO",
    "OECD"
  ],
  "capital": {
    "name": "Ottawa",
    "latitude": 45.42,
    "longitude": -75.7
  },
  "deep": {
    "population": 41288599,
    "gdp_usd": 2319899772425.92,
    "gdp_per_capita_usd": 55697.66,
    "population_growth_percent": 0.94,
    "urban_population_percent": 82.88,
    "internet_users_percent": 94.35,
    "area": 9984670,
    "land_area": 9093507,
    "water_area": 891163,
    "coastline": 202080,
    "lowest_point": {
      "name": "Atlantic/Pacific/Arctic Oceans",
      "elevation": 0
    },
    "highest_point": {
      "name": "Mount Logan",
      "elevation": 5959
    },
    "elevation_average": 487,
    "tld": ".ca",
    "week_start": "sunday",
    "units": "metric",
    "driving_side": "right",
    "plugs": [
      "A",
      "B"
    ],
    "voltage": 120,
    "frequency": 60,
    "emergency": {
      "police": "911",
      "ambulance": "911",
      "fire": "911"
    },
    "postal_format": "A#A #A#",
    "postal_regex": "^(?:[ABCEGHJKLMNPRSTVXY]\\d[ABCEGHJ-NPRSTV-Z] ?\\d[ABCEGHJ-NPRSTV-Z]\\d)$",
    "tax": {
      "name": "GST",
      "rate": 5
    },
    "ioc": "CAN",
    "fifa": "CAN",
    "plate": "CDN"
  }
}

District lists under /state/{code}/districts also carry deep.population when requested on paid plans and available.

Questions? Email