# API reference

53 operations from BeMap's own specification. Every path is relative to `https://bemap.benomad.com/bgis/service`. Authentication is HTTP Basic: the account is the user name, the API key the password.

## [Authentication](https://benomad.com/dev/doc/bemap-api/api/authentication.md)

How a call proves who sends it, and how BeMap answers when it does not.

- [Authentication methods](https://benomad.com/dev/doc/bemap-api/api/authentication/methods.md)

## [Routing](https://benomad.com/dev/doc/bemap-api/api/routing.md)

Routes and arrival times for a vehicle profile, isochrones and matrices, and GPS traces matched to the road network.

### [Route calculation](https://benomad.com/dev/doc/bemap-api/routing/route-calculation.md)

Optimal routes and ETAs for a vehicle profile, with isochrones and origin-destination matrices from the same endpoint.

- [`POST /routing/1.0`](https://benomad.com/dev/doc/bemap-api/api/routing/routing.md): Routing

### [Trace route](https://benomad.com/dev/doc/bemap-api/routing/traceroute.md)

The most probable driving route from a GPS trace, corrected and ready to display.

- [`POST /routing/1.0/traceroute`](https://benomad.com/dev/doc/bemap-api/api/routing/routing-traceroute.md): Trace route

## [Electric mobility](https://benomad.com/dev/doc/bemap-api/api/electric-mobility.md)

Electric trips with their charging stops, reachable areas, charging stations and tariffs, charging time and cost, and the electric vehicle database.

### [EV smart routing](https://benomad.com/dev/doc/bemap-api/electric-mobility/ev-smart-routing.md)

A trip planned for one electric vehicle, with the charging stops it needs and the charge at each one.

- [`POST /2.0/evsmartrouting`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-v2-0.md): EV smart routing · v2.0
- [`GET /evsmartrouting/servicecategory/autocomplete/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-servicecategory-autocomplete.md): Service category
- [`POST /evsmartrouting/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-v1-0.md): EV smart routing · v1.0 (older version)

### [EV reachable area](https://benomad.com/dev/doc/bemap-api/electric-mobility/ev-reachable-area.md)

How far an electric vehicle can go without charging, as an area around its start point.

- [`POST /evreachablearea/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evreachablearea.md): EV reachable area

### [Charging stations](https://benomad.com/dev/doc/bemap-api/electric-mobility/charging-stations.md)

Charging stations around a place or along a route, with connectors, availability, networks, tariffs and charge passes.

- [`POST /chargingstation/search/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-search.md): Charging station search
- [`POST /chargingstation/tariffs/1.0/search`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-tariffs-search.md): Get charging station tariffs
- [`GET /chargingstation/chargepass/1.0/list`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-chargepass-list.md): Charging station charge pass
- [`GET /chargingstation/chargepass/1.0/autocomplete`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-chargepass-autocomplete.md): Charging station charge pass autocomplete suggestions
- [`GET /chargingstation/brand/1.0/list`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-brand-list.md): Charging station brands
- [`GET /chargingstation/brand/autocomplete/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-brand-autocomplete.md): Pool brand autocomplete suggestions
- [`GET /chargingstation/filter/autocomplete/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-filter-autocomplete.md): Charging station filters autocomplete suggestions
- [`GET /chargingstation/connector/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingstation-connector-list.md): Connector list of charging station

### [Charging time and cost](https://benomad.com/dev/doc/bemap-api/electric-mobility/charging-time-cost.md)

How long a vehicle needs to charge from one level to another, and what it will cost at a given station.

- [`POST /chargingTime/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingtime.md): Charging time
- [`POST /chargingcost/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/chargingcost.md): Charging cost calculation

### [Electric vehicle database](https://benomad.com/dev/doc/bemap-api/electric-mobility/ev-vehicles.md)

BeNomad's database of electric vehicles: brands, models, motor types, WLTP data, battery capacity, charging speed, photos and logos.

- [`GET /vehicle/1.1/findvehicles`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-findvehicles-v1-1-get.md): Find vehicles (GET) · v1.1
- [`POST /vehicle/1.1/findvehicles`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-findvehicles-v1-1-post.md): Find vehicles (POST) · v1.1
- [`GET /vehicle/1.1/getbrands`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getbrands-v1-1.md): Vehicle brands · v1.1
- [`GET /vehicle/1.1/getmotortypes`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getmotortypes-v1-1.md): Vehicle motor types · v1.1
- [`GET /vehicle/1.1/getlevelvehicleinfo`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getlevelvehicleinfo-v1-1-get.md): Get level vehicle info · v1.1 · GET
- [`POST /vehicle/1.1/getlevelvehicleinfo`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getlevelvehicleinfo-v1-1-post.md): Get level vehicle info · v1.1 · POST
- [`GET /vehicle/1.1/getbrandlogo`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getbrandlogo.md): Vehicle brand logo object
- [`GET /vehicle/1.1/getbrandlogolite`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getbrandlogolite.md): Vehicle brand logo in byte
- [`GET /vehicle/picture/1.0/getall`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-picture-getall.md): Vehicle pictures
- [`GET /vehicle/picture/1.0/getone`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-picture-getone.md): Vehicle picture
- [`GET /vehicle/picture/1.0/getviews`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-picture-getviews.md): Available vehicle views
- [`GET /evsmartrouting/vehiclebrands/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-vehiclebrands-list.md): EV vehicle brands
- [`GET /evsmartrouting/vehiclemodels/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-vehiclemodels-list-get.md): EV vehicles (GET)
- [`POST /evsmartrouting/vehiclemodels/list/1.0`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/evsmartrouting-vehiclemodels-list-post.md): EV vehicles (POST) (deprecated)
- [`GET /vehicle/1.0/findvehicles`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-findvehicles-v1-0-get.md): Find vehicles (GET) · v1.0 (deprecated)
- [`POST /vehicle/1.0/findvehicles`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-findvehicles-v1-0-post.md): Find vehicles (POST) · v1.0 (deprecated)
- [`GET /vehicle/1.0/getbrands`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getbrands-v1-0.md): Vehicle brands · v1.0 (deprecated)
- [`GET /vehicle/1.0/getmotortypes`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getmotortypes-v1-0.md): Vehicle motor types · v1.0 (deprecated)
- [`GET /vehicle/1.0/getlevelvehicleinfo`](https://benomad.com/dev/doc/bemap-api/api/electric-mobility/vehicle-getlevelvehicleinfo-v1-0.md): Get level vehicle info · v1.0 (deprecated)

## [Search](https://benomad.com/dev/doc/bemap-api/api/search.md)

Addresses from text, coordinates from addresses and back, one at a time or in batches.

### [Geocoding](https://benomad.com/dev/doc/bemap-api/search/geocoding.md)

An address, structured or free text, turned into coordinates: one at a time, as you type, or in batch.

- [`POST /geocoding/1.0`](https://benomad.com/dev/doc/bemap-api/api/search/geocoding.md): Geocoding
- [`POST /geocoding/1.0/natural`](https://benomad.com/dev/doc/bemap-api/api/search/geocoding-natural.md): Natural geocoding
- [`POST /geocoding/autocomplete/1.0`](https://benomad.com/dev/doc/bemap-api/api/search/geocoding-autocomplete.md): Auto-complete
- [`POST /geocodingBatch/1.0`](https://benomad.com/dev/doc/bemap-api/api/search/geocodingbatch.md): Geocoding for batch job

### [Reverse geocoding](https://benomad.com/dev/doc/bemap-api/search/reverse-geocoding.md)

Coordinates turned into a readable address, one at a time or in batch.

- [`POST /geocoding/1.0/reverse`](https://benomad.com/dev/doc/bemap-api/api/search/geocoding-reverse.md): Reverse geocoding
- [`POST /geocodingBatch/1.0/reverse`](https://benomad.com/dev/doc/bemap-api/api/search/geocodingbatch-reverse.md): Reverse geocoding for batch job

## [Map context](https://benomad.com/dev/doc/bemap-api/api/map-context.md)

What lies around a position or a route: points of interest, geofences, the road network of an area, live traffic, the weather, and currency conversion for costs.

### [Near POI](https://benomad.com/dev/doc/bemap-api/search/near-poi.md)

Points of interest around a place, limited by the distance to drive or walk to them.

- [`POST /nearpoi/1.0`](https://benomad.com/dev/doc/bemap-api/api/map-context/nearpoi.md): Near POI

### [Geofencing](https://benomad.com/dev/doc/bemap-api/search/geofencing.md)

Whether assets are inside or outside the areas you define.

- [`POST /geofencing/1.0`](https://benomad.com/dev/doc/bemap-api/api/map-context/geofencing.md): Natural geocoding

### [Roads extractor](https://benomad.com/dev/doc/bemap-api/routing/roads-extractor.md)

Every road segment inside a polygon, filtered by transport mode: the input of a tour that covers a whole zone.

- [`POST /roadsextractor/1.0`](https://benomad.com/dev/doc/bemap-api/api/map-context/roadsextractor.md): Roads extractor

### [Traffic](https://benomad.com/dev/doc/bemap-api/more-services/traffic.md)

Live traffic events and flow for an area.

- [`POST /traffic/1.0`](https://benomad.com/dev/doc/bemap-api/api/map-context/traffic.md): Traffic

### [Weather](https://benomad.com/dev/doc/bemap-api/more-services/weather.md)

Current weather and forecasts at a place.

- [`POST /weather/1.0`](https://benomad.com/dev/doc/bemap-api/api/map-context/weather.md): Weather
- [`POST /weather/1.0/current`](https://benomad.com/dev/doc/bemap-api/api/map-context/weather-current.md): Current weather
- [`POST /weather/1.0/forecast`](https://benomad.com/dev/doc/bemap-api/api/map-context/weather-forecast.md): Forecast weather

### [Currency](https://benomad.com/dev/doc/bemap-api/more-services/currency.md)

Exchange rates and conversions, for costs in the reader's currency.

- [`GET /currency/1.0/codes`](https://benomad.com/dev/doc/bemap-api/api/map-context/currency-codes.md): Currency rates · codes
- [`GET /currency/1.0/rates`](https://benomad.com/dev/doc/bemap-api/api/map-context/currency-rates.md): Currency rates
- [`GET /currency/1.0/rate`](https://benomad.com/dev/doc/bemap-api/api/map-context/currency-rate.md): Currency single rate
- [`GET /currency/1.0/convert`](https://benomad.com/dev/doc/bemap-api/api/map-context/currency-convert-get.md): Currency convert · GET
- [`POST /currency/1.0/convert`](https://benomad.com/dev/doc/bemap-api/api/map-context/currency-convert-post.md): Currency convert · POST

## [Map rendering](https://benomad.com/dev/doc/bemap-api/api/map-rendering.md)

Map images over the OGC Web Map Service. BeNomad Tiles, the vector map, has a host and an API of its own.

- [GetMap service · 1.3.0](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-3-0-getmap.md)
- [GetCapabilities service · 1.3.0](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-3-0-getcapabilities.md)
- [GetFeatureInfo service · 1.3.0](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-3-0-getfeatureinfo.md)

### Older versions

- [GetMap service · 1.1.1](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-1-1-getmap.md)
- [GetCapabilities service · 1.1.1](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-1-1-getcapabilities.md)
- [GetFeatureInfo service · 1.1.1](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-wms-1-1-1-getfeatureinfo.md)
- [REST API, BND version 0.9 (Deprecate see WMS API)](https://benomad.com/dev/doc/bemap-api/api/map-rendering/mapping-bnd.md)

See also [BeNomad Tiles](https://benomad.com/dev/doc/bemap-api/maps/tiles.md): Vector map tiles, styles and fonts for MapLibre on the web and on mobile, with 3D buildings, terrain and the globe.
