APIResponse[list[VariableSummary]]

data object[]required

Array [

api_nameApi Name (string)required

Stable API identifier, e.g. 'sex_and_age_total_population'

census_code object

Census Bureau variable code, e.g. 'B01001_001E'

anyOf

• string
• null

string

labelLabel (string)required

Human-readable variable label

unitUnit (string)required

Measurement unit: count | dollar | percent | year

topic object

anyOf

• TopicSummary
• null

topic_keyTopic Key (string)required

Unique slug for the topic, e.g. 'demographics'

labelLabel (string)required

Human-readable topic name

depthDepth (integer)required

Nesting depth (0 = root)

display_format object

Suggested display format hint, e.g. 'integer', 'percent_1dp'

anyOf

• string
• null

string

matched_census_codes object

Census codes that matched the search query (only present when search matches a Census code)

anyOf

• object[]
• null

Array [

codeCode (string)required

Census Bureau variable code, e.g. 'DP05_0001E'

vintagesinteger[]required

Vintage years where this code maps to this variable

]

]

meta objectrequired

Metadata envelope present in every response.

source object

Data provenance; null for catalog endpoints

anyOf

• SourceMeta
• null

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
• null

string

census_programCensus Program (string)

Default value: U.S. Census Bureau

variable_count object

Number of variables returned (data endpoint only)

anyOf

• integer
• null

integer

geography_count object

Number of geographies returned (data endpoint only)

anyOf

• integer
• null

integer

total_count object

Total records available before pagination (list endpoints)

anyOf

• integer
• null

integer

hint object

Contextual guidance when results are empty or limited

anyOf

• string
• null

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
• null

string

prev object

Previous page URL (if paginated)

anyOf

• string
• null

string

APIResponse[list[VariableSummary]]

{
  "data": [
    {
      "api_name": "string",
      "census_code": "string",
      "label": "string",
      "unit": "string",
      "topic": {
        "topic_key": "string",
        "label": "string",
        "depth": 0
      },
      "display_format": "string",
      "matched_census_codes": [
        {
          "code": "string",
          "vintages": [
            0
          ]
        }
      ]
    }
  ],
  "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"
  }
}