Credit API (Credit Remaining)

Q: How do I authenticate to Credit in REST and SOAP?

For REST, send your TrackServiceKey in the X-API-Key header on POST /rest/Credit. For SOAP, send your TrackServiceKey in SessionIDHeader as SessionID for each CreditRemaining call.

Q: What does CreditRemaining return?

CreditRemaining returns a CreditResult that includes the Credit integer, which is your remaining API credit balance.

Use Credit to check how much API credit remains for your TrackServiceKey. REST returns CreditResult. SOAP uses CreditRemaining.

Check your remaining API credit using REST POST /rest/Credit or SOAP CreditRemaining.

Need the full contract?

Swagger includes the REST model (CreditResult) and endpoint details. SOAP is available via WSDL.

View Swagger UI View SOAP WSDL API Reference Overview

What Credit does
Endpoints and base URLs
Authentication (REST & SOAP)
Request schema
Response schema
Examples
Common errors
Best practices
Related endpoints
FAQ

What Credit does#

Credit returns your remaining balance for the current API key. It helps you monitor usage and avoid failures in high-volume jobs such as bulk geocoding, batch route generation, and dispatch optimization.

REST: POST /rest/Credit. SOAP: CreditRemaining.

Endpoints and base URLs#

REST (JSON)

Item	Value
Base URL	https://ts6.trackroad.com
Endpoint	`POST /rest/Credit`
Full URL	https://ts6.trackroad.com/rest/Credit
Produces	`application/json` (XML is also supported)
Body	No body

SOAP (CreditRemaining)

Item	Value
SOAP URL	https://ts6.trackroad.com/TrackService.asmx
WSDL	https://ts6.trackroad.com/TrackService.asmx?WSDL
Method	`CreditRemaining`
SOAPAction	http://TrackService.TrackRoad.com/CreditRemaining
SOAP 1.1 Content-Type	`text/xml; charset=utf-8`
SOAP 1.2 Content-Type	`application/soap+xml; charset=utf-8`

Recommended: use REST unless you must integrate with an existing SOAP-only system.

Authentication (REST & SOAP)#

REST authentication (X-API-Key)

Send your TrackServiceKey in the X-API-Key header on every REST request. See API Authentication .

SOAP authentication (SessionIDHeader)

SOAP requests use SessionIDHeader. Send your TrackServiceKey as SessionID for each CreditRemaining call.

Request schema#

REST request

REST Credit is a POST request with no request body. Authentication is provided through the X-API-Key header.

SOAP request

SOAP uses the CreditRemaining method together with a SessionIDHeader.

Response schema#

CreditResult (REST + SOAP)

Property	Type	Description
`Credit`	int	Remaining credit balance.
`Errors`	Error[]	Errors or warnings, if any.
`Status`	int (enum)	0=None, 1=Success, 2=Failed, 3=SuccessWithErrors.

The same result concept is used across REST and SOAP, making it easy to monitor remaining API credit in different integration stacks.

Examples#

REST request examples

curl -X POST "https://ts6.trackroad.com/rest/Credit" \
  -H "X-API-Key: YOUR_TRACKSERVICEKEY"

using System.Net.Http;

var url = "https://ts6.trackroad.com/rest/Credit";
using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-API-Key", "YOUR_TRACKSERVICEKEY");

var resp = await http.PostAsync(url, null);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://ts6.trackroad.com/rest/Credit";

const res = await fetch(url, {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_TRACKSERVICEKEY"
  }
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    Request request = new Request.Builder()
      .url("https://ts6.trackroad.com/rest/Credit")
      .post(RequestBody.create(new byte[0], null))
      .addHeader("X-API-Key", "YOUR_TRACKSERVICEKEY")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://ts6.trackroad.com/rest/Credit"
headers = {"X-API-Key": "YOUR_TRACKSERVICEKEY"}

r = requests.post(url, headers=headers)
print(r.text)

<?php
$url = "https://ts6.trackroad.com/rest/Credit";

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "X-API-Key: YOUR_TRACKSERVICEKEY"
  ]
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

uri = URI("https://ts6.trackroad.com/rest/Credit")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

req = Net::HTTP::Post.new(uri)
req["X-API-Key"] = "YOUR_TRACKSERVICEKEY"

res = http.request(req)
puts res.body

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://ts6.trackroad.com/rest/Credit"
  req, _ := http.NewRequest("POST", url, nil)
  req.Header.Set("X-API-Key", "YOUR_TRACKSERVICEKEY")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://ts6.trackroad.com/rest/Credit"
  val client = HttpClient.newHttpClient()

  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("X-API-Key", "YOUR_TRACKSERVICEKEY")
    .POST(HttpRequest.BodyPublishers.noBody())
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://ts6.trackroad.com/rest/Credit";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_POST, 1L);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://ts6.trackroad.com/rest/Credit";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "X-API-Key: YOUR_TRACKSERVICEKEY");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_POST, 1L);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://ts6.trackroad.com/rest/Credit"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"YOUR_TRACKSERVICEKEY" forHTTPHeaderField:@"X-API-Key"];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req
      completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://ts6.trackroad.com/rest/Credit")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("YOUR_TRACKSERVICEKEY", forHTTPHeaderField: "X-API-Key")

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

SOAP request examples

curl -X POST "https://ts6.trackroad.com/TrackService.asmx" \
  -H "Content-Type: text/xml; charset=utf-8" \
  -H "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining" \
  -d @creditRemaining.xml

using System.Net.Http;
using System.Text;

var url = "https://ts6.trackroad.com/TrackService.asmx";

var soap = @"<?xml version=""1.0"" encoding=""utf-8""?>
<soap:Envelope xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance""
               xmlns:xsd=""http://www.w3.org/2001/XMLSchema""
               xmlns:soap=""http://schemas.xmlsoap.org/soap/envelope/"">
  <soap:Header>
    <SessionIDHeader xmlns=""http://TrackService.TrackRoad.com/"">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns=""http://TrackService.TrackRoad.com/"" />
  </soap:Body>
</soap:Envelope>";

using var http = new HttpClient();
var content = new StringContent(soap, Encoding.UTF8, "text/xml");
content.Headers.Add("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining");

var resp = await http.PostAsync(url, content);
Console.WriteLine(await resp.Content.ReadAsStringAsync());

const url = "https://ts6.trackroad.com/TrackService.asmx";

const soap = `<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>`;

const res = await fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "text/xml; charset=utf-8",
    "SOAPAction": "http://TrackService.TrackRoad.com/CreditRemaining"
  },
  body: soap
});

console.log(await res.text());

import okhttp3.*;

public class Main {
  public static void main(String[] args) throws Exception {
    OkHttpClient client = new OkHttpClient();

    String soap =
      "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    + "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    + " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    + " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    + " <soap:Header>"
    + "  <SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    + "   <SessionID>YOUR_TRACKSERVICEKEY</SessionID>"
    + "  </SessionIDHeader>"
    + " </soap:Header>"
    + " <soap:Body>"
    + "  <CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" />"
    + " </soap:Body>"
    + "</soap:Envelope>";

    RequestBody body = RequestBody.create(soap, MediaType.parse("text/xml; charset=utf-8"));
    Request request = new Request.Builder()
      .url("https://ts6.trackroad.com/TrackService.asmx")
      .post(body)
      .addHeader("Content-Type", "text/xml; charset=utf-8")
      .addHeader("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")
      .build();

    try (Response response = client.newCall(request).execute()) {
      System.out.println(response.body().string());
    }
  }
}

import requests

url = "https://ts6.trackroad.com/TrackService.asmx"
soap = """<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
"""

headers = {
  "Content-Type": "text/xml; charset=utf-8",
  "SOAPAction": "http://TrackService.TrackRoad.com/CreditRemaining"
}

r = requests.post(url, data=soap.encode("utf-8"), headers=headers)
print(r.text)

<?php
$url = "https://ts6.trackroad.com/TrackService.asmx";
$soap = <<<XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
XML;

$ch = curl_init($url);
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Content-Type: text/xml; charset=utf-8",
    "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining"
  ],
  CURLOPT_POSTFIELDS => $soap
]);

echo curl_exec($ch);
curl_close($ch);

require "net/http"

uri = URI("https://ts6.trackroad.com/TrackService.asmx")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

soap = <<~XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
XML

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "text/xml; charset=utf-8"
req["SOAPAction"] = "http://TrackService.TrackRoad.com/CreditRemaining"
req.body = soap

res = http.request(req)
puts res.body

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://ts6.trackroad.com/TrackService.asmx"
  soap := []byte(`<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>`)

  req, _ := http.NewRequest("POST", url, bytes.NewBuffer(soap))
  req.Header.Set("Content-Type", "text/xml; charset=utf-8")
  req.Header.Set("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")

  resp, err := http.DefaultClient.Do(req)
  if err != nil { panic(err) }
  defer resp.Body.Close()

  b, _ := io.ReadAll(resp.Body)
  fmt.Println(string(b))
}

import java.net.URI
import java.net.http.HttpClient
import java.net.http.HttpRequest
import java.net.http.HttpResponse

fun main() {
  val url = "https://ts6.trackroad.com/TrackService.asmx"
  val soap = """
    <?xml version="1.0" encoding="utf-8"?>
    <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <soap:Header>
        <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
          <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
        </SessionIDHeader>
      </soap:Header>
      <soap:Body>
        <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
      </soap:Body>
    </soap:Envelope>
  """.trimIndent()

  val client = HttpClient.newHttpClient()
  val req = HttpRequest.newBuilder()
    .uri(URI.create(url))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "http://TrackService.TrackRoad.com/CreditRemaining")
    .POST(HttpRequest.BodyPublishers.ofString(soap))
    .build()

  val resp = client.send(req, HttpResponse.BodyHandlers.ofString())
  println(resp.body())
}

#include <stdio.h>
#include <curl/curl.h>

int main(void) {
  CURL *curl = curl_easy_init();
  if(!curl) return 1;

  const char *url = "https://ts6.trackroad.com/TrackService.asmx";
  const char *soap =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "<soap:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
    "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
    "</soap:Envelope>";

  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining");

  curl_easy_setopt(curl, CURLOPT_URL, url);
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap);

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#include <curl/curl.h>
#include <string>

int main() {
  CURL* curl = curl_easy_init();
  if(!curl) return 1;

  std::string url = "https://ts6.trackroad.com/TrackService.asmx";
  std::string soap =
    "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
    "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""
    " xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\""
    " xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
    "<soap:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\">"
    "<SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
    "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
    "</soap:Envelope>";

  struct curl_slist* headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: text/xml; charset=utf-8");
  headers = curl_slist_append(headers, "SOAPAction: http://TrackService.TrackRoad.com/CreditRemaining");

  curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, soap.c_str());

  CURLcode res = curl_easy_perform(curl);

  curl_slist_free_all(headers);
  curl_easy_cleanup(curl);
  return (res == CURLE_OK) ? 0 : 1;
}

#import <Foundation/Foundation.h>

int main() {
  @autoreleasepool {
    NSURL *url = [NSURL URLWithString:@"https://ts6.trackroad.com/TrackService.asmx"];
    NSMutableURLRequest *req = [NSMutableURLRequest requestWithURL:url];
    [req setHTTPMethod:@"POST"];
    [req setValue:@"text/xml; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
    [req setValue:@"http://TrackService.TrackRoad.com/CreditRemaining" forHTTPHeaderField:@"SOAPAction"];

    NSString *soap =
      @"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
       "<soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">"
       "<soap:Header><SessionIDHeader xmlns=\"http://TrackService.TrackRoad.com/\"><SessionID>YOUR_TRACKSERVICEKEY</SessionID></SessionIDHeader></soap:Header>"
       "<soap:Body><CreditRemaining xmlns=\"http://TrackService.TrackRoad.com/\" /></soap:Body>"
       "</soap:Envelope>";

    [req setHTTPBody:[soap dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLSessionDataTask *task =
      [[NSURLSession sharedSession] dataTaskWithRequest:req completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        if (error) { NSLog(@"%@", error); return; }
        NSString *text = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
        NSLog(@"%@", text);
      }];

    [task resume];
    [[NSRunLoop currentRunLoop] run];
  }
  return 0;
}

import Foundation

let url = URL(string: "https://ts6.trackroad.com/TrackService.asmx")!
var req = URLRequest(url: url)
req.httpMethod = "POST"
req.setValue("text/xml; charset=utf-8", forHTTPHeaderField: "Content-Type")
req.setValue("http://TrackService.TrackRoad.com/CreditRemaining", forHTTPHeaderField: "SOAPAction")

let soap = """
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionIDHeader xmlns="http://TrackService.TrackRoad.com/">
      <SessionID>YOUR_TRACKSERVICEKEY</SessionID>
    </SessionIDHeader>
  </soap:Header>
  <soap:Body>
    <CreditRemaining xmlns="http://TrackService.TrackRoad.com/" />
  </soap:Body>
</soap:Envelope>
"""
req.httpBody = soap.data(using: .utf8)

let task = URLSession.shared.dataTask(with: req) { data, _, error in
  if let error = error { print(error); return }
  print(String(data: data ?? Data(), encoding: .utf8) ?? "")
}
task.resume()
RunLoop.main.run()

Response examples

REST JSON response example (shape)#

{
  "Credit": 12345,
  "Errors": [],
  "Status": 1
}

SOAP response example (SOAP 1.1)#

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreditRemainingResponse xmlns="http://TrackService.TrackRoad.com/">
      <CreditRemainingResult>
        <Credit>12345</Credit>
      </CreditRemainingResult>
    </CreditRemainingResponse>
  </soap:Body>
</soap:Envelope>

Common errors#

REST 401 / Unauthorized: Missing or invalid X-API-Key.
REST 403 / Forbidden: The key is valid but blocked, expired, or out of credit.
Status = 2 (Failed): Check Errors[] for the reason.
SOAP authentication failure: Missing or invalid SessionIDHeader (SessionID must be your TrackServiceKey).

Best practices#

Monitor credit in production and alert when it falls below your safe threshold.
Check credit before batch jobs such as geocoding, routing, or dispatching at scale.
Keep keys server-side and rotate keys if they are compromised.
Prefer REST unless you have a SOAP-only integration requirement.

FAQ#

What does the Credit API do?

The Credit API returns how much API credit remains for your TrackServiceKey.

How do I authenticate to Credit in REST and SOAP?

For REST, send your TrackServiceKey in the X-API-Key header on POST /rest/Credit. For SOAP, send your TrackServiceKey in SessionIDHeader as SessionID for each CreditRemaining call.

What does CreditRemaining return?

CreditRemaining returns a CreditResult that includes the Credit integer, which is your remaining API credit balance.

When should I check my remaining API credit?

Check your remaining API credit before running bulk geocoding, route optimization, or dispatch jobs, and monitor it in production to avoid interruptions.

Next step: calculate routes

After confirming your remaining credit, continue with Routes or Dispatch to optimize deliveries and fleet operations.

Go to Routes Go to Dispatch

Table of Contents