Turkiye API Documentation

What is the purpose of this API?

This API allows you to get data about provinces in Turkey. 🇹🇷

If you want to see API features as Postman documentation, you can click here.

If you want to see API features as Swagger documentation, you can click here.

For explanation of the API in Turkish language, you can click here.

To see example usages, you can click here.

Provinces

Here are the routes related to provinces.

Get All Provinces

GET/api/v1/provinces

You can use this route to get data for all provinces.

Query Params	Type	Description
name	string	It shows all the provinces containing or matching your search query.
minPopulation	number	It shows all the provinces with a population greater than or equal to the value you entered.
maxPopulation	number	It shows all the provinces with a population less than or equal to the value you entered.
isMetropolitan	boolean	It shows all the provinces that are metropolitan or not.
offset	number	Used for pagination. Use this to set a starting point in search results.
limit	number	Used for pagination. Use this to set the maximum number of results to show you.
fields	string	It shows the fields you want to see in the response.
sort	string	It sorts the results in ascending or descending order.

Get Exact Province

GET/api/v1/provinces/:id

You can use this route to get data for exact province.

Path Variables	Description
id	ID of province

Query Params	Type	Description
fields	string	It shows the fields you want to see in the response.
extend	boolean	It shows the extended data (neighborhoods and villages) of the province. [Default: false] This is an experimental feature. It may not work properly.

Districts

Here are the routes related to districts.

Get All Districts

GET/api/v1/districts

You can use this route to get data for all districts.

Query Params	Type	Description
name	string	It shows all the districts containing or matching your search query.
minPopulation	number	It shows all the districts with a population greater than or equal to the value you entered.
maxPopulation	number	It shows all the districts with a population less than or equal to the value you entered.
offset	number	Used for pagination. Use this to set a starting point in search results.
limit	number	Used for pagination. Use this to set the maximum number of results to show you.
fields	string	It shows the fields you want to see in the response.
sort	string	It sorts the results in ascending or descending order.

Get Exact District

You can use this route to get data for exact district.

GET/api/v1/districts/:id

You can use this route to get data for all districts.

Path Variables	Description
id	ID of district

Query Params	Type	Description
fields	string	It shows the fields you want to see in the response.

Neighborhoods

Here are the routes related to neighborhoods.

Get All Neighborhoods

GET/api/v1/neighborhoods

You can use this route to get data for all neighborhoods.

It is a recently added endpoint and is experimental. It may not work properly.

Query Params	Type	Description
name	string	It shows all the neighborhoods containing or matching your search query.
minPopulation	number	It shows all the neighborhoods with a population greater than or equal to the value you entered.
maxPopulation	number	It shows all the neighborhoods with a population less than or equal to the value you entered.
offset	number	Used for pagination. Use this to set a starting point in search results.
limit	number	Used for pagination. Use this to set the maximum number of results to show you.
fields	string	It shows the fields you want to see in the response.
sort	string	It sorts the results in ascending or descending order.

Get Exact Neighborhood

You can use this route to get data for exact neighborhood.

It is a recently added endpoint and is experimental. It may not work properly.

GET/api/v1/neighborhoods/:id

You can use this route to get data for exact neighborhood.

Path Variables	Description
id	ID of neighborhood

Query Params	Type	Description
fields	string	It shows the fields you want to see in the response.

Villages

Here are the routes related to villages.

Get All Villages

GET/api/v1/villages

You can use this route to get data for all villages.

It is a recently added endpoint and is experimental. It may not work properly.

Query Params	Type	Description
name	string	It shows all the villages containing or matching your search query.
minPopulation	number	It shows all the villages with a population greater than or equal to the value you entered.
maxPopulation	number	It shows all the villages with a population less than or equal to the value you entered.
offset	number	Used for pagination. Use this to set a starting point in search results.
limit	number	Used for pagination. Use this to set the maximum number of results to show you.
fields	string	It shows the fields you want to see in the response.
sort	string	It sorts the results in ascending or descending order.

Get Exact Village

You can use this route to get data for exact village.

It is a recently added endpoint and is experimental. It may not work properly.

GET/api/v1/villages/:id

You can use this route to get data for exact village.

Path Variables	Description
id	ID of village

Query Params	Type	Description
fields	string	It shows the fields you want to see in the response.

Turkiye API is an open-source project. Click here for GitHub link! 😻