Distance Calculator
Distance Calculator is a simple tool for calculating the distance between two locations. It returns the distance in miles and kilometers.
This API provides reliable and fast access to distance calculator data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.
View API in DirectoryEndpoint
GET https://api.apiverve.com/v1/distancecalculatorCode Examples
Here are examples of how to call this API in different programming languages:
curl -X GET \
"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 response = await fetch('https://api.apiverve.com/v1/distancecalculator', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/distancecalculator', headers=headers)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const req = https.request('https://api.apiverve.com/v1/distancecalculator', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.end();<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/distancecalculator');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/distancecalculator", nil)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/distancecalculator')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))Authentication
This API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereParameters
The following parameters are available for this API endpoint:
| Parameter | Type | Required | Location | Description | Example |
|---|---|---|---|---|---|
| lat1 | number | Yes | query | The latitude of the first location | 36.7783 |
| lon1 | number | Yes | query | The longitude of the first location | -119.4179 |
| lat2 | number | Yes | query | The latitude of the second location | 34.0522 |
| lon2 | number | Yes | query | The longitude of the second location | -118.2437 |
Response
The API returns responses in JSON, XML, and YAML formats:
Example Responses
{
"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"
}
}
}<Root>
<status>ok</status>
<error />
<data>
<distanceMiles>199.6804337234997</distanceMiles>
<distanceKm>321.25354627586279</distanceKm>
<location1>
<latitude>36.728450</latitude>
<longitude>-119.53571</longitude>
<city>Sanger</city>
<state>California</state>
</location1>
<location2>
<latitude>34.044662</latitude>
<longitude>-118.24255</longitude>
<city>Los Angeles</city>
<state>California</state>
</location2>
</data>
</Root>status: ok
error:
data:
distanceMiles: 199.6804337235
distanceKm: 321.253546275863
location1:
latitude: 36.728450
longitude: -119.53571
city: Sanger
state: California
location2:
latitude: 34.044662
longitude: -118.24255
city: Los Angeles
state: CaliforniaResponse Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
| error | string | null | Contains error message if status is "error", otherwise null | null |
| data | object | null | Contains the API response data if successful, otherwise null | {...} |
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value |
|---|---|---|
| distanceMiles | number | 199.6804337234997 |
| distanceKm | number | 321.2535462758628 |
| location1 | object | {...} |
| location1.latitude | string | "36.728450" |
| location1.longitude | string | "-119.53571" |
| location1.city | string | "Sanger" |
| location1.state | string | "California" |
| location2 | object | {...} |
| location2.latitude | string | "34.044662" |
| location2.longitude | string | "-118.24255" |
| location2.city | string | "Los Angeles" |
| location2.state | string | "California" |
Headers
Required and optional headers for API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
| X-API-Key | Yes | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
| Accept | No | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
| User-Agent | No | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
| X-Request-ID | No | req_123456789 | Custom request identifier for tracking and debugging requests |
| Cache-Control | No | no-cache | Control caching behavior for the request and response |
Client Libraries
To get started with minimal code, most of our APIs are available through client libraries and clients:
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
| Status Code | Message | Description |
|---|---|---|
| 200 | OK | Request successful, data returned |
| 400 | Bad Request | Invalid request parameters or malformed request |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key does not have permission for this endpoint |
| 429 | Too Many Requests | Rate limit exceeded, please slow down requests |
| 500 | Internal Server Error | Server error, please try again later |
Was this page helpful?
Help us improve our documentation




