Vector Tiles API
The Vector Tiles endpoint provides geographic map data as squared sections called vector tiles, presented in a vector format.
- Each tile contains predefined collections of map features, such as points, lines, road shapes, water polygons, and building footprints, delivered in the specified vector formats.
- The tile's format is defined using the protobuf schema.
- Each tile layer's content and meaning are detailed in the tile layers description.
To get the vector map tile data use the following endpoint:
GET
Path Parameters
| Name | Required | Format & Usage | Description |
|---|---|---|---|
| z | Yes | Type: integer Minimum Value: 0 Maximum Value: 22 | Zoom level of the tile to be rendered. The values should be in the range of [0,22]. |
| x | Yes | Type: integer Maximum Value: 2z-1 | Specify the x-coordinate of the tile or the tile’s column on the zoom grid z. The maximum value should be less than 2z. |
| y | Yes | Type: integer Maximum Value: 2z-1 | Specify the y-coordinate of the tile or the tile’s row on the zoom grid z. The maximum value should be less than 2z. |
| format | Yes | Type: string Allowed Values: pbf | The format of the response. |
Request Parameters
| Name | Required | Format & Usage | Description |
|---|---|---|---|
| key | Yes | Type: string Format: 32 character alphanumeric string Example: key=API_KEY | A key is a unique identifier that is required to authenticate a request to the API. |
| apiVersion | No | Type: integer Allowed Values: 1 | Specify the version of the API service to be called. Current value is 1. |
| layer | No | Type: string Allowed Values: basic | Layer of the tile to be rendered. The basic layer provides all mapping data such as geographic polygons, road shapes, borders, labels, and road icons. |
| view | No | Type: string Default value: See the following Default view mapping section. Other values: Unified, IN, PK, AR, Arabic, KR, RS, MY, CL, DZ, PH, BN, TW, MA, IL, VN, TR, US. | A geopolitical view. Usage of a value outside of the given set will result in the server sending a HTTP 400 response. |
Sample Request
API Query Limits
- NextBillion.ai allows a maximum rate limit of 6000 queries per minute or 100 queries/second for continuous requests.
Note: We can increase the quota if needed, on request. Contact support@nextbillion.ai for more details.
API Error Codes
| Response code | Description | Additional notes |
|---|---|---|
| 200 | Normal success case. | Normal success case. |
| 400 | Input validation failed. | There is a missing or an invalid parameter or a parameter with an invalid value type is added to the request. |
| 401 | APIKEY not supplied or invalid | This error occurs when the wrong API key is passed in the request or the key is missing altogether. |
| 403 | APIKEY is valid but does not have access to requested resources | You might be querying for a geographical region which is not valid for your account or requesting a service which is not enabled for you. |
| 404 | Requested host/path not found | This error occurs when a malformed hostname is used. |
| 422 | Could not process the request | A feasible solution could not be generated for the given set of locations or parameter configuration. |
| 429 | Too many requests | QPM reached or API request count quota reached. |
| 500 | Internal Service error. | There was an internal issue with NextBillion.ai services. You can reach out to support@nextbillion.ai for an explanation. |