Skip to main content

VariableDetail

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
labelLabel (string)required
unitUnit (string)required
universe object

Population universe this variable applies to

anyOf
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
display_format object
anyOf
string
topic object
anyOf
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
    census_table_id object
    anyOf
    string
    census_concept object
    anyOf
    string
    is_availableIs Available (boolean)required
  • ]
  • VariableDetail
    {
    "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
    }
    ]
    }