API V3 – Fetch a Lane GIS Breakdown

The /v3/lanes/fetch/breakdown endpoint allows you quickly fetch the GIS data and road distance of a lane described with two zip codes.

For TMS integrators, this endpoint is a courtesy feature for you to quickly grab a usable data structure that describes a lane, for instances where you don’t have the information cached or stored in your system.

Notes on this endpoint:

  1. Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
GET

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
email
string
Email address of the VETCarriers user who is making the API call
origin_zip
string
The origin zip code. For US zip codes, only 5-digit format is accepted (omit the plus-4). For Canadian zip codes, only the first three characters are accepted.
destination_zip
string
The origin zip code. For US zip codes, only 5-digit format is accepted (omit the plus-4). For Canadian zip codes, only the first three characters are accepted.

Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
breakdown
object
{}
An object with the following fields:

{
object
object
number
}
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "breakdown": {
        "origin": {
            "city": "LOS ANGELES",
            "state": "CA",
            "zip": "90058"
        },
        "destination": {
            "city": "SPARKS",
            "state": "NV",
            "zip": "89436"
        },
        "distance": 484
    },
    "response": {
        "date_time": "2022-11-28 23:09:14 UTC",
        "timestamp": 1669676954,
        "status": 200
    }
}