Routestripe API
MainKnowledge BaseSupport CentreAPI Reference
MainKnowledge BaseSupport CentreAPI Reference
  1. Introduction
  • Introduction
    • What Is RouteStripe
    • Quick Start Guide
    • API Parameters
  • Default module
    • Get optimized locations
      POST
  • Management API
    • Visits
      • Store Visit
      • Update Visit by field
      • Get Visit
      • Get Visits
      • Delete Visit
    • Attachments
      • Store Attachment
      • Get Attachments
      • Get Attachment Image
      • Delete Attachment
    • Warehouses
      • Store Warehouse
      • Update Warehouse by field
      • Get Warehouse
      • Get Warehouses
      • Delete Warehouse
    • Vehicles
      • Store Vehicle
      • Update Vehicle by field
      • Get Vehicle
      • Get Vehicles
      • Delete Vehicle
    • Members
      • Store Member
      • Update Member by field
      • Get Member
      • Get Members
      • Delete Member
    • Plans
      • Store Plan
      • Update Plan by field
      • Get Plan
      • Get Plans.
      • Delete Plan
    • Routes
      • Store Route
      • Update Route by field
      • Get Route
      • Get Routes
      • Delete Route
    • Companies
      • Get Company
      • Update Company by field
    • Countries
      • Get Countries
  • Webhooks
    • Webhooks & Real-time Updates
  1. Introduction

Quick Start Guide

This page gives the information on how to start using RouteStripe API.

Getting Started#

The RouteStripe API key is required for all API calls. Follow these steps to set up and start using the API:
1.
Sign In or Create an Account
Visit RouteStripe Sign-Up Page and log in or create a new account.
{E9133944-4E0E-426E-B843-F04EDCF00AC8}.png
2.
Create a Company
In your dashboard, create or select a company for which you want to use the RouteStripe API.
image.png
3.
Access the API Section
Navigate to the API section in your dashboard side menu to proceed.
image.png
4.
Copy Your API Key
Copy the API key. Note that the API is available during your trial period.
image.png
5.
Explore Additional Information
You can view Billing Info and Calculation History in the dashboard for insights into your API usage.

Making API Calls#

Authentication#

Use your API key for authenticating all requests.
Here is an example of a cURL command to make an API call:

Request and Response Single Driver Example#

Request
Response
  {
"fleet": {
    "99": {
        "load": 0,
        "profile": "auto",
        "shift_end": "21:00",
        "vehicle_id": 55,
        "shift_start": "08:00",
        "max_distance": 1001000,
        "speed_factor": 1,
        "start_location": {
            "id": "start_location_50.426195_30.538123",
            "lat": 50.426195,
            "lng": 30.538123,
            "name": "start_location_50.426195_30.538123"
        }
    }
},
"visits": {
    "562": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.424083,
            "lng": 30.532379
        }
    },
    "563": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.472606,
            "lng": 30.498047
        }
    },
    "822": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.466693,
            "lng": 30.487747
        }
    }
},
"options": {
    "polylines": true,
    "avoid_tolls": false,
    "avoid_highways": true,
    "squash_duration": "1.00",
    "visit_balance_coefficient": 0
},
"country_id": 1
}

Request and Response Multiple Drivers Example#

Request
Response
{
"fleet": {
    "99": {
        "load": 0,
        "profile": "auto",
        "shift_end": "21:00",
        "vehicle_id": 55,
        "shift_start": "08:00",
        "max_distance": 1001000,
        "speed_factor": 1,
        "start_location": {
            "id": "start_location_50.426195_30.538123",
            "lat": 50.426195,
            "lng": 30.538123,
            "name": "start_location_50.426195_30.538123"
        }
    },
    "111": {
        "load": 100,
        "profile": "auto",
        "capacity": 5,
        "shift_end": "20:11",
        "vehicle_id": 1,
        "shift_start": "13:01",
        "max_distance": 1001000,
        "speed_factor": 1,
        "start_location": {
            "id": "start_location_50.426195_30.538123",
            "lat": 50.426195,
            "lng": 30.538123,
            "name": "start_location_50.426195_30.538123"
        }
    }
},
"visits": {
    "562": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.424083,
            "lng": 30.532379
        }
    },
    "563": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.472606,
            "lng": 30.498047
        }
    },
    "822": {
        "end": "20:00",
        "load": 0,
        "type": "D",
        "start": "08:00",
        "capacity": 0,
        "duration": 5,
        "location": {
            "lat": 50.466693,
            "lng": 30.487747
        }
    }
},
"options": {
    "polylines": true,
    "avoid_tolls": false,
    "avoid_highways": true,
    "squash_duration": "1.00",
    "visit_balance_coefficient": 0
},
"country_id": 1
}
Modified at 2026-04-21 08:52:10
Previous
What Is RouteStripe
Next
API Parameters
Built with