INRIX documentation logo DOCUMENTATION

/lots

GET Get lots in a given area

Parameters

Name Located in Description Type
accesstoken query See Authorization documenation. A valid access token provided from either the GET appToken, signIn or refreshToken api response. String
id query If used, other Location parameters cannot be used. An 'id' can be a single lot id or multiple separated by | symbols." Integer
alias query If used, other Location parameters cannot be used. A pipe-delimited data source and lot id, eg: < data_source_key >|< lot_id > String
box query If used, other Location parameters cannot be used. 'box' specifies two lat/long pairs (using the WGS 84 datum) that outline a bounding box. The first lat/long pair should be the northwestern most point, and the second pair the southeastern most point, eg: < lat1 >|< long1 >,< lat2 >|< long2 >. String
point query Used to select a region based on a point and radius. If used, other Location parameters cannot be used, eg: < lat >|< long >. String
radius query Used to select a region based on a point and radius in meters. If 'radius' is used, 'point' must also be used and 'box' / 'geoid' cannot be used." Float
polygon query Used to specify a geography region. If used, other Location parameters cannot be used, eg: < lat1 >|< long1 >,< lat2 >|< long2 >,< lat3 >|< long3 >,< lat4 >|< long4 >. String
polyline query Used to specify a region along a route. If used, other Location parameters cannot be used, eg: < lat1 >|< long1 >,< lat2 >|< long2 >,< lat3 >|< long3 > String
entry_time query yyyy-mm-ddTHH:MM:ss String
duration query Duration in minutes. Can be pipe delimited for multiple durations, eg: 60|120|720|1400 Integer
limit query Maximum number of elements to return from a large collection (for pagination). Integer
offset query Starting index within the requested collection (for pagination) Integer
outputfields query Commas separate list of output fields String
locale query The locale as defined by ISO 15897, default: en-US String

Responses

200 Lot objects returned
{
  "copyright": "Copyright INRIX Inc.",
  "versionNumber": "5.0",
  "createdDate": "2014-10-23T19:18:46.5582393Z",
  "responseId": "51219570-0e56-43b7-9cf0-cd45a9981ea5",
  "result": [
    {
      "id": 92912, // integer
      "name": "Parking Lot 3",  // varchar(128)
      "navigationAddress": {
        "street": "123 Main Street",
        "city": "Santa Monica",
        "state": "CA",
        "zip": "90272",
        "country": "US"
      },
      "buildingAddress": {
        "street": "112 Main Street",
        "city": "Santa Monica",
        "state": "CA",
        "zip": "90272",
        "country": "US"
      },
      "distance": 123, // Cartesian distance in meters from the center
      "point": {
        "type": "Point",
        "coordinates": [118.4912, 34.0195],
      },
      "polygon": "mtqaHz~uiVjeMqjgEG_rlCuBfBcmA",
      "url": "http://www.parkme.com/lot/92913/1-39-widgery-wharf-portland-me-04101-usa",
      "href": "http://api-parking.inrix.com/v2/lot/12345",
      "format": "Surface",
      "type": "Non-restricted",
      "operator": "ACME Parking",
      "phone": "(555) 555-5555",
      "phones": [
        { // Types include Tow, Central, etc. First list item is best for default
          "type": "Lot",
          "number": "(555) 555-5555"
        },
      ],
      "hrs": [
        "Weekdays: 9am - 6pm",
        "Closed Sundays"
      ],
      "pmtTypes": [
        "Bills",
        "Coins",
        "Checks",
        "MC/Visa",
        "Amex",
        "Discover"
      ],
      "costIndex": 1,
      "rateCard": [
        "First Hour: $7",
        "Each Add'l Hour: $2",
        "..."
      ],
      "calculatedRates": {
        "rateCost": 7, // Cost in dollars
        "rateType": "B",
        "quotedDuration": "1:00:00" // Duration requested
      },
      "structured_rates": [
        {
          "time_in": "06:00-14:00",
          "rate": 2,
          "dow_end": 7,
          "dow_start": 1
        },
      ],
      "currency": "$",
      "currencyIso": "USD",
      "spacesTotal": 321,
      "occupancy": {
          "available": 125,
          "start": "2017-11-22T07:33:56Z",
          "bucket": 2,
          "probability": 60,
          "pct": 63,
          "rank": 1
      },
      "occupancyPct": [
          {
              "occPct": 63,
              "occAvail": null,
              "occFull": null,
              "occStartDate": null,
              "occIndex": null
          }
      ],
      "peps": [
        {
          "pepPt": [
            "lon",
            "lat"
          ],
          "pepPpoint": "sdkjhdskj",
          "pepAz": 218,
          "pepPrimary": true,
          "pepType": "IN"
        }
      ],
      "photoThumbs": [
        "http://... ...b2e_thumb.jpg"
      ],
      "photos": [
        {
          "thumbnail": "http://... ...23_thumb.jpg",
          "medium": "http://... ...23_medium.jpg",
          "full": "http://... ...23.jpg",
          "asset_types": [
            "Entrance",
           ],
          "photo_date": "2012-02-11T17:15:00Z"
        }
      ],
      "amenities": [
        {
          "metric": 2.1336,     // Value in metric units (meters)
          "id": 2,  // Each amenity has an integer id
          "value": 84,     // Integer value, if applicable (inches default)
          "name": "Max Height"   // Readable string description of amenity
        },
        {
          "id": 4,
          "value": true,   // Boolean value indicating presence of the amenity
          "name": "EV Chargers"
        }
      ],
      "reservations": [
        {
          "rate_card": "Weekdays 4PM-11PM",
          "source": "ParkMe",
          "href": "http://api-parking.inrix.com/v2/reservation/12345",
        },
        {
          "source": "ParkWhiz",
          "link": "http://www.parkwhiz.com/p/chicago-parking/172-w-adams-st/",
          "href": "http://api-parking.inrix.com/v2/reservation/12345",
        }
      ],
      "reviewCount": 15,
      "reviewScore": 4,
      "reviews": [
        {
          "stars": 4,
          "review": "Great experience. Lot was clean and attendant was friendly.
                     Will definitely park here again.",
          "name": "John D.",
          "reviewDate": "2012-02-11T17:15:00Z"
        },
        {
          "stars": 2,
          "review": "Parked here for 4 hours overnight and got charged twice. Not happy.",
          "name": "Susan B.",
          "reviewDate": "2011-02-11T17:15:00Z"
        }
      ],
      "timestamp": "2011-02-11T17:15:00Z",  // transaction timestamp
      "note": "Lorem Ipsum",
      "isOpen": true
    }
  ]
}
Name Type Additional Info
reviewScore Integer minimum: 0, maximum: 5
reviews Array
reviews[].stars Integer minimum: 0, maximum: 5
reviews[].review String
reviews[].name String
reviews[].reviewDate String format: date-time
point.type String
point.coordinates Number
reservations Array
reservations[].monthly Boolean
reservations[].source String
reservations[].link String format: uri
reservations[].rate_card String
reservations[].href String format: uri
navigationAddress.city String
navigationAddress.country String
navigationAddress.state String
navigationAddress.street String
navigationAddress.postal String
navigationAddress.type String
buildingAddress.city String
buildingAddress.country String
buildingAddress.state String
buildingAddress.street String
buildingAddress.postal String
buildingAddress.type String
costIndex Integer, null
currency String
href String
occupancy.available Integer minimum: 0
occupancy.start String format: date-time
occupancy.probability Integer minimum: 0, maximum: 100
occupancy.pct Integer minimum: 0, maximum: 100
occupancy.bucket Integer minimum: 0, maximum: 10
occupancy.rank Number minimum: 1, maximum: 5
operator String, null
photoThumbs String format: uri
id Integer
polygon String
hrs String
note String, null
amenities Array
amenities[].id Integer
amenities[].value Boolean, integer
amenities[].name String
amenities[].metric Number
currencyIso String
type String
calculatedRates Array, null
calculatedRates[].rateCost Number
calculatedRates[].rateType String
calculatedRates[].quotedDuration String
reviewCount Integer
structured_rates Array
structured_rates[].dow_start Integer
structured_rates[].rate Number, null
structured_rates[].dow_end Integer
structured_rates[].increment Integer
structured_rates[].time_in String
structured_rates[].time_out String
structured_rates[].repeats Boolean
structured_rates[].additional Integer
structured_rates[].min Integer
structured_rates[].max Integer
structured_rates[].month_start Integer
structured_rates[].month_end Integer
isOpen Boolean
format String
rateCard String
phone String, null
phones Array
phones[].type String
phones[].number String
pmtTypes String
distance Number
name String
photos Array
photos[].assetTypes String
photos[].medium String format: uri
photos[].full String format: uri
photos[].thumbnail String format: uri
peps Array
peps[].pepType String
peps[].pepPrimary Number, null
peps[].pepAz Integer
peps[].pepPt Number
url String format: uri
spacesTotal Number
400 Bad request
401 invalid or expired token
404 lot instance not found

/lot

POST Create a new parking lot

Parameters

Name Located in Description Type
user body A unique user id String
lng body longitude Float
lat body latitude Float
pk_lot_type_id body A lot type id.(Resticted /Non-restricted etc.) Integer
pk_lot_status_id body A lot status id.(Default takes 1) Integer
address body Lot address based on longitude and latitude. Integer
destination body A lot destination. Integer
pk_operator body A lot operator id Integer
restrictive body Is Restrictive Lot ? Boolean
building_address body Building's legal address. Integer
cloneFrom body A lot destination. Integer

Responses

200 Lot object Updated.
{  

   'pk_meter_type’:2,
   'dt_create_date':datetime.datetime(2017,9,18,20,21,33,210010,tzinfo=<UTC>),
   'str_gc_address':'335 Wilshire Blvd',
   'i_lot_id':2375,
   'pk_payment_method_source':1,
   'pk_user_modified':552701,
   'pk_lot_status':6,
   'pk_lot_type':2,
   'dt_effective_timestamp':datetime.datetime(2017,9,18,20,21,33,210010,tzinfo=<UTC>),
   'tz':'America/Los_Angeles',
   'str_modified_who’:’user_email@inrix.com'
}
400 Bad request
404 lot instance not found
409 Conflict/Duplicate Record
500 Internal Error

PUT Update parking lot details

Parameters

Name Located in Description Type
Accepts header 'application/json' or 'application/xml' String
pk_user_profile body A unique user id String
f_id body A unique lot id Integer
pk_lot_type body A lot type id Integer
f_long body longitude Float
f_lat body latitude Float
i_spaces body Total Number Of Spaces Integer
i_floors body Total Number of Floors. Integer
str_gc_address body Address information String
pk_lot_status body Status of Lot. Integer
pk_lot_format body Format of Lot. Integer
ppoly_array body ppoly_array. Array of string
pk_lot_status body Status of Lot. Integer

Responses

200 Lot object Updated.
400 Bad request
401 invalid or expired token
404 lot instance not found
500 Internal Error

Description

Want to find the cheapest parking lot near your local sushi restaurant? How about the best monthly parking options near your new office? Our how about parking for a nearby sporting event?

The Off-Street Parking Lots API is used to return a list of parking lots with location, pricing, restrictions, and attributes.

All-in-all INRIX tracks over 91+ attributes per lot. We are the worlds largest and most accurate parking database.

Usage

Lot Queries can be made as follows:

  1. Querying a single lot for a known lot id
  2. Querying a list of lots by lot id or by operator alias
  3. Querying a geographic region
    1. by a bounded box defined by four points
    2. by a circle defined by a point and radius
    3. by a polygon defined by a list of points
    4. by a route defined by a list of points
  4. Add or Update lot detail

FILTERING AND PAGINATION

A returned list of results can be pre-filtered by lot operator. Additionally, a maximum number of results to be returned can be defined. The list of results can be paginated i.e. return second list of 20 results.

Additional filtering must be defined in client logic after results are returned. A wealth of metadata is returned for each lot that might be used to further filter results, including but not limited to:

  1. name
  2. hours of operation
  3. occupancy
  4. reservations
  5. reviews

Sample Request

GET http://parking-api.inrix.com/lots?box=47.7757724964185|-122.20724916406249,47.743362594532755|-122.16227388330077&units=1 HTTP/1.1
Host: parking-api.inrix.com
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: Bearer
INRIXClientAgent:

Special Reponse Objects

peps

PEPs are “Parking Entry/Exit Points” and they direct the user to the entry or exit points of the lot. Here’s an example:


"peps": [ {                         // Parking Entry Points
    "pep_pt":   [lon, lat],         // in GeoJSON format
    "pep_ppoint": "sdkjhdskj"       // Polyline encoded version of the entry point
    "pep_az":   218,                // The azimuth of the pep
    "pep_b_primary": true           // One of the PEPs will be listed as "Primary".
    "pep_type": "IN"                // IN, OUT, or IN/OUT
    }, ...
],

Remember that some lots will have more than one entry point.