BeMapAPI
BeMap 4.1.0

Get charging station tariffs Look up charging prices

BeMap name: Get charging station tariffs

POST/chargingstation/tariffs/1.0/search

Part of Charging stations1 tutorialBeMap's service page

What charging costs at a station, for a data provider, a charge pass and a connector.

The whole description

In BeMap's words

Returns tariff information based on providers, charge passes, and connectors.

Returns tariff information based on providers, charge passes, and connectors.

Requires the Charging station search or EV smart routing option. Allow to get the charging station information. Not enabled on your account? Ask your BeNomad contact.

Request body

JSON, Content-Type: application/json. Schema ChargingStationTariffsRequest.

  • providerNamestringrequired

    Provider name used by BeMap (bgis).

  • linksChargingTariffConnectorLinkFront[]required

    Represents a list of associations between charging tariffs and connectors.

    ChargingTariffConnectorLinkFront fields
    • poolIdstringrequired

      Unique identifier of the charging pool.

    • chargingPointIdstringrequired

      Unique identifier of the charging point. Use the ID field from charging station search service.

    • connectorIdstringrequired

      Unique identifier of the charging connector. Use the operator ID field from charging station search service.

    • stationIdstring

      Unique identifier of the charging station.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • logTagstring

    Log tag is an UUID tag used during the request calculation in log and send to another provider (if need).

  • chargePassHashIdsstring[]

    Represents a collection of hashed identifiers for tariff charge passes added in response. The tariffs of charge passes are returned in response to the AD/HOC tariffs. The AD/HOC tariffs are always returned when they are available.

Response

200, schema ChargingStationTariffsResponse.

Response fields
  • itemsFindTariffsItemFront[]required

    List of tariffs.

    FindTariffsItemFront fields
    • poolIdstringrequired

      Unique identifier of the charging pool.

    • stationIdstringrequired

      Unique identifier of the charging station.

    • chargingPointIdstringrequired

      Unique identifier of the charging point.

    • connectorIdstringrequired

      Unique identifier of the charging connector.

    • tariffContentChargingTariffContentFrontrequired

      Details of the charging tariff.

      ChargingTariffContentFront fields
      • idstringrequired

        Unique identifier of database entry, generated by the database.

      • providerNamestringrequired

        Provider name of data.

      • updateDateinteger (int64)required

        Update date, time stamp in milliseconds.

      • providerTariffIdstringrequired

        A unique identifier for the tariff provided by a charging service provider. This identifier is used to distinguish between various tariff plans or pricing structures offered by the provider. Typically assigned by the provider, it serves as a reference for mapping and managing charging tariffs.

      • typeenumrequired

        Represents the type of charging tariff applied in the context of a charging session.

        3 accepted values
        AD_HOC
        MSP
        CPO_SUB
      • chargePassChargingTariffChargePassFrontrequired

        The charge pass may provide information about specific subscription features, fees, or charge network details relevant to the charging process.

        ChargingTariffChargePassFront fields
        • hashIdstringrequired

          Unique identifier of charge pass.

        • titlestringrequired

          Name of charge pass.

        • networkNamestring

          Unique name of charge network.

        • descriptionstring

          A brief description or summary of the station charge pass.

        • currencystring

          Currency used for the subscription fee. This field stores the currency code or symbol used for the subscription fee.

        • subscriptionTypestring

          Type of subscription associated with the entity. This may denote the specific subscription model or tier for accessing the station service.

        • subscriptionFeeExclVatnumber (float)

          Subscription fee excluding VAT. This field stores the fee amount charged for a subscription before any value-added tax is applied.

        • networkUrlstring

          URL link to the website of charge network.

        • androidAppUrlstring

          URL link to the Android application of charge network.

        • iosAppUrlstring

          URL link to the iOS application of charge network.

      • currencystringrequired

        Currency ISO 4217 Code.

      • minPriceChargingPriceTaxFrontrequired

        When this field is set, the minimum cost of a Charging Session before taxes cannot be lower than this amount.

        ChargingPriceTaxFront fields
        • excludeTaxnumber (float)required

          Represents the price of a charge without a tax.

        • includeTaxnumber (float)required

          Represents the price of a charge with tax. The amount of money of this tax that is due.

        • namestring

          The name of the tax. The intention is that Parties use short names where possible, e.g. VAT.

      • maxPriceChargingPriceTaxFrontrequired

        When this field is set, the maximum cost of a Charging Session before taxes cannot exceed this amount.

        ChargingPriceTaxFront fields
        • excludeTaxnumber (float)required

          Represents the price of a charge without a tax.

        • includeTaxnumber (float)required

          Represents the price of a charge with tax. The amount of money of this tax that is due.

        • namestring

          The name of the tax. The intention is that Parties use short names where possible, e.g. VAT.

      • tariffItemsChargingTariffItemFront[]required

        A list containing tariff items associated with the charging tariff.

        ChargingTariffItemFront fields
        • pricesChargingPrice[]required

          List of price.

          ChargingPrice fields
          • typeenumrequired

            Type of price dimension.

            4 accepted values
            FLATflat fee, no unit.
            PARKING_TIMEtime not charging, defined in hours.
            ENERGYdefined in kWh.
            TIMEtime charging, defined in hours.
          • pricenumber (float)required

            Price per unit (excluding VAT) for this tariff dimension.

          • unitenum

            Unit of price.

            3 accepted values
            NA
            PER_HOUR
            PER_KWH
          • vatnumber (float)

            Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable.

          • minAmountnumber (float)

            Minimum amount to be billed.

        • restrictionChargingPriceRestriction

          Restriction information of prices.

          ChargingPriceRestriction fields
          • startTimestring

            Start time of day (hh:mm).

          • endTimestring

            End time of day (hh:mm).

          • startDatestring

            Start date (AAAA-MM-DD).

          • endDatestring

            End date (AAAA-MM-DD).

          • minKwhnumber (float)

            Minimum used energy in kWh for this tariff to be valid.

          • maxKwhnumber (float)

            Maximum used energy in kWh for this tariff to be valid.

          • minPowernumber (double)

            Minimum power in kW for this tariff to be valid.

          • maxPowernumber (double)

            Maximum power in kW for this tariff to be valid.

          • minDurationinteger (int32)

            Minimum duration in seconds for this tariff to be valid.

          • maxDurationinteger (int32)

            Maximum duration in seconds for this tariff to be valid.

          • dayOfWeekenum[]

            List of day of the week for this tariff to be valid. Values can be MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.

            7 accepted values
            MONDAY
            TUESDAY
            WEDNESDAY
            THURSDAY
            FRIDAY
            SATURDAY
            SUNDAY
      • providerUpdatedstring

        Represents the date and time when the charging tariff information was last updated. This timestamp allows tracking changes and updates to the tariff details.

      • tariffExplainTextsLanguageTextFront[]

        A list of multilingual textual descriptions for explaining the tariff.

        LanguageTextFront fields
        • languagestringrequired

          Language code (e.g., 'fr', 'en').

        • textstringrequired

          The actual text content.

      • tariffUrlstring

        URL to a web page that contains an explanation of the tariff information in human-readable form.

Errors

  • 400 Bad Request, ErrorResponse
  • 302 No credentials were sent. Do not follow the redirect.
  • 401 The account or the API key is wrong.

How to read each one: Errors.

Tutorials

Reference pages