---
outline: deep
---

# Welcome

**TurkiyeAPI** is a comprehensive **REST API** that provides demographic and geographic data about Turkey’s administrative divisions (provinces, districts, neighborhoods, and villages).

This guide explains the features of TurkiyeAPI and how to use it in detail.

## Features

- **REST Principles**: Built in accordance with Representational State Transfer (REST) architecture
- **Open Source**: Source code is available on [GitHub](https://github.com/ubeydeozdmr/turkiye-api)
- **Comprehensive Data**: Offers demographic and geographic data on administrative divisions
- **Data Handling**: Supports filtering, sorting, and pagination
- **API Tools**: Fully compatible with Postman and Swagger
- **Easy Access**: No authentication required; open to all users

## New Documentation

The documentation has been redesigned using VitePress:

- Provides detailed explanations of both successful and failed API calls
- Includes rich example requests
- Enhances the overall user experience

For more information on why the documentation was changed and how to access the old version, refer to the [related FAQ page](./faq.md).

## API Tools

TurkiyeAPI is compatible with popular API tools such as Postman and Swagger:

- [Postman Documentation](https://documenter.getpostman.com/view/19561492/UzBguVHM)
- [Swagger UI](https://api.turkiyeapi.dev/swagger)

## Authentication

TurkiyeAPI is a public API that does not require authentication. This means anyone can access and use the API without an API key or login. This approach allows a broader audience to benefit from the service and ensures easy accessibility.

## Contact

If you have any questions or feedback about TurkiyeAPI, please visit the [GitHub repository](https://github.com/ubeydeozdmr/turkiye-api) or send an email directly to [ubeydeozdmr@gmail.com](mailto:ubeydeozdmr@gmail.com).

## Support & Donations

TurkiyeAPI is completely free, open source, and non-commercial. However, if you'd like to support the ongoing development of the project, you can make a donation. Contributions help cover server costs and enable the addition of new features.

To donate, please visit [this link](https://www.buymeacoffee.com/ubeydeozdmr).

<a href="https://www.buymeacoffee.com/ubeydeozdmr"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="buymeacoffee button" width="150" /></a>
