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
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | No | Filter by region type, such as country, state, or county. |
parent | string | No | Filter by parent region code. |
Region object
| Field | Type | Description |
|---|---|---|
code | string | Stable region code. Counties commonly use 5-digit FIPS codes. |
type | string | Region type. |
name | string | Display name. |
slug | string | URL-safe region slug. |
parent_code | string or null | Parent geography when available. |
fips_state | string or null | State FIPS code when applicable. |
fips_county | string or null | County 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
| Status | Code | Meaning |
|---|---|---|
500 | INTERNAL_SERVER_ERROR | The regions catalog could not be loaded. |
Last updated on