Welcome to the API documentation for the Qatar National Address Open API service. This documentation provides detailed information about the endpoints, request parameters, and response formats of our API.
Introduction
The Qatar National Address API allows you to access accurate and up-to-date location information for Qatar. Our API provides endpoints to retrieve zone, street, and building details, as well as geolocation coordinates and polygon boundaries.
Base URL
The base URL for all API requests is: https://qnas.qa/
Endpoints
Our API offers the following endpoints:
- GET /get_zones/: Retrieve a list of all zones in Qatar.
- GET /get_zone_polygon/{zone}: Retrieve the polygon boundary coordinates for a specific zone.
- GET /get_streets/{zone}: Retrieve a list of streets in a specific zone.
- GET /get_street_polygon/{zone}/{street}: Retrieve the polygon boundary coordinates for a specific street.
- GET /get_buildings/{zone}/{street}: Retrieve a list of buildings on a specific street.
- GET /get_location/{zone}/{street}/{building}: Retrieve geolocation coordinates for a specific building.
Rate Limiting
Our API has rate limiting to ensure fair usage. The rate limits are as follows:
- Requests per minute (RPM): 60 requests
- Requests per day (RPD): 1000 requests
Errors
If an error occurs, the API will return an error response in JSON format. The response will include an error code and a message describing the error.
Conclusion
Thank you for using the Qatar National Address API. If you have any questions, feedback, or issues, please don't hesitate to contact our support team at [email protected].