API Reference
Start typing to search…

Tariffs

Use the tariffs endpoint to retrieve the raw tariffs that were shared with Eco-Movement by the CPOs using the OCPI protocol.

🚧

Caution

The tariffs endpoint is still active, but the prices endpoint is much more complete and is contributed by multiple sources.

The tariffs endpoint provides a list of prices at the connector level. In locations endpoint's result, the tariff_id attribute corresponds with the tariffs endpoint.

📘

Note

Eco-Movement recommends that you retrieve all the tariffs once a day or once a week.

Request

The request for the tariffs endpoint contains a few query parameters.

See tariffs to know more about the parameters that are used with the tariffs endpoint.

Response

The following is a sample response for the tariffs endpoint:

{
    data: [  
      
        element 1 
          [{...},{...}],
        element 2 
          [{...},{...}]
                
    ], 
}
🚧

Caution

Eco-Movement always upholds the API contract, but we may send new attributes in our JSON response when:

  • we add an OCPI mandatory attribute to the JSON response to be OCPI compliant
  • we improve your licensing module with new features

Hence, we strongly recommend that you handle or ignore unknown JSON fields.

Response Definitions

The following are the attributes for the tariffs endpoint:

Attribute

Description

data.id

The unique id for a tariff.

data.currency

The three digit currency code of the country where the charging station is located.

data.tariff_alt_text

A list of multi language alternative tariff information text.

data.tariff_alt_url

The alternative URL for tariff information.

data.last_updated

The timestamp when the Tariff was last updated or created.

data.cpo_tariff_id

The unique ID of the tariff in the system of the CPO.

data.elements

The list of tariff elements.

data.elements.price_components

The list of price components that make up the pricing of the tariff.

data.elements.price_components.type

The type of tariff. The different types of tariff are:

  • ENERGY: The price per kWh.

  • FLAT: The fixed price per charging session.

  • PARKING_TIME: The parking price per hour.

  • TIME: The fixed price per hour.

data.elements.price_components.price

The price per unit for the tariff type.

data.elements.price_components.step_size

Indicates the minimum amount that is billed. A
unit is billed in step_size blocks. For example, if the type is TIME and step_size is 300, then the time is billed in blocks of 5 minutes. Hence, if 6 minutes is used, then 10 minutes (2 blocks of step_size) is billed.

Note: step_size also depends on the type. Every type (except FLAT) defines a step_size multiplier. This is the size of every 'step' and the unit. For example, PARKING_TIME has a step_size multiplier of 1 second. Therefore, step_size of a price component is multiplied by 1 second. Thus, step_size = 300 means 300 seconds.

data.elements.price_components.restrictions

The list of restrictions for the tariff. The restrictions are:

  • start_time: The starting time of the day for the tariff.

  • end_time: The ending time of the day for the tariff.

  • start_date: The starting date for the tariff.

  • end_date: The ending date for the tariff.

  • min_kwh: The minimum energy used in kWh.

  • max_kwh: The maximum energy used in kWh.

  • min_power: The minimum charging speed in kW.

  • max_power: The maximum charging speed in kW.

  • min_duration: The minimum duration in seconds.

  • max_duration: The maximum duration in seconds.

  • day_of_week: The day(s) of the week that the tariff is valid.