Token Usage : Documentation

Request Details

Example Request Url
https://geodata.cdxtech.com/api/utility/tokenusage?key={key}&details={details}&format={format}

	Description	Required	Default Value	Example
key	Authentication Key			key=dd76pxfi4feydh4bz_dtrjyf6flu4-987asdjhajkd555usds28ad984yhz
details	Flag to return full usage detail		0	details=1 (supported options: "true", "1", "yes", "on")
format	Output Formatting		json	format=json (supported formats: json, xml)

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 details = "1";
string format = "json";

HttpResponseMessage message = null;

using (HttpClient client = new HttpClient())
{
    client.BaseAddress = new Uri("https://geodata.cdxtech.com");

    StringBuilder url = new StringBuilder("/api/utility/tokenusage?");
    url.Append("key=").Append(key);
    url.Append("&details=").Append(details);
    url.Append("&format=").Append(format);

    message = client.GetAsync(url.ToString()).Result;
}

Python



import requests

def get_token_usage(api_key, details, response_format="json"):
    """Fetch token usage details using utility endpoint."""
    base_url = "https://geodata.cdxtech.com"
    endpoint = "/api/utility/tokenusage"
    url = f"{base_url}{endpoint}"
    params = {
        "key": api_key,
        "details": details,
        "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}"
    details = "1"
    format = "json"
    data = get_token_usage(key, details, format)
    import json
    if isinstance(data, (dict, list)):
        print(json.dumps(data, indent=2))
    else:
        print(data)

Rust



// 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_token_usage(
    api_key: &str,
    details: &str,
    response_format: &str,
) -> Result> {
    let client = reqwest::blocking::Client::new();
    let resp = client
        .get("https://geodata.cdxtech.com/api/utility/tokenusage")
        .query(&[
            ("key", api_key),
            ("details", details),
            ("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 details = "1";
    let format = "json";

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

    Ok(())
}

JavaScript



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

Visual Basic .NET



Dim key As String = "{your-key}"
Dim details As String = "1"
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/utility/tokenusage?")
    url.Append("key=").Append(key)
    url.Append("&details=").Append(details)
    url.Append("&format=").Append(format)

    message = client.GetAsync(url.ToString()).Result
End Using

VBA

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 details As String
Dim format As String

key = "{your-key}"
details = "1"
format = "json"

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

Request.Method = WebMethod.HttpGet
Request.ResponseFormat = WebFormat.Json
Request.Resource = "tokenusage?key={key}&details={details}&format={format}"
Request.AddUrlSegment "key", key
Request.AddUrlSegment "details", details 
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.

Json



{
  "service": "GeoDataUtility",
  "url": "https://geodata.cdxtech.com/api/utility/tokenusage?key={your-key}&details=1",
  "status": "Success",
  "tokenCharge": 0,
  "message": null,
  "totalResults": 1,
  "results": [
    {
      "service": "GeoGeneral",
      "requestUrl": "https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&zipcode=07869&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 1
    },
    {
      "service": "GeoZipListState",
      "requestUrl": "https://geodata.cdxtech.com/api/geozipliststate?key={your-key}&state=pa&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 100
    },
    {
      "service": "GeoGender",
      "requestUrl": "https://geodata.cdxtech.com/api/geogender?key={your-key}&zipcode=07869&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 1
    },
    {
      "service": "GeoRadius",
      "requestUrl": "https://geodata.cdxtech.com/api/georadius/?key={your-key}&zipcode=07869&mileage=3",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 3
    },
    {
      "service": "GeoGeneral",
      "requestUrl": "https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&zipcode=07869&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 1
    },
    {
      "service": "GeoRadius",
      "requestUrl": "https://geodata.cdxtech.com/api/georadius/?key={your-key}&zipcode=07869&mileage=3",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 3
    },
    {
      "service": "GeoRadius",
      "requestUrl": "https://geodata.cdxtech.com/api/georadius/?key={your-key}&zipcode=07869&mileage=3",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 3
    },
    {
      "service": "GeoZipListCity",
      "requestUrl": "https://geodata.cdxtech.com/api/geoziplistcity?key={your-key}&state=nj&county=morris&city=randolph&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 1
    },
    {
      "service": "GeoGeneral",
      "requestUrl": "https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&zipcode=07869&format=",
      "ipAddress": "127.0.0.1",
      "tokenCharge": 1
    }
  ],
  "usage": {
    "used": 100,
    "remaining": 1000
  },
  "duration": 0.0021103,
  "timeStamp": "2017-02-22T17:51:43.8377347-05:00"
}

Xml



<Root>
    <Service>GeoDataUtility</Service>
    <Url>https://geodata.cdxtech.com/api/utility/tokenusage?key={your-key}&amp;details=1&amp;format=xml</Url>
    <Status>Success</Status>
    <TokenCharge>0</TokenCharge>
    <Message />
    <TotalResults>1</TotalResults>
    <Results>
        <Service>GeoGeneral</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&amp;zipcode=07869&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>1</TokenCharge>
    </Results>
    <Results>
        <Service>GeoZipListState</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/geozipliststate?key={your-key}&amp;state=pa&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>100</TokenCharge>
    </Results>
    <Results>
        <Service>GeoGender</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/geogender?key={your-key}&amp;zipcode=07869&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>1</TokenCharge>
    </Results>
    <Results>
        <Service>GeoRadius</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/georadius/?key={your-key}&amp;zipcode=07869&amp;mileage=3</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>3</TokenCharge>
    </Results>
    <Results>
        <Service>GeoGeneral</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&amp;zipcode=07869&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>1</TokenCharge>
    </Results>
    <Results>
        <Service>GeoRadius</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/georadius/?key={your-key}&amp;zipcode=07869&amp;mileage=3</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>3</TokenCharge>
    </Results>
    <Results>
        <Service>GeoRadius</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/georadius/?key={your-key}&amp;zipcode=07869&amp;mileage=3</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>3</TokenCharge>
    </Results>
    <Results>
        <Service>GeoZipListCity</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/geoziplistcity?key={your-key}&amp;state=nj&amp;county=morris&amp;city=randolph&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>1</TokenCharge>
    </Results>
    <Results>
        <Service>GeoGeneral</Service>
        <RequestUrl>https://geodata.cdxtech.com/api/GeoGeneral?key={your-key}&amp;zipcode=07869&amp;format=</RequestUrl>
        <IpAddress>127.0.0.1</IpAddress>
        <TokenCharge>1</TokenCharge>
    </Results>
    <Usage>
        <Used>100</Used>
        <Remaining>1000</Remaining>
    </Usage>
    <Duration>0.0017093</Duration>
    <TimeStamp>2017-02-22T17:56:50.885135-05:00</TimeStamp>
</Root>