GET
/
api
/
v1
/
price-data
Retrieve price data
curl --request GET \
  --url https://api.fleetworks.ai/api/v1/price-data \
  --header 'Authorization: Bearer <token>'
{
  "marketAnalytics": {
    "ratePerMile": 123,
    "loadVolume": 123,
    "laneAverageRate": 123,
    "spread": {
      "high": 123,
      "low": 123
    }
  },
  "total": 123
}

Authorizations

​
Authorization
string
header
required

An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.

Query Parameters

​
startDate
string<date>

Start date for the analytics period.

​
endDate
string<date>

End date for the analytics period.

​
date
string<date>

Filter price data by specific date.

​
origin
string

Origin location to filter price data.

​
destination
string

Destination location to filter price data.

​
offset
number
default:0

Pagination offset

Required range: x >= 0
​
limit
number
default:20

Number of records to return per page

Required range: 1 <= x <= 100

Response

200
application/json

Successful retrieval of price data with analytics.

The response is of type object.