Capacity Lane Scores

This endpoint allows permissioned users to call and return our SONAR Capacity Lane Scores. The scores provided in this endpoint come from combining tender rejection rates and market balance of inbound/outbound loads and convey unique insight into the current capacity conditions on a given lane. Our capacity data is updated daily.

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

Returns capacity lane scores, market scores, and day over day change in lane score based off of SONAR internal metrics. Note that even though the origin and destination input fields take zip codes, the lane score is based on the market to market lane. This endpoint handles the following input fields:

• start_date: the start date of the range over which the Capacity Lane Scores are being requested (YYYY-MM-DD); required field

• end_date: the end date of the range over which the Capacity Lane Scores are being requested (YYYY-MM-DD); required field

• lanes: an embedded list of the following fields:

• lane_id: a unique identifier set by the client and will be returned with the response; optional field

• origin: the 5 (or 3) digit postal/zip code for the origin point including leading zero(s); required field

• destination: the 5 (or 3) digit postal/zip code for the destination point including leading zero(s); required field

• equipment_type: must be ‘VAN’ or ‘REEFER’; required field

• origin_country_code: country code for the origin; optional field, defaults to (and currently scores are only available for) 'USA'; accepts “CAN” and “MEX” for future iterations

• destination_country_code: country code for the destination; optional field, defaults to (and currently scores are only available for) 'USA'; accepts “CAN” and “MEX” for future iterations

Here are the output fields returned in a successful call:

• lane_id: the identifier sent in the corresponding call if provided
• data_timestamp: the date for which the data in the response was calculated (ie: the date of the capacity lane and market scores in the response)
• origin: the origin zip/postal code provided in the API call by the client
• origin_country_code: the country code for the origin provided in the API call by the client; defaults to 'USA' if none was given
• origin_market: the 3 character market code for the origin market that corresponds to the origin zip code zip code provided by the client
• destination: the destination zip/postal code provided in the API call by the client
• destination_country_code: the country code for the destination provided in the API call by the client; defaults to 'USA' if none was given
• destination_market: the 3 character market code for the destination market that corresponds to the destination zip code provided by the client
• equipment_type: the equipment_type provided in the API call by the client (for which the scores in the response apply)
• capacity_lane_score: the capacity lane score for the lane (origin_market and destination_market pair) on the corresponding date (data_timestamp)
• day_over_day_change: the change in capacity lane score from the previous day. It is the lane score for the requested day (data_timestamp) minus the lane score for the previous day.
• origin_capacity_trend_score: the 4 week capacity trend score for the origin market (origin_market) that corresponds to the origin zip/postal code provided in the API call by the client.
• destination_capacity_trend_score: the 4 week capacity trend score for the destination market (destination_market) that corresponds to the destination zip/postal code provided in the API call by the client.