API Reference

Locations endpoint

get
https://customer-api.prod.paren.app/realtime/v1/locations

Return a list of locations

Query Params
number

Mandatory if longitude is set

number

Mandatory if latitude is set

integer

Mandatory with latitude and longitude, maximum of 25km or 15 miles

string
enum
Defaults to meters

Radius unit, one of 'meters' or 'miles'

Allowed:
integer
1 to 100
Defaults to 50

Limits the number of objects that are returned.

integer
≥ 0

Indicates the number of items to skip.

integer
≥ 0

Filter locations to only include those with at least one connector having a minimum power level of the specified value (in kW)

integer

Filter locations to only include those with at least one connector having a maximun power level of the specified value (in kW)

port_types
array of strings
Defaults to all

Filter locations to only include those that have at least one port of the specified connector type(s)

port_types
countries
array of strings
Defaults to all

Filter on countries

countries
states
array of strings
Defaults to all

Filter on states or provinces of the location

states
ids
array of integers

Filter on IDs of the locations

ids
Responses

Updated 28 days ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago