GET /api/v1/places
Fetch community_areas and zip codes list

Fetch community areas and zip codes list

This API is used to fetch community areas and zip codes list
Response data is composed of community_areas list and zip_codes list

Supported Formats

json

GET /api/v1/place/:geo_slug
Fetch community_area/zip_code details

Fetch community area details using community area slug or zip code

This API is used to fetch community area or zip code details.
It has basic info for community area or zip code.
Detailed charts and statistics data can be get using detailed apis.
This API has only basic info for community area or zip code.

Supported Formats

json

Params

Param name Description
geo_slug
required

community_area slug or zip code

Validations:

  • Must be a String


GET /api/v1/place/category/:cat_id/:geo_slug
Fetch category dataset using category id and community area/zip code

Fetch category dataset using category id and community area/zip code

category id is index number of category table and community area/zip code is slug. It has useful data for chart.

Supported Formats

json

Params

Param name Description
geo_slug
required

community_area slug or zip code

Validations:

  • Must be a String

cat_id
required

category_id

Validations:

  • Must be a String


GET /api/v1/place/demography/:geo_slug
Fetch demography chart info of community_area or zip code

Fetch demography info for community_area or zip code

This api gets detailed domography info for community_area or zip code.
You can get the chart info too(map box) using this api.
The result can be easily used on map box.

Supported Formats

json

Params

Param name Description
geo_slug
required

community_area slug or zip code

Validations:

  • Must be a String


GET /api/v1/place/insurance/:cat_id/:geo_slug
Fetch insurance info regarding community area or zip code and category name

Fetch insurance data using category id and community area / zip code

Result data is easily used on chart and it has info for insurance

Supported Formats

json

Params

Param name Description
geo_slug
required

community_area slug or zip code

Validations:

  • Must be a String

cat_id
required

category id

Validations:

  • Must be a String


GET /api/v1/place/providers/:geo_slug
Fetch provider info using community area or zip code

Fetch provides info using community_area or zip code.

It can be easily used on charts.

Supported Formats

json

Params

Param name Description
geo_slug
required

community_area slug or zip code

Validations:

  • Must be a String


GET /api/v1/resources(/:dataset_id)/:north/:east/:south/:west
Fetch resources info for community_area/zip code

GET /api/v1/resources(/:dataset_id)/:community_area_slug
Fetch resources info for community_area/zip code

Fetch community area or zip code resources

This api fetches the detailed resources info of community_area or zip code.
It has detailed info for resources placed in community area or zip code.

Supported Formats

json

Params

Param name Description
geo_slug
optional

community_area slug or zip code

Validations:

  • Must be a String

north
optional

north

Validations:

  • Must be a String

east
optional

east

Validations:

  • Must be a String

southh
optional

south

Validations:

  • Must be a String

west
optional

west

Validations:

  • Must be a String

dataset_slug
optional

dataset slug

Validations:

  • Must be a String

community_area_slug
optional

community_area_slug

Validations:

  • Must be a String


GET /api/v1/resources_all(/:dataset_slug)
Fetch all resources

Fetch all of the resources exists in chicago city.

Supported Formats

json

Params

Param name Description
dataset_slug
optional

dataset slug

Validations:

  • Must be a String


GET /api/v1/resources_category/:category_slug(/:dataset_slug)
Fetch all resources with category slug

Fetch all of the resources exists in chicago city with category slug.

Supported Formats

json

Params

Param name Description
dataset_slug
optional

dataset slug

Validations:

  • Must be a String

category_slug
optional

category slug

Validations:

  • Must be a String


GET /api/v1/:geo_slug/:category_slug/community_area_detail
Fetch all community area details

Fetch all of the community area details.

Supported Formats

json

Params

Param name Description
geo_slug
optional

geo slug

Validations:

  • Must be a String


GET /api/v1/area_indices/:indicator_slug
Fetch detailed data of indicators economic-hardship and child-opportunity-index

Fetch detailed data of indicators economic-hardship and child-opportunity-index

Supported Formats

json

Params

Param name Description
indicator_slug
required

indicator slug

Validations:

  • Must be a String