real time capabilities.md
Real time Capabilities
With GenLogs' Real-Time API, you can instantly identify carriers with the right equipment who are currently within a 150-mile radius of your origin and are likely seeking backhauls to your destination. Integrate Real-Time GenLogs data into your TMS and internal systems to unlock new opportunities, increase efficiency, and reduce empty miles.
When the real_time parameter is set to 'True', the recommendation system prioritizes real-time data by applying additional weight to recent detections near the origin of the search. While the recommendations still incorporate historical data and follow the usual logic, the real-time information takes precedence, resulting in a more dynamic focus on current activity.
Permissions
The realtime-api permission is required to use this parameter.
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
Use the real_time parameter in addition to the required and optional base parameters described in the Carrier Recommendations document.
- real_time (boolean, optional): Indicates whether to return recommendations that include real-time detections. If enabled, carriers recently seen within 150-mi of your search radius will be returned.
Response Body
- real_time_locs (dictionary of locations where real time carrier observations)
- dot_number: string, usdot of the detected carrier.
- current_lon: float, longitude of the detection location.
- current_lat: float, latitude of the detection location.
- is_inbound (bool): flag indicates when a carrier is currently inbound to the origin
- recommendations (array of
CarrierRecommendationobjects): List of recommended carriers. See Carrier Recommendation docs for more. is_inboundappears in:- [1] real_time_locs[is_inbound]
- [2] rt_detection_detail[][is_inbound] – both mean carrier inbound to origin.
Request Example
curl -X GET 'https://api.genlogs.io/carrier/recommendations?origin_city=Tucker&origin_state=Georgia&destination_city=Orange+Park&destination_state=Florida&origin_radius=50.0&destination_radius=50.0&fleet_size_min=0&fleet_size_max=1000&preferred_carriers=True&real_time=True' \
-H 'Access-Token: {access_token}' \
-H 'x-api-key: {your_api_key}' \
-i