API V3 – Fetch a List of Your Active Lanes

The /v3/lanes/fetch/list endpoint allows you get a full list of lanes on which you have announced loads. This includes the total loads, covered loads, and number of different carriers who have covered the lane for you.

For TMS integrators, this endpoint is useful for screens where the broker can review historical load information and/or lane intelligence dashboards.

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.
  2. Potential for large responses. This endpoint can potentially return very large responses. There is no limit to how many different lanes a broker may post loads on over time. For this reason, we recommend handling requests to this endpoint asynchronously.

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 BrokerCarrier user who is making the API call

Return values

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

Key
Type
Value
lanes
array
[]
An array of objects, each with the following fields:

{
array
integer
integer
}
response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "lanes": {
        "details": [
            {
                "lane_id": "BC-8953f945-a472-4b6a-acd4-a4a2990372ad",
                "origin": "LOS ANGELES, CA",
                "destination": "SPARKS, NV",
                "load_counts": {
                    "total": 11,
                    "covered": 11,
                    "carriers": 6
                }
            },
            {
                "lane_id": "BC-f927363e-01dc-4d39-9006-12b18e7d5618",
                "origin": "RENO, NV",
                "destination": "SALT LAKE CITY, UT",
                "load_counts": {
                    "total": 6,
                    "covered": 4,
                    "carriers": 2
                }
            }

            # This array can potentially contain hundreds or thousands of objects like the above.

        ],
        "total": 17,
        "covered": 15
    },
    "response": {
        "date_time": "2022-11-28 23:17:04 UTC",
        "timestamp": 1669677424,
        "status": 200
    }
}