Skip to main content
POST
places.parking.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
center
object
required

Center of the search.

radiusMeters
integer
default:100

Radius in meters; on-street searches support up to 1000.

Required range: 1 <= x <= 10000
kind
enum<string>
default:facilities

Parking facilities or on-street probability segments; default facilities.

Available options:
facilities,
on-street
targetTime
string<date-time>

Future UTC time for on-street probability.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
sort
enum<string>
default:distance

Sort on-street results by distance or probability; facilities support distance.

Available options:
distance,
probability
limit
number

Results to return, up to 100; default 20.

Required range: x >= 1

Response

The result

results
object[]
required

Facilities or on-street segments. Only facilities with follow-up data carry handles.