Overview
The OpenSpots API provides a list of recently vacated on-street parking spots in the vicinity of a lat/long. The listed OpenSpots events have a location and timestamp when the Openspot was reported. All OpenSpots events represent a public, on-street parking opportunities.
The API is designed for the creation of an in-vehicle parking experience when a driver is searching for or should be aware of parking at their location. As such, it’s not appropriate for bulk download of data in any form. If your requirement is different and this API does not work for you, please contact your INRIX representative.
GET OpenSpots
There is one API endpoint: openspots/events
. It returns a list of OpenSpots events around a location in a google polyline format and the time the OpenSpot was created. The call also optionally returns a length field indicating the size of the OpenSpot derived from the reporting vehicle.
Example Call
https://api.parkme.com/api/openspots/events?latitude=34.024354&longitude=-118.494631&accesstoken=${userToken}&radius=1
Call parameters:
- latitude Car location (float, WSG-84)
- longitude Car location (float, WSG-84)
- accessToken INRIX UAS accesstoken, string
- radius Radius around car location to query for OpenSpots, in km (float). The radius requested should reflect the distance the car can travel in 2-3 minutes, as OpenSpots expire in 5 minutes.
- limit Maximum number (integer) of OpenSpots to return. Clients should manage the result size by specifying a radius instead of relying on a limit. The limit is a hard cut-off on the unordered set of results intended as a safety measure against overloading the client.
Example Result
The result is a JSON array of 0 or more unordered OpenSpots events with an age between 0 to 5 minutes.
{
"data":
[
{
"polyline": "ogqnE|bgrU",
"ts": "2021-05-14T18:16:24.974511-07:00",
"quadkey17": "02301231121111022",
"length": 4.85
},
{
"polyline": "y_snExjfrU",
"ts": "2021-10-19T13:51:22.866511-07:00",
"quadkey17": "02301231103333223",
"length": 5.25
}
]
}
- polyline Latitude and Longitude and of the OpenSpots event encoded as a Google polyline of one point. In a compressed text-only format.
- ts ISO date of OpenSpots event creation, timezone aware, as a string
- quadkey17 Level-17 Bing quadkey
- length (optional) The length of the OpenSpots is estimated size from the vehicle that reported the OpenSpots. The length is in meters Length may also include measured space in front and behind the reporting vehicle. Length is returned only if the reporting vehicle includes it. When not reported this return value is empty. An example use case is as an OpenSpots filter for larger cars, such as a compact car leaving a spot may not create a genuine parking opportunity for a full-length limousine.
This is a RESTful API, which is extensible. Callers should safely ignore keys that they’re not expecting.