APIResponse[VariableDetail]

data objectrequired

Full variable record including vintage availability matrix.

api_nameApi Name (string)required

census_code object

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

anyOf

• string
• null

string

labelLabel (string)required

unitUnit (string)required

universe object

Population universe this variable applies to

anyOf

• string
• null

string

is_estimateIs Estimate (boolean)required

True when the value comes with a margin-of-error

data_type object

Underlying data type hint, e.g. 'integer', 'float'

anyOf

• string
• null

string

display_format object

anyOf

• string
• null

string

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)

availability object[]

Which dataset/vintage combinations carry this variable

Array [

dataset_keyDataset Key (string)required

dataset_labelDataset Label (string)required

vintage_yearVintage Year (integer)required

census_variable_code object

anyOf

• string
• null

string

census_table_id object

anyOf

• string
• null

string

census_concept object

anyOf

• string
• null

string

is_availableIs Available (boolean)required

]

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[VariableDetail]

{
  "data": {
    "api_name": "string",
    "census_code": "string",
    "label": "string",
    "unit": "string",
    "universe": "string",
    "is_estimate": true,
    "data_type": "string",
    "display_format": "string",
    "topic": {
      "topic_key": "string",
      "label": "string",
      "depth": 0
    },
    "availability": [
      {
        "dataset_key": "string",
        "dataset_label": "string",
        "vintage_year": 0,
        "census_variable_code": "string",
        "census_table_id": "string",
        "census_concept": "string",
        "is_available": 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"
  }
}