BeMapAPI
BeMap 4.1.0

Charging station search Find charging stations

BeMap name: Charging station search

POST/chargingstation/search/1.0

Part of Charging stations4 tutorialsBeMap's service page

The charging stations around a place or along a route, with their connectors, their availability and the networks that run them.

The whole description

Use it to show the stations on a map, to keep only those a vehicle can use, or to find the ones available near a driver.

In BeMap's words

Returns the list of charging station (EVSE) around a coordinate.

Returns the list of charging station (EVSE) around a coordinate.

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 ChargingStationSearchRequest.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • modeenum

    Mode of charging station research.

    7 accepted values
    LOCALPerform the research only with the local database or cache.
    REMOTETransfer and perform the request research to the provider database.
    LOCAL_AND_REMOTEPerform the research on local database/cache and on provider database (remote), the results are merged in single response.
    LOCAL_OR_REMOTECapability preference between local and remote request. If the provider have the local capability mode, the request will executed only in local. If not, the remote mode will be used (if remote is available too).
    REMOTE_OR_LOCALCapability preference between remote and local request. If the provider have the remote capability mode, the request will be send to remote provider. If not, the local mode will be used (if local is available too).
    LOCAL_IFNOPOOLS_REMOTECapability preference between local and remote request. If the provider have the local capability mode, the request will executed on local database in first. If not pools are found, the remote mode will be used (if remote is available too).
    REMOTE_IFNOPOOLS_LOCALCapability preference between remote and local request. If the provider have the remote capability mode, the request will be send to remote provider in first. If not pools are found, the local mode will be used (if local is available too).
  • optionsenum[]

    Options of charging station service.

    8 accepted values
    AVAILABLE_CONNECTOR_TYPESReturn the list of available connector type supported by the server.
    DEPRECATED_CONNECTORInclude all deprecated connector types.
    PATH_POOL_MAPDepth of path limited to the minimal pool information to display on map. Limited filtering capacity.
    PATH_POINT_MAPDepth of path limited to the minimal pool information to show on map. But allow filtering based on charging point.
    PATH_POOLDepth of path limited to the pool information.
    PATH_STATIONDepth of path limited to the station information.
    PATH_POINTDepth of path limited to the charging point information.
    PATH_AUTOAutomatic switching between PATH_POOL_MAP to PATH_POINT data precision. The depth of a path limits the charging point information.
  • pathAutoMaxPoolinteger (int32)

    Define the maximum of pool found by request to automatic switching between DepthOfPath. The depth of a path limits the charging point information. See the option PATH_AUTO. 20 by default.

  • providersstring[]

    Provider names used by BeMap (bgis).

  • coordinateCoordinate

    Coordinate research center in degrees decimal (WGS84). The radius parameter can be used with this parameter. The parameters coordinate, corridor, and boundingBox are mutually exclusive. Use one of them is required.

    Coordinate fields
    • lonnumber (double)required

      Longitude in degrees decimal (WGS84).

      Also accepted as longitude.

    • latnumber (double)required

      Latitude in degrees decimal (WGS84).

      Also accepted as latitude.

  • corridorCoordinate[]

    List of coordinate in degrees decimal (WGS84) represent the corridor of research. The radius parameter can be used with this parameter. The parameters coordinate, corridor, and boundingBox are mutually exclusive. Use one of them is required.

    Coordinate fields
    • lonnumber (double)required

      Longitude in degrees decimal (WGS84).

      Also accepted as longitude.

    • latnumber (double)required

      Latitude in degrees decimal (WGS84).

      Also accepted as latitude.

  • radiusinteger (int32)

    Define the radius in meters of search. Required by the center or corridor parameters.

  • bboxBoundingBox

    Bounding box in degrees decimal (WGS84) represent the corridor of research. The parameters coordinate, corridor, and boundingBox are mutually exclusive. Use one of them is required.

    BoundingBox fields
    • minLonnumber (double)

      Minimum longitude, in degrees decimal (WGS84).

    • minLatnumber (double)

      Minimum latitude, in degrees decimal (WGS84).

    • maxLonnumber (double)

      Maximum longitude, in degrees decimal (WGS84).

    • maxLatnumber (double)

      Maximum latitude, in degrees decimal (WGS84).

  • maxPoolResultinteger (int32)

    Define the maximum pools will be returned in response.

  • maxProviderResultinteger (int32)

    Define the maximum of provider item researched.

  • connectorIdFiltersinteger (int32)[]

    List of connector type ID to perform a filtration based on those values.

  • poolIdFilterstring

    Pool ID filter, return only the pool with the input ID.

  • stationIdFilterstring

    Station ID filter, return only the station with the input ID.

  • pointIdFilterstring

    Point ID filter, return only the point with the input ID.

  • filtersVersionbase64 string

    Represents the version of the filtering logic used in the charging station search query. This field determines which filtering implementation or algorithm is applied during processing. The default is 1. The available values are: 1, 2.

  • filtersstring[]

    Filters, return only the points matching the filters. Documentation of available filters.

  • languagestring

    Define the language that will be used to perform the address lookup.

Response

200, schema ChargingStationSearchResponse.

Response fields
  • poolsChargingStationPool[]

    Pools of charging station.

    ChargingStationPool fields
    • providerNamestring

      Provider name used by BeMap (bgis).

    • providerModeenum

      Define if the data come from the local database or directly from provider API.

      3 accepted values
      LOCALThe charging station data come from the local database or cache (local request to spatial database).
      REMOTEThe charging station data come directly from the provider database (remote request to provider API).
      NOT_SUPPORTED_VALUENot supported value for this API version.
    • idstring

      Unique identifier of pool, come from the provider.

    • operatorIdstring

      Operator unique identifier like eMI3 format.

    • sourceProviderstring

      Name of the original provider.

    • customerIdstring

      Customer id.

    • updateDateinteger (int64)

      Update date, time stamp in milliseconds.

    • tagsstring[]

      List of tags, will be used to perform some filtration based on provider or customer references.

    • brandstring

      Brand name of pool.

    • nameOfPoolstring

      Name of pool.

    • accessibilityenum

      Define the accessibility of a pool of charging station.

      13 accepted values
      UNSUPPORTED_VALUENot found, not supported new value.
      NAUnspecified access to the area.
      PUBLICPublicly accessible area.
      PUBLIC_WITH_MEMBERSHIPPublic with membership.
      PUBLIC_UPON_PRESENTATIONPublic upon presentation.
      PRIVATEPrivate.
      PRIVATE_EMPLOYEES_ONLYPrivate employees only.
      PRIVATE_CUSTOMERS_ONLYPrivate customers only.
      PRIVATE_RESIDENTS_ONLYPrivate residents only.
      PRIVATE_UPON_PRESENTATIONPrivate upon presentation.
      RESTRICTEDControlled or restricted area access.
      CAR_SHARING_ONLYCar sharing only.
      OTHEROther.
    • availabilityStatusenum

      Define the status of availability.

      8 accepted values
      UNSUPPORTED_VALUENot found, not supported new value.
      NANot specified.
      OUT_OF_ORDEROut Of Order.
      IN_SERVICEIn service.
      IN_SERVICE_FREEIn service and free.
      IN_SERVICE_BUSYIn service but busy.
      IN_SERVICE_RESERVEDIn service but reserved.
      FUTUREFuture.
    • longitudenumber (double)

      Longitude in degrees decimal (WGS84) (double).

    • latitudenumber (double)

      Latitude in degrees decimal (WGS84) (double).

    • countryCodestring

      ISO country code, 2 or 3 letters depends on provider (ISO 3166-1 alpha-2 and alpha-3).

    • countrystring

      Country.

    • postalCodestring

      Zip code.

    • citystring

      City name.

    • streetstring

      Street name.

    • streetNumberstring

      House number.

    • addressComplementstring

      Pool complement of address.

    • floorNumberstring

      Address floor number.

    • siteTypestring

      Textual description of site.

    • siteCategoryenum

      Reflects the general category type of the pool.

      10 accepted values
      NANot available.
      UNKNOWNUnknown category.
      OTHEROther, not categorized.
      ON_STREETParking in public space along a street.
      ON_MOTORWAYLocation on a parking facility/rest area along a motorway, freeway, interstate, highway etc.
      PARKING_LOTA cleared area that is intended for parking vehicles, i.e. at super markets, bars, etc.
      BUILDING_DRIVEWAYLocation is on the driveway of a house/building.
      BUILDING_PARKINGMulti-storey car park.
      UNDERGROUND_PARKINGMulti-storey car park, mainly underground.
      UNSUPPORTED_VALUENot found, not supported new value.
    • phoneNumberstring

      Phone number.

    • timeZonestring

      Time zone. One of IANA tzdata's TZ-values representing the time zone of the location. Examples: "Europe/Oslo", "Europe/Zurich". (http://www.iana.org/time-zones)

    • open24x7boolean

      Pool is opened 24x7 hours.

    • openingHoursPoolOpeningHour[]

      List of opening hours.

      PoolOpeningHour fields
      • dayOfweekenum

        Day of week.

        7 accepted values
        MONDAYMONDAY.
        TUESDAYTUESDAY.
        WEDNESDAYWEDNESDAY.
        THURSDAYTHURSDAY.
        FRIDAYFRIDAY.
        SATURDAYSATURDAY.
        SUNDAYSUNDAY.
      • startstring

        Start time of opened pool.

      • endstring

        End time of opened pool.

    • numberOfParkingSpaceinteger (int32)

      Number of parking space in the pool (parking).

    • commentstring

      Comment.

    • imagesImageUrl[]

      Links to images related to the location such as photos or logos.

      ImageUrl fields
      • urlstring

        URL from where the image data can be fetched through a web browser.

      • thumbnailUrlstring

        URL from where a thumbnail of the image can be fetched through a web browser.

      • categoryenum

        Describes what the image is used for. Values can be CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER.

        8 accepted values
        CHARGERCharger
        ENTRANCEEntrance
        LOCATIONLocation
        NETWORKNetwork
        OPERATOROperator
        OTHEROther
        OWNEROwner
        NOT_SUPPORTED_VALUENot supported value for this API version.
      • formatstring

        Image format like gif, jpeg, png, svg.

      • widthinteger (int32)

        Width of the full-scale image.

      • heightinteger (int32)

        Height of the full-scale image.

    • chargingStationsChargingStation[]

      List of charging stations.

      ChargingStation fields
      • idstring

        ID of station.

      • operatorIdstring

        Operator unique identifier like eMI3 format.

      • natureenum

        Nature define the interpretation and behavior. If VGROUP the data must be interpreted as an no reality object, just like a simple group. If is REAL, the object exist in the reality world.

        2 accepted values
        VGROUPThe data must not be interpreted as an actual physical object, but as a simple group.
        REALThe object exists in the real world.
      • availabilityStatusenum

        Define the status of availability.

        8 accepted values
        UNSUPPORTED_VALUENot found, not supported new value.
        NANot specified.
        OUT_OF_ORDEROut Of Order.
        IN_SERVICEIn service.
        IN_SERVICE_FREEIn service and free.
        IN_SERVICE_BUSYIn service but busy.
        IN_SERVICE_RESERVEDIn service but reserved.
        FUTUREFuture.
      • authenticationModesstring[]

        Authentication mode.

      • authenticationInformationstring

        Information about the authentication.

      • paymentModesstring[]

        Payment mode.

      • paymentInformationstring

        Information about the payment mode.

      • chargePassesChargingTariffChargePassFront[]

        List of charge pass available a station.

        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.

      • bookableboolean

        Bookable. Set to true if the station is bookable.

      • imagesImageUrl[]

        Links to images related to the location such as photos or logos.

        ImageUrl fields
        • urlstring

          URL from where the image data can be fetched through a web browser.

        • thumbnailUrlstring

          URL from where a thumbnail of the image can be fetched through a web browser.

        • categoryenum

          Describes what the image is used for. Values can be CHARGER, ENTRANCE, LOCATION, NETWORK, OPERATOR, OTHER, OWNER.

          8 accepted values
          CHARGERCharger
          ENTRANCEEntrance
          LOCATIONLocation
          NETWORKNetwork
          OPERATOROperator
          OTHEROther
          OWNEROwner
          NOT_SUPPORTED_VALUENot supported value for this API version.
        • formatstring

          Image format like gif, jpeg, png, svg.

        • widthinteger (int32)

          Width of the full-scale image.

        • heightinteger (int32)

          Height of the full-scale image.

      • tagsstring[]

        List of tags, will be used to perform some filtration based on provider or customer references.

      • chargingPointsChargingPoint[]

        List of charging points.

        ChargingPoint fields
        • idstring

          ID of charging point.

        • operatorIdstring

          Operator unique identifier like eMI3 format.

        • availabilityStatusenum

          Define the status of availability.

          8 accepted values
          UNSUPPORTED_VALUENot found, not supported new value.
          NANot specified.
          OUT_OF_ORDEROut Of Order.
          IN_SERVICEIn service.
          IN_SERVICE_FREEIn service and free.
          IN_SERVICE_BUSYIn service but busy.
          IN_SERVICE_RESERVEDIn service but reserved.
          FUTUREFuture.
        • availabilityUntilinteger (int64)

          Availability available until time (Time stamp in milliseconds).

        • typeinteger (int32)

          ID of first connector type.

        • connectorTypesConnectorTypeFront[]

          List of connector type.

          ConnectorTypeFront fields
          • idinteger (int32)

            BeMap unique identifier of connector.

          • keystring

            BeMap unique identifier text key of connector. Same as id field but with string value.

          • operatorIdstring

            Operator unique identifier like eMI3 format.

          • deprecatedboolean

            Set to true if the information is deprecated.

          • namestring

            Name of connector.

          • normstring

            Norm of connector.

          • maxPowernumber (double)

            Maximal power in kW of connector. Unlimited is 0.

          • powernumber (double)

            Available power in kW can be delivered by the station or charge point.

          • voltagenumber (float)

            Voltage of current.

          • amperenumber (float)

            Ampere of current.

          • acSingleboolean

            AC single phase.

          • acThreeboolean

            Current type AC three phases.

          • dcboolean

            Current type DC.

          • cableboolean

            The connector have a cable.

        • currentTypeenum

          Current type (AC/DC).

          5 accepted values
          NANot available (NA).
          ACAlternating current (AC), but the number of phases is not available.
          AC_SINGLE_PHASEAlternating current (AC), single phase.
          AC_THREE_PHASESAlternating current (AC), three phases.
          DCDirect current (DC).
        • voltagenumber (float)

          Voltage of current.

        • amperenumber (float)

          Ampere of current.

        • powernumber (double)

          Electrical power in kW.

        • currencystring

          Currency ISO 4217 Code.

        • remoteChargingboolean

          True if a charging session can be started remotely.

        • tariffsTypestring

          Represents the type of tariffs, e.i. AD_HOC, MSP.

        • tariffsChargePassHashIdstring

          Represents a unique identifier hash associated with the tariffs used for calculating charges.

        • tariffsChargingTariffItemFront[]

          List of 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
        • parkingSpotParkingVehicleAccessFront

          Vehicle access restrictions and parking information for this charging point.

          ParkingVehicleAccessFront fields
          • maxHeightinteger (int32)

            Maximum height (in cm) of a vehicle to access the parking. Null if no restriction.

          • maxWidthinteger (int32)

            Maximum width (in cm) of a vehicle to access the parking. Null if no restriction.

          • maxLengthinteger (int32)

            Maximum length (in cm) of a vehicle to access the parking. Null if no restriction.

          • maxWeightinteger (int32)

            Maximum weight (in tenth of ton) of a vehicle to access the parking. Null if no restriction.

          • dangerousGoodsAllowedboolean

            Whether vehicles loaded with dangerous goods are allowed to park.

          • overnightParkingAllowedboolean

            Whether overnight parking is allowed for heavy vehicles.

          • parkingOrientationenum

            The direction in which vehicles are parked at the charging station.

            4 accepted values
            PARALLELParking happens parallel to the roadway on which vehicles approach the charging station.
            PERPENDICULARParking happens perpendicular to the roadway on which vehicles approach the charging station.
            ANGLEParking happens at an angle to the roadway on which vehicles approach the charging station (i.e. echelon parking).
            DRIVE_THROUGHA vehicle can stop, charge, and proceed without reversing into or out of a parking bay. This is particularly important for heavy vehicles with trailers.
          • transportTypesenum[]

            List of transport types that can use this parking.

            9 accepted values
            PEDESTRIANPedestrian.
            BICYCLEBicycle.
            MOTORCYCLEMotorcycle.
            CARPassenger car.
            TAXITaxi.
            PUBLIC_BUSPublic bus.
            EMERGENCYEmergency vehicle.
            DELIVERY_TRUCKDelivery truck. Deprecated, use TRUCK instead.
            TRUCKTruck.
        • tagsstring[]

          List of tags, will be used to perform some filtration based on provider or customer references.

    • summaryOfConnectorTypeIdsinteger (int32)[]

      Summarized of connector type, used as cache of different connector types present in pool.

    • maxNominalPowernumber (double)

      Maximum of nominal power (in kW) present in pool.

    • numberOfChargingPointinteger (int32)

      Summarized of number of charging point present in pool.

    • reliabilityScoreinteger (int32)

      Reliability score of the pool. A score of 1 is the least reliable, and a score of 5 is the most reliable.

    • predictedOccupancyTimeSlotsPredictedOccupancyTimeSlot[]

      List of predicted occupancy time slots for a charging station. Each time slot provides information about the predicted occupancy level within a specific time range on a given day.

      PredictedOccupancyTimeSlot fields
      • dayOfweekenum

        Day of week.

        7 accepted values
        MONDAYMONDAY.
        TUESDAYTUESDAY.
        WEDNESDAYWEDNESDAY.
        THURSDAYTHURSDAY.
        FRIDAYFRIDAY.
        SATURDAYSATURDAY.
        SUNDAYSUNDAY.
      • startstring

        Start time of opened pool.

      • endstring

        End time of opened pool.

      • predictedOccupancyinteger (int32)

        Predicted occupancy. This value ranges from 0 to 10, where: 0 means the station is least occupied. 10 means the station is fully occupied.

    • vehicleAccessSummaryParkingVehicleAccessFront

      Restrictions regarding vehicles.

      SummaryParkingVehicleAccessFront fields
      • maxHeightinteger (int32)

        Maximum height (in cm) of a vehicle to access the parking. Null if no restriction.

      • maxWidthinteger (int32)

        Maximum width (in cm) of a vehicle to access the parking. Null if no restriction.

      • maxLengthinteger (int32)

        Maximum length (in cm) of a vehicle to access the parking. Null if no restriction.

      • maxWeightinteger (int32)

        Maximum weight (in tenth of ton) of a vehicle to access the parking. Null if no restriction.

      • dangerousGoodsAllowedboolean

        Whether vehicles loaded with dangerous goods are allowed to park.

      • overnightParkingAllowedboolean

        Whether overnight parking is allowed for heavy vehicles.

      • parkingOrientationenum

        The direction in which vehicles are parked at the charging station.

        4 accepted values
        PARALLELParking happens parallel to the roadway on which vehicles approach the charging station.
        PERPENDICULARParking happens perpendicular to the roadway on which vehicles approach the charging station.
        ANGLEParking happens at an angle to the roadway on which vehicles approach the charging station (i.e. echelon parking).
        DRIVE_THROUGHA vehicle can stop, charge, and proceed without reversing into or out of a parking bay. This is particularly important for heavy vehicles with trailers.
      • transportTypesenum[]

        List of transport types that can use this parking.

        9 accepted values
        PEDESTRIANPedestrian.
        BICYCLEBicycle.
        MOTORCYCLEMotorcycle.
        CARPassenger car.
        TAXITaxi.
        PUBLIC_BUSPublic bus.
        EMERGENCYEmergency vehicle.
        DELIVERY_TRUCKDelivery truck. Deprecated, use TRUCK instead.
        TRUCKTruck.
      • parkingOrientationsenum[]
        4 accepted values
        PARALLEL
        PERPENDICULAR
        ANGLE
        DRIVE_THROUGH

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