API reference

The Atasu Maps API reference, generated from the openapi.yaml specification.

Specification 1.0.0-draft.1: 26 operations available, 15 planned.

Map sessions & styles

Map session, tile token and style JSON. Tile token format is in the `TileToken` security scheme.

POST/v1/map-sessionsStart a map session and get a tile tokenAvailable
POST/v1/map-sessions/{session_id}/tokensRefresh the tile token of a live sessionAvailable
GET/v1/styles/{style_id}.jsonMapLibre style JSONAvailable

Vector tiles on tiles.atasumaps.com. Served by Martin / traffic-edge, not by apps/api.

GET/v1/basemap/{z}/{x}/{y}.mvtBasemap vector tile (OSM + Overture, ODbL)Available
GET/v1/canopy/{z}/{x}/{y}.mvtTree canopy height classes (Meta & WRI, CC BY 4.0), Almaty and AstanaAvailable
GET/v1/overlay/{z}/{x}/{y}.mvtApproved crowdsourced places and entrancesAvailable
GET/v1/reports/{z}/{x}/{y}.mvtLive road events (z ≥ 10)Available
GET/v1/fonts/{fontstack}/{range}.pbfGlyph range of a font stack (the style's `glyphs` URL)Available
GET/v1/sprites/{sprite_file}Sprite sheet image or index (the style's `sprite` URL)Available
GET/v1/native-styles/{style_file}Static style for MapLibre Native (one theme, Kazakh labels)Available
GET/v1/native-styles/patches/{patch_file}Theme or language patch for a native styleAvailable
GET/v1/traffic/tiles.jsonTileJSON for the traffic flow source (zoom range, coverage, TomTom attribution)Available
GET/v1/traffic/{z}/{x}/{y}.pbfTraffic flow tile (TomTom through the budgeted proxy)Available

Autocomplete, address search, reverse geocoding with entrances.

GET/v1/geocode/autocompleteType-ahead suggestions (kk / ru / en, mixed Cyrillic and Latin)Available
GET/v1/geocode/searchFull-text and structured address / place searchAvailable
GET/v1/geocode/reverseCoordinates → address and nearest entranceAvailable

Place details with entrances.

Route, ETA, matrix, map matching, pickup points.

POST/v1/routeDriving / walking route with alternatives and turn-by-turn stepsAvailable
POST/v1/etaFixed-route live travel time (for quotes)Planned
POST/v1/matrixSources × targets travel-time matrix (dispatch)Planned
POST/v1/snapMap-match a GPS trace to roadsPlanned
POST/v1/pickup-pointsRecommended pickup points — stairwell entrances, compound gates, legal stopsPlanned

Live road events and "still there / gone" votes.

POST/v1/reportsReport a road eventAvailable
POST/v1/reports/{report_id}/votesVote "still there" / "gone" on an eventAvailable

Crowdsourced places, entrances and fixed cameras. Never pre-filled from OSM.

POST/v1/places/submissionsSubmit a new place, a place edit, an entrance or a fixed cameraAvailable

The signed-in user — profile, devices, my submissions, appeals, deletion, rewards.

GET/v1/meCurrent userAvailable
PATCH/v1/meUpdate display name or localePlanned
POST/v1/me/devicesRegister this devicePlanned
GET/v1/me/submissionsMy submissions and reports with their statusAvailable
GET/v1/me/submissions/{report_id}One of my submissions, with status historyAvailable
POST/v1/me/submissions/{report_id}/withdrawWithdraw a pending submissionPlanned
POST/v1/me/submissions/{report_id}/appealAppeal a rejected submission (once)Available
POST/v1/me/submissions/{report_id}/mediaAttach a photo to my submissionPlanned
GET/v1/me/deletion-requestStatus of my deletion requestPlanned
POST/v1/me/deletion-requestRequest deletion of my dataPlanned
GET/v1/me/rewardsMy jarmaq grant history (Beta; off until its tests pass)Planned

Partner fleet positions and passenger trip sharing.

POST/v1/fleet/positionsPublish vehicle positions (HTTP alternative to the stream `pub` op)Planned
POST/v1/tripsStart sharing a trip (vehicle ↔ passenger)Planned
POST/v1/trips/{trip_id}/ticketsIssue a short-lived passenger ticket for a tripPlanned
POST/v1/trips/{trip_id}/endEnd a trip; tickets stop working and subscribers get a tombstonePlanned

WebSocket endpoint; protocol in packages/openapi/WEBSOCKET.md.