Skip to main content

VariableSummary

Compact variable representation used in list responses.

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

Human-readable variable label

unitUnit (string)required

Measurement unit: count | dollar | percent | year

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)

display_format object

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

anyOf
string
matched_census_codes object

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

anyOf
  • Array [
    • codeCode (string)required

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

    vintagesinteger[]required

    Vintage years where this code maps to this variable

  • ]
    • VariableSummary
    {
      "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
          ]
        }
      ]
    }