The Destination API may be used to request cities, neighbourhoods, and venues with parking information.
- Query operators are passed to the API via HTTP/1.1 GET requests
- GET requests will always return a response payload. In the event that there are no Destinations, the payload will be an empty list as defined below.
- The system supports deflate/gzip encodings which are highly recommended to reduce bandwidth usage.
Required Parameters:
pub_id | The Publisher ID issued to the syndication partner. |
One of the following feature query parameters must be included:
A point & radius.
pt=<lon>|<lat>|<radius in meters>
- The coordinates of the center and radius of the target
…or, A bounding box.
bbox=<ll_lon>|<ll_lat>|<ur_lon>|<ur_lat>
- The Lower Left and Upper Right coordinates of the target bounding box.
Optional Parameters:
lot_count | Default: 1 The minimum number of lots in the destinations returned. Used to return high-quality parking related options. |
max | Default: 10 The maximum number of destinations that may be returned in the response (May be Limited on a per-publisher basis). |
categories | Pipeline delimited list of categories to be returned. See categories list below for options |
name | Fuzzy match on the display name. Example: Santa Monica Pier. Note: matching occurs after other filters (including max and geo) so ensure that the data appears in the pre-filtered query. |
sort | Options are either distance or popularity. Default is distance |
locale | Translate city name (options: da, de, es, fi, fr, it, nl, no, pl, pt, pt_BR, ru, sv, tr) |
Categories
- (‘CITY’, ‘Cities’)
- (‘VENUE’, ‘Theatres and Venues’)
- (‘LANDMARK’, ‘Landmarks and POI’s’)
- (‘NEIGHBORHOOD’, ‘Neighborhood’)
- (‘HOTEL’, ‘Hotels’)
- (‘SCHOOL’, ‘University and Schools’)
- (‘AIRPORT’, ‘Airports’)
- (‘SHOP’, ‘Shopping’)
- (‘EATERY’, ‘Bars and Restaurants’)
- (‘STADIUM’, ‘Stadiums and Arenas’)
Example URLS:
Point & Radius style | https://api.parkme.com/destination? pt=-118.4428|34.2522|100000& categories=City|Neighborhood& pub_id=<YOUR-PUBID> |
https://api.parkme.com/destination? categories=City& chk=<YOUR-CHK>& lot_count=10& max=40& pt=11.5820%7C48.1351%7C48280& pub_id=<YOUR-PUBID>& locale=de |
|
BBox style | https://api.parkme.com/destination? bbox=-118.4428|34.2522|-118.0428|33.8522& max=5& pub_id=<YOUR-PUBID> |
Response Payload
{
"DestinationCount": 5,
"Destinations": [
{
// Geography Info
"point": [-118.2552, 34.04697], // point in GeoJSON format
"poly": null, // poly in GeoJSON format
"distance": 1457.3514449638028, // distance in meters
// Display Info
"slug": "los-angeles-parking",
"display_name": "Los Angeles",
"category": "CITY", // Can be CITY, AIRPORT, VENUE, etc.
"lot_count": 524,
"meters_enabled": true, // publicly serving meter data
"search_rank": 320, // comparative popularity rank of destination
// Image info
// Note: In most cases, the images provided are square images hosted by
// eventful.com. ParkMe has a partnership with eventful, however that partnership
// might not always carry forward to third party applications.
"image": "https://static.eventful.com/images/block/04-3.jpeg",
// Audit Information
"modified": 1371199373,
]
}, ...
]
}
/destination
GET Retrieves cities, neighbourhoods, and venues with parking information.
Parameters
= requiredName | Located In | Type | Description |
---|---|---|---|
pub_id | Query | String | The Publisher ID issued to the syndication partner. |
pt | Query | String | Used to select a region based on a point and radius. If used, other Location parameters cannot be used, eg: < lat >|< long >| < radius in meters > . One location parameter must be used.
|
bbox | Query | String | Used to select a region based on a target bounding box. If used, other Location parameters cannot be used. For bounding box, you must provide the Lower Left lat, long then the bottom right lat, long. eg: < ll_lon >|< ll_lat >|< ur_lon >|< ur_lat > . One location parameter must be used.
|
lot_count | Query | Integer | The minimum number of lots in the destinations returned. Used to return high-quality parking related options. Defaults to 1. |
max | Query | Integer | The maximum number of destinations that may be returned in the response (May be Limited on a per-publisher basis). Defaults to 10. |
categories | Query | String | Pipeline delimited list of categories to be returned. See categories list below for options |
name | Query | String | Fuzzy match on the display name. Example: Santa Monica Pier. Note: matching occurs after other filters (including max and geo) so ensure that the data appears in the pre-filtered query. |
sort | Query | String | Options are either distance or popularity. Default is distance |
locale | Query | String | Translate city name to one of the following: da, de, es, fi, fr, it, nl, no, pl, pt, pt_BR, ru, sv, tr |