Developer

Parking Prices

Request Access
Last edit: 2025.10.06
Automotive only
TomTom Orbis Maps

Important note This API is unavailable on a Freemium or Pay As You Grow (PAYG) basis. Click the Request Access button above to contact our Sales team.

Private Preview Notice

Important notes:

  • This TomTom Orbis Maps API is restricted to private preview.
  • This API is powered by the TomTom Orbis Maps.
  • See the TomTom Orbis Maps documentation for more information.

Purpose

The Parking Prices API offers the following features:

  • Calculation of estimated price of the off-street parking stay from the start time and for given duration
  • List of available payment methods
  • List of pricing structure with ticket prices for different:
    • stay duration (5 minutes, 30 minutes, 1 day, etc)
    • time of day/week etc (like evening or weekend prices)
    • classifiers (parkAndRide, motorcycles, customers, etc)

Request data

HTTPS method: GET

For ease of viewing and identification:

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

Request format

get
Request URL format
https://{baseURL}/maps/orbis/places/parkingPrices.{ext}?key={Your_API_Key}&id={parkingId}[&startTime={startTime}][&duration={duration}]

Request curl command example

get
Request curl command example
curl 'https://api.tomtom.com/maps/orbis/places/parkingPrices.json?key={Your_API_Key}&id=0123456789&startTime=2023-05-15T14:30&duration=120' \
    -H 'TomTom-Api-Version: 1'

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Parameters and values are case-sensitive.
  • Optional parameters may be used.

Required parameters

Description

baseURL


string

The base URL for calling the API.


Value: api.tomtom.com

ext


string

The response format of the API request. The valid response format is JSON or XML.


Value: json or xml

key


string

An API Key valid for the requested service.


Value: Your valid API Key.

id


string

The parking ID, previously retrieved from a Search request.


Value: Example: 0123456789

Optional parameters

Description

startTime


string

Start time in UTC format according to ISO 8601.


Format: "YYYY-MM-DDThh:mm"


Example: "2023-05-15T14:30"

duration


integer

Duration in minutes. Taken into account only if 'startTime' is provided.


Default value: 60


Maximum value: 43200 (30 days)

Request headers

The following table describes HTTP request headers.

Required headersDescription
TomTom-Api-Version

The version of the API being called. Currently, only version 1 is supported. Example: 1

Optional headersDescription
Tracking-ID

Specifies an identifier for the request.

  • It can be used to trace a call.

  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.

  • An example of the format that matches this regular expression is UUID (e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1 ). For details check RFC 4122.

  • If specified, it is replicated in the Tracking-ID response header.

  • It is only meant to be used for support and does not involve tracking of you or your users in any form.

Value: An identifier for the request.

Accept-Encoding

Requests that the response is compressed in the specified way. The service supports http compression if desired.


Value: gzip

If-None-Match

Provides the entity-tag (E-tag) of the requested resource as last received by the client. Allows efficient updates of cached information with a minimum amount of transaction overhead: The service can respond with a 304 (not modified) message if the data that would otherwise be provided has the same entity tag.

If-Modified-Since

Specifies the time stamp of the last actual update of the requested resource received by the client. Allows the service to respond with a 304 (not modified) message if no newer data is available.

Response data

Response body

If the <ext> parameter value is set to .json, the response will be a JSON object with the following structure:

Response body with the request URL <ext> parameter value set to ".json"
1{
2  "id": "PP-001",
3  "additionalInfo": "Underground parking, 24/7 access",
4  "payment": {
5    "paymentAttributes": {
6      "paymentMethod": "CARD",
7      "paymentTypes": [
8        "MC_OR_VISA",
9        "PAY_BY_PHONE",
10        "APPLE_PAY"
11      ]
12    },
13    "rates": [
14      {
15        "priceClassifier": "STANDARD",
16        "activeTimes": [
17          {
18            "days": ["MON", "TUE", "WED", "THU", "FRI"],
19            "startTime": "0800",
20            "endTime": "1800"
21          }
22        ],
23        "prices": [
24          {
25            "amounts": [
26              {
27                "currency": "EUR",
28                "value": 2.5
29              }
30            ],
31            "timeUnit": {
32              "exactDuration": {
33                "value": "1h",
34                "additional": false
35              }
36            },
37            "conditions": [
38              {
39                "days": ["MON", "TUE", "WED", "THU", "FRI"],
40                "enter": {
41                  "start": "0800",
42                  "end": "1700"
43                },
44                "exit": {
45                  "start": "0800",
46                  "end": "1800"
47                }
48              }
49            ]
50          }
51        ]
52      }
53    ]
54  },
55  "parkingPrice": {
56    "startTime": "2024-01-01T08:00:00Z",
57    "duration": 60,
58    "fees": [
59      {
60        "amount": 1.0,
61        "currency": "EUR",
62        "classifier": "SERVICE_FEE"
63      }
64    ]
65  }
66}

If the <ext> parameter value is set to .xml, the response will be an XML format with the following structure:

Response body with the request URL <ext> parameter value set to ".xml"
1<?xml version="1.0" encoding="UTF-8"?>
2<reponse>
3    <id>PP-001</id>
4    <additionalInfo>Underground parking, 24/7 access</additionalInfo>
5    <payment>
6        <paymentAttributes>
7            <paymentMethod>CARD</paymentMethod>
8            <paymentTypes>
9                <paymentType>MC_OR_VISA</paymentType>
10                <paymentType>PAY_BY_PHONE</paymentType>
11                <paymentType>APPLE_PAY</paymentType>
12            </paymentTypes>
13        </paymentAttributes>
14        <rates>
15            <rate>
16                <priceClassifier>STANDARD</priceClassifier>
17                <activeTimes>
18                    <activeTime>
19                        <days>
20                            <day>MON</day>
21                            <day>TUE</day>
22                            <day>WED</day>
23                            <day>THU</day>
24                            <day>FRI</day>
25                        </days>
26                        <startTime>0800</startTime>
27                        <endTime>1800</endTime>
28                    </activeTime>
29                </activeTimes>
30                <prices>
31                    <price>
32                        <amounts>
33                            <amount>
34                                <currency>EUR</currency>
35                                <value>2.5</value>
36                            </amount>
37                        </amounts>
38                        <timeUnit>
39                            <exactDuration value="1h" additional="false"/>
40                        </timeUnit>
41                        <conditions>
42                            <condition>
43                                <days>
44                                    <day>MON</day>
45                                    <day>TUE</day>
46                                    <day>WED</day>
47                                    <day>THU</day>
48                                    <day>FRI</day>
49                                </days>
50                                <enter>
51                                    <start>0800</start>
52                                    <end>1700</end>
53                                </enter>
54                                <exit>
55                                    <start>0800</start>
56                                    <end>1800</end>
57                                </exit>
58                            </condition>
59                        </conditions>
60                    </price>
61                </prices>
62            </rate>
63        </rates>
64    </payment>
65    <parkingPrice>
66        <startTime>2024-01-01T08:00:00Z</startTime>
67        <duration>60</duration>
68        <fees>
69            <fee>
70                <amount>1.0</amount>
71                <currency>EUR</currency>
72                <classifier>SERVICE_FEE</classifier>
73            </fee>
74        </fees>
75    </parkingPrice>
76</reponse>

Usage and freshness of Parking Prices data

Updates are provided regularly, typically once per day.

Response fields

The following table describes all the fields that can appear in a response. Fields are listed by the response section they belong to and in the order that they appear in the response.

Primary fields

Field

Description

id


string

The ID of the returned entity.

additionalInfo


string

Additional information for the parking site provided in the local language.

payment


object

Details of payment options and prices charged.


payment object

parkingPrice


object

Calculated parking price for a given 'duration' and 'startTime'.


parkingPrice object

payment object

FieldDescription

paymentAttributes


object

Attributes describing payment methods and types.


paymentAttributes object

rates


array

Details of various rates for a given period of time.


array of rate objects

paymentAttributes object

FieldDescription

paymentMethod


string

The payment method.

paymentTypes


array

Available payment types.


Available values:

  • UNKNOWN, MC_OR_VISA, PAY_BY_PHONE, DEBIT_CARD, APPLE_PAY, COINS, NOTES, CARDS, MOBILE, CARDS_VISA, CARDS_MASTERCARD, CARDS_AMEX, CARDS_MAESTRO, EFTPOS, CARDS_DINERS, CARDS_GELDKARTE, CARDS_DISCOVER, CHEQUE, CARDS_ECASH, CARDS_JCB, CARDS_OPERATORCARD, CARDS_SMARTCARD, CARDS_TELEPEAGE, CARDS_TOTALGR, CARDS_MONEO, CARDS_FLASHPAY, CARDS_CASHCARD, CARDS_VCASHCARD, CARDS_CEPAS, CARDS_OCTOPUS, ALIPAY, WECHATPAY, CARDS_EASYCARD, CARDS_CARTEBLEUE, CARDS_TOUCHNGO, CONTACTLESS

rate object

FieldDescription

priceClassifier


string

Price classifier for which the price is applicable.

activeTimes


array

List of active time periods for this rate.


array of activeTime objects

prices


array

List of price objects for this rate.


array of price objects

activeTime object

FieldDescription

days


array

Days of the week this rate is active.


Available values: MON, TUE, WED, THU, FRI, SAT, SUN

startTime


string

4 digit time indicating start of interval (HHMM) eg. 0900.

endTime


string

4 digit time indicating end of interval (HHMM) eg. 0900.

price object

FieldDescription

amounts


array

List of amount objects.


array of amount objects

timeUnit


object

Time unit for which Amount needs to be paid.


timeUnit object

conditions


array

List of conditions for this price.


array of condition objects

amount object

FieldDescription

currency


string

The currency applicable (3-letter ISO 4217 currency code) for the parking prices and transaction.

value


number

The amount applicable in the given currency.

timeUnit object

FieldDescription

exactDuration


object

ISO8601 interval denoting period or duration.


exactDuration object

fuzzyDuration


string

Name of fuzzy duration.


Available values: UNKNOWN, EVENING, OVERNIGHT, FLAT_RATE, MAX, MONTH_MON-FRI, QUARTER_MON-FRI, YEAR_MON-FRI, EARLY_BIRD, BANK_HOLIDAY, MONTH_UNRESERVED, MONTH_RESERVED, 6_MONTHS_MON-FRI, MINIMUM, DAYTIME, UNTIL_CLOSING, MAX_ONLY_ONCE, WEEKEND

exactDuration object

FieldDescription

value


string

ISO8601 interval denoting fixed period or duration.

additional


boolean

Indicates if duration is additional. For ex: additional 30 minutes.

condition object

FieldDescription

days


array

Days of the week for this condition.


Available values: MON, TUE, WED, THU, FRI, SAT, SUN

enter


object

Entry time range between which the condition applies.


startEnd object

exit


object

Exit time range between which the condition applies.


startEnd object

startEnd object

FieldDescription

start


string

4 digit time indicating start time of entry/exit (HHMM) eg. 0900.

end


string

4 digit time indicating end time of entry/exit (HHMM) eg. 0900.

parkingPrice object

FieldDescription

startTime


string

Start time for the parking price calculation.

duration


integer

Duration in minutes.

fees


array

List of fee objects.


array of fee objects

fee object

FieldDescription

amount


number

The fee amount.

currency


string

The currency applicable (3-letter ISO 4217 currency code) for the fee.

classifier


string

Price classifier for this fee.

Response codes

Code

Meaning & possible causes

200

OK : If the given parking was found, the body of the response will contain the data. Otherwise - empty response:


Empty response example - JSON
{"id":"0123456789"}

400

Bad request : One or more parameters were incorrectly specified or are out of range.

403

Forbidden : Permission, capacity, or authentication issues:

  • Forbidden
  • Not authorized
  • Account inactive
  • Account over queries per second limit
  • Account over rate limit
  • Rate limit exceeded

404

Not Found : The requested resource could not be found, but it may be available again in the future.

405

Method Not Allowed : The client used an HTTP method other than GET.

408

Request timeout : The request took too long to complete.

414

URI Too Long : Requested URI is too long.

500

Internal Server Error : An error occurred while processing the request. Please try again later.

502

Bad Gateway : Internal network connectivity issue.

503

Service Unavailable : Service currently unavailable.

504

Gateway Timeout : Internal network connectivity issue or a request that has taken too long to complete.

596

Service Not Found : The requested service could not be found.

Response headers

The following table lists HTTP response headers of particular interest to Parking Prices service clients.

Header

Description

Access-Control-Allow-Origin

The Parking Prices service allows cross-origin resource sharing.


Value: * This asterisk signifies access to the TomTom API using the Access-Control-Allow-Origin (ACAO) header in its response, indicating which origin sites are allowed.

Content-Encoding

The Parking Prices service supports HTTP compression if requested by the client.


Value: gzip

Cache-Control

The Cache-Control general-header field is used to specify directives that must be obeyed by all caching mechanisms along the request/response chain.

  • Supported by HTTP/1.1 clients.
  • May not be supported by HTTP/1.0 clients.

Value: no-cache

Tracking-ID

An identifier for the request. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service. It is only meant to be used for support and does not involve tracking of you or your users in any form.


Value: An identifier for the request.