- Reference
- OCPI 2.1.1 (CPO)
- Sender Location
OpenAPI reference
Sender Location
/locations/{location_id}Retrieve a specific Location by its id.
API: OCPI 2.1.1 (CPO) · Module: Locations (CPO)
Base path:/locations· Base URL:https://ocpi-api.gridos.co/ocpi/cpo/2.1.1
Overview
GET /locations/{location_id}Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/locations/{location_id}
Retrieve a specific Location by its id.
Requires authentication. Use Authorization: Token <token>. See OCPI credentials.
How to call
Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.
curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/locations/LOC1' \
-H "Authorization: Token $OCPI_TOKEN"Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_id | string | Yes | Location.id of the Location object. |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Successful Response | LocationResponse |
400 | Invalid or missing parameters (HTTP 200, OCPI envelope) | — |
401 | Unauthorized | — |
404 | Not Found | — |
422 | Validation Error | HTTPValidationError |
200 — successful response
application/json
Schema: LocationResponse
| Field | Type | Required | Description |
|---|---|---|---|
status_code | integer | No | Default: 1000 |
status_message | string | No | — |
timestamp | string (date-time) | No | — |
data | LocationOut | No | LocationOut |
Response example
{
"status_code": 1000,
"status_message": "Success",
"timestamp": "2015-06-29T22:39:09Z",
"data": {
"address": "F.Rooseveltlaan 3A",
"charging_when_closed": true,
"city": "Gent",
"coordinates": {
"latitude": "51.047599",
"longitude": "3.729944"
},
"country": "BEL",
"directions": [
{
"language": "en",
"text": "Enter via main gate"
}
],
"energy_mix": {
"energy_sources": [
{
"percentage": 100,
"source": "SOLAR"
}
],
"is_green_energy": true
},
"evses": [
{
"connectors": [
{
"amperage": 64,
"format": "SOCKET",
"id": "1",
"last_updated": "2015-03-16T10:10:02Z",
"power_type": "AC_1_PHASE",
"standard": "IEC_62196_T2",
"tariff_id": "11",
"voltage": 230
}
],
"evse_id": "BE-BEC-E041503003",
"floor_level": "-1",
"last_updated": "2015-06-28T08:12:01Z",
"physical_reference": "1",
"status": "AVAILABLE",
"uid": "3256"
}
],
"facilities": [
"BUS_STOP"
],
"id": "LOC1",
"images": [],
"last_updated": "2015-06-29T20:39:09Z",
"name": "Gent Zuid",
"opening_times": {
"twentyfourseven": true
},
"operator": {
"name": "BeCharged"
},
"owner": {
"name": "Gent Municipality"
},
"postal_code": "9000",
"related_locations": [],
"suboperator": {
"name": "BeCharged Sub"
},
"time_zone": "Europe/Brussels",
"type": "ON_STREET"
}
}400 — invalid or missing parameters (HTTP 200, OCPI envelope)
application/json
Response example
{
"status_code": 2001,
"status_message": "Invalid or missing parameters",
"timestamp": "2025-01-01T00:00:00Z",
"doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
"errors": [
{
"field": "country_code",
"message": "expected 'NL' to match Token A identity",
"type": "value_error.identity_mismatch"
}
]
}401 — unauthorized
application/json
Response example
{
"status_code": 2000,
"status_message": "Unauthorized",
"timestamp": "2025-01-01T00:00:00Z"
}404 — not found
application/json
Response example
{
"status_code": 2004,
"status_message": "Resource not found",
"timestamp": "2025-01-01T00:00:00Z"
}422 — validation error
application/json
Schema: HTTPValidationError
| Field | Type | Required | Description |
|---|---|---|---|
detail | ValidationError[] | No | Detail |
Response example
{
"detail": [
{
"loc": [],
"msg": "string",
"type": "string",
"input": {
"_type": "Input"
},
"ctx": {
"_type": "Context"
}
}
]
}Examples
Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).
curl -sS -X GET 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/locations/LOC1' \
-H "Authorization: Token $OCPI_TOKEN"