RateEngine API Integration

Overview

The Rate Engine API is designed to allow customers to individually determine the predicted price of a given load transported from point A to point B.

Using quote and vehicle API endpoints, you can submit load details and get an estimated quote (price) for them almost instantly. In addition to the predicted price, the API returns a confidence level indicating how confident our machine learning models are in the prediction.

Authentication

No registration is required. If you’d like to make requests to our service via Rate Engine API, you’ll need a query token. Contact us by email for more information.


Quotes

Quotes provide a description of the parameters of a given load which is translated into an estimated price charged by the carrier assigned to transport it. Once calculated, the expected total price is shown to the user who requested the quote.

Create a new quote

Creates a new (standard) quote using vehicle parameters, destination and carrier type, and returns a predicted total vehicle price.

Depending on the query token you have, you may also be able to create an extended quote.

Such requests rely on the same fields needed for generating a standard quote but return a couple of additional fields in the response schema. Extended quotes are useful when you’d like to make changes to your original quote request without having to send an entirely new one.

For example, instead of making a second request to get the price prediction for the reversed route, you can get that information within the response of a single extended quote request.

Refer to:

Rate Engine API - to create a new quote (price prediction)

Upon successful call, the endpoint creates the quote and returns the complete quote response schema. If one or more required fields are invalid, the endpoint generates an error.

When quotes concern a list of vehicles instead of a single vehicle, the response schema simply returns data for each individual vehicle, as well as the whole predicted load price.


Vehicles

Vehicle APIs are responsible for returning lists of registered vehicles based on a provided input - their year, make and model data. With the help of three endpoints, information can be retrieved from the database for each individual parameter.

Using registered vehicles as request parameters for the quote API leads to accurate price predictions.

Retrieve manufacture years

Returns a list of all vehicle manufacture years kept in the database. No data is required for the process.

Upon successful call, the endpoint returns a list of vehicle manufacture years.

Refer to:

Retrieve manufacture years

Retrieve vehicle makes

Returns a list of all vehicle makes kept in the database. Using the year query parameter found within the url for fetching manufacture years, you can optionally filter makes by their manufacture years.

Upon successful call, the endpoint returns a list of vehicle makes for a given year.

Refer to:

Retrieve vehicle makes

Retrieve vehicle models

Returns a list of all vehicle models kept in the database. Using the year and make query parameter found within the url for fetching manufacture years and vehicle makes, you can optionally filter models by their manufacture years and/or makes.

Upon successful call, the endpoint returns a list of vehicle models for a given year and make.

Refer to:

Retrieve vehicle models