Skip to main content

APIResponse[GeographyDetail]

data objectrequired

Full geography record.

geo_keyGeo Key (string)required

Stable API identifier, e.g. 'county:48201'

nameName (string)required

Full official name

name_short object

Abbreviated name

anyOf
string
geo_typeGeo Type (string)required

Geography type, e.g. 'county', 'state'

fips_state object
anyOf
string
fips_county object
anyOf
string
geoid_full object

Full Census GEOID, e.g. '0500000US48201'

anyOf
string
parent_geo_key object

geo_key of the parent geography

anyOf
string
geo_level_code object

Census summary level code, e.g. 50 for county

anyOf
integer
is_activeIs Active (boolean)
Default value: true
meta objectrequired

Metadata envelope present in every response.

source object

Data provenance; null for catalog endpoints

anyOf
datasetDataset (string)required

Dataset key, e.g. 'acs5'

vintage_yearVintage Year (integer)required

Survey vintage year, e.g. 2022

reference_period object

Human-readable reference period, e.g. '2018–2022'

anyOf
string
census_programCensus Program (string)
Default value: U.S. Census Bureau
variable_count object

Number of variables returned (data endpoint only)

anyOf
integer
geography_count object

Number of geographies returned (data endpoint only)

anyOf
integer
total_count object

Total records available before pagination (list endpoints)

anyOf
integer
hint object

Contextual guidance when results are empty or limited

anyOf
string
request_idRequest Id (string)required

UUID identifying this request

elapsed_msElapsed Ms (integer)required

Server-side processing time in milliseconds

links objectrequired
selfSelf (string)required

Canonical URL of this response

next object

Next page URL (if paginated)

anyOf
string
prev object

Previous page URL (if paginated)

anyOf
string
APIResponse[GeographyDetail]
{
  "data": {
    "geo_key": "string",
    "name": "string",
    "name_short": "string",
    "geo_type": "string",
    "fips_state": "string",
    "fips_county": "string",
    "geoid_full": "string",
    "parent_geo_key": "string",
    "geo_level_code": 0,
    "is_active": true
  },
  "meta": {
    "source": {
      "dataset": "string",
      "vintage_year": 0,
      "reference_period": "string",
      "census_program": "U.S. Census Bureau"
    },
    "variable_count": 0,
    "geography_count": 0,
    "total_count": 0,
    "hint": "string",
    "request_id": "string",
    "elapsed_ms": 0
  },
  "links": {
    "self": "string",
    "next": "string",
    "prev": "string"
  }
}