docs.geocoding

Geocoding API

Revolutionary geocoding for India with DigiPin support and administrative boundary lookup — get state, division, locality, and pincode from any coordinates.

Authentication

All authenticated endpoints require an API key in the x-api-key header. Create a key in the developer dashboard.

Never expose API keys in client-side code for server-only workflows. For browser widgets like checkout, use a public key scoped to your domain.

Quick start

Convert latitude and longitude to a DigiPin code in one request:

bash
curl -X POST https://api.quantaroute.com/v1/digipin/coordinates-to-digipin \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"latitude": 28.6139, "longitude": 77.2090}'

Geocoding

Convert addresses and coordinates to DigiPin codes, autocomplete addresses, and batch geocode.

POST/v1/digipin/geocodex-api-key

Address to DigiPin

Convert a free-form address to a DigiPin code with coordinates and confidence score.

request

json
{
  "address": "Nirman Bhawan, New Delhi",
  "city": "New Delhi",
  "state": "Delhi",
  "pincode": "110011",
  "country": "India"
}

response

json
{
  "success": true,
  "data": {
    "digipin": "39J-438-TJC7",
    "coordinates": {
      "latitude": 28.6139,
      "longitude": 77.2090
    },
    "address": "Nirman Bhawan, New Delhi",
    "confidence": 0.95
  }
}
POST/v1/digipin/coordinates-to-digipinx-api-key

Coordinates to DigiPin

Convert latitude and longitude to a DigiPin code. Used by the checkout widget when a user confirms a map pin.

request

json
{
  "latitude": 28.6139,
  "longitude": 77.2090
}

response

json
{
  "success": true,
  "data": {
    "digipin": "39J-438-TJC7",
    "coordinates": {
      "latitude": 28.6139,
      "longitude": 77.2090
    }
  }
}
GET/v1/digipin/autocompletex-api-key

Address autocomplete

Return address suggestions for a search query. Pass the user's current lat/lng to enable location-biased results and near me / nearby keyword support.

query parameters

NameRequiredDescription
qYesSearch query (minimum 3 characters). Supports "near me" / "nearby" when lat+lng are provided.
limitNoMaximum suggestions (default 5, max 10).
latNoUser latitude. Biases results within ~50 km. Required for near me searches.
lngNoUser longitude. Biases results within ~50 km. Required for near me searches.
POST/v1/digipin/batchx-api-key

Batch geocoding

Geocode up to 100 addresses in a single request.

request

json
{
  "addresses": [
    { "address": "Connaught Place, New Delhi" },
    { "address": "MG Road, Bengaluru", "city": "Bengaluru", "state": "Karnataka" }
  ]
}

Reverse geocoding

Convert DigiPin codes back to coordinates and structured address data.

POST/v1/digipin/reversex-api-key

DigiPin to coordinates

Reverse geocode a DigiPin code to coordinates and address details.

request

json
{
  "digipin": "39J-438-TJC7"
}

Location lookup

Administrative boundary lookup — state, district, division, locality, pincode, and delivery status from coordinates or DigiPin.

POST/v1/location/lookupx-api-key

Boundary lookup

Look up administrative boundaries from coordinates or a DigiPin. Provide either latitude+longitude or digipin.

request

json
{
  "latitude": 28.6139,
  "longitude": 77.2090
}

response

json
{
  "success": true,
  "data": {
    "state": "Delhi",
    "district": "New Delhi",
    "division": "New Delhi Central",
    "locality": "Nirman Bhawan SO",
    "pincode": "110011",
    "delivery": "Delivery"
  }
}
POST/v1/location/batch-lookupx-api-key

Batch boundary lookup

Look up administrative boundaries for multiple coordinates or DigiPin values in one request.

GET/v1/location/statsx-api-key

Boundary statistics

Get statistics about location boundaries and cache status.

Validation

Validate DigiPin format and Indian pincodes against the postal database.

GET/v1/digipin/validate/{digipin}x-api-key

Validate DigiPin

Validate DigiPin format and check whether it corresponds to a real location.

GET/v1/pincode/validate/{pincode}x-api-key

Validate pincode

Validate a 6-digit Indian pincode against the postal database. Used by the checkout widget to block invalid pincodes.

Official DigiPin compatibility

India Post–compatible encode and decode endpoints for interoperability with the official DigiPin specification.

GET/v1/digipin/encodex-api-key

Encode (official)

Convert latitude and longitude to DigiPin using the official API-compatible format.

query parameters

NameRequiredDescription
latitudeYesLatitude coordinate.
longitudeYesLongitude coordinate.
GET/v1/digipin/decodex-api-key

Decode (official)

Convert a DigiPin code to latitude and longitude using the official API-compatible format.

query parameters

NameRequiredDescription
digipinYesThe DigiPin code to decode.

Usage & monitoring

GET/v1/digipin/usagex-api-key

API usage

Get usage information for the authenticated API key. Track request counts against your plan limits from the dashboard or programmatically.

Error responses

Failed requests return a JSON body with error, message, and code fields. Common status codes:

StatusMeaning
400Invalid request — missing or malformed parameters.
401Missing or invalid API key.
429Rate limit exceeded — retry after backoff.

Need the full OpenAPI spec?

Explore every schema, try requests live, and download the spec from Swagger UI.

Open interactive docs