Carrier Recommendations
Carrier Recommendations Endpoint
Retrieve a list of recommended carriers operating near an origin, destination, or on a specified lane.
Authentication
Include your
Access-Token
in the header of your requests.Include your
x-api-key
The API key provided by GenLogs. This header must be included in the request.
Permissions
The external-api-carrier-recommendation
permission is required to access this endpoint.
Endpoint
URL:
https://api.genlogs.io/carrier/recommendations
Method:
GET
Headers
Access-Token:
token
(string, required): The access token obtained from the "Create Access Token" endpoint.x-api-key (string, required): The API key provided by GenLogs. This header must be included in the request
Query Parameters:
origin_city (string, required): Name of the origin city. Note that townships and counties are not accepted.
origin_state (string, required): Full name or two-letter abbreviation of the origin state.
destination_city (string, required): Name of the destination city. Note that townships and counties are not accepted.
destination_state (string, required): Full name or two-letter abbreviation of the destination state.
origin_radius (number, optional): Radius (miles) around the origin location for carrier search - default 50 miles
destination_radius (number, optional): Radius (miles) around the destination location for carrier search - default 50 miles.
carrier_score_min (number, optional): Minimum acceptable carrier score.
carrier_score_max (number, optional): Maximum acceptable carrier score.
fleet_size_min (number, optional): Minimum fleet size of carriers - default 0 power units
fleet_size_max (number, optional): Maximum fleet size of carriers - default 1000 power units
carried_cargo (string, optional): Type of cargo registered to carried., Possible values:
Passengers
Garbage/Refuse
Mobile Homes
Drive/Tow away
Water Well
Livestock
Utilities
Agricultural/Farm Supplies
General Freight
Household Goods
US Mail
Beverages
Paper Products
Fresh Produce
Meat
Refrigerated Food
Metal: sheets, coils rolls
Logs, Poles, Beams, Lumber
Building Materials
Machinery, Large Objects
Oilfield Equipment
Construction
Liquids/Gases
Chemicals
Motor Vehicles
Grain Feed Hay
Coal/Coke
Commodities Dry Bulk
Intermodal Cont.
equipment_types (case sensitive string, optional): A list of equipment types and subtypes used by the carrier. You may list multiple values using a pipe (“|”) delimiter. The scheme is Type 1: Subtype 1 | Type 2: Subtype 2 | Type 3: Subtype 3.
Possible values:
Reefer
Flatbed
Tanker
Dry Bulk
Dump
Container
Car Hauler
Dry Van
Examples:
equipment_types: Dry Van | Box Truck
equipment_types: Dry Van: Double Pup | Box Truck | Flatbed: Step deck | Flatbed: Lowboy RGN
preferred_carriers: (boolean, optional): Only return carriers marked as preferred.
auth_months_min (number, optional, default=1): Minimum number of months a carrier has an active common or contract authority with FMCSA
power_only (boolean, optional): Filters carriers that operate tractors without owning trailers.
Search Tips
To perform and origin- or destination-only search, follow these steps.
Origin-only search
Fill out origin_city and origin_state
Include destination_city and destination_state but leave the parameters null
Omit the destination_radius parameter
Destination-only search
Fill out destination_city and destination_state
Include origin_city and origin_state but leave the parameters null
Omit the origin_radius parameter
Response:
200 OK: A JSON object containing recommendations and lane volume details.
400 Bad Request: If required parameters are missing or invalid.
401 Unauthorized: If the authentication credentials (email and password) are missing or incorrect.
403 Forbidden: Access to the requested resource is forbidden.
500 Internal Server Error: If there is an issue on the server that prevents processing the request.
Response Body:
recommendations (array of
CarrierRecommendation
objects): List of recommended carriers.add_date (string): Date the recommendation was added.
bipd_insurance_on_file (number): Amount in of BIPD insurance on file (in US dollars)
cargo_insurance_on_file (number): Amount of cargo insurance on file (in US dollars)
carried_cargo (string): Type of cargo carried by the carrier.
carrier_driver_oos_rate (number): Carrier’s driver Out-of-Service (OOS) rate.
carrier_driver_oos_rate_national_avg (number): National average OOS rate for drivers.
carrier_score (number): The carrier match score is a metric that indicates the likelihood of a carrier meeting the specific needs of a given search query.
carrier_score_scaled (number): The carrier's score on a scaled basis.
carrier_total_power_units (number): Total power units operated by the carrier.
carrier_vehicle_oos_rate (number): Carrier’s vehicle OOS rate.
carrier_vehicle_oos_rate_national_avg (number): National average OOS rate for vehicles.
dba_name (nullable string): Doing Business As (DBA) name of the carrier.
dot_number (string): DOT number of the carrier.
email_address (string): Email address of the carrier, provided by the FMCSA.
is_visually_sighted (boolean): Whether the carrier has been visually sighted.
is_possible_backhaul (boolean): indicates if the specified lane is a possible backhaul for the carrier
is_preferred (boolean): Whether the carrier has been marked as preferred or not.
lat (nullable number): Latitude of the FMCSA registered address.
legal_name (string): Legal name of the carrier.
lon (nullable number): Longitude of the FMCSA registered address.
mc_number (number): Motor Carrier (MC) number of the carrier.
phy_city (string): Physical city location of the carrier.
phy_state (string): Physical state location of the carrier.
phy_street (string): Physical street address of the carrier.
phy_zip (string): Physical ZIP code of the carrier.
telephone (string): FMCSA listed telephone number
is_power_only (boolean): Carriers that operate tractors without owning trailers.
Request Example:
Origin city for the recommendation
Nashville
Example: Tennessee City
Origin state for the recommendation
TN
Example: Tennessee
Destination city for the recommendation
Dallas
Example: Tascosa
Destination state for the recommendation
TX
Example: Texas
Search radius around the origin location in miles
50
Example: 50
Search radius around the destination location in miles
50
Example: 50
Minimum carrier score
0
Example: 0
Maximum carrier score
100
Example: 100
Minimum fleet size
1
Example: 1
Maximum fleet size
500
Example: 500
Type of cargo carried
general goods
Example: general goods
Type of equipment used by carriers
flatbed
Example: flatbed
Filter for preferred carriers
false
Example: true
Request real-time data if available
false
Example: true
Minimum number of months a carrier has an active common or contract authority with FMCSA
1
Example: 1
false
Example: true
false
Example: true
Specifies the format of the response.
application/json
Example: application/json
Access Token for authentication
[Token]
API key for authentication
[x-api-key]
GET /carrier/recommendations HTTP/1.1
Host: api.genlogs.io
accept: application/json
Access-Token: [Token]
x-api-key: [x-api-key]
Accept: */*
The JSON response containing recommendations and lane volume
{
"real_time_locs": [
{
"current_lat": 1,
"current_lon": 1,
"dot_number": "text",
"is_inbound": true
}
],
"recommendations": [
{
"add_date": "text",
"bipd_insurance_on_file": 1,
"cargo_insurance_on_file": 1,
"carried_cargo": "text",
"carrier_driver_oos_rate": 1,
"carrier_driver_oos_rate_national_avg": 1,
"carrier_score_scaled": 1,
"carrier_total_power_units": 1,
"carrier_vehicle_oos_rate": 1,
"carrier_vehicle_oos_rate_national_avg": 1,
"dba_name": "text",
"dot_number": "text",
"email_address": "text",
"is_inbound": true,
"is_real_time": true,
"is_visually_sighted": true,
"is_possible_backhaul": true,
"lat": 1,
"legal_name": "text",
"lon": 1,
"mc_number": 1,
"phy_city": "text",
"phy_state": "text",
"phy_street": "text",
"phy_zip": "text",
"telephone": "text",
"power_only": true,
"broker_authority_status": "text"
}
]
}
Last updated