---
title: "Coverage Guide"
method: POST
path: "/v2/truckload/coverage_guide"
tags: ["Truckload V2"]
---

# Coverage Guide

`POST /v2/truckload/coverage_guide`

This endpoint allows permissioned users to get the coverage guide for a set of lanes.

You can click on the Body Sample to the right to populate the example in the test body below.

For more information about getting access to this endpoint or using this endpoint, please reach out to our Customer Success team (cs@gosonar.com).

This endpoint handles the following input fields:

*   lanes: A list object that contains the input information associated with the lanes
    *   lane\_id: an optional identifier that will be returned with the associated response object
    *   origin\_type: currently only accepts 'zip'
    *   origin: currently only accepts a zip code with at least 3 digits
    *   origin\_country\_code: currently only accepts 'USA'
    *   destination\_type: currently only accepts 'zip'
    *   destination: currently only accepts a zip code with at least 3 digits
    *   destination\_country\_code: currently only accepts 'USA'
    *   equipment\_type: currently accepts 'VAN', 'REEFER', or 'FLATBED'
    *   input\_miles: optional integer number of miles, if left off a distance will be calculated based on the origin and destination

Here are the output fields returned in a successful call:

*   lanes: A list object that contains the output information associated with the valid requested lanes
    *   lane\_id: the identifier sent in the corresponding request
    *   data\_timestamp: date of the latest spot rate data
    *   generated\_on: date the coverage guide was generated
    *   origin: zip code
    *   origin\_market: KMA associated with the origin zip code
    *   origin\_country\_code: country code
    *   destination: zip code
    *   destination\_market: KMA associated with the destination zip code
    *   destination\_country\_code: country code
    *   equipment\_type: equipment type
    *   miles: the distance between the origin and destination either provided in the request or calculated based on the origin and destination
    *   rpm: latest TRAC rpm for the lane
    *   rpm\_high: latest high TRAC rpm for the lane
    *   rpm\_low: latest low TRAC rpm for the lane
    *   rpm\_wow\_change\_percent: week over week percent change for TRAC rpm
    *   rate: latest TRAC rate for the lane
    *   rate\_high: latest high TRAC rate for the lane
    *   rate\_low: latest low TRAC rate for the lane
    *   confidence\_score: confidence score associated with the TRAC data for this lane
    *   mytrac\_rate: myTRAC rate for the lane (org must be entitled to myTRAC and data must exist for the lane)
    *   mytrac\_rpm: myTRAC rpm for the lane (org must be entitled to myTRAC and data must exist for the lane)
    *   origin\_rejection\_percent: latest tender rejection at the origin
    *   destination\_rejection\_percent: latest tender rejection at the destination
    *   current\_capacity\_condition: description of current conditions
    *   directional\_capacity\_change: description of the directional conditions over the last week
    *   coverage\_difficulty\_score: combination of current and directional conditions showing how difficult a lane is to cover, 9 being most difficult
    *   coverage\_guidance: coverage guidance
*   errors: a list object that contains information on lanes that we are unable to return a coverage guide for
    *   original\_lane: the request that produced the error
    *   error\_found: description of the error

## Headers

- `x-api-version` string

## Request body

- CoverageGuideApiRequest
  - `lanes` CoverageGuideApiLaneRequest[], required
    - `lane_id` string
    - `origin_type` string
    - `origin` string, required
    - `origin_country_code` string
    - `destination_type` string
    - `destination` string, required
    - `destination_country_code` string
    - `equipment_type` string, required
    - `input_miles` integer

## Response `200`

OK

- CoverageGuideApiLaneResponseV2
  - `lane_id` string
  - `data_timestamp` string
  - `generated_on` string
  - `origin` string, required
  - `origin_market` string, required
  - `origin_country_code` string
  - `destination` string, required
  - `destination_market` string, required
  - `destination_country_code` string
  - `equipment_type` string, required
  - `miles` number, double
  - `rpm` number, double
  - `rpm_high` number, double
  - `rpm_low` number, double
  - `rate` number, double
  - `rate_high` number, double
  - `rate_low` number, double
  - `confidence_score` number, double
  - `rpm_wow_change_percent` number, double
  - `mytrac_rate` number, double
  - `mytrac_rpm` number, double
  - `origin_rejection_percent` number, double
  - `destination_rejection_percent` number, double
  - `current_capacity_condition` string
  - `directional_capacity_change` string
  - `coverage_difficulty_score` integer
  - `coverage_guidance` string

---

[API](https://skmtc.net/freightwaves/apis/sonar-api.md) · [All operations](https://skmtc.net/freightwaves/apis/sonar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/freightwaves/sonar-api/revisions/3a995f316cda/schema)