INRIX documentation logo

Description

The USS or ultrasonic sensors API is available to provide open parking spot information. We take raw, un-sanitized USS data and use machine learning and high definition maps to convert it into valid open spots.

How It Works

As a car moves down a street, ultrasonic sensors (USS) transmit sound waves and collect data on parked cars and empty spaces. This data is then sent anonymously to the INRIX Parking Cloud to be analyzed and combined with our existing parking availability prediction engine to determine open spots.

USS

The API can return a list of open spots in a geographic region. An OpenParkingSpot represents a valid parking space based on our processing of raw USS data and existing prediction engine.

Usage

Sample GET Request

GET http://api-parking.inrix.com/USS?Type=ParkingSpots&Clat=574322149&Clon=138157004&Dlat=577022382&Dlon=129979649&Bearing=220&Velocity=120 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:

Example GET /USS response

/USS?Type=ParkingSpots

GET Get list of open spots in a geographic region

Parameters

  = required
Name Located In Type Description
accesstoken Query String A valid access token provided from the GET appToken API response. Alternatively, the accesstoken can be added to the request header instead of a url parameter using format 'Authorization: Bearer xxxx.xxx.xxxx'.
Clat Query Integer Latitude
Clon Query Integer Longitude
Bearing Query Integer Bearing
Velocity Query Integer Velocity

Responses

200 OpenParkingSpot objects returned
{
  "copyright": "Copyright INRIX Inc.",
  "versionNumber": "5.2",
  "createdDate": "2018-10-17T17:03:14Z",
  "responseId": "39273cc5-942e-437b-b7a3-fcb0d801343e",
  "status": "1",
  "result": {
    "OpenParkingSpot": [
      {
        "Location": {
          "longitude": "11.55860",
          "latitude": "48.14865"
        },
        "OpenAt": "2018-10-18T17:18:51Z"
      },
      {
        "Location": {
          "longitude": "11.57958",
          "latitude": "48.13167"
        },
        "OpenAt": "2018-10-18T17:19:11Z"
      },
      {
        "Location": {
          "longitude": "11.58482",
          "latitude": "48.13390"
        },
        "OpenAt": "2018-10-18T17:19:17Z"
      },
      {
        "Location": {
          "longitude": "11.59251",
          "latitude": "48.14424"
        },
        "OpenAt": "2018-10-18T17:19:28Z"
      },
      {
        "Location": {
          "longitude": "11.56481",
          "latitude": "48.14989"
        },
        "OpenAt": "2018-10-18T17:20:14Z"
      },
      {
        "Location": {
          "longitude": "11.57515",
          "latitude": "48.15649"
        },
        "OpenAt": "2018-10-18T17:20:32Z"
      },
      {
        "Location": {
          "longitude": "11.55514",
          "latitude": "48.14215"
        },
        "OpenAt": "2018-10-18T17:20:29Z"
      },
      {
        "Location": {
          "longitude": "11.55693",
          "latitude": "48.13471"
        },
        "OpenAt": "2018-10-18T17:20:48Z"
      },
      {
        "Location": {
          "longitude": "11.58337",
          "latitude": "48.13293"
        },
        "OpenAt": "2018-10-18T17:21:22Z"
      },
      {
        "Location": {
          "longitude": "11.58121",
          "latitude": "48.15446"
        },
        "OpenAt": "2018-10-18T17:21:38Z"
      },
      {
        "Location": {
          "longitude": "11.58061",
          "latitude": "48.15456"
        },
        "OpenAt": "2018-10-18T17:21:58Z"
      },
      {
        "Location": {
          "longitude": "11.58765",
          "latitude": "48.13064"
        },
        "OpenAt": "2018-10-18T17:22:17Z"
      }
    ]
  }
}
400 Bad request
401 invalid or expired token
404 OpenParkingSpot instance not found

/USS

POST Send a new parking event

Parameters

  = required
Name Located In Type Description
data Body String

Responses

200 Park event created.
{
  'data':{
    'metaData': null,
    'reports': [
      {
        'identity':
        {
          'sensorId': 'ZIL2BACDEPJCEMA2J'
        }
        ,
        'measurements': [
          {
            'location':
            {
              'coordinates': [
                48.12815,
                11.56179],
              'heading': '51',
              'speed': '3',
              'speedmetric': 'KilometersPerHour'
            }
            ,
            'observationTime': '2018-10-22T16:50:49Z',
            'parkedOut': '1'
          }]
      }]
  },
  'vendorId': '1234567890',
  'vendorName': 'Test Parking',
  'requestId': '3b31p235-01ad-44a1-87b7-020336934b6a',
  'arrivalDtUtc': '2018-10-11T03:00:02.656Z'
}
400 Bad request
404 OpenParkingSpot instance not found
409 Conflict/Duplicate Record
500 Internal Error