Skip to main content

APIResponse[GeocodeResult]

data objectrequired

Geocode lookup result: coordinates + containing geographies.

coordinates objectrequired

Resolved coordinates.

latitudeLatitude (number)required
longitudeLongitude (number)required
address object

Matched address (only present when address input was used)

anyOf
string
geographies object

Containing geographies keyed by geo_type

property name* GeocodedGeography

A single geography containing the queried point.

geo_keyGeo Key (string)required

Geography key, e.g. 'county:48453'

nameName (string)required

Full official name

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

anyOf
string
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[GeocodeResult]
{
  "data": {
    "coordinates": {
      "latitude": 0,
      "longitude": 0
    },
    "address": "string",
    "geographies": {}
  },
  "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"
  }
}