Skip to content

50,000 free calls a month, card-free. Get an API key →

Documentation menu
docs / api / post-route-along
routing

POST/route/along

API key required, sent as Authorization: Bearer snk_… or ?api_key=snk_….

Call it

bash
curl -fsS -X POST "https://api.mapmap.ai/route/along" \
  -H "Authorization: Bearer $MAPMAP_KEY" \
  -H "Content-Type: application/json" \
  -d @request.json

Request body

application/json

Along-route search: a route (geometry_polyline6, or origin + destination + costing), a free-text query, optional max_detour_minutes (default 10), max_results (default 5, max 25), source (geocode default | places), category (an OSM category token for geocode, the customer taxonomy for places), sort (cheapest_diesel | cheapest_petrol, fuel-enriched results by price then detour), Valhalla costing_options and an optional top-level adr profile

The OpenAPI document declares this body as a free-form JSON object with no field list, so there is nothing here to generate a table from. The prose above is what the gateway states about it; the raw document is the authority.

Responses

200Places along the route, each with its honest engine-computed detour: {query, source, costing, route, max_detour_minutes, candidates: {considered, costed, cap}, results[]: {place, detour_minutes, detour_km, along_route_position, off_route_m}}, sorted by detour. When the geocode source browsed the first-party index by category (an explicit category, or a query that is entirely category phrases (fuel, petrol station, coffee near me), which promotes automatically), the response also carries matched_categories naming the normalised tokens browsed. With the fuel-price store configured (SN_FUEL_PRICES), fuel-station results also carry fuel_prices, fuel_brand and fuel_updated_at, and the response a fuel_attribution string
400Invalid request
401Missing or invalid API key
404source: "places" on a gateway without customer places
429Quota or rate limit exceeded
501source: "geocode" on a gateway without a geocoder (SN_PHOTON_URL unset), or an explicit category on a gateway without the first-party geocode index (SN_GEOCODE_DIR unset; urn:sn-gateway:problem:reverse-filtering-not-enabled, the same feature-detect status GET /geocode/reverse uses for its first-party-only filters). A category *promoted* from the query degrades to free-text search instead of failing
502Upstream routing engine or geocoder failed

Error bodies follow the shared problem model documented on API conventions.

Also under routing

Generated from https://api.mapmap.ai/openapi.json on 2026-09-17 · operationId post_route_along