Planisfy
Api

Tiles API

Serve published TileJSON, vector tiles, dotted aliases, immutable versions, and PMTiles-backed tilequery.

Tiles API

Tiles are served from published uploaded PMTiles artifacts or proxied Martin sources.

Routes

MethodRouteDescription
GET/tiles/v1/{owner}/{handle}.jsonStable TileJSON for the promoted version.
GET/tiles/v1/{owner}/{handle}@{version}.jsonStable path with inline version suffix.
GET/tiles/v1/{owner}/{handle}/{z}/{x}/{y}Stable vector tile.
GET/tiles/v1/{owner}/{handle}/versions/{version}.jsonImmutable version TileJSON.
GET/tiles/v1/{owner}/{handle}/versions/{version}/{z}/{x}/{y}Immutable version vector tile.
GET/tiles/v1/{owner}.{handle}.jsonDotted stable TileJSON alias.
GET/tiles/v1/{owner}.{handle}@{version}.jsonDotted immutable TileJSON alias.
GET/tiles/v1/{owner}.{handle}/{z}/{x}/{y}Dotted stable vector tile alias.
GET/tiles/v1/{source}.jsonLegacy Martin TileJSON proxy when the source is not a Planisfy tileset slug.
GET/tiles/v1/{source}/{z}/{x}/{y}Legacy Martin tile proxy when the source is not a Planisfy tileset slug.
GET/v4/{owner}.{handle}/tilequery/{lon},{lat}.jsonPMTiles-backed vector tilequery.

Stable URLs resolve to the promoted current version. Version URLs are immutable and receive long cache headers where supported.

Example

curl "https://api.example.com/tiles/v1/acme/places.json"
const source = {
  type: "vector",
  url: "https://api.example.com/tiles/v1/acme/places.json"
};

Auth

Published public tiles can be read anonymously. Valid API keys or sessions may attach identity for private-owner reads and metering.

Tilequery

Tilequery is available for PMTiles-backed vector tilesets:

curl "https://api.example.com/v4/acme.places/tilequery/9.1829,48.7758.json?radius=50&limit=5&geometry=point"

Supported query parameters are z, radius, limit, layers, and geometry=point|full. Raster tilequery is not supported.

Common errors

CodeMeaning
NOT_FOUNDTileset, version, source, or tile was not found.
VALIDATION_ERRORInvalid version, tile coordinate, or tilequery request.
ARTIFACT_MISSINGPublished metadata points at a missing storage artifact.

On this page