API 2.0
Endpoints
/commodities_routes
Retrieve a list of common routes calculated based on data reports
| Method | GET |
|---|---|
| URLs |
// Example 1 https://uexcorp.space/api/2.0/commodities_routes?id_terminal_origin={int} // Example 2 https://uexcorp.space/api/2.0/commodities_routes?id_terminal_origin={int}&id_terminal_destination={int} // Example 3 https://uexcorp.space/api/2.0/commodities_routes?id_commodity={int} |
| Authorization | — |
| Cache TTL | +30 minutes |
| Input |
// at least one of these inputs are required id_terminal_origin int(11) id_planet_origin int(11) id_orbit_origin int(11) id_commodity int(11) // optional inputs id_terminal_destination int(11) id_planet_destination int(11) id_orbit_destination int(11) id_faction_origin int(11) id_faction_destination int(11) investment int(11) |
| Output |
id int(11) id_commodity int(11) id_star_system_origin int(11) id_star_system_destination int(11) id_planet_origin int(11) id_planet_destination int(11) id_orbit_origin int(11) id_orbit_destination int(11) id_terminal_origin int(11) id_terminal_destination int(11) id_faction_origin int(11) id_faction_destination int(11) code string(255) // unique route code (used by UEX for shared links) price_origin float(11) // per SCU price_origin_users float(11) // per SCU, average from users trades price_origin_users_rows float(11) // number of user trades used to calculate 'price_origin_users' price_destination float(11) // per SCU price_destination_users float(11) // per SCU, average from users trades price_destination_users_rows float(11) // number of user trades used to calculate 'price_destination_users' price_margin float(11) price_roi float(11) scu_origin float(11) scu_origin_users float(11) // average from users trades scu_origin_users_rows float(11) // number of user trades used to calculate 'scu_origin_users' scu_destination float(11) scu_destination_users float(11) // average from users trades scu_destination_users_rows float(11) // number of user trades used to calculate 'scu_destination_users' scu_margin float(11) // percentage volatility_origin float(11) // price coefficient of variation. higher is worse volatility_destination float(11) // price coefficient of variation. higher is worse status_origin int(11) // stock level at origin, higher is better status_destination int(11) // stock level at destination, lower is better investment float(11) // maximum investment expected (scu_buy_avg * price_buy_avg) profit float(11) // maximum profit expected distance float(11) // Distance in Giga Meters (GM) score int(11) // UEX score level, higher is better container_sizes_origin string(255) // csv container_sizes_destination string(255) // csv game_version_origin string(255) // e.g. 3.24 game_version_destination string(255) // e.g. 4.0 has_docking_port_origin int(1) has_docking_port_destination int(1) has_freight_elevator_origin int(1) has_freight_elevator_destination int(1) has_loading_dock_origin int(1) has_loading_dock_destination int(1) has_refuel_origin int(1) has_refuel_destination int(1) has_cargo_center_origin int(1) has_cargo_center_destination int(1) has_quantum_marker_origin int(1) has_quantum_marker_destination int(1) is_monitored_origin int(1) // monitored by UEE (Comm-Link) is_monitored_destination int(1) // monitored by UEE (Comm-Link) is_space_station_origin int(1) is_space_station_destination int(1) is_on_ground_origin int(1) is_on_ground_destination int(1) commodity_name string(255) commodity_code string(255) commodity_slug string(255) origin_star_system_name string(255) origin_planet_name string(255) origin_orbit_name string(255) origin_terminal_name string(255) origin_terminal_code string(255) origin_terminal_slug string(255) origin_terminal_is_player_owned int(1) origin_faction_name string(255) destination_star_system_name string(255) destination_planet_name string(255) destination_orbit_name string(255) destination_terminal_name string(255) destination_terminal_code string(255) destination_terminal_slug string(255) destination_terminal_is_player_owned int(1) destination_faction_name string(255) date_added int(11) // unix timestamp |
| Response status |
• missing_one_required_inputs • ok |
| Limits | Maximum of 500 rows |
| Update rate | Hourly |
| Documentation update: | 1 day ago |
Optional Required
