{ "info": { "name": "Lanewise API", "description": "Store points of interest (POIs), enrich them with an address, query them by attributes,\ncategories and distance, and plan routes around them.\n\nAuthenticate every request with an API key from the [dashboard](https://dash.lanewise.app)\nin the `X-API-KEY` header. Every authenticated response carries `X-RateLimit-*` headers.\nGuides: https://docs.lanewise.app\n\nSet the `apiKey` collection variable to one of your API keys.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-KEY", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.lanewise.app/v1", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "item": [ { "name": "POIs", "item": [ { "name": "List POIs", "request": { "method": "GET", "description": "A cursor-paginated list of your POIs, sorted by ID, with optional filters. Requires `read-pois`.\nFilter by attributes with `attributes[]=` (deep object).\n", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pois", "host": [ "{{baseUrl}}" ], "path": [ "pois" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true }, { "key": "attributes[owner_id]", "value": "123", "description": "Attribute values to match, keyed by attribute name or ID, e.g. `attributes[owner_id]=123`.", "disabled": true }, { "key": "category_id", "value": "", "description": "ID of a category. Cannot be combined with `category_name`.", "disabled": true }, { "key": "category_name", "value": "Parking", "description": "Exact name of a category.", "disabled": true }, { "key": "latitude", "value": "41.3874", "description": "Latitude of the search point. Required with `longitude` or `distance`.", "disabled": true }, { "key": "longitude", "value": "2.1686", "description": "Longitude of the search point. Required with `latitude` or `distance`.", "disabled": true }, { "key": "distance", "value": "500", "description": "Search radius in meters around the point. Defaults to 1000.", "disabled": true }, { "key": "country_id", "value": "", "disabled": true }, { "key": "city_id", "value": "", "disabled": true }, { "key": "zipcode_id", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a POI", "request": { "method": "POST", "description": "Creates a POI and reverse-geocodes it in the background. Requires `create-pois`; returns 403 when the team reached its POI limit.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pois", "host": [ "{{baseUrl}}" ], "path": [ "pois" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Plaça de Catalunya car park\",\n \"latitude\": 41.387,\n \"longitude\": 2.17,\n \"attributes\": {\n \"owner_id\": 123,\n \"open_24h\": true\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve a POI", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pois/:id", "host": [ "{{baseUrl}}" ], "path": [ "pois", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } }, { "name": "Update a POI", "request": { "method": "PUT", "description": "Send only the fields to change. Attributes are merged; `null` removes one. Moving a POI geocodes it again. Requires `update-pois`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pois/:id", "host": [ "{{baseUrl}}" ], "path": [ "pois", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] }, "body": { "mode": "raw", "raw": "{\n \"attributes\": {\n \"open_24h\": false\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a POI", "request": { "method": "DELETE", "description": "Requires `delete-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pois/:id", "host": [ "{{baseUrl}}" ], "path": [ "pois", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } } ] }, { "name": "Attributes", "item": [ { "name": "List attributes", "request": { "method": "GET", "description": "Requires `read-attributes`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/attributes", "host": [ "{{baseUrl}}" ], "path": [ "attributes" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true } ], "variable": [] } } }, { "name": "Create an attribute", "request": { "method": "POST", "description": "Requires `create-attributes`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/attributes", "host": [ "{{baseUrl}}" ], "path": [ "attributes" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"owner_id\",\n \"type\": \"number\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve an attribute", "request": { "method": "GET", "description": "Requires `read-attributes`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/attributes/:id", "host": [ "{{baseUrl}}" ], "path": [ "attributes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } }, { "name": "Rename an attribute", "request": { "method": "PUT", "description": "The type can't be changed. Requires `update-attributes`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/attributes/:id", "host": [ "{{baseUrl}}" ], "path": [ "attributes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"driver_id\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an attribute", "request": { "method": "DELETE", "description": "Also deletes its values on every POI. Requires `delete-attributes`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/attributes/:id", "host": [ "{{baseUrl}}" ], "path": [ "attributes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } } ] }, { "name": "Categories", "item": [ { "name": "List categories", "request": { "method": "GET", "description": "Requires `read-categories`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true }, { "key": "name", "value": "", "description": "Only categories whose name contains this text.", "disabled": true } ], "variable": [] } } }, { "name": "Create a category", "request": { "method": "POST", "description": "Requires `create-categories`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories", "host": [ "{{baseUrl}}" ], "path": [ "categories" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Parking\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Retrieve a category", "request": { "method": "GET", "description": "Requires `read-categories`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } }, { "name": "Rename a category", "request": { "method": "PUT", "description": "Requires `update-categories`.", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Car parks\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a category", "request": { "method": "DELETE", "description": "Its POIs are kept, without a category. Requires `delete-categories`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } } ] }, { "name": "Geolocation", "item": [ { "name": "List the countries your POIs are in", "request": { "method": "GET", "description": "Requires `read-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geo/countries", "host": [ "{{baseUrl}}" ], "path": [ "geo", "countries" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true }, { "key": "name", "value": "", "description": "Only places whose name (or code) contains this text.", "disabled": true } ], "variable": [] } } }, { "name": "List the cities your POIs are in", "request": { "method": "GET", "description": "Requires `read-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geo/cities", "host": [ "{{baseUrl}}" ], "path": [ "geo", "cities" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true }, { "key": "name", "value": "", "description": "Only places whose name (or code) contains this text.", "disabled": true }, { "key": "country_id", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "List the zip codes your POIs are in", "request": { "method": "GET", "description": "Requires `read-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/geo/zipcodes", "host": [ "{{baseUrl}}" ], "path": [ "geo", "zipcodes" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true }, { "key": "name", "value": "", "description": "Only places whose name (or code) contains this text.", "disabled": true }, { "key": "country_id", "value": "", "disabled": true }, { "key": "city_id", "value": "", "disabled": true } ], "variable": [] } } } ] }, { "name": "Imports", "item": [ { "name": "List imports", "request": { "method": "GET", "description": "Newest first. Requires `read-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ], "query": [ { "key": "limit", "value": "15", "description": "Items per page.", "disabled": true }, { "key": "cursor", "value": "", "description": "The `next` value of the previous page.", "disabled": true } ], "variable": [] } } }, { "name": "Upload a CSV file of POIs", "request": { "method": "POST", "description": "Columns `name`, `latitude`, `longitude` are required; `category` is optional; any other column must be an\nattribute name (or send `create_missing_attributes=1` to create them as text attributes; columns that are not\nvalid attribute names are ignored). Comma or semicolon delimited, up to 10 MB and 50,000 rows. Processed in\nthe background; poll the returned import. Rows past the team's POI limit are reported as not imported, and\nthe upload returns 403 when the team is already at its limit. The upload counts as one request.\nRequires `create-pois`.\n", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ], "query": [], "variable": [] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "create_missing_attributes", "type": "text", "value": "false", "disabled": true } ] } } }, { "name": "Retrieve an import", "request": { "method": "GET", "description": "Requires `read-pois`.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/imports/:id", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":id" ], "query": [], "variable": [ { "key": "id", "value": "01JGZ8Q3N5T9B2C4D6F8H0K2M4" } ] } } } ] }, { "name": "Routing", "item": [ { "name": "Plan a route that avoids POIs", "request": { "method": "POST", "description": "A route through 2 to 50 waypoints, in order. Send `avoid` to keep `radius` meters away from the POIs it\nselects, with the filters of `GET /pois` plus `poi_ids` (all filters combine). Only POIs around the waypoints\nare considered (their bounding box grown by 10% of its diagonal, at least 1 km and at most 10 km); POIs within\n`radius` of a waypoint are skipped, since the route has to reach it. Up to 500 POIs to avoid, and up to\n150 km in a straight line between waypoints when at least one POI is avoided.\n\nRequires `plan-routes`, plus `read-pois` when a waypoint is a POI or `avoid` is sent. Each call counts as one\nrequest. Returns 503 while routing is unavailable or busy, and 502 when the routing service fails to answer.\n", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/routes", "host": [ "{{baseUrl}}" ], "path": [ "routes" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"profile\": \"driving-car\",\n \"waypoints\": [\n {\n \"latitude\": 41.387,\n \"longitude\": 2.1701\n },\n {\n \"poi_id\": \"01JGZ8Q3N5T9B2C4D6F8H0K2M4\"\n }\n ],\n \"avoid\": {\n \"category_name\": \"speed-camera\",\n \"radius\": 100\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Group stops into clusters", "request": { "method": "POST", "description": "Groups up to 2,000 stops into compact clusters, e.g. one per driver. Send either `stops` or a `pois` selection,\nand either `clusters` (how many) or `max_stops` (the most stops per cluster). `balanced` makes the clusters\nequal in size (they differ by at most one stop). The result is deterministic: the same input always gives the\nsame clusters. Computed with straight-line distances, so it is always available.\n\nRequires `plan-routes`, plus `read-pois` when a stop is a POI or `pois` is sent. Each call counts as one request.\n", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/routes/clusters", "host": [ "{{baseUrl}}" ], "path": [ "routes", "clusters" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"stops\": [\n {\n \"id\": \"order-1\",\n \"latitude\": 41.387,\n \"longitude\": 2.1701\n },\n {\n \"id\": \"order-2\",\n \"latitude\": 41.4036,\n \"longitude\": 2.1744\n },\n {\n \"id\": \"order-3\",\n \"poi_id\": \"01JGZ8Q3N5T9B2C4D6F8H0K2M4\"\n }\n ],\n \"clusters\": 2,\n \"balanced\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Optimize deliveries (VRPTW)", "request": { "method": "POST", "description": "Assigns up to 50 stops to up to 3 vehicles and orders each vehicle's stops to minimize travel time, meeting\ncapacities, time windows and skills. Datetimes are ISO 8601; the response uses the offset of the first datetime\nof the request (UTC when there is none, and then vehicles leave now). Durations are in seconds, distances in meters.\nStops that cannot be served are listed in `unassigned` with a reason.\n\nRequires `plan-routes`, plus `read-pois` when a stop or depot is a POI. Each call counts as one request.\nReturns 503 while routing is unavailable or busy, and 502 when the routing service fails to answer.\n", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/routes/optimize", "host": [ "{{baseUrl}}" ], "path": [ "routes", "optimize" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"profile\": \"driving-car\",\n \"vehicles\": [\n {\n \"id\": \"van-1\",\n \"start\": {\n \"latitude\": 41.387,\n \"longitude\": 2.1701\n },\n \"end\": {\n \"latitude\": 41.387,\n \"longitude\": 2.1701\n },\n \"capacity\": 10,\n \"time_window\": [\n \"2026-10-01T08:00:00+02:00\",\n \"2026-10-01T14:00:00+02:00\"\n ]\n }\n ],\n \"stops\": [\n {\n \"id\": \"order-1\",\n \"latitude\": 41.4036,\n \"longitude\": 2.1744,\n \"service\": 300,\n \"demand\": 4,\n \"time_windows\": [\n [\n \"2026-10-01T09:00:00+02:00\",\n \"2026-10-01T10:00:00+02:00\"\n ]\n ]\n },\n {\n \"id\": \"order-2\",\n \"poi_id\": \"01JGZ8Q3N5T9B2C4D6F8H0K2M4\",\n \"service\": 120\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "API key", "item": [ { "name": "Retrieve the current API key", "request": { "method": "GET", "description": "The key that authenticated the request, with its permissions and recent usage. Needs no permission.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/info", "host": [ "{{baseUrl}}" ], "path": [ "info" ], "query": [], "variable": [] } } } ] }, { "name": "Pricing", "item": [ { "name": "Pricing tiers", "request": { "method": "GET", "description": "Public. Request and POI tiers with monthly prices, and the preset plans.", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pricing", "host": [ "{{baseUrl}}" ], "path": [ "pricing" ], "query": [], "variable": [] }, "auth": { "type": "noauth" } } } ] } ] }