Ola Map SDK Documentation

Welcome to the official documentation for the Ola Map SDK - a comprehensive Node.js client for the Ola Maps API.

Overview

The Ola Map SDK provides easy access to all Ola Maps API endpoints, including:

• Places API - Search, geocode, and get place details
• Routing API - Get directions, distance matrices, and route optimization
• Roads API - Snap to roads, find nearest roads, and get speed limits
• Geofencing API - Create and manage geographic fences
• Elevation API - Get elevation data for locations
• Tiles API - Access map tiles and static map images

Quick Start

Get up and running in minutes:

const OlaMapsClient = require('ola-map-sdk');

// Initialize the client
const client = new OlaMapsClient('YOUR_API_KEY');

// Search for places
const results = await client.places.autocomplete('Koramangala, Bangalore');

// Get directions
const route = await client.routing.getDirections(
    { lat: 12.993103, lon: 77.543326 },
    { lat: 12.972006, lon: 77.580085 }
);

Features

Core Documentation

• Installation Guide - Install and set up the SDK
• API Reference - Complete API documentation
• Places API - Search and geocoding features
• Routing API - Directions and route planning
• Map Display - Display maps with MapLibre GL
• Examples - Code examples and use cases

Getting Started

If you're new to Ola Map SDK, start here:

1. Installation Guide - Install the SDK and understand requirements
2. Authentication - Get your API key and authenticate
3. Quick Start Examples - Common use cases and patterns

Need Help?

• Check out the GitHub Repository
• Report issues on GitHub Issues
• View the npm package