Frequently Asked Questions (FAQ)
This section answers some of the most commonly asked questions by users.
What is TurkiyeAPI?
TurkiyeAPI is a comprehensive REST API that provides demographic and geographical data about Turkey's administrative divisions (provinces, districts, neighborhoods, and villages). It is designed for developers and researchers who want to explore or work with Turkey's administrative structure.
How Do I Use TurkiyeAPI?
TurkiyeAPI is designed as a RESTful API. To use it, simply send HTTP requests. It responds with data in JSON format and does not require authentication. Here’s how to get started:
- Send a request using the API URL. For example, to get all provinces, use the
/api/v1/provincesendpoint. - If the request is successful, the API will return data in JSON format.
- Process the returned data to access the information you need.
What Kind of Data Does TurkiyeAPI Provide?
TurkiyeAPI provides various types of data about Turkey’s administrative units, including:
Names, IDs, population figures, and surface areas of provinces, districts, neighborhoods, and villages. It also offers relational data, such as which region a province belongs to, or which province a district is part of.
Where Can I Find TurkiyeAPI?
The source code for TurkiyeAPI is available on GitHub, along with complete API documentation.
Is TurkiyeAPI Free to Use?
Yes, TurkiyeAPI is completely free and open-source. It is available to everyone and does not require authentication or a subscription. However, if you'd like to support its development, you can make a donation via Buy Me a Coffee.
I Want to Contribute to TurkiyeAPI. How Can I Help?
If you want to contribute, you can visit the GitHub repository. You can report bugs, suggest new features, or contribute directly to the codebase.
Can I Run TurkiyeAPI on My Own Server?
Yes! Since TurkiyeAPI is open-source, you can run it on your own server and customize it as needed. The repository includes instructions to help you set it up locally.
Why Has the Documentation Changed?
The documentation has been redesigned to improve the user experience and make the API easier to understand and use. The new version provides detailed explanations for both successful and failed requests, includes rich request examples, and is better structured for the upcoming v2 version of the API.
Can I Still Access the Old Documentation?
Yes, you can access the previous version of the documentation here.