Calculate the straight-line (as-the-crow-flies) distance between U.S. ZIP Codes. Calculations use the centroid point of each ZIP Code area. Distance is provided in miles, kilometers, or nautical miles.
Request Details
Example Request Url
https://geodata.cdxtech.com/api/geodistance?key={key}&zipcode1={zipcode1}&zipcode2={zipcode2}&format={format}
Description | Required | Default Value | Example | |
key | Authentication Key | key=dd76pxfi4feydh4bz_dtrjyf6flu4-987asdjhajkd555usds28ad984yhz | ||
zipcode1 | 1st Zip Code Reference | zipcode1=07869 | ||
zipcode2 | 2nd Zip Code Reference | zipcode2=07840 | ||
format | Output Formatting | json | format=json (supported formats: json, xml, csv) |
Coding Examples
Here are some coding examples to get you started. Please feel free to contact support if you need additional assistance.
string key = "{your-key}";
string zipcode1 = "07869";
string zipcode2 = "07840";
string format = "json";
HttpResponseMessage message = null;
using (HttpClient client = new HttpClient())
{
client.BaseAddress = new Uri("https://geodata.cdxtech.com");
StringBuilder url = new StringBuilder("/api/geodistance?");
url.Append("key=").Append(key);
url.Append("&zipcode1=").Append(zipcode1);
url.Append("&zipcode2=").Append(zipcode2);
url.Append("&format=").Append(format);
message = client.GetAsync(url.ToString()).Result;
}
import requests
def get_geodistance(api_key, zipcode1, zipcode2, response_format="json"):
"""Fetch distance between two ZIP codes using the API."""
base_url = "https://geodata.cdxtech.com"
endpoint = "/api/geodistance"
url = f"{base_url}{endpoint}"
params = {
"key": api_key,
"zipcode1": zipcode1,
"zipcode2": zipcode2,
"format": response_format,
}
response = requests.get(url, params=params)
response.raise_for_status()
try:
return response.json()
except ValueError:
return response.text
if __name__ == "__main__":
key = "{your-key}"
zipcode1 = "07869"
zipcode2 = "07840"
format = "json"
data = get_geodistance(key, zipcode1, zipcode2, format)
import json
if isinstance(data, (dict, list)):
print(json.dumps(data, indent=2))
else:
print(data)
// Cargo.toml
// [dependencies]
// reqwest = { version = "0.11", features = ["blocking", "json"] }
// serde = { version = "1.0", features = ["derive"] }
// serde_json = "1.0"
use std::error::Error;
fn get_geodistance(
api_key: &str,
zipcode1: &str,
zipcode2: &str,
response_format: &str,
) -> Result> {
let client = reqwest::blocking::Client::new();
let resp = client
.get("https://geodata.cdxtech.com/api/geodistance")
.query(&[
("key", api_key),
("zipcode1", zipcode1),
("zipcode2", zipcode2),
("format", response_format),
])
.send()?
.error_for_status()?;
let json: serde_json::Value = resp.json()?;
Ok(json)
}
fn main() -> Result<(), Box> {
let api_key = "{your-key}";
let zipcode1 = "07869";
let zipcode2 = "07840";
let format = "json";
match get_geodistance(api_key, zipcode1, zipcode2, format) {
Ok(data) => println!("Response JSON:\n{}", serde_json::to_string_pretty(&data)?),
Err(err) => eprintln!("Error fetching data: {}", err),
}
Ok(())
}
async function getGeodistance({ key, zipcode1, zipcode2, format = "json" }) {
const baseUrl = "https://geodata.cdxtech.com";
const endpoint = "/api/geodistance";
const params = new URLSearchParams({ key, zipcode1, zipcode2, format });
const url = `${baseUrl}${endpoint}?${params.toString()}`;
const response = await fetch(url);
if (!response.ok) {
throw new Error(`HTTP error! Status: ${response.status}`);
}
const text = await response.text();
try {
return JSON.parse(text);
} catch {
return text;
}
}
// Example usage:
(async () => {
const key = "{your-key}";
const zipcode1 = "07869";
const zipcode2 = "07840";
const format = "json";
try {
const data = await getGeodistance({ key, zipcode1, zipcode2, format });
console.log("Response:", data);
} catch (err) {
console.error("Error fetching data:", err);
}
})();
Dim key As String = "{your-key}"
Dim zipcode1 As String = "07869"
Dim zipcode2 As String = "07840"
Dim format As String = "json"
Dim message As HttpResponseMessage = Nothing
Using client As New HttpClient()
client.BaseAddress = New Uri("https://geodata.cdxtech.com")
Dim url As New StringBuilder("/api/geodistance?")
url.Append("key=").Append(key)
url.Append("&zipcode1=").Append(zipCode1)
url.Append("&zipcode2=").Append(zipCode2)
url.Append("&format=").Append(format)
message = client.GetAsync(url.ToString()).Result
End Using
The following is for the VBA-WEB Excel template available at http://vba-tools.github.io/VBA-Web/
Dim Client As New WebClient
Dim Request As New WebRequest
Dim key As String
Dim zipcode1 As String
Dim zipCode2 AS String
Dim format As String
key = "{your-key}"
zipcode1 = "07869"
zipCode2 = "07840"
format = "json"
Client.BaseUrl = "https://geodata.cdxtech.com/api/"
Request.Method = WebMethod.HttpGet
Request.ResponseFormat = WebFormat.Json
Request.Resource = "geodistance?key={key}&zipcode={zipCode}&format={format}"
Request.AddUrlSegment "key", key
Request.AddUrlSegment "zipCode1", zipcode1
Request.AddUrlSegment "zipCode2", zipcode2
Request.AddUrlSegment "format", format
Set Response = Client.Execute(Request)
Output Examples
Here are some output data examples. You can also use the Report Generator tab to export specific data files.
{
"service": "GeoDistance",
"url": "https://geodata.cdxtech.com/api/geodistance?key={your-key}&zipcode1=07869&zipcode2=07840&format=json",
"status": "Success",
"tokenCharge": 1,
"message": null,
"totalResults": 1,
"results": [{
"coordinates": [{
"zipCode": "07869",
"latitude": 40.842115,
"longitude": -74.58229
},
{
"zipCode": "07840",
"latitude": 40.864954,
"longitude": -74.822685
}],
"distance": 12.6614,
"distanceUnit": "miles"
}],
"usage": {
"used": 100,
"remaining": 1000
},
"duration": 0.0882471,
"timeStamp": "2017-02-02T15:33:41.0854463-05:00"
}
<Root>
<Service>GeoDistance</Service>
<Url>https://geodata.cdxtech.com/api/geodistance?key={your-key}&zipcode1=07869&zipcode2=07840&format=xml</Url>
<Status>Success</Status>
<TokenCharge>1</TokenCharge>
<Message />
<TotalResults>1</TotalResults>
<Results>
<Coordinates>
<ZipCode>07869</ZipCode>
<Latitude>40.842115</Latitude>
<Longitude>-74.58229</Longitude>
</Coordinates>
<Coordinates>
<ZipCode>07840</ZipCode>
<Latitude>40.864954</Latitude>
<Longitude>-74.822685</Longitude>
</Coordinates>
<Distance>12.6614</Distance>
<DistanceUnit>miles</DistanceUnit>
</Results>
<Usage>
<Used>100</Used>
<Remaining>1000</Remaining>
</Usage>
<Duration>0.0683063</Duration>
<TimeStamp>2017-02-02T15:33:43.078064-05:00</TimeStamp>
</Root>