Catalog

Browse the topics, measures and indices you can ask for. Free.

List the topics you can ask for

GET /v1/topics

A topic is a subject, such as Demographics or Labor market. Each topic is made of groups of related measures, and you pay one credit per group per place. Free.

Answers

Status	When	Body
200	The topics, with the groups in each.	object
429	Too many requests in a short time. Wait the number of seconds in Retry-After, then try again.	Problem

Search for measures

GET /v1/variables

Find the measures you can ask for. A measure is a single number, such as median household income. Free.

Parameters

Name	In	Type	What it is
`q`	query	string	Words to search for, such as 'rent' or 'jobs by industry'.
`topic`	query	TopicId	Only show measures in this topic.
`group`	query	string	Only show measures in this group, such as income.household.
`source`	query	string	Only show measures from this source, such as acs5 (the Census Bureau's American Community Survey). Mostly useful for checking where numbers come from.
`geography`	query	GeographyLevel	Only show measures available for this kind of area.
`limit`	query	integer	How many results to return on each page.
`cursor`	query	string	To get the next page, pass the `next_cursor` value from the previous page.

Answers

Status	When	Body
200	Matching measures.	object
429	Too many requests in a short time. Wait the number of seconds in Retry-After, then try again.	Problem

Get the details of one measure

GET /v1/variables/{id}

What the measure means, its unit, who it counts, where it comes from, and the years and kinds of area it's available for. Free.

Parameters

Name	In	Type	What it is
`id` required	path	string	The measure's ID.

Answers

Status	When	Body
200	The measure's details.	Variable
404	Something went wrong. The response explains what happened and what to do next. Failed requests are never charged. (The format is RFC 9457, a standard layout for API errors.)	Problem
429	Too many requests in a short time. Wait the number of seconds in Retry-After, then try again.	Problem

List groups of related measures

GET /v1/groups

A group is a small set of related measures, such as household income. Groups are what you pay for, one credit per group per place. Free.

Parameters

Name	In	Type	What it is
`topic`	query	TopicId	Only show groups in this topic.

Answers

Status	When	Body
200	The groups.	object
429	Too many requests in a short time. Wait the number of seconds in Retry-After, then try again.	Problem

List presets

GET /v1/presets

A preset is a ready-made request, such as a site report, that you ask for by name instead of listing groups. Each says which groups it includes, which comparisons it adds, the area it suggests around each point and what each place costs. Free.

Answers

Status	When	Body
200	The presets.	object
429	Too many requests in a short time. Wait the number of seconds in Retry-After, then try again.	Problem

List Kadrin indices

GET /v1/indices

An index is a single score that combines several measures, such as economic momentum. Each one has a published recipe. Free.

Answers

Status	When	Body
200	The indices.	object

See how an index is built

GET /v1/indices/{id}

The index's definition, the measures it combines and how much each one counts, what it can't tell you, and how it has changed over time. Free.

Parameters

Name	In	Type	What it is
`id` required	path	string	The index's ID.
`version`	query	string	Get an earlier version of the recipe. Leave this out for the current one.

Answers

Status	When	Body
200	How the index is built.	IndexMethodology
404	Something went wrong. The response explains what happened and what to do next. Failed requests are never charged. (The format is RFC 9457, a standard layout for API errors.)	Problem