API V3 – Fetch a Lane Coverage Report

The /v3/lanes/fetch/coverage/report endpoint allows you get a full profile of a lane. This includes a complete report of the loads you’ve posted on the lane and the carriers that have covered those loads for you. These carriers are the first to be notified when you announce a load on this lane.

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 loads can be posted on a single lane, and brokers with dedicated lanes may list thousands of loads 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
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
description
object
{}
An object with the following fields:

{
string
object
object
number
}
loads
array
[]
An array of objects, each with the following fields:

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

{
string
integer
integer
}

Example response

{
    "description": {
        "lane_id": "BC-7f7325da-400b-4d73-b6fb-2b77a8a36e8f",
        "origin": {
            "city": "LOS ANGELES",
            "state": "CALIFORNIA",
            "zip": "90058"
        },
        "destination": {
            "city": "SPARKS",
            "state": "NEVADA",
            "zip": "89436"
        },
        "distance": 484
    },
    "loads": [
        {
            "created": {
                "date_time": "2022-11-28 19:18:23.625189 UTC",
                "contact": {
                    "name": "JANE AGENT",
                    "email": "jane@demobroker.com",
                    "phone": "5558675309"
                }
            },
            "load_number": "DFG98D7FG97DF9G87A",
            "origin": {
                "city": "LOS ANGELES",
                "state": "CA",
                "zip": "90058",
                "full": "LOS ANGELES, CA 90058"
            },
            "destination": {
                "city": "SPARKS",
                "state": "NV",
                "zip": "89436",
                "full": "SPARKS, NV 89436"
            },
            "distance": "484",
            "rate": {
                "total": "2350",
                "per_mile": "4.86"
            },
            "type": "full",
            "cargo": {
                "weight": "1300",
                "length": "5.5",
                "width": "3.75",
                "commodity": "3d printer resin"
            },
            "equipment": [
                "box_truck",
                "cargo_van",
                "sprinter_van"
            ],
            "services": [
                "expedited",
                "pallet_exchange",
                "gps"
            ],
            "pickup": {
                "earliest": "2022-12-01",
                "latest": "2022-12-02"
            },
            "delivery": {
                "earliest": "2022-12-03",
                "latest": "2022-12-04"
            },
            "notes": null,
            "covered_by": {
                "business_name": "AWESOME CARRIER INC",
                "dot_num": "9876543",
                "mc_num": "987654"
            }
        }

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

    ],
    "response": {
        "date_time": "2022-11-28 22:35:05 UTC",
        "timestamp": 1669674905,
        "status": 200
    }
}