latestSwagger 2.02026-08-1274120326.8 KB

3a995f316cda

Truckload

TRAC KMA Weekly Forecast

This endpoint allows permissioned users to call and return our SONAR TRAC weekly spot rate forecast at a KMA (Key Market Area) to KMA lane level. This forecast is available from 1 to 52 weeks out, and is completely overwritten every week on Sundays with new forecast values based on the most recent data points available. OD pairs are defined by Market Airport Codes. A comprehensive list of KMAs, their airport codes, and the zip3’s associated with those KMAs can be found by calling the KMA Reference List endpoint located under the “Lookup” menu. Additionally, the Zip3 Specific endpoint (also located under the Lookup tab), will return the airport code associated with a zip3 under the “qualifier” header (along with the reference city and state). The date range between start and end dates MUST contain at least one Sunday, as that is the date to which the weekly forecasts correspond. 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:

<ul><li>start_date: the earliest date of the range over which the TRAC forecast is being requested. Must be between the current date and 52 weeks into the future. (YYYY-MM-DD); required</li><li>end_date: the furthest into the future date of the range over which the TRAC forecast is being requested. Must be between the current date and 52 weeks into the future (YYYY-MM-DD); required</li><li>lane_id: a unique identifier set by the client and will be returned with the response; required</li><li>origin: the 3 character airport code for the origin Key Market Area (KMA), required</li><li>origin_country_code: country code for the origin; at this time only the 135 contiguous US markets are available, must be ‘USA’, required</li><li>destination: the 3 character airport code for the destination Key Market Area (KMA), required</li><li>destination_country_code: country code for the destination; at this time, only the 135 contiguous US markets are available, must be ‘USA’; required</li><li>equipment_type: current only ‘VAN’ is available; required.</li><li>current_customer_rate: the current rate that the client is experiencing on the specified lane. Will be multiplied by the forecasted percent change to show the expected trend applied to the clients rates; optional.</li></ul><b>Here are the output fields returned in a successful call:</b><ul><li>Lanes: A list object that contains the output information associated with the valid requested lanes.</li><li>lane_id: the unique identifier sent in the corresponding call.</li><li>data_timestamp: the date corresponding to the Sunday of the week for which the rate is being forecasted</li><li>generated_on: the date on which the forecast was generated</li><li>origin: the 3 character airport code for the origin Key Market Area (KMA) provided in the API call by the client</li><li>origin_country_code: ‘USA’, will return an error if anything other than ‘USA’ is entered</li><li>destination: the 3 character airport code for the destination Key Market Area (KMA) provided in the API call by the client</li><li>destination_country_code: ‘USA’, will return an error if anything other than ‘USA’ is entered</li><li>equipment_type: the equipment_type provided in the API call by the client (for which the rates in the response apply)</li><li>current_customer_rate: the client’s current rate as specified in the API call.</li><li>forecast_index_value: the median forecasted percent change between the rate estimate corresponding to the data_timestamp and the current (yesterday’s) rate (ie. the direction and amount the current rate is expected to change by).</li><li>forecast_index_value_high: the high-end (75th percentile estimate) of the forecasted percent change between the rate estimate corresponding to the data_timestamp and the current (yesterday’s) rate (ie. the upper end of the direction and amount the current rate is expected to change by).</li><li>forecast_index_value_low: the low-end (25th percentile estimate) of the forecasted percent change between the rate estimate corresponding to the data_timestamp and the current (yesterday’s) rate (ie. the lower end of the direction and amount the current rate is expected to change by).</li><li>forecast_rpm_trac: the median total (linehaul plus fuel surcharge) forecasted rate-per-mile value that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the most recent (yesterday’s) median TRAC spot rate.</li><li>forecast_rpm_trac_high: the high-end (75th percentile) total (linehaul plus fuel surcharge) forecasted rate-per-mile that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the most recent (yesterday’s) median TRAC spot rate.</li><li>forecast_rpm_trac_low: the low-end (25th percentile) total (linehaul plus fuel surcharge) forecasted rate-per-mile that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the most recent (yesterday’s) median TRAC spot rate.</li><li>forecast_customer_rate: the median total (linehaul plus fuel surcharge) forecasted rate that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the current_customer_rate provided in the API request by the client.</li><li>forecast_customer_rate_high: the high-end (75th percentile) total (linehaul plus fuel surcharge) forecasted rate that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the current_customer_rate provided in the API request by the client.</li><li>forecast_customer_rate_low: the low-end (25th percentile) total (linehaul plus fuel surcharge) forecasted rate that corresponds to the origin, destination, equipment_type and data_timestamp provided in the API call by the client, based on the current_customer_rate provided in the API request by the client.</li><li>Errors: a list object that contains information on lanes that are not valid for the rate request.</li><li>lane_id: the unique identifier sent in the corresponding call.</li><li>origin: the 3 character airport code for the origin Key Market Area (KMA) provided in the API call by the client</li><li>origin_country_code: ‘USA’</li><li>destination: the 3 character airport code for the destination Key Market Area (KMA) provided in the API call by the client</li><li>destination_country_code: ‘USA’</li><li>error_found: A lane/date/equipment specific explanation of the issue with the lane information that caused an error.</li></ul>
post/truckload/rates/trac_forecast_weekly

Headers

x-api-versionstring

Request body

start_datestring date-time required
end_datestring date-time required

Example request

{
  "start_date": "2025-12-01",
  "end_date": "2025-12-31",
  "lanes": [
    {
      "lane_id": "ATL-MOB",
      "origin": "ATL",
      "origin_country_code": "USA",
      "destination": "MOB",
      "destination_country_code": "USA",
      "equipment_type": "VAN",
      "current_customer_rate": 968,
      "input_miles": 320
    }
  ]
}

Response

OK

Example response

{
  "lanes": [
    {
      "lane_id": "ATL-MOB",
      "data_timestamp": "2025-12-12",
      "generated_on": "2025-12-12",
      "origin": "ATL",
      "origin_country_code": "USA",
      "destination": "MOB",
      "destination_country_code": "USA",
      "equipment_type": "VAN",
      "current_customer_rate": 1000,
      "forecast_index_value_high": 0.1,
      "forecast_index_value_low": -0.1,
      "forecast_rpm_trac": 6.07,
      "forecast_rpm_trac_high": 6.13,
      "forecast_rpm_trac_low": 6,
      "forecast_rate_customer": 1000,
      "forecast_rate_customer_high": 1010,
      "forecast_rate_customer_low": 990
    }
  ],
  "errors": [
    {
      "original_lane": {
        "lane_id": "ATL-MOB",
        "origin": "ATL",
        "origin_country_code": "USA",
        "destination": "MOB",
        "destination_country_code": "USA",
        "equipment_type": "VAN",
        "current_customer_rate": 968,
        "input_miles": 320
      }
    }
  ]
}