GeoRoute - Documentation

string key = "{your-key}";
string routeStart = "34.1026760,-118.4524720";
string routeEnd = "33.78750,-117.93320"
string travelMode = "driving";
string optimize = "";
string distanceUnit = "mi";
string avoidOptions = "";
string transitDateTime = "";
string transitTimeMode = "departure";
string format = "json";
HttpResponseMessage message = null;
using (HttpClient client = new HttpClient())
{
	client.BaseAddress = new Uri("https://geodata.cdxtech.com");
	StringBuilder url = new StringBuilder("/api/georoute?");
	url.Append("key=").Append(key);
	url.Append("&routeStart=").Append(routeStart);
	url.Append("&routeEnd=").Append(routeEnd);
	url.Append("&travelMode=").Append(travelMode);
	url.Append("&optimize=").Append(optimize);
	url.Append("&distanceUnit=").Append(distanceUnit);
	url.Append("&avoidOptions=").Append(avoidOptions);
	url.Append("&transitDateTime=").Append(transitDateTime);
	url.Append("&transitTimeMode=").Append(transitTimeMode);
	url.Append("&format=").Append(format);
	message = client.GetAsync(url.ToString()).Result;
}

import requests

def get_georoute(
    api_key,
    route_start,
    route_end,
    travel_mode,
    optimize,
    distance_unit,
    avoid_options,
    transit_datetime,
    transit_time_mode,
    response_format="json",
):
    """Fetch route data using the generic georoute endpoint."""
    base_url = "https://geodata.cdxtech.com"
    endpoint = "/api/georoute"
    url = f"{base_url}{endpoint}"
    params = {
        "key": api_key,
        "routeStart": route_start,
        "routeEnd": route_end,
        "travelMode": travel_mode,
        "optimize": optimize,
        "distanceUnit": distance_unit,
        "avoidOptions": avoid_options,
        "transitDateTime": transit_datetime,
        "transitTimeMode": transit_time_mode,
        "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}"
    route_start = "34.1026760,-118.4524720"
    route_end = "33.78750,-117.93320"
    travel_mode = "driving"
    optimize = ""
    distance_unit = "mi"
    avoid_options = ""
    transit_datetime = ""
    transit_time_mode = "departure"
    fmt = "json"
    data = get_georoute(
        key,
        route_start,
        route_end,
        travel_mode,
        optimize,
        distance_unit,
        avoid_options,
        transit_datetime,
        transit_time_mode,
        fmt,
    )
    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_georoute(
    api_key: &str,
    route_start: &str,
    route_end: &str,
    travel_mode: &str,
    optimize: &str,
    distance_unit: &str,
    avoid_options: &str,
    transit_datetime: &str,
    transit_time_mode: &str,
    response_format: &str,
) -> Result> {
    let client = reqwest::blocking::Client::new();
    let resp = client
        .get("https://geodata.cdxtech.com/api/georoute")
        .query(&[
            ("key", api_key),
            ("routeStart", route_start),
            ("routeEnd", route_end),
            ("travelMode", travel_mode),
            ("optimize", optimize),
            ("distanceUnit", distance_unit),
            ("avoidOptions", avoid_options),
            ("transitDateTime", transit_datetime),
            ("transitTimeMode", transit_time_mode),
            ("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 route_start = "34.1026760,-118.4524720";
    let route_end = "33.78750,-117.93320";
    let travel_mode = "driving";
    let optimize = "";
    let distance_unit = "mi";
    let avoid_options = "";
    let transit_datetime = "";
    let transit_time_mode = "departure";
    let fmt = "json";

    match get_georoute(
        api_key,
        route_start,
        route_end,
        travel_mode,
        optimize,
        distance_unit,
        avoid_options,
        transit_datetime,
        transit_time_mode,
        fmt,
    ) {
        Ok(data) => println!("Response JSON:\n{}", serde_json::to_string_pretty(&data)?),
        Err(err) => eprintln!("Error fetching data: {}", err),
    }

    Ok(())
}

async function getGeoroute({
    key,
    routeStart,
    routeEnd,
    travelMode,
    optimize,
    distanceUnit,
    avoidOptions,
    transitDateTime,
    transitTimeMode,
    format = "json",
}) {
    const baseUrl = "https://geodata.cdxtech.com";
    const endpoint = "/api/georoute";
    const params = new URLSearchParams({
        key,
        routeStart,
        routeEnd,
        travelMode,
        optimize,
        distanceUnit,
        avoidOptions,
        transitDateTime,
        transitTimeMode,
        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 routeStart = "34.1026760,-118.4524720";
    const routeEnd = "33.78750,-117.93320";
    const travelMode = "driving";
    const optimize = "";
    const distanceUnit = "mi";
    const avoidOptions = "";
    const transitDateTime = "";
    const transitTimeMode = "departure";
    const format = "json";
    try {
        const data = await getGeoroute({
            key,
            routeStart,
            routeEnd,
            travelMode,
            optimize,
            distanceUnit,
            avoidOptions,
            transitDateTime,
            transitTimeMode,
            format,
        });
        console.log("Response:", data);
    } catch (err) {
        console.error("Error fetching data:", err);
    }
})();

Dim key As String = "{your-key}"
Dim routeStart As String = "34.1026760,-118.4524720";
Dim routeEnd As String = "33.78750,-117.93320"
Dim travelMode As String = "driving";
Dim optimize As String = "";
Dim distanceUnit As String = "mi";
Dim avoidOptions As String = "";
Dim transitDateTime As String = "";
Dim transitTimeMode As String = "departure";
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/georoute?")
	url.Append("key=").Append(key)
	url.Append("&routeStart=").Append(routeStart)
	url.Append("&travelMode=").Append(travelMode)
	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 routeStart As String
Dim routeEnd As String
Dim travelMode As String
Dim optimize As String
Dim distanceUnit As String
Dim avoidOptions As String
Dim transitDateTime As String
Dim transitTimeMode As String
Dim format As String
key = "{your-key}"
routeStart = "34.1026760,-118.4524720"
routeEnd = "33.78750,-117.93320"
travelMode = "driving"
format = "json"
Client.BaseUrl = "https://geodata.cdxtech.com/api/"
Request.Method = WebMethod.HttpGet
Request.ResponseFormat = WebFormat.Json
Request.Resource = "georoute?key={key}&routeStart={routeStart}&routeEnd={routeEnd}&travelMode={driving}&format={format}"
Request.AddUrlSegment "key", key
Request.AddUrlSegment "wayPoints", wayPoints
Request.AddUrlSegment "travelMode", travelMode
Request.AddUrlSegment "format", format 
	
Set Response = Client.Execute(Request)

{
	"service": "GeoRoute",
	"url": "https://geodata.cdxtech.com/api/georoute?key={your-key}&routeStart=34.1026760,-118.4524720&routeEnd=33.78750,-117.93320&travelMode=driving&optimize=&distanceUnit=mi&avoidOptions=&transitDateTime=&transitTimeMode=departure&format=json",
	"status": "Success",
	"tokenCharge": 2,
	"message": null,
	"totalResults": 1,
	"results": [{
		"travelDistance": 48.370019,
		"travelDuration": 3249.0
	}],
	"usage": {
		"used": 2597,
		"usedPercentage": 1.315582843,
		"remaining": 197403,
		"remainingPercentage": 98.684417157
	},
	"duration": 0.9913322,
	"timeStamp": "2017-07-24T09:55:29.5369088-04:00"
}

<Root>
  <Service>GeoRoute</Service>
  <Url>https://geodata.cdxtech.com/api/georoute?key={your-key}&amp;routeStart=34.1026760,-118.4524720&amp;routeEnd=33.78750,-117.93320&amp;travelMode=driving&amp;optimize=&amp;distanceUnit=mi&amp;avoidOptions=&amp;transitDateTime=&amp;transitTimeMode=departure&amp;format=xml</Url>
  <Status>Success</Status>
  <TokenCharge>2</TokenCharge>
  <Message />
  <TotalResults>1</TotalResults>
  <Results>
	<TravelDistance>48.370019</TravelDistance>
	<TravelDuration>3249</TravelDuration>
  </Results>
  <Usage>
	<Used>2599</Used>
	<UsedPercentage>1.316609338</UsedPercentage>
	<Remaining>197401</Remaining>
	<RemainingPercentage>98.683390662</RemainingPercentage>
  </Usage>
  <Duration>0.1123689</Duration>
  <TimeStamp>2017-07-24T09:55:31.9213573-04:00</TimeStamp>
</Root>