# OSRM Route Planner Scraper (`crawlerbros/osrm-route-planner`) Actor Route planning, distance matrix, and nearest-road lookup via the free OSRM routing engine. Supports driving, cycling, and walking profiles. No auth or proxy required. - **URL**: https://apify.com/crawlerbros/osrm-route-planner.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Travel, Developer tools, Open source - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## OSRM Route Planner Scraper Plan driving, cycling, and walking routes using the free [OSRM (Open Source Routing Machine)](http://project-osrm.org/) public API. No API key, no proxy, no cost. ### Features - **Route planning** — get turn-by-turn directions between two or more coordinates with distance, duration, and step-by-step instructions - **Distance/time matrix** — compute an N×M table of distances and travel times between multiple origins and destinations - **Nearest road lookup** — snap any coordinate to the nearest routable road/path - **Three transport profiles** — driving, cycling, walking - **Waypoints** — add intermediate stops for multi-leg routes - **Direct URL mode** — fetch any OSRM API URL directly via `startUrls` ### Input | Field | Type | Description | |-------|------|-------------| | `mode` | string (enum) | `route`, `matrix`, or `nearest` | | `profile` | string (enum) | `driving`, `cycling`, or `walking` (default: `driving`) | | `startCoordinate` | string | Start point as `"lat,lon"` (e.g. `"51.5074,-0.1278"`) | | `endCoordinate` | string | Destination as `"lat,lon"` | | `waypoints` | string[] | Intermediate stops as `"lat,lon"` strings (route mode) | | `origins` | string[] | Origin coordinates for matrix mode | | `destinations` | string[] | Destination coordinates for matrix mode | | `startUrls` | URL[] | Direct OSRM API URLs to fetch | | `maxItems` | integer | Max records to emit (default: 100) | ### Output #### Route record (`recordType: "route"`) ```json { "recordType": "route", "sourceUrl": "http://router.project-osrm.org/route/v1/driving/...", "scrapedAt": "2026-01-01T00:00:00+00:00", "profile": "driving", "startCoordinate": "51.5074,-0.1278", "endCoordinate": "48.8566,2.3522", "distanceMeters": 620363.4, "durationSeconds": 43265.6, "steps": [ { "instruction": "depart", "name": "King Charles I Island", "distanceMeters": 21.0, "durationSeconds": 2.9, "mode": "driving" } ] } ```` #### Matrix record (`recordType: "matrix"`) ```json { "recordType": "matrix", "sourceUrl": "http://router.project-osrm.org/table/v1/driving/...", "scrapedAt": "2026-01-01T00:00:00+00:00", "profile": "driving", "origins": ["51.5074,-0.1278"], "destinations": ["48.8566,2.3522"], "matrixCells": [ { "origin": "51.5074,-0.1278", "destination": "48.8566,2.3522", "durationSeconds": 43265.6, "distanceMeters": 620363.4 } ] } ``` #### Nearest record (`recordType: "nearest"`) ```json { "recordType": "nearest", "sourceUrl": "http://router.project-osrm.org/nearest/v1/driving/...", "scrapedAt": "2026-01-01T00:00:00+00:00", "profile": "driving", "queryCoordinate": "51.5074,-0.1278", "nearestCoordinate": "51.507478,-0.127965", "nearestLatitude": 51.507478, "nearestLongitude": -0.127965, "nearestRoadName": "King Charles I Island", "distanceToRoadMeters": 14.37 } ``` ### Example Use Cases - **Logistics planning** — compute travel times between a warehouse and multiple delivery addresses - **Route comparison** — compare driving vs cycling distances for the same trip - **Geocoding fallback** — snap coordinates to the nearest named road - **Distance matrix for TSP** — feed matrix data into a Travelling Salesman solver ### Frequently Asked Questions **Is this free to use?** Yes. OSRM is an open-source project with a free public demo server. No API key or account required. **What coordinate format should I use?** Enter coordinates as `"lat,lon"` strings, e.g. `"51.5074,-0.1278"` for London. The OSRM API internally uses `lon,lat` order — this actor handles the conversion automatically. **What is the coverage?** Global — OSRM uses OpenStreetMap data, which covers the entire world. **How accurate are the routes?** Routes are based on OpenStreetMap road data and are generally accurate for most roads worldwide. Rural and newly built roads may have limited coverage. **Can I plan routes with multiple stops?** Yes — add intermediate coordinates to the `waypoints` field for multi-stop route planning. **What is the matrix mode?** Matrix mode computes an N×M table of travel times and distances between all origin-destination pairs in a single API call — ideal for logistics and routing optimization. **Are there rate limits?** The public OSRM demo server is a shared resource. This actor adds small delays between requests to be a good citizen. For high-volume use, consider running your own OSRM instance. ### Data Source [router.project-osrm.org](http://router.project-osrm.org) — free public OSRM routing API based on OpenStreetMap. # Actor input Schema ## `mode` (type: `string`): Operation mode: route planning, origin-destination matrix, or nearest-road lookup. ## `profile` (type: `string`): Routing profile to use. ## `startCoordinate` (type: `string`): Starting point as 'lat,lon' (e.g. '51.5074,-0.1278'). Required for route and nearest modes. ## `endCoordinate` (type: `string`): Destination as 'lat,lon' (e.g. '48.8566,2.3522'). Required for route mode. ## `waypoints` (type: `array`): Optional intermediate stops as 'lat,lon' strings (route mode only). Example: \['52.5200,13.4050'] ## `origins` (type: `array`): List of origin coordinates as 'lat,lon' strings for matrix mode. ## `destinations` (type: `array`): List of destination coordinates as 'lat,lon' strings for matrix mode. ## `startUrls` (type: `array`): Optional OSRM API URLs to fetch directly. Overrides other inputs when provided. ## `maxItems` (type: `integer`): Hard cap on emitted records. ## Actor input object example ```json { "mode": "route", "profile": "driving", "startCoordinate": "51.5074,-0.1278", "endCoordinate": "48.8566,2.3522", "waypoints": [], "origins": [], "destinations": [], "startUrls": [], "maxItems": 100 } ``` # Actor output Schema ## `routes` (type: `string`): Dataset containing all scraped OSRM routing records (routes, matrices, nearest). # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "route", "profile": "driving", "startCoordinate": "51.5074,-0.1278", "endCoordinate": "48.8566,2.3522", "waypoints": [], "origins": [], "destinations": [], "startUrls": [], "maxItems": 100 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/osrm-route-planner").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "route", "profile": "driving", "startCoordinate": "51.5074,-0.1278", "endCoordinate": "48.8566,2.3522", "waypoints": [], "origins": [], "destinations": [], "startUrls": [], "maxItems": 100, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/osrm-route-planner").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "route", "profile": "driving", "startCoordinate": "51.5074,-0.1278", "endCoordinate": "48.8566,2.3522", "waypoints": [], "origins": [], "destinations": [], "startUrls": [], "maxItems": 100 }' | apify call crawlerbros/osrm-route-planner --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/osrm-route-planner", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OSRM Route Planner Scraper", "description": "Route planning, distance matrix, and nearest-road lookup via the free OSRM routing engine. Supports driving, cycling, and walking profiles. No auth or proxy required.", "version": "1.0", "x-build-id": "RtqQG61e3wQEdqHrf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~osrm-route-planner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-osrm-route-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~osrm-route-planner/runs": { "post": { "operationId": "runs-sync-crawlerbros-osrm-route-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~osrm-route-planner/run-sync": { "post": { "operationId": "run-sync-crawlerbros-osrm-route-planner", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "route", "matrix", "nearest" ], "type": "string", "description": "Operation mode: route planning, origin-destination matrix, or nearest-road lookup.", "default": "route" }, "profile": { "title": "Transport profile", "enum": [ "driving", "cycling", "walking" ], "type": "string", "description": "Routing profile to use.", "default": "driving" }, "startCoordinate": { "title": "Start coordinate", "type": "string", "description": "Starting point as 'lat,lon' (e.g. '51.5074,-0.1278'). Required for route and nearest modes." }, "endCoordinate": { "title": "End coordinate", "type": "string", "description": "Destination as 'lat,lon' (e.g. '48.8566,2.3522'). Required for route mode." }, "waypoints": { "title": "Intermediate waypoints", "type": "array", "description": "Optional intermediate stops as 'lat,lon' strings (route mode only). Example: ['52.5200,13.4050']", "default": [], "items": { "type": "string" } }, "origins": { "title": "Origins (matrix mode)", "type": "array", "description": "List of origin coordinates as 'lat,lon' strings for matrix mode.", "default": [], "items": { "type": "string" } }, "destinations": { "title": "Destinations (matrix mode)", "type": "array", "description": "List of destination coordinates as 'lat,lon' strings for matrix mode.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional OSRM API URLs to fetch directly. Overrides other inputs when provided.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 100 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```