How to retrieve a list of parking facilities

This resource returns parking facilities that match the search criteria.

Send an HTTP GET request and include a search-geometry parameter:

  • prox: A circle defined by its center coordinates and radius.
  • corridor: A path defined by coordinate points and a width.
  • bbox: A rectangular area defined by its top-left and bottom-right coordinates.

Request example

Use this command to search for facilities within 5 km of the specified point and request a JSON response:

curl --get \
  --header "Authorization: Bearer {YOUR_TOKEN}" \
  --data-urlencode "prox=50.70295,7.178353,5000" \
  "https://parking-v2.cc.api.here.com/parking/facilities.json"

Request parameters

The table lists the query parameters supported by the facilities resource and indicates which are required.

ParameterRequiredDescription
app_id - LegacyYesA 20-byte Base64 URL-safe encoded client application ID.
app_code - LegacyYesA 20-byte Base64 URL-safe encoded client application code.
proxOne of prox, bbox, or corridor is requiredSpecify the center latitude, center longitude, and radius in meters, separated by commas. Coordinates must use WGS 84. For example, prox=52.5079549,13.5472861,5000 searches within 5 km of that point. Maximum radius: 200 km.
bboxOne of prox, bbox, or corridor is requiredSpecify the top-left latitude and longitude, followed by the bottom-right latitude and longitude. Separate each coordinate pair with a comma and the pairs with a semicolon. Coordinates must use WGS 84. For example, bbox=53.66033,9.6532373;52.5079549,13.5472861. Maximum width or height: 400 km.
corridorOne of prox, bbox, or corridor is requiredSpecify the path as semicolon-separated latitude,longitude pairs in WGS 84. For example, corridor=52.51666,13.38333;52.13333,11.61666;53.56527,10.00138 describes a route from Berlin via Magdeburg to Hamburg. Maximum corridor area: 5,000 km². The full request must not exceed 4 KB. At five decimal places, the corridor can contain approximately 150 points, but the actual limit depends on the complete request.
corridorwidthNoCorridor width in meters. Applies only when corridor is specified. Maximum: 20 km. Default: 5,000 m.
arrivalNoExpected arrival time at the destination, in UTC and formatted according to ISO 8601 (for example, 2015-04-02T15:40:00.000Z).
Defaults to the current time if omitted.
Required to calculate parking fees.
durationNoEstimated parking duration in minutes. Valid range: 1 to 20,160 minutes. Default: 120 minutes (2 hours). Required to calculate parking fees.
sortkeyNoSort results using one of these values:
• distance - sort by distance (ASC) from the center of the searching area (prox or bbox)
• name - sort by name, alphanumeric, ASC
• parking_space_free - sort by amount of available parking spaces .facilityAvailability.spacesAvailable (ASC) with null being treated as the smallest value possible;
• parking_space_open - sort by parking availability (.facilityAvailability.available) (ASC) with null being treated as the smallest value possible;
• parking_space_total - sort by the total spaces available in the facility (.facilityAvailability.spacesTotal) (ASC) with null being treated as the smallest value possible;
Default sorting is by distance.
Default order is ascending (nulls will come first).
Note: sortkey only works for prox requests, not for bbox, corridor or requests for facility IDs.
sortorderNoSet the result order to one of these values:
• asc (ascending)
• desc (descending)
Default: asc.
maxresultsNoMaximum number of results to return. Use with offset and the response's hasMore field for pagination. Default: 50.
offsetNoZero-based index of the first result. Use with maxresults and the response's hasMore field for pagination. Default: 0.
hideNoComma-separated list of facility attributes to exclude from the results. Supported values:
• customeronly
If omitted, no facilities are excluded.

Response

For response fields and pagination details, see Parking Facilities Response.


Did this page help you?