GeoGeneralCanadian - Documentation

string key = "{your-key}";
string postalcode = "J7M 1X8";
string format = "json";

HttpResponseMessage message = null;

using (HttpClient client = new HttpClient())
{
    client.BaseAddress = new Uri("https://geodata.cdxtech.com");
    
    StringBuilder url = new StringBuilder("/api/geocanadiangeneral?");
    url.Append("key=").Append(key);
    url.Append("&postalcode=").Append(postalCode);
    url.Append("&format=").Append(format);
    
    message = client.GetAsync(url.ToString()).Result;
}

import requests

def get_geocanadiangeneral(api_key, postalcode, response_format="json"):
    """Fetch Canadian general geocode data using the API."""
    base_url = "https://geodata.cdxtech.com"
    endpoint = "/api/geocanadiangeneral"
    url = f"{base_url}{endpoint}"
    params = {
        "key": api_key,
        "postalcode": postalcode,
        "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}"
    postalcode = "J7M 1X8"
    format = "json"
    data = get_geocanadiangeneral(key, postalcode, 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_geocanadiangeneral(
    api_key: &str,
    postalcode: &str,
    response_format: &str,
) -> Result> {
    let client = reqwest::blocking::Client::new();
    let resp = client
        .get("https://geodata.cdxtech.com/api/geocanadiangeneral")
        .query(&[
            ("key", api_key),
            ("postalcode", postalcode),
            ("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 postalcode = "J7M 1X8";
    let format = "json";

    match get_geocanadiangeneral(api_key, postalcode, format) {
        Ok(data) => println!("Response JSON:\n{}", serde_json::to_string_pretty(&data)?),
        Err(err) => eprintln!("Error fetching data: {}", err),
    }

    Ok(())
}

async function getGeoCanadianGeneral({ key, postalcode, format = "json" }) {
    const baseUrl = "https://geodata.cdxtech.com";
    const endpoint = "/api/geocanadiangeneral";
    const params = new URLSearchParams({ key, postalcode, 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 postalcode = "J7M 1X8";
    const format = "json";
    try {
        const data = await getGeoCanadianGeneral({ key, postalcode, format });
        console.log("Response:", data);
    } catch (err) {
        console.error("Error fetching data:", err);
    }
})();

Dim key As String = "{your-key}"
Dim postalcode As String = "J7M 1X8"
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/geocanadiangeneral?")
    url.Append("key=").Append(key)
    url.Append("&postalcode=").Append(postalCode)
    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 postalcode As String
Dim format As String

key = "{your-key}"
postalcode = "J7M 1X8"
format = "json"

Client.BaseUrl = "https://geodata.cdxtech.com/api/"

Request.Method = WebMethod.HttpGet
Request.ResponseFormat = WebFormat.Json
Request.Resource = "geocanadiangeneral?key={key}&postalcode={postalCode}&format={format}"
Request.AddUrlSegment "key", key
Request.AddUrlSegment "postalCode", postalcode 
Request.AddUrlSegment "format", format 
    
Set Response = Client.Execute(Request)

{
    "service": "GeoGeneral",
    "url": "https://geodata.cdxtech.com/api/geocanadiangeneral?key={your-key}&postalcode=J7M%201X8&format=json",
    "status": "Success",
    "tokenCharge": 1,
    "message": null,
    "totalResults": 1,
    "results": {
        "postalCode": "J7M 1X8",
        "city": "Terrebonne",
        "cityAliasName": "Terrebonne",
        "provinceFullName": "Quebec",
        "province": "QC",
        "latitude": "45.76754",
        "longitude": "-73.70935"
    },
    "usage": {
        "used": 100,
        "remaining": 1000
    },
    "duration": 0.21330259999999998,
    "timeStamp": "2017-02-02T15:59:10.5668527-05:00"
}

<Root>
  <Service>GeoGeneral</Service>
  <Url>https://geodata.cdxtech.com/api/geocanadiangeneral?key={your-key}&postalcode=J7M%201X8&format=xml</Service>
  <Status>Success</Status>
  <TokenCharge>1</TokenCharge>
  <Message />
  <TotalResults>1</TotalResults>
  <Results>
    <PostalCode>J7M 1X8</PostalCode>
    <City>Terrebonne</City>
    <CityAliasName>Terrebonne</CityAliasName>
    <ProvinceFullName>Quebec</ProvinceFullName>
    <Province>QC</Province>
    <Latitude>45.76754</Latitude>
    <Longitude>-73.70935</Longitude>
  </Results>
  <Usage>
    <Used>100</Used>
    <Remaining>1000</Remaining>
  </Usage>
  <Duration>0.036340399999999995</Duration>
  <TimeStamp>2017-02-02T15:59:13.709104-05:00</TimeStamp>
</Root>