Skip to Content

Regions

GET /v1/regions lists available geographies. This endpoint is anonymous and cached.

Request

curl "https://api.creativeforesight.io/v1/regions?type=county&parent=TN"

Query parameters

ParameterTypeRequiredDescription
typestringNoFilter by region type, such as country, state, or county.
parentstringNoFilter by parent region code.

Region object

FieldTypeDescription
codestringStable region code. Counties commonly use 5-digit FIPS codes.
typestringRegion type.
namestringDisplay name.
slugstringURL-safe region slug.
parent_codestring or nullParent geography when available.
fips_statestring or nullState FIPS code when applicable.
fips_countystring or nullCounty FIPS code when applicable.

Response

{ "data": [ { "code": "47187", "type": "county", "name": "Williamson County, Tennessee", "slug": "williamson-county-tennessee", "parent_code": "TN", "fips_state": "47", "fips_county": "187" } ] }

Errors

StatusCodeMeaning
500INTERNAL_SERVER_ERRORThe regions catalog could not be loaded.
Last updated on