Overview
Distance Calculator works by calculating the distance between two locations based on their latitude and longitude coordinates. It uses advanced algorithms to calculate the distance accurately and returns the distance in miles and kilometers.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/distancecalculator?lat1=36.7783&lon1=-119.4179&lat2=34.0522&lon2=-118.2437" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/distancecalculator?lat1=36.7783&lon1=-119.4179&lat2=34.0522&lon2=-118.2437', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/distancecalculator?lat1=36.7783&lon1=-119.4179&lat2=34.0522&lon2=-118.2437",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/distancecalculator?lat1=36.7783&lon1=-119.4179&lat2=34.0522&lon2=-118.2437", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
lat1Required | number | The latitude of the first location range -90–90 |
lon1Required | number | The longitude of the first location range -180–180 |
lat2Required | number | The latitude of the second location range -90–90 |
lon2Required | number | The longitude of the second location range -180–180 |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"distanceMiles": 199.6804337234997,
"distanceKm": 321.2535462758628,
"location1": {
"latitude": "36.728450",
"longitude": "-119.53571",
"city": "Sanger",
"state": "California"
},
"location2": {
"latitude": "34.044662",
"longitude": "-118.24255",
"city": "Los Angeles",
"state": "California"
},
"bearing": 198,
"direction": "South",
"estimatedDriveTime": "5h 11m"
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
distanceMiles | number | 199.6804337234997 | Distance between the two locations in miles |
distanceKm | number | 321.2535462758628 | Great-circle distance between the two points in kilometres |
location1 | object | {...} | Resolved origin location |
latitude | string | "36.728450" | Latitude of the origin in decimal degrees |
longitude | string | "-119.53571" | Longitude of the origin in decimal degrees |
city | string | "Sanger" | City the origin resolves to |
state | string | "California" | State or region the origin resolves to |
location2 | object | {...} | Resolved destination location |
latitude | string | "34.044662" | Latitude of the destination in decimal degrees |
longitude | string | "-118.24255" | Longitude of the destination in decimal degrees |
city | string | "Los Angeles" | City the destination resolves to |
state | string | "California" | State or region the destination resolves to |
bearingPremium | number | 198 | Compass bearing in degrees (0-360) from location1 to location2 |
directionPremium | string | "South" | Cardinal direction: North, Northeast, East, Southeast, South, Southwest, West, Northwest |
estimatedDriveTimePremium | string | "5h 11m" | Estimated driving time (e.g., 3h 45m) |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Travel App
- Use the Distance Calculator API to calculate distance between locations for a travel app. Use the data to plan trips, estimate travel time, and optimize routes
- Logistics App
- Calculate distance between locations by using the Distance Calculator API for a logistics app. Use the data to optimize deliveries, track shipments, and manage routes
- Mapping App
- Use the Distance Calculator API to calculate distance between locations for a mapping app. Use the data to display distances, provide directions, and enhance user experience
- Geolocation
- Calculate distance between locations by using the Distance Calculator API for geolocation. Use the data to measure distances, track movements, and analyze locations
Other ways to use Distance Calculator
Set up Distance Calculator on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Geography: