neshan_direction
Calculate a route between two points with selectable traffic modeling: live, historical, typical, or no traffic. Supports waypoints, vehicle type, and zone avoidance for accurate navigation.
Instructions
Calculate a route between two points, choosing how traffic is modeled.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bearing | No | Optional heading (0-360) at the origin. Only usable with traffic_mode 'live' or 'typical'. | |
| vehicle | No | 'car', 'motorcycle', or 'pedestrian'. Must stay 'car' (the default) when traffic_mode='historical' — that mode has no vehicle choice. | car |
| dest_lat | Yes | ||
| dest_lng | Yes | ||
| date_time | No | Required when traffic_mode='historical'. Target date and time as 'YYYY-MM-DDThh:mm' (no timezone, UTC+0). | |
| waypoints | No | Optional ordered stops as [[lat, lng], ...]. Not usable with traffic_mode='historical'. | |
| origin_lat | Yes | ||
| origin_lng | Yes | ||
| alternative | No | Also return alternative routes. | |
| routing_type | No | Required when traffic_mode='historical'. 'DepartAt' to specify departure time, 'ArriveAt' for arrival time. | |
| traffic_mode | No | How to account for traffic when routing: - 'live' (default): current real-time traffic. Use for "how long would this take if I left right now". - 'no_traffic': static road speeds; traffic is ignored entirely. - 'typical': pattern-based traffic refreshed every 15 minutes. Use for a stable ETA when live traffic is flaky or unavailable. - 'historical': traffic-aware ETA for a *future* date/time, based on historical patterns for that time of day. Requires routing_type and date_time. Covers Tehran, Mashhad, and Karaj only, up to one week ahead. | live |
| avoid_traffic_zone | No | Avoid the central traffic (طرح ترافیک) zone. | |
| avoid_odd_even_zone | No | Avoid the odd/even (زوج و فرد) zone. Not usable with traffic_mode='historical'. |