Skip to main content
GET
Get a location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

If-None-Match
string

The ETag of the answer you have. When it's still the same, the answer is an empty 304.

Path Parameters

id
string
required

The location's id, from a pin's ids or a search result.

Response

The location.

id
string
required
name
string | null
required
address
string | null
required
postal_code
string | null
required
city
string | null
required
country
string | null
required

ISO 3166-1 alpha-3.

coordinates
object
required
time_zone
string | null
required

IANA time zone, such as Europe/Amsterdam.

operator
string | null
required

Who runs the location.

opening_times
object | null
required

OCPI's Hours, as the operator gives them: twentyfourseven, regular_hours, exceptional_openings, exceptional_closings.

facilities
string[]
required

OCPI facilities, such as SUPERMARKET.

parking_type
string | null
required

OCPI parking type, such as ON_STREET.

evses
object[]
required
prices_include_vat
boolean
required

Always false: prices are before VAT. A price component's vat is the percentage on top, when the operator gives it.

tariffs
object
required

The connectors' tariffs, by id.

out_of_order_ratio_30d
number

The share of the last 30 days the connectors were out of order. Only once the location has two weeks of history.

Required range: 0 <= x <= 1
occupancy
((number | null)[])[]

How busy the location usually is: 7 days, Monday first, of 24 hours in its own time zone. Each is the share of the working connectors that were occupied, null for an hour without data. Only once the location has two weeks of history.

Required array length: 7 elements
Required array length: 24 elements
Required range: 0 <= x <= 1