The Iternio EV route planner is built around the same route optimizer which powers the well-known and highly trusted ABetterRoutePlanner app, available at https://abetterrouteplanner.com as well as https://apps.apple.com/us/app/a-better-routeplanner-abrp/id1490860521 and https://play.google.com/store/apps/details?id=com.iternio.abrpapp. As ABRP is developed, the same features also become available in the route planning API; new car models, weather features, charger database updates and so on.
\nTo be able to use the API, you will need to obtain an API key. The pricing is simple: There is a small setup cost for new customers and thereafter we charge per successful plan delivered by the API, that is specifically the plan endpoint documented below. All other calls are free of charge. Contact us to discuss your need and obtain an API key.
\nThe API is a standard REST API with HTTP parameters and JSON output. The API is versioned, and the present vesion is 1. When we introduce non-backwards compatible changes, we will bump the API version and run the versions in parallel as long as it is possible.
\nAuthentication is done vida the URL query parameter \"api_key=xxxx\" or the HTTP header \"Authorization\" with the value \"APIKEY xxxxx\". You can obtain API keys and more information by contacting us at contact@iternio.com.
\nThe API uses JSON objects for return values, outside of the normal HTTP status codes. HTTP status codes are only used to indicate serious errors such as invalid API key or wrong usage of the API. Everything else is returned with an HTTP 200 and an application/json payload.
\nThe return object has two mandatory fields
\nstatus: One of \"ok\", \"error\" or other more specific strings
\n[Optional] result: The actual result of the operation (list of chargers, plan, etc). Will always be present of the status is ok.
\n[Optional] metadata: Some metadata about the request which may be helpful if there are issues.
\nThe Iternio route planner supports a large and growing number of EV models. These are internally represented by an advanced model which captures each individual model’s properties when it comes to consumption in relation to speed, elevation, weather, and charging speed for different types of chargers and car SoC.
\nThe get_vehicle_library endpoint lists data for all EV models in the database, and replaces the deprecated get_carmodels endpoint. The differences between the two is that get_vehicle_library returns more specific properties (like manufacturer, model and year) and that it support vehicle options as described above. get_carmodels will list all possible combinations of options as separate vehicles.
\nThe output data is returned in JSON format, and the definition of the outpt is here described in TypeScript syntax:
\n export interface CarModel {\n typecode: string; // The unique ID string of this vehicle. Additional options are added at the end, separated by ':'\n title: string; // Title appended to the folders to create the full vehicle title\n ref_cons: number; // The default reference consumption for the vehicle, i.e fixed speed, flat land, 20C driving at 110 km/h [Wh/km]\n rec_max_speed: number; // Recommended max speed in [km/h]\n fast_chargers: string[]; // Supported fast chargers for this vehicle (potentially including common adapters)\n rec_fast_chargers: string[];// Recommended fast chargers for this vehicle\n level2_chargers: string[]; // Supported level 2 chargers for the vehicle\n deprecated?: boolean; // If true, this vehicle has been deprecated and should not be shown in the listing (but still works in the planner)\n replaced_by?: string; // If deprecated, this is the recommended typecode to replace it with. Can be done automatically without asking the user.\n usable_battery_wh?: number; // The usable battery of the vehicle model [Wh] \n folder: string[]; // A list of folder names for hierarchical display of the vehicle list - typically ['<manufacturer>', '<model>', ...]\n options?: CarOption[]; // A list of CarOption objects describing options for this vehicle (described below)\n manufacturer?: string; // The vehicle manufacturer\n model?: string; // The vehicle model (not including trim)\n year?: string; // The vehicle model year(s) (can be an interval)\n type?: 'car' | 'truck' | 'mc' | string; // The type of the vehicle\n maturity?: 'mature' | 'alpha' | 'beta'; // The maturity of the vehicle model\n }\nWhen using this endpoint and displaying the list or hierarchy to in a UI, the CarOptions needs to be displayed too to allow the user to specify the exact options of the vehicle. The result of the options selections becomes a typecode string with the selected options as new codes at the end, separated by ':'. For example the VW ID.3 medium range with heatpump becomes \"volkswagen:id3:20:58:mr:heatpump\" based on the base typecode \"volkswagen:id3:20:58:mr\" plus the option \"heatpump\".
\n export interface CarOption {\n title: string; // The title of the option, for example \"Wheels\" or \"Heatpump\"\n choices: CarOptionChoice[]; // A list of option choices. If only one choice, this is a binary yes/no option, for example for heatpump.\n }\n\n export interface CarOptionChoice {\n value: string; // The option value, added to the typecode string\n title?: string; // A title to display for the choice, if applicable\n selected?: boolean; // If true, this choice is pre-selected in the UI\n ref_cons_delta?: number; // This number should be added to the reference consumption of the vehicle if the choice is selected\n level2_chargers_delta?: string[]; // This set of chargers should be added to the vehicle level2 chargers if the choice is selected\n fast_chargers_delta?: string[]; // This set of chargers should be added to the vehicle fast chargers if the choice is selected\n rec_fast_chargers_delta?: string[]; // This set of chargers should be added to the vehicle recommended fast chargers if the choice is selected\n }\nExample:
\n {\n \"typecode\": \"volkswagen:id3:20:58:mr\",\n \"folder\": [\n \"Volkswagen\",\n \"ID.3\"\n ],\n \"rec_max_speed\": 130.0,\n \"title\": \"Pro 58kWh\",\n \"ref_cons\": 174.0,\n \"fast_chargers\": [\n \"ccs\"\n ],\n \"rec_fast_chargers\": [\n \"ccs\"\n ],\n \"level2_chargers\": [\n \"j1772\",\n \"type2\",\n \"type2_cable\"\n ],\n \"options\": [\n {\n \"title\": \"Heatpump\",\n \"choices\": [\n {\n \"value\": \"heatpump\",\n \"selected\": true\n }\n ]\n }\n ],\n \"maturity\": \"alpha\",\n \"manufacturer\": \"Volkswagen\",\n \"model\": \"ID.3\",\n \"year\": \"2021-\",\n \"type\": \"car\"\n }\n[Optional] If true, return the ideal usable battery for the vehicle model
\n","type":"text/plain"},"key":"usable_battery","value":"true"}],"variable":[]}},"response":[],"_postman_id":"941797b0-9c5b-4713-95b3-d2990e633aac"},{"name":"get_carmodels [DEPRECATED]","id":"9cf0a0dc-3ae8-40ff-a471-e8a7b976378a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.iternio.com/1/get_carmodels","description":"The Iternio route planner supports a large and growing number of EV models. These are internally represented by an advanced model which captures each individual model’s properties when it comes to consumption in relation to speed, elevation, weather, and charging speed for different types of chargers and car SoC.
\nThe get_carmodels endpoint lists data for all EV models in the database. This is DEPRECATED but will continue to work in version 1 of the API. Use get_vehicle_library for new implementations.
\nA list of vehicle models, with the follwing properties
\nExample:
\n {\n \"id\": 66,\n \"typecode\": \"tesla:m3:19:bt36:none\",\n \"name\": \"Tesla;Model 3;Standard Range Plus RWD (beta)\",\n \"rec_max_speed\": 150.0,\n \"ref_cons\": 160.0,\n \"fast_chargers\": \"SC,ccs,tesla_ccs,chademo\",\n \"rec_fast_chargers\": \"SC\",\n \"level2_chargers\": \"type2,type2_cable,destcharger\",\n \"usable_battery_wh\": xxxx,\n \"deprecated\": 0,\n \"replaced_by\": null\n }\nThe EV routes produced by the Iternio planner uses the internal database of chargers at Iternio. This database, in turn, consists mostly of data from various chargers database around the world, which we have received permission to use for the ABetterRoutePlanner service. To display these chargers in your application, you may have to receive the explicit permission from the original database owner.
\nThe planner will plan routes using the chargers in this database – if you want to include your charger database chargers in planning, these will have to be imported/synchronized to the Iternio database first.
\nThe get_chargers method will return a set of chargers according to filter parameters around a given lat, lon coordinate in a given radius.
\nThe returned charger objects have the following properties:
\nThe outlet objects have the following properties:
\nExample:
\n {\n \"name\": \"Ionity - Greve, DK [Ionity]\",\n \"id\": 4288487,\n \"address\": \"Mosede Landevej 64, Greve\",\n \"lat\": 55.5847374120105,\n \"lon\": 12.2576344182219,\n \"url\": null,\n \"comment\": \"\",\n \"status\": \"Open\",\n \"region\": \"europe\",\n \"network_id\": 85,\n \"network_name\": \"Ionity\",\n \"network_icon\": \"ionity.png\",\n \"outlets\": [\n {\n \"type\": \"ccs\",\n \"stalls\": 10,\n \"power\": 350.0\n }\n ],\n \"locationid\": \"ocm_130563\"\n },\nThe center latitude of the charger search. Accepts either a float or a list of floats for multiple locations (for example to find chargers along a path). The maximum number of locations is 100.
\n","type":"text/plain"},"key":"lat","value":"54.0"},{"description":{"content":"The center longitude of the charger search. Accepts either a float or a list of floats for multiple locations (for example to find chargers along a path). The maximum number of locations is 100.
\n","type":"text/plain"},"key":"lon","value":"10.0"},{"description":{"content":"The radius of the search in meters.
\n","type":"text/plain"},"key":"radius","value":"200000.0"},{"description":{"content":"[Optional] The types of outlets to be included in the search. Valid types are listed by the get_outlet_types endpoint.
\n","type":"text/plain"},"key":"types","value":"ccs"},{"description":{"content":"[Optional] The maximum number of chargers returned. If not given, and also the maxmum value, the value is 5000. If multiple locations are specified, the number of chargers returned are evenly distributed among the locations.
\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"[Optional] A comma-separated list of short names for charger databases to include, or all available of not given. There is a set of free charger databases which you can use for your application, including \"tesla\", \"sc\" (Tesla superchargers), \"ocm\" (Open ChargeMap).
\n","type":"text/plain"},"key":"allowed_dbs","value":"ocm"},{"disabled":true,"description":{"content":"[Optional] If true, sort the chargers by distance to the center. Can be combined with sort_by_power. Default false.
\n","type":"text/plain"},"key":"sort_by_distance","value":"true"},{"disabled":true,"description":{"content":"[Optional] If true, sort the chargers by power. Default true.
\n","type":"text/plain"},"key":"sort_by_power","value":"true"},{"disabled":true,"description":{"content":"[Optional] Comma-separated list of strings indicating which access groups on chargers should be allowed. A charger with an access_group set needs to be explicitly allowed to be included.
\n","type":"text/plain"},"key":"access_groups","value":"group1,group2"}],"variable":[]}},"response":[],"_postman_id":"1c8b7cca-639f-4450-8900-265518d80fbd"},{"name":"get_outlet_types","id":"a3034cd7-53ac-452c-9609-20f80b081321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.iternio.com/1/get_outlet_types","description":"Each charger in the database has one or more charge outlets, and each outlet has a certain outlet (plug) type. This endpoint lists the supported types of outlets in the Iternio database.
\nFor some API keys we also provide a translation table to the customer's own set of plug types with this call.
\n","auth":{"type":"apikey","apikey":{"value":"Iternio keeps an internal database of charger networks with names and IDs. These IDs are used in e.g. the plan endpoint to give network preferences - see for example the parameter network_preferences.
\nThe get_networks endpoint lists the complete set of charger networks in our database.
\n","auth":{"type":"apikey","apikey":{"value":"This is the main method of the Iternio Route Planner API. It will return a set of proposed routes which match the given input parameters.
\nThe execution time of this method varies with the complexity of the route and other factors. Short routes should return with a couple of seconds whereas long routs with uncommon parameters can take tens of seconds the first time. Since planning is heavily using caching of distances and other information, subsequent method calls with similar parameters will usually be much faster.
\nThe plan method accepts a large set of optional parameters. Since most of them are optional, you can leave out all parameters you have no real opinon and a reasonable default will be chosen. The mandatory parameters are noted as such.
\nThe status returned from the plan endpoint is one of
\n\"ok\" - everything is OK, a valid plan returned
\n\"invalid\" - we could not find a working plan, but something which fails at some step. We still return the invalid plan, indicating which step fails with an is_valid_step=False. Showing this to the user usually helps the user to understand what makes the trip impossible.
\n\"notfound\" - we could not find anything close to a working plan. No plan returned.
\n\"address_not_found\" - One or more of the addresses supplied could not be mapped to a lat/lon position
\n\"address_different_regions\" - The addresses are in different regions of the world
\n\"error\" - planning failed for abnormal reason (such as an internal crash)
\nThe fail_reason may be present if the status is not \"ok\" and can have the following values:
\n\"outside_region\" - one or more of the waypoints are outside the (optional) geographical region defined by the API key
\n... other values may be added
\nThe plan result object contains
\nroutes [array of routes]: An array of routes, of which the first is the fastest found option. The others are alternative routes which are defined as being reasonably close in time to the best, and significantly different when it comes to route.
\nlog_id [number]: The incremental log ID number for the call - refer to this when submitting issues or bug reports.
\nplan_uuid [string]: The unique plan UUID which identifies this plan. Use this to reproduce the plan in ABRP or when using the refresh_plan endpoint.
\ncar_model [typecode string]: The car model typecode for which the route was planned.
\npath_indices [object] An object defining the column index definition of the path array in the steps object. This is only to compact the size of the path array.
\nwhere each route object is defined by
\nsteps [array of steps]: Each step is a destination or charger plus the path between the present destination and the next one. The last step will therefore not contain a path.
\ntotal_drive_duration [s]: The total time spent driving the vehicle in this route.
\ntotal_charge_duration [s]: The total time spent charging the vehicle in this route.
\ntotal_dist [m]: The total distance for this route.
\naverage_consumption [Wh/km]: The estimated average consumption for this route.
\nis_valid_route [m]: True if all steps in the route have is_valid_step set to true.
\nThe step object is defined by
\nname: The name of this charger/waypoint.
\npath [array of path steps]: This is the path between two steps in resolution about 200m steps or less. Each path steps is represented as an array (instead of an object, for compression) defined by the path_indices in the plan result. We will describe it as if each path step is an object.
If you do not need this information, you can disable the this field in the plan method by setting the parameter path_steps=false.
id integer The waypoint/charger id in the Iternio database. This can be used for planning destinations.
arrival_perc [SoC %]: The planned arrival SoC at this step (before any charging).
\narrival_duration [s]: The total time left for the whole route when arriving at this step.
\ndeparture_perc [SoC %]: The planned departure SoC at this step (after any charging).
\ndeparture_duration [s]: The total time left for the whole route when departing this step.
\ndeparture_dist [m]: The total distance left for the whole route when departing this step.
\nlat: The latitude of the waypoint/charger.
\nlon: The longitude of the waypoint/charger.
\nis_valid_step [boolean]: If false, this step cannot be driven according to the consumption model. The plan is returned with status \"invalid\", however, the plan can be displayed to the user to indicate where it does not work out. This particular step should be marked as being broken. The arrival_perc of the next step will likely be below the arrival_soc_perc parameter.
\nutc_offset [s]: The current offset from UTC for the local time zone at the waypoint/charger.
\nis_charger [boolean]: True if this step is a charger.
\nis_waypoint [boolean]: True if this step is a given input destination.
\nis_station [boolean]: True if this step was inserted because it is a ferry terminal or railway station, and it is the departure station
\nis_end_station [boolean]: True if this step was inserted because it is a ferry terminal or railway station, and it is the arrival station
\nis_ferry [boolean]: True if this step is a ferry line. This usually means that is_station is also true, but there are cases where the ferry has multiple stops on the way and we only set is_station on the ferry departure step and is_end_station after the last ferry step.
\nwaypoint_idx [integer]: The index in the input destination array for this destination
\nmax_speed [m/s]: The planned maximum driving speed for path to the next step (if allowed by adjust_speed)
\nis_mod_speed [boolean]: If the maximum speed has been reduced to reach the next step.
\ncharger [charger object]: If this step is a charger, this is a copy of the charger object (as given by the get_chargers endpoint)
\ndrive_duration [s]: The driving time from this step to the next.
\ncharge_duration [s]: The charging time at this step before leaving for the next.
\ncharge_energy [kWh]: The charging energy added (if charger)
\nwait_duration [s]: The expected waiting time at this step before starting to drive. This can be for e.g. ferry terminals.
\ndrive_dist [m]: The driving distance from this step to the next.
\ndrive_weather [weather object]: If weather forecast is available, the driving weather for the step is summarized in this object
\nThe weather object is defined by:
\ntemp [degrees C]: The outside temperature (average for a step)
\nwind_dir [degrees]: The typical wind direction (north is 0, clockwise)
\nwind_speed [m/s]: The typical wind speed
\ncondition [string]: One of \"clear\", \"clouds\", \"fog\", \"light_snow\", \"snow\", \"heavy_snow\", \"light_rain\", \"rain\", \"heavy_rain\", \"thunderstorm\"
\npath_indices point out the indices to data in the path steps array. Contents include
\nlat: Latitude in degrees
\nlon: Longitude in degrees
\nsoc_perc: Estimated SoC in percent (0-100)
\ncons_per_km: Instantaneous consumption in [Wh/km]
\nspeed: Estimated driving speed [km/h]
\nremaining_time: Remaining time to the end of the plan [s]
\nremaining_dist: Remaining distance to the end of the plan [m]
\nspeed_limit: Speed limit for the current road [km/h], if available, or the string \"∞\" if free speed
\nelevation: Elevation of the path step [m]
\nThere are also some traffic-related and step-by-step-navi related properties, which are still under construction and may change.
\nExample:
\n{\n \"name\": \"Udby Kro\",\n \"id\": 3660371,\n \"lat\": 55.080424,\n \"lon\": 11.9595256,\n \"utc_offset\": 3600,\n \"is_charger\": true,\n \"is_station\": false,\n \"is_end_station\": false,\n \"is_waypoint\": false,\n \"is_new_waypoint\": false,\n \"is_destcharger\": false,\n \"arrival_perc\": 46,\n \"departure_perc\": 83,\n \"departure_duration\": 12866,\n \"departure_dist\": 243479,\n \"arrival_dist\": 243479,\n \"arrival_duration\": 14929,\n \"max_speed\": 41.666666666666664,\n \"is_mod_speed\": false,\n \"is_valid_step\": true,\n \"region\": \"europe\",\n \"charge_duration\": 2063,\n \"charger\": {\n \"name\": \"Udby Kro\",\n \"id\": 3660371,\n \"address\": \"Københavnsvej 558, Lundby\",\n \"lat\": 55.080424,\n \"lon\": 11.9595256,\n \"url\": null,\n \"comment\": \"\",\n \"status\": \"Open\",\n \"region\": \"europe\",\n \"outlets\": [\n {\n \"type\": \"chademo\",\n \"stalls\": 1,\n \"power\": 50.0\n },\n {\n \"type\": \"ccs\",\n \"stalls\": 1,\n \"power\": 50.0\n },\n {\n \"type\": \"type2\",\n \"stalls\": 1,\n \"power\": 43.0\n }\n ],\n \"locationid\": \"ocm_31300\"\n },\n \"drive_duration\": 2518,\n \"wait_duration\": 0,\n \"drive_dist\": 72909\n}\n\nAnd finally, the path step object (which is encoded as an array for compression) is defined by:
\nlat: Latitude of the path step.
\nlon: Longitude of the pat step.
\nsoc_perc [SoC %]: The remaining estimated SoC.
\ncons_per_km [Wh/km]: The instantaneous estimated consumption.
\nspeed [km/h]: The estimated speed of the vehicle
\nremaining_time [s]: The remaining time for the whole route.
\nremaining_dist [km]: The remaining distance for the whole route.
\ninstruction: An English turn instruction.
\nspeed_limit [m/s]: The present speed limit, if known (note the unit!)
\nelevation [m]: The elevation over mean sea level.
\npath_distance [m]: The travel distance for this path step only, always 200 m or less.
\njam_factor [0-4]: The traffic jam factor when planning with realtime traffic. 0 means no traffic, 3 means heavy (very slow) traffic and 4 means completely blocked.
\ninstruction_obj: An instruction object for turn-by-turn instructions - see below.
\nThe instruction object is defined by
\nlat: The latitude of the start of the turn
\nlon: The longitude of the start of the turn
\ntype: One of \"turn\", \"roundabout\", \"continue\", \"fork\", \"arrive\", \"off ramp\"
\ndirection: (Optional) One of \"sharp left\", \"left,\" \"slight left\", \"straight\", \"slight right\", \"right\", \"sharp right\" and \"return\"
\nname: (Optional) The name of the road to turn to or the text on the road sign
\nref: (Optional) The technical name of the road to turn to (like \"E 6\")
\nexit: (Optional) The exit number (1, 2, 3 ...) in a roundabout
\nrotation: (Optional) \"cw\" for clockwise roundabouts and \"ccw\" for counterclockwise
\nbearing_change [degrees]: (Optional) The turn angle for roundabouts
\n[Mandatory] A list of at least two destination (the start and final destination) of the plan. Each destination object is has the following properties, in the order they will be used to identify the location:
\n[Mandatory] The typecode of the car model for which to plan.
\n","type":"text/plain"},"key":"car_model","value":"hyundai:kona:19:64:other"},{"description":{"content":"If given and false, the plan output will not include the path object in each step object. This will make the plan object much smaller.
\n","type":"text/plain"},"key":"path_steps","value":"false"},{"description":{"content":"[\"true\"/\"false\"] Return only a polyline (the first two elements of the path output), skip the remaining output details between steps. If path_steps is strue, this parameter is ignored.
\n","type":"text/plain"},"key":"path_polyline","value":"false"},{"description":{"content":"[Wh/km @ 110 km/h] This overrides the default reference consumption of the carmodel. Use this to adjust the assumed consumption of the vehicle. The default value is given by the ref_cons property of the carmodel object given by the get_carmodels endpoint.
\n","type":"text/plain"},"key":"ref_consumption","value":"200"},{"description":{"content":"Comma-separated string of allowed outlet types for planning. The default value is taken from the rec_fast_chargers property of the carmodel.
\n","type":"text/plain"},"key":"fast_chargers","value":"ccs"},{"description":{"content":"[\"true\"/\"false\"] If true, current or forecasted weather will be used for consumption modeling. This can be used together with departure_time in the destination object. (This also means that the static weather parameters will be ignored.)
\n","type":"text/plain"},"key":"realtime_weather","value":"false"},{"description":{"content":"[SoC %] The starting point SoC of the vehicle.
\n","type":"text/plain"},"key":"initial_soc_perc","value":"90"},{"description":{"content":"[SoC %] The minimum SoC allowed when arriving at any charger or waypoint.
\n","type":"text/plain"},"key":"charger_soc_perc","value":"10"},{"description":{"content":"[SoC %] If given, this is the maximum SoC allowed when charging.
\n","type":"text/plain"},"key":"charger_max_soc_perc","value":"100.0"},{"description":{"content":"[SoC %] The minimum SoC allowed when arriving at the final destination.
\n","type":"text/plain"},"key":"arrival_soc_perc","value":"10"},{"description":{"content":"[s] The overhead to add to the driving time and charging time for each charge stop. This typically accounts for finding the charger, connecting it and starting it. A higher value here will lead to fewer but longer charge stops.
\n","type":"text/plain"},"key":"charge_overhead","value":"300"},{"description":{"content":"[%] A speed factor relative to the speed limits or estimated speed of the road. Default is 100, and e.g. 110 means 10% faster than speed limits.
\n","type":"text/plain"},"key":"speed_factor_perc","value":"100"},{"description":{"content":"[km/h] The maximum speed which the planner will allow for the car, even if speed limits allow more. This is mostly useful for very high speed highways, such as Autobahns. If not given, the recommended max speed for the car model is used.
\n","type":"text/plain"},"key":"max_speed","value":"150"},{"description":{"content":"[\"true\"/\"false\"] Allow the route to include ferries.
\n","type":"text/plain"},"key":"allow_ferry","value":"true"},{"description":{"content":"[\"true\"/\"false\"] Allow the route to include highways.
\n","type":"text/plain"},"key":"allow_motorway","value":"true"},{"description":{"content":"[\"true\"/\"false\"] Allow the route to include toll roads.
\n","type":"text/plain"},"key":"allow_toll","value":"true"},{"description":{"content":"[Optional] If false, the route will not allow country border crossings, or more specifically, not allow chargers or waypoints in different countries
\n","type":"text/plain"},"key":"allow_border","value":"true"},{"description":{"content":"[\"true\"/\"false\"] Allow the planner to lower the maximum speed for individual legs if this is needed to reach the next charger.
\n","type":"text/plain"},"key":"adjust_speed","value":"false"},{"description":{"content":"[degrees C] The assumed outside temperature for the plan; this will affect vehicle consumption.
\n","type":"text/plain"},"key":"outside_temp","value":"20"},{"description":{"content":"[m/s] The assumed wind speed for the plan.
\n","type":"text/plain"},"key":"wind_speed","value":"0.0"},{"description":{"content":"[\"head\"/\"tail\"] The assumed wind direction for the plan.
\n","type":"text/plain"},"key":"wind_dir","value":"head"},{"description":{"content":"[\"normal\"/\"rain\"/\"heavy_rain\"] Anything other than normal will increase the assumed consumption of the vehicle.
\n","type":"text/plain"},"key":"road_condition","value":"normal"},{"description":{"content":"[kg] Extra weight assumed for the vehicle. This will typically increase consumption (except downhill).
\n","type":"text/plain"},"key":"extra_weight","value":"0"},{"description":{"content":"[\"true\"/\"false\"] If true, the returned plan may contain up to three routes if there are several reasonable alternatives. These alternatives have been selected to not completely overlap geographically - i.e. different charger selections along the same basic route are not counted as alternatives.
\n","type":"text/plain"},"key":"find_alts","value":"false"},{"description":{"content":"[\"true\"/\"false\"] If true, up to five options for the next charger are returned (as different routes). Cannot be used at the same time as find_alts=\"true\".
\n","type":"text/plain"},"key":"find_next_charger_alts","value":"false"},{"description":{"content":"Comma-separated list of charger ids to exclude from the plan.
\n","type":"text/plain"},"key":"exclude_ids","value":"0"},{"disabled":true,"description":{"content":"Comma-separated list of charger location_ids to exclude from the plan. Same as in the destinations object, these are of the format _.
\n","type":"text/plain"},"key":"exclude_locationids","value":""},{"description":{"content":"A JSON object of network preferences. The properties in the object are string network IDs, and the value of each property can be one of:
\nIf given, the charge time of a preferred network charge is multiplied by this factor. For example, 0.7 means that only 70% of the charging time is accounted for as cost in the optimization. This does not affect the charging time presented to the user.
\n","type":"text/plain"},"key":"preferred_charge_cost_multiplier","value":"0.7"},{"description":{"content":"[s] If given, charging at a non-preferred network charge costs this many seconds extra. For example, a value of 600 means that charging at a non-preferred network charger is assumed to take 5 extra minutes (to make it less likely to be chosen). This does not affect the charging time presented to the user.
\n","type":"text/plain"},"key":"nonpreferred_charge_cost_addition","value":"0"},{"description":{"content":"A JSON object of group preferences. A charger may have a list of groups associated with it (defined when importing a specific charger database). The meaning of these groups is up to the customer to define.\nThe plan can select chargers based on charger membership of these groups using the group_preferences object, defined similar to network_preferences, but instead of network IDs as keys, this is group names. The values can be anything from -2 to +3.
\n","type":"text/plain"},"key":"group_preferences","value":"{}"},{"description":{"content":"A JSON array of strings corresponding to access groups which are allowed among the chargers for this plan. Chargers without an access group list are always allowed. Access groups for each charger can be provided to use via e.g. OCPI.
\n","type":"text/plain"},"key":"access_groups","value":"[]"},{"disabled":true,"description":{"content":"[Deprecated] Comma-separated list of allowed network IDs for the plan. Use network_preferences instead.
\n","type":"text/plain"},"key":"allowed_network_ids","value":""},{"disabled":true,"description":{"content":"[Deprecated] Comma-separated list of preferred network IDs. This has been deprecated - use the network_preferences parameter instead.
\n","type":"text/plain"},"key":"preferred_network_ids","value":""},{"description":{"content":"Comma-separated string of charger database identifiers to be used in the planning. For example \"ocm,sc\" would include chargers only from OpenChargeMap and Tesla Superchargers.
\n","type":"text/plain"},"key":"allowed_dbs","value":"ocm"},{"disabled":true,"description":{"content":"[\"true\"/\"false\"] Available pending approval, this beta feature allows planning with realtime traffic information and routing for the first hour of driving
\n","type":"text/plain"},"key":"realtime_traffic","value":"true"},{"disabled":true,"description":{"content":"[\"true\"/\"false\"] Available pending approval, this beta feature will enable realtime charger status to be used in planning as well as returned as status in the plan
\n","type":"text/plain"},"key":"realtime_chargers","value":"true"},{"disabled":true,"description":{"content":"If given, a string which uniquely identifies the user requesting the plan - preferably anonymized, e.g.. no email address but rather a hash or user_id. This is used in case we need to count the number of unique users or gather statistics on the usage of the API.
\n","type":"text/plain"},"key":"user_identifier","value":""},{"description":{"content":"[One of \"most\", \"more\", \"optimal\", \"fewer\", \"least\"] - bias the number of charge stops in the plan, the default value is \"optimal\" which gives shortest total trip time.
\n","type":"text/plain"},"key":"charge_stops","value":"optimal"}],"variable":[]}},"response":[],"_postman_id":"0796780b-0c95-46db-b003-a6387ca0ca6f"},{"name":"plan_light","id":"c57e90ff-9624-4605-bc4c-e9813fcf64af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.iternio.com/1/plan_light?car_model=3long&destinations=[{\"address\": \"Lund, Sweden\"}, {\"address\": \"Berlin, Germany\"}]&initial_soc_perc=90","description":"This is a light-weight version Iternio EV Planner API plan endpoint. It will return the fundamental information of a plan from point A to point B together with an ABRP URL to refer the end user to for full planning.
\nThe output of this endpoint is a subset of the normal plan endpoint - please refer to that documentation. The only additional information is
\n[Mandatory] The typecode of the car model for which to plan.
\n","type":"text/plain"},"key":"car_model","value":"3long"},{"description":{"content":"[Mandatory] A list of at exactly two destination (the start and final destination) of the plan. Each destination object is has the following properties, in the order they will be used to identify the location:
\n[SoC %] The starting point SoC of the vehicle.
\n","type":"text/plain"},"key":"initial_soc_perc","value":"90"}],"variable":[]}},"response":[],"_postman_id":"c57e90ff-9624-4605-bc4c-e9813fcf64af"},{"name":"refresh_plan","id":"615a81b1-5b47-423c-9f3b-ddff9aa66664","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.iternio.com/1/refresh_plan?plan_uuid=This is a method intended to be periodically (or on events) called while a user is driving a plan, to refresh it with new data like traffic, weather, updated consumption, busy chargers etc.\nA reasonable calling period is 1-10 minutes.
\nSince this is a refresh call, it needs the plan_uuid reference to the original plan to find its stored state and its parameters. The set of parameters for refresh_plan is therefore quite limited.
\n","auth":{"type":"apikey","apikey":{"value":"The plan UUID of the original plan which is being refreshed. This is returned in the result object of the plan endpoint.
\n","type":"text/plain"},"key":"plan_uuid","value":"The current SoC % of the vehicle.
\n","type":"text/plain"},"key":"current_soc_perc","value":"50"},{"description":{"content":"The latitude of the current location of the vehicle. The plan refresh assumes that this is somewhere near the original plan and will plan from this point.
\n","type":"text/plain"},"key":"current_lat","value":"51.1"},{"description":{"content":"The longitude of the current location.
\n","type":"text/plain"},"key":"current_lon","value":"9.312"},{"description":{"content":"[Optional] The bearing/heading of the vehicle in degrees.
\n","type":"text/plain"},"key":"current_bearing","value":"92.1"},{"description":{"content":"A list of route step references for the remaining route the user is driving. Each route step reference contains:
\nA list of route step references for the past route steps on the route the user is driving. Each route step reference contains:
\n[Optional] If true a path object is part of every step, including estimated coordinates, speed, turn instructions, estimated SoC and more in less than 200m resolution.
\n","type":"text/plain"},"key":"path_steps","value":"false"},{"disabled":true,"description":{"content":"[Optional] Returns the path object limited to lat, lon and SoC
\n","type":"text/plain"},"key":"path_polyline","value":"false"}],"variable":[]}},"response":[],"_postman_id":"615a81b1-5b47-423c-9f3b-ddff9aa66664"}],"auth":{"type":"apikey","apikey":{"value":"