INRIX documentation logo DOCUMENTATION

/destination

GET Retrieves cities, neighbourhoods, and venues with parking information.

Parameters

Name Located in Description Type
pub_id query The Publisher ID issued to the syndication partner. String
pt query 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. String
bbox query 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. String
lot_count query The minimum number of lots in the destinations returned. Used to return high-quality parking related options. Defaults to 1. Integer
max query The maximum number of destinations that may be returned in the response (May be Limited on a per-publisher basis). Defaults to 10. Integer
categories query Pipeline delimited list of categories to be returned. See categories list below for options String
name query 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. String
sort query Options are either distance or popularity. Default is distance String
locale query Translate city name to one of the following: da, de, es, fi, fr, it, nl, no, pl, pt, pt_BR, ru, sv, tr String

Responses

200 Success!
{
  "DestinationCount": 2,
  "Destinations": [
    {
      "category": "NEIGHBORHOOD",
      "distance": 3309.6407215164945,
      "display_name": "Mission Hills",
      "point": [
        -118.46467468108074,
        34.268841569492515
      ],
      "search_rank": 0,
      "lot_count": 5,
      "modified": "2017-05-22T21:51:25.392000+00:00",
      "str_city": "Mission Hills",
      "slug": "los-angeles-parking/mission-hills"
    },
    {
      "category": "NEIGHBORHOOD",
      "distance": 3850.0318372578204,
      "display_name": "Pacoima",
      "point": [
        -118.41493302148317,
        34.269129492927405
      ],
      "search_rank": 0,
      "lot_count": 1,
      "modified": "2017-05-01T06:20:30.653051+00:00",
      "str_city": "Pacoima",
      "slug": "san-fernando-ca-parking/pacoima"
    }, ...
  ]
}

The Destination API may be used to request cities, neighbourhoods, and venues with parking information.

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.

…or, A 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

Example URLS:

Point & Radius style http://api.parkme.com/destination?
   pt=-118.4428|34.2522|100000&
   categories=City|Neighborhood&
   pub_id=<YOUR-PUBID>
  http://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 http://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,
            ]
        }, ...
    ]
}