Skip to main content

APIResponse[dict[str, GeographyDataPoint]]

data objectrequired
property name* GeographyDataPoint

All requested variable values for a single geography.

geo_keyGeo Key (string)required
nameName (string)required
geo_typeGeo Type (string)required
fips_state object
anyOf
string
fips_county object
anyOf
string
geoid_full object
anyOf
string
variables objectrequired

Map of api_name → VariableValue

property name* VariableValue

A single variable's observed value for one geography.

api_nameApi Name (string)required
labelLabel (string)required
unitUnit (string)required
display_format object
anyOf
string
estimate objectrequired

Numeric estimate; null when suppressed

anyOf
number
margin_of_error object

Margin of error at 90% confidence; null for non-estimates

anyOf
number
moe_annotation object

Census annotation flag on the MoE, e.g. '**'

anyOf
string
census_annotation object

Census annotation flag on the estimate, e.g. '-'

anyOf
string
suppressedSuppressed (boolean)

True when the Census Bureau suppressed this value

Default value: false
null_reason object

Why the value is null/suppressed, if known

anyOf
string
geometry object

GeoJSON geometry (20m resolution) when include_geometry=true

anyOf
object
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[dict[str, GeographyDataPoint]]
{
  "data": {},
  "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"
  }
}