INRIX documentation logo

Description

The Filters API is used to determine what possible amenities of on-street parking are filterable for a particular area. Passing in encoded coordinates the API will return a list of options to filter for block parking in the area.

The API is queried at a Block level, and returns data based on block’s amenities in a 5km radius

A typical workflow would be:

  1. Filter API
    • Request Filter data
    • Request /blocks using specific filters returned from the Filter API
    • Receive {block} metadata – address, rates, occupancy, reviews, etc.

Usage

FILTER QUERIES

Filter queries can be made as follows:

Example /filters request

GET http://parking-api.inrix.com/filters?Clon=-1413659307&output=json&Clat=405805212 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:

/filters

GET Get filters for on-street parking in a given area.

Parameters

  = required
Name Located In Type Description
output Query String Set output to "xml" to get an xml response. The default is JSON.
locale Query String Can be set to 'deu', 'fra', 'ita', 'spa', or 'nld' for localized Filter names, default is English.
Clat Query Integer Current Latitude encoded in WGS84--Value = (Input / 360°) * 2^32
Clon Query Integer Current Longitude encoded in WGS84--Value = (Input / 360°) * 2^32
Dlat Query Integer Destination Latitude encoded in WGS84--Value = (Input / 360°) * 2^32
Dlon Query Integer Destination Longitude encoded in WGS84--Value = (Input / 360°) * 2^32

Responses

200 filters returned
{
    "status": 200,
    "statusMessage": "ok",
    "filters": [
        {
            "id": 1,
            "name": "Free"
        },
        {
            "id": 2,
            "name": "Metered parking"
        },
        {
            "id": 3,
            "name": "Overnight parking"
        }
    ]
}
400 Bad request
401 invalid or expired token
404 instance not found