Skip to main content

APIResponse[list[TopicResponse]]

data object[]required
  • Array [
  • topic_keyTopic Key (string)required

    Unique slug, e.g. 'demographics'

    labelLabel (string)required

    Human-readable name

    description object

    Brief description of the topic

    anyOf
    string
    depthDepth (integer)required

    Nesting depth (0 = root)

    variable_countVariable Count (integer)required

    Number of active variables in this topic

  • ]
  • 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[list[TopicResponse]]
    {
    "data": [
    {
    "topic_key": "string",
    "label": "string",
    "description": "string",
    "depth": 0,
    "variable_count": 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"
    }
    }