Skip to main content
GET
/
v1
/
api
/
tiles
/
roads
/
metadata
Get Roads Metadata
curl --request GET \
  --url https://api.bookovia.com/v1/api/tiles/roads/metadata \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "file": "<string>",
  "url": "<string>",
  "header": {},
  "metadata": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bookovia.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Roads Metadata endpoint returns detailed information about the roads PMTiles archive, including zoom levels, geographic bounds, tile counts, and compression details.
This endpoint is useful for understanding tile coverage, data quality, and technical specifications of the roads dataset.

​
Authentication

This endpoint requires authentication via API key in the X-API-Key header. Required permissions: maps:read

​
Request

No request parameters required.

​
Request Example

curl -H "X-API-Key: bkv_your_api_key_here" \
  https://api.bookovia.com/v1/api/tiles/roads/metadata

​
Response

The response structure is identical to Buildings Metadata, but contains roads-specific information.
​
success
boolean
Indicates whether the request was successful
​
file
string
PMTiles filenameValue: usa-roads.pmtiles
​
url
string
Direct URL to PMTiles archiveValue: https://maptiles.bookovia.com/usa-roads.pmtiles
​
header
object
PMTiles header with zoom levels, bounds, and size information
​
metadata
string
JSON-encoded metadata including road layer schema

​
Response Example

{
  "success": true,
  "file": "usa-roads.pmtiles",
  "url": "https://maptiles.bookovia.com/usa-roads.pmtiles",
  "header": {
    "specVersion": 3,
    "minZoom": 0,
    "maxZoom": 15,
    "minLon": -179.1473,
    "minLat": 18.9110,
    "maxLon": -66.9498,
    "maxLat": 71.3577,
    "centerZoom": 4,
    "centerLon": -98.5795,
    "centerLat": 39.8283,
    "tileType": "mvt",
    "compression": "gzip",
    "tileDataSize": 6120580150,
    "metadataSize": 2048
  },
  "metadata": "{\"vector_layers\":[{\"id\":\"roads\",\"fields\":{\"id\":\"String\",\"class\":\"String\",\"name\":\"String\",\"ref\":\"String\",\"lanes\":\"Number\",\"surface\":\"String\",\"speed_limit\":\"Number\",\"oneway\":\"Boolean\",\"bridge\":\"Boolean\",\"tunnel\":\"Boolean\",\"toll\":\"Boolean\",\"access\":\"String\"},\"minzoom\":0,\"maxzoom\":15}],\"name\":\"USA Roads\",\"description\":\"Road network from Overture Maps\",\"attribution\":\"© Overture Maps Foundation, © OpenStreetMap contributors\"}"
}

​
Layer Schema

The metadata JSON includes the schema for the roads layer: 
{
  "vector_layers": [
    {
      "id": "roads",
      "fields": {
        "id": "String",
        "class": "String",
        "name": "String",
        "ref": "String",
        "lanes": "Number",
        "surface": "String",
        "speed_limit": "Number",
        "oneway": "Boolean",
        "bridge": "Boolean",
        "tunnel": "Boolean",
        "toll": "Boolean",
        "access": "String"
      },
      "minzoom": 0,
      "maxzoom": 15
    }
  ],
  "name": "USA Roads",
  "description": "Road network from Overture Maps",
  "attribution": "© Overture Maps Foundation, © OpenStreetMap contributors"
}

​
Use Cases

Use zoom levels and coverage to determine appropriate detail levels for displaying routes from the Routing API.
Extract and display proper attribution for Overture Maps and OpenStreetMap as required by data licenses.
Discover available road properties (class, lanes, surface, etc.) to plan your map styling strategy.
Verify archive availability and structure before deploying map features to production.