Overview

Tareky API 1

Maps, search, routing and transit for Iraq, from our own data and servers.

Authentication

Every call needs a key – create one in the developer console.

• tareky_pk_... public keys may ship in a browser or an app. Send one as ?access_token=tareky_pk_... (a simple GET, no CORS preflight) or as Authorization: Bearer tareky_pk_.... Restrict it to your website’s origins in the console.
• tareky_sk_... secret keys are for servers: Authorization: Bearer tareky_sk_... only. A secret key in a URL is refused.
• The legacy x-access-key-id / x-secret-access-key headers keep working until their sunset.

Limits and billing

Each call spends units from your plan’s monthly quota (most cost 1; matrix, optimization, static maps, transit planning and places along a route cost more). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and on metered plans X-Quota-Limit / X-Quota-Remaining. Over a limit you get 429 with Retry-After. Only successful (2xx) calls are billed. A map is billed once per style load (GET /v1/styles/{theme}); its vector tiles are free.

Errors

Every error has the same shape:

{ "error": { "code": "quota_exceeded", "message": "Monthly quota exhausted for this app", "status": 429, "docsUrl": "..." }, "requestId": "..." }

Branch on code: missing_key, invalid_key, forbidden, origin_not_allowed, scope_not_allowed, rate_limited, quota_exceeded, invalid_request (with details), not_found, no_route, no_segment, no_match, no_trips, too_big, service_unavailable, internal_error. Quote requestId when you contact support.

Attribution

Maps must show “© OpenMapTiles © OpenStreetMap contributors” (and, for satellite, “Contains modified Copernicus Sentinel data ”). The styles carry it; MapLibre shows it for you.

Information

• OpenAPI version: 3.0.0

Operations

GET

/v1/locations/reverse-geocode

GET

/v1/locations/search

POST

/v1/locations/geo-coding

GET

/v1/locations/geocode

POST

/v1/tokens

GET

/v1/poi/nearby

GET

/v1/poi/in-bounds

POST

/v1/poi/along-route

GET

/v1/directions/{profile}/{coordinates}

GET

/v1/matrix/{profile}/{coordinates}

GET

/v1/match/{profile}/{coordinates}

GET

/v1/optimize/{profile}/{coordinates}

GET

/v1/traffic/tiles/{z}/{x}/{y}

GET

/v1/traffic/flow

GET

/v1/traffic/historical

GET

/v1/traffic/snapshot

GET

/v1/static-map/{theme}/{coords}/{size}

POST

/v1/probes

GET

/v1/probes/config

POST

/v1/probes/bulk

GET

/v1/offline/catalog

GET

/v1/client-config

POST

/v1/telemetry/car-renderer

GET

/v1/geofences

POST

/v1/geofences

POST

/v1/geofences/import

GET

/v1/geofences/{id}

DELETE

/v1/geofences/{id}

POST

/v1/tracking/devices/{externalId}/positions

GET

/v1/tracking/devices/{externalId}

POST

/v1/tracking/devices/{externalId}/shares

GET

/v1/styles/glyphs/{handle}/{fontstack}/{file}

GET

/v1/styles/{theme}

GET

/v1/styles/{handle}/{styleId}

GET

/v1/styles/{handle}/{styleId}/sprites/{file}

GET

/v1/styles/{handle}/{styleId}/static/{coords}/{size}

GET

/v1/styles/{handle}/{styleId}/tiles/{z}/{x}/{y}

GET

/v1/tilesets/{id}

POST

/v1/tilesets/{name}/uploads

POST

/v1/tilesets/{name}/builds

GET

/v1/tilesets/{name}/builds/{jobId}

GET

/v1/tiles/{theme}/{z}/{x}/{y}

GET

/v1/tilequery/{point}

GET

/v1/transit/plan/{points}

GET

/v1/transit/{points}

GET

/v1/feeds/cifs.json

GET

/v1/feeds/incidents.geojson

POST

/v1/feeds/incidents

Authentication

key

Tareky_pk_… or tareky_sk_…

Security scheme type: http

Bearer format: JWT

access_token

Tareky_pk_… only

Security scheme type: apiKey

Query parameter name: access_token

legacy

Legacy, until its sunset

Security scheme type: apiKey

Header parameter name: x-access-key-id