Dynamic Data

VERSION 1.17.0

PUBLIC PREVIEW

To use the Maps SDK in your application you need to obtain a TomTom API key by following these instructions. Remember to keep your API key secure.

This API is unavailable on a Freemium or Pay As You Grow (PAYG) basis. [Request access]() to contact our sales team.

The Dynamic Data module is comprised of four APIs: fuel prices, parking availability, parking prices and EV charging availability. These APIs provide up-to-date information and can be useful for drivers to decide where to park, refill and charge.

Initializing

To use our dynamic data feed, you must configure its credentials and add the SDK as a dependency:

Get your TomTom API Key and configure the project as described in the Project setup guide.
Add the Dynamic data module dependency in the build.gradle.kts of your application module and synchronize the project.
```
implementation("com.tomtom.sdk.search:dynamic-data-online:1.17.0")
```

Fuel prices

The fuel prices API provides information on the current fuel prices at a specified fuel station. The only required request parameter is the fuel station identifier, which can be fetched from Fuzzy Search. The identifier is in the SearchResultId of the SearchResult, labeled fuelPriceId.

Not every SearchResult contains fuel price information.

1val fuelPriceOptions =
  searchResult.searchResultId.fuelPriceId?.let { fuelPriceId ->
      FuelPriceOptions(fuelPriceId)
  }

A successful request returns a FuelPriceResponse. If the request fails, a SearchFailure is returned.

1fuelPriceProvider = OnlineDynamicDataProviderFactory.createFuelPriceProvider(context, "YOUR_TOMTOM_API_KEY")
2fuelPriceOptions?.let { options ->
  fuelPriceProvider.requestFuelPrices(
      options,
      object : FuelPriceCallback {
          override fun onSuccess(result: FuelPriceResponse) {
              // YOUR CODE GOES HERE
          }
9
          override fun onFailure(failure: SearchFailure) {
              // YOUR CODE GOES HERE
          }
      },
  )
15}

Parking availability

The parking availability API provides up-to-date information about the number of available parking places and the trend in occupancy at a specified parking location. The only required parameter is the parking information identifier.

You can get this identifier from the result of a Fuzzy Search. The identifier is in the SearchResultId of the SearchResult, labeled parkingDetailId.

Not every SearchResult contains parking information.

1val parkingAvailabilityOptions =
  searchResult.searchResultId.parkingDetailId?.let { parkingDetailId ->
      ParkingAvailabilityOptions(parkingDetailId)
  }

A successful request returns ParkingAvailabilityResponse. If the request fails, a SearchFailure is returned.

1parkingDetailProvider =
  OnlineDynamicDataProviderFactory.createParkingDetailProvider(
      context,
      "YOUR_TOMTOM_API_KEY",
  )
6parkingAvailabilityOptions?.let { options ->
  parkingDetailProvider.requestParkingAvailability(
      options,
      object :
          ParkingAvailabilityCallback {
          override fun onSuccess(result: ParkingAvailabilityResponse) {
              // YOUR CODE GOES HERE
          }
14
          override fun onFailure(failure: SearchFailure) {
              // YOUR CODE GOES HERE
          }
      },
  )
20}

Parking prices

The parking prices API provides up-to-date parking price information of the specified parking location. The only required parameter is the parking information identifier.

You can get this identifier by doing a Fuzzy Search. The identifier is in the SearchResultId of the SearchResult, labeled parkingDetailId.

Not every SearchResult contains parking information.

1val parkingPriceOptions =
  searchResult.searchResultId.parkingDetailId?.let { parkingDetailId ->
      ParkingPriceOptions(
          parkingDetailId = parkingDetailId,
          startTime = Calendar.getInstance(),
          duration = 3.hours,
      )
  }

You can also pass a startTime, which defines the beginning of the parking period and a duration, which defines how long the parking is needed.

A successful request returns a ParkingPriceResponse. If the request fails, a SearchFailure is returned.

1parkingDetailProvider =
  OnlineDynamicDataProviderFactory.createParkingDetailProvider(
      context,
      "YOUR_TOMTOM_API_KEY",
  )
6parkingPriceOptions?.let { options ->
  parkingDetailProvider.requestParkingPrice(
      options,
      object : ParkingPriceCallback {
          override fun onSuccess(result: ParkingPriceResponse) {
              // YOUR CODE GOES HERE
          }
13
          override fun onFailure(failure: SearchFailure) {
              // YOUR CODE GOES HERE
          }
      },
  )
19}

EV charging availability

The EV charging availability API provides information on the availability of Electric Vehicle (EV) charging points at a specific charging park. The only required parameter is the charging availability identifier, which can be fetched from Fuzzy Search. The identifier is in the SearchResultId of the evChargingAvailabilityId.

Not every SearchResult contains charging station information.

1val evChargingAvailabilityOptions =
  searchResult.searchResultId.evChargingAvailabilityId?.let { chargingAvailabilityId ->
      EvChargingAvailabilityOptions(
          availabilityId = chargingAvailabilityId,
          connectors =
              setOf(
                  ConnectorType.Iec62196Type1Ccs,
                  ConnectorType.Iec62196Type3,
              ),
          minPower = Power.kilowatts(5),
          maxPower = Power.kilowatts(15),
      )
  }

Additionally, you can pass optional restrictions when constructing EvChargingAvailabilityOptions: connectors, minPower and maxPower.

A successful request returns an EvChargingAvailabilityResponse. If the request fails, a SearchFailure is returned.

1evChargingAvailabilityProvider =
  OnlineDynamicDataProviderFactory.createEvChargingAvailabilityProvider(context, "YOUR_TOMTOM_API_KEY")
3
4evChargingAvailabilityOptions?.let { options ->
  evChargingAvailabilityProvider.requestEvChargingAvailability(
      options,
      object : EvChargingAvailabilityCallback {
          override fun onSuccess(result: EvChargingAvailabilityResponse) {
              // YOUR CODE GOES HERE
          }
11
          override fun onFailure(failure: SearchFailure) {
              // YOUR CODE GOES HERE
          }
      },
  )
17}