Route Overview

Route Overview

Get route information between geographical points. Returns route geometry, distance, duration, and waypoints in polyline or GeoJSON format. Use for displaying routes, calculating distances, and showing ETAs.

note

Coordinates must be in "longitude,latitude" format.

Usage

import { createBarikoiClient } from "barikoiapis";

const barikoi = createBarikoiClient({
  apiKey: "YOUR_BARIKOI_API_KEY",
});

const result = await barikoi.routeOverview({
  coordinates: "90.4125,23.8103;90.4000,23.8000",
  geometries: "geojson",
});

const route = result.data?.routes?.[0];
const distanceKm = route.distance / 1000;
const durationMin = route.duration / 60;

Response

This API returns:

code, routes (array with geometry, legs, distance, duration, weight_name, weight), waypoints

Parameters

Parameter	Type	Description
coordinates	string	Required. Coordinates in format: longitude,latitude;longitude,latitude;...
geometries	string	Response geometry format: "polyline", "polyline6", or "geojson"
profile	string	Routing profile: "car" or "foot"

Example with GeoJSON Geometry

const result = await barikoi.routeOverview({
  coordinates: "90.4125,23.8103;90.4000,23.8000",
  geometries: "geojson",
  profile: "car",
});

const route = result.data?.routes?.[0];
const waypoints = result.data?.waypoints || [];

console.log(`Distance: ${(route?.distance / 1000).toFixed(2)} km`);
console.log(`Duration: ${(route?.duration / 60).toFixed(0)} minutes`);
console.log(`Waypoints: ${waypoints.length}`);

Type Definitions

export type RouteOverviewParams = {
  coordinates: string; // Format: longitude,latitude;longitude,latitude;...
  geometries?: "polyline" | "polyline6" | "geojson";
  profile?: "car" | "foot";
};

export type RouteOverviewSuccess = {
  code?: string;
  routes?: Array<{
    /**
     * Encoded polyline (string) or GeoJSON (object)
     */
    geometry?:
      | string
      | {
          [key: string]: unknown;
        };
    legs?: Array<{
      steps?: Array<unknown>;
      /**
       * Distance in meters
       */
      distance?: number;
      /**
       * Duration in seconds
       */
      duration?: number;
      summary?: string;
      weight?: number;
    }>;
    distance?: number;
    duration?: number;
    weight_name?: string;
    weight?: number;
  }>;
  waypoints?: Array<{
    hint?: string;
    distance?: number;
    name?: string | null;
    location?: [number, number];
  }>;
};