Skip to main content
POST
/
api
/
census
/
variables
/
search
/census/variables/search
curl --request POST \
  --url https://api.anysite.io/api/census/variables/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "dataset": "<string>",
  "count": 2,
  "timeout": 300,
  "keyword": "income"
}
'
[
  {
    "id": "<string>",
    "@type": "@census_variable",
    "label": "<string>",
    "concept": "<string>",
    "group": "<string>",
    "predicate_type": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
dataset
string
required

Dataset path ({year}/{program}/...)

Minimum string length: 1
Examples:

"2023/acs/acs1/profile"

"2022/acs/acs5"

"2020/dec/pl"

​
count
integer
required

Number of variables to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
keyword
string | null

Filter by words in the variable label or concept

Example:

"income"

Response

Successful Response

​
id
string
required
​
@type
string
default:@census_variable
​
label
string | null
​
concept
string | null
​
group
string | null
​
predicate_type
string | null