GET /ocpi/cpo/2.2/cdrs
GET/ocpi/cpo/2.2/cdrs
Query parameters
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
GET /ocpi/cpo/2.2/cdrsOCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/cdrs' \ -H 'Authorization: Token <your-ocpi-token>'
Try itruns against your network · response is live
GET /ocpi/cpo/2.2/cdrs/{country_code}/{party_id}/{cdr_id}
GET/ocpi/cpo/2.2/cdrs/{country_code}/{party_id}/{cdr_id}
Path & query parameters
country_codestring · pathrequired
party_idstring · pathrequired
cdr_idstring · pathrequired
GET /ocpi/cpo/2.2/cdrs/{country_code}/{party_id}/{cdr_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/cdrs/{country_code}/{party_id}/{cdr_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/cpo/2.2/chargingprofiles/{session_id}
GET/ocpi/cpo/2.2/chargingprofiles/{session_id}
Path & query parameters
session_idstring · pathrequired
durationinteger · int32 · queryoptional
response_urlstring · queryrequired
GET /ocpi/cpo/2.2/chargingprofiles/{session_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/chargingprofiles/{session_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
PUT /ocpi/cpo/2.2/chargingprofiles/{session_id}
PUT/ocpi/cpo/2.2/chargingprofiles/{session_id}
Path & query parameters
session_idstring · pathrequired
Request body
charging_profileobjectoptional
start_date_timeobject · date-timeoptional
durationinteger · int32optional
charging_rate_unitstringoptional
min_charging_ratenumber · doubleoptional
charging_profile_periodarray of objectoptional
response_urlstringoptional
PUT /ocpi/cpo/2.2/chargingprofiles/{session_id}OCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/cpo/2.2/chargingprofiles/{session_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
DELETE /ocpi/cpo/2.2/chargingprofiles/{session_id}
DELETE/ocpi/cpo/2.2/chargingprofiles/{session_id}
Path & query parameters
session_idstring · pathrequired
response_urlstring · queryoptional
DELETE /ocpi/cpo/2.2/chargingprofiles/{session_id}OCPI Token
curl -X DELETE 'https://api.proranked.com/ocpi/cpo/2.2/chargingprofiles/{session_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
POST /ocpi/cpo/2.2/commands/{command}/{command_id}
POST/ocpi/cpo/2.2/commands/{command}/{command_id}
Path & query parameters
commandstring · pathrequired
command_idstring · pathrequired
POST /ocpi/cpo/2.2/commands/{command}/{command_id}OCPI Token
curl -X POST 'https://api.proranked.com/ocpi/cpo/2.2/commands/{command}/{command_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/cpo/2.2/commands/{command_id}
GET/ocpi/cpo/2.2/commands/{command_id}
Path & query parameters
command_idstring · pathrequired
GET /ocpi/cpo/2.2/commands/{command_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/commands/{command_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/{version}/credentials
GET/ocpi/{version}/credentials
Get credentials for this CPO
Path & query parameters
versionstring · pathrequired
Response — 200
dataobjectoptional
tokenstringoptional
urlstringoptional
rolesarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/{version}/credentialsOCPI Token
curl 'https://api.proranked.com/ocpi/{version}/credentials' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"token": "string",
"url": "string",
"roles": [
{
"role": "string",
"businessDetails": {
"name": "string",
"website": "string",
"logo": {
"url": null,
"thumbnail": null,
"category": null,
"type": null,
"width": null,
"height": null
}
},
"partyId": "string",
"countryCode": "string"
}
]
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
POST /ocpi/{version}/credentials
POST/ocpi/{version}/credentials
Register new partner credentials
Path & query parameters
versionstring · pathrequired
Response — 200
dataobjectoptional
tokenstringoptional
urlstringoptional
rolesarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
POST /ocpi/{version}/credentialsOCPI Token
curl -X POST 'https://api.proranked.com/ocpi/{version}/credentials' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"token": "string",
"url": "string",
"roles": [
{
"role": "string",
"businessDetails": {
"name": "string",
"website": "string",
"logo": {
"url": null,
"thumbnail": null,
"category": null,
"type": null,
"width": null,
"height": null
}
},
"partyId": "string",
"countryCode": "string"
}
]
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PUT /ocpi/{version}/credentials
PUT/ocpi/{version}/credentials
Update existing partner credentials
Path & query parameters
versionstring · pathrequired
Request body
tokenstringoptional
urlstringoptional
rolesarray of objectoptional
Response — 200
dataobjectoptional
tokenstringoptional
urlstringoptional
rolesarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PUT /ocpi/{version}/credentialsOCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/{version}/credentials' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"token": "string",
"url": "string",
"roles": [
{
"role": "string",
"businessDetails": {
"name": "string",
"website": "string",
"logo": {
"url": null,
"thumbnail": null,
"category": null,
"type": null,
"width": null,
"height": null
}
},
"partyId": "string",
"countryCode": "string"
}
]
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
DELETE /ocpi/{version}/credentials/{country_code}/{party_id}
DELETE/ocpi/{version}/credentials/{country_code}/{party_id}
Delete partner credentials
Path & query parameters
versionstring · pathrequired
country_codestring · pathrequired
party_idstring · pathrequired
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
DELETE /ocpi/{version}/credentials/{country_code}/{party_id}OCPI Token
curl -X DELETE 'https://api.proranked.com/ocpi/{version}/credentials/{country_code}/{party_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/locations
GET/ocpi/cpo/2.2/locations
Get all locations with optional filtering
Query parameters
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
Response — 200
dataarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/locationsOCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/locations' \ -H 'Authorization: Token <your-ocpi-token>'
Response · 200
{
"data": [
{
"countryCode": "string",
"partyId": "string",
"id": "string",
"publish": true,
"publishAllowedTo": [
{
"uid": "string",
"type": "string",
"visualNumber": "string",
"issuer": "string",
"groupId": "string"
}
],
"name": "string",
"address": "string",
"city": "string",
"postalCode": "string",
"state": "string",
"country": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"relatedLocations": [
{
"coordinates": {
"latitude": null,
"longitude": null
},
"name": {
"language": null,
"text": null
}
}
],
"parkingType": {
"value": "string"
},
"evses": [
{
"uid": "string",
"evse_id": "string",
"location_ocpi_id": "string",
"status": "string",
"status_schedule": [
null
],
"capabilities": [
null
],
"connectors": [
null
],
"floor_level": "string",
"coordinates": {
"latitude": null,
"longitude": null
},
"physical_reference": "string",
"directions": [
null
],
"parking_restrictions": [
null
],
"images": [
null
],
"last_updated": null,
"last_heartbeat": null
}
],
"directions": [
{
"language": "string",
"text": "string"
}
],
"operator": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"suboperator": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"owner": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"facilities": [
{
"value": "string"
}
],
"timeZone": "string",
"openingTimes": {
"twentyFourSeven": true,
"regularHours": [
{
"weekday": null,
"periodBegin": null,
"periodEnd": null
}
],
"exceptionalOpenings": [
{
"periodBegin": null,
"periodEnd": null
}
],
"exceptionalClosings": [
{
"periodBegin": null,
"periodEnd": null
}
]
},
"chargingWhenClosed": true,
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
],
"energyMix": {
"isGreenEnergy": true,
"energySources": [
{
"source": null,
"percentage": null
}
],
"environmentalImpacts": [
{
"category": null,
"amount": null
}
],
"supplierName": "string",
"energyProductName": "string"
},
"lastUpdated": null
}
],
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/locations/{location_id}
GET/ocpi/cpo/2.2/locations/{location_id}
Get a specific location by ID
Path & query parameters
location_idstring · pathrequired
Response — 200
dataobjectoptional
countryCodestringoptional
partyIdstringoptional
idstringoptional
publishbooleanoptional
publishAllowedToarray of objectoptional
namestringoptional
addressstringoptional
citystringoptional
postalCodestringoptional
statestringoptional
countrystringoptional
coordinatesobjectoptional
latitudestringoptional
longitudestringoptional
relatedLocationsarray of objectoptional
parkingTypeobjectoptional
valuestringoptional
evsesarray of objectoptional
directionsarray of objectoptional
operatorobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
suboperatorobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
ownerobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
facilitiesarray of objectoptional
timeZonestringoptional
openingTimesobjectoptional
twentyFourSevenbooleanoptional
regularHoursarray of objectoptional
exceptionalOpeningsarray of objectoptional
exceptionalClosingsarray of objectoptional
chargingWhenClosedbooleanoptional
imagesarray of objectoptional
energyMixobjectoptional
isGreenEnergybooleanoptional
energySourcesarray of objectoptional
environmentalImpactsarray of objectoptional
supplierNamestringoptional
energyProductNamestringoptional
lastUpdatedobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/locations/{location_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"countryCode": "string",
"partyId": "string",
"id": "string",
"publish": true,
"publishAllowedTo": [
{
"uid": "string",
"type": "string",
"visualNumber": "string",
"issuer": "string",
"groupId": "string"
}
],
"name": "string",
"address": "string",
"city": "string",
"postalCode": "string",
"state": "string",
"country": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"relatedLocations": [
{
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"name": {
"language": "string",
"text": "string"
}
}
],
"parkingType": {
"value": "string"
},
"evses": [
{
"uid": "string",
"evse_id": "string",
"location_ocpi_id": "string",
"status": "string",
"status_schedule": [
{
"periodBegin": null,
"periodEnd": null,
"status": null
}
],
"capabilities": [
"string"
],
"connectors": [
{
"id": null,
"standard": null,
"format": null,
"power_type": null,
"status": null,
"max_voltage": null,
"max_amperage": null,
"max_electric_power": null,
"tariff_ids": null,
"terms_and_conditions": null,
"last_updated": null
}
],
"floor_level": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"physical_reference": "string",
"directions": [
{
"language": null,
"text": null
}
],
"parking_restrictions": [
{
"value": null
}
],
"images": [
{
"url": null,
"thumbnail": null,
"category": null,
"type": null,
"width": null,
"height": null
}
],
"last_updated": null,
"last_heartbeat": null
}
],
"directions": [
{
"language": "string",
"text": "string"
}
],
"operator": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"suboperator": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"owner": {
"name": "string",
"website": "string",
"logo": {
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
},
"facilities": [
{
"value": "string"
}
],
"timeZone": "string",
"openingTimes": {
"twentyFourSeven": true,
"regularHours": [
{
"weekday": 0,
"periodBegin": "string",
"periodEnd": "string"
}
],
"exceptionalOpenings": [
{
"periodBegin": null,
"periodEnd": null
}
],
"exceptionalClosings": [
{
"periodBegin": null,
"periodEnd": null
}
]
},
"chargingWhenClosed": true,
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
],
"energyMix": {
"isGreenEnergy": true,
"energySources": [
{
"source": "string",
"percentage": 0
}
],
"environmentalImpacts": [
{
"category": "string",
"amount": 0
}
],
"supplierName": "string",
"energyProductName": "string"
},
"lastUpdated": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PUT /ocpi/cpo/2.2/locations/{location_id}
PUT/ocpi/cpo/2.2/locations/{location_id}
Create or replace a location
Path & query parameters
location_idstring · pathrequired
Request body
countryCodestringoptional
partyIdstringoptional
idstringoptional
publishbooleanoptional
publishAllowedToarray of objectoptional
namestringoptional
addressstringoptional
citystringoptional
postalCodestringoptional
statestringoptional
countrystringoptional
coordinatesobjectoptional
latitudestringoptional
longitudestringoptional
relatedLocationsarray of objectoptional
parkingTypeobjectoptional
valuestringoptional
evsesarray of objectoptional
directionsarray of objectoptional
operatorobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
suboperatorobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
ownerobjectoptional
namestringoptional
websitestringoptional
logoobjectoptional
urlstringoptional
thumbnailstringoptional
categorystringoptional
typestringoptional
widthinteger · int32optional
heightinteger · int32optional
facilitiesarray of objectoptional
timeZonestringoptional
openingTimesobjectoptional
twentyFourSevenbooleanoptional
regularHoursarray of objectoptional
exceptionalOpeningsarray of objectoptional
exceptionalClosingsarray of objectoptional
chargingWhenClosedbooleanoptional
imagesarray of objectoptional
energyMixobjectoptional
isGreenEnergybooleanoptional
energySourcesarray of objectoptional
environmentalImpactsarray of objectoptional
supplierNamestringoptional
energyProductNamestringoptional
lastUpdatedobject · date-timeoptional
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PUT /ocpi/cpo/2.2/locations/{location_id}OCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PATCH /ocpi/cpo/2.2/locations/{location_id}
PATCH/ocpi/cpo/2.2/locations/{location_id}
Partially update a location
Path & query parameters
location_idstring · pathrequired
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PATCH /ocpi/cpo/2.2/locations/{location_id}OCPI Token
curl -X PATCH 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/locations/evse/{evse_uid}
GET/ocpi/cpo/2.2/locations/evse/{evse_uid}
Get a specific EVSE by its UID only
Path & query parameters
evse_uidstring · pathrequired
Response — 200
dataobjectoptional
uidstringoptional
evse_idstringoptional
location_ocpi_idstringoptional
statusstringoptional
status_schedulearray of objectoptional
capabilitiesarray of stringoptional
connectorsarray of objectoptional
floor_levelstringoptional
coordinatesobjectoptional
latitudestringoptional
longitudestringoptional
physical_referencestringoptional
directionsarray of objectoptional
parking_restrictionsarray of objectoptional
imagesarray of objectoptional
last_updatedobject · date-timeoptional
last_heartbeatobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/locations/evse/{evse_uid}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/locations/evse/{evse_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"uid": "string",
"evse_id": "string",
"location_ocpi_id": "string",
"status": "string",
"status_schedule": [
{
"periodBegin": null,
"periodEnd": null,
"status": "string"
}
],
"capabilities": [
"string"
],
"connectors": [
{
"id": "string",
"standard": "string",
"format": "string",
"power_type": "string",
"status": "string",
"max_voltage": 0,
"max_amperage": 0,
"max_electric_power": 0,
"tariff_ids": [
"string"
],
"terms_and_conditions": "string",
"last_updated": null
}
],
"floor_level": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"physical_reference": "string",
"directions": [
{
"language": "string",
"text": "string"
}
],
"parking_restrictions": [
{
"value": "string"
}
],
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
],
"last_updated": null,
"last_heartbeat": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
GET/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
Get a specific EVSE at a location
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
Response — 200
dataobjectoptional
uidstringoptional
evse_idstringoptional
location_ocpi_idstringoptional
statusstringoptional
status_schedulearray of objectoptional
capabilitiesarray of stringoptional
connectorsarray of objectoptional
floor_levelstringoptional
coordinatesobjectoptional
latitudestringoptional
longitudestringoptional
physical_referencestringoptional
directionsarray of objectoptional
parking_restrictionsarray of objectoptional
imagesarray of objectoptional
last_updatedobject · date-timeoptional
last_heartbeatobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"uid": "string",
"evse_id": "string",
"location_ocpi_id": "string",
"status": "string",
"status_schedule": [
{
"periodBegin": null,
"periodEnd": null,
"status": "string"
}
],
"capabilities": [
"string"
],
"connectors": [
{
"id": "string",
"standard": "string",
"format": "string",
"power_type": "string",
"status": "string",
"max_voltage": 0,
"max_amperage": 0,
"max_electric_power": 0,
"tariff_ids": [
"string"
],
"terms_and_conditions": "string",
"last_updated": null
}
],
"floor_level": "string",
"coordinates": {
"latitude": "string",
"longitude": "string"
},
"physical_reference": "string",
"directions": [
{
"language": "string",
"text": "string"
}
],
"parking_restrictions": [
{
"value": "string"
}
],
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"type": "string",
"width": 0,
"height": 0
}
],
"last_updated": null,
"last_heartbeat": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PUT /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
PUT/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
Create or replace an EVSE
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
Request body
uidstringoptional
evse_idstringoptional
location_ocpi_idstringoptional
statusstringoptional
status_schedulearray of objectoptional
capabilitiesarray of stringoptional
connectorsarray of objectoptional
floor_levelstringoptional
coordinatesobjectoptional
latitudestringoptional
longitudestringoptional
physical_referencestringoptional
directionsarray of objectoptional
parking_restrictionsarray of objectoptional
imagesarray of objectoptional
last_updatedobject · date-timeoptional
last_heartbeatobject · date-timeoptional
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PUT /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}OCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PATCH /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
PATCH/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}
Partially update an EVSE
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PATCH /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}OCPI Token
curl -X PATCH 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
GET/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
Get a specific connector at an EVSE
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
connector_idstring · pathrequired
Response — 200
dataobjectoptional
idstringoptional
standardstringoptional
formatstringoptional
power_typestringoptional
statusstringoptional
max_voltageinteger · int32optional
max_amperageinteger · int32optional
max_electric_powerinteger · int32optional
tariff_idsarray of stringoptional
terms_and_conditionsstringoptional
last_updatedobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"id": "string",
"standard": "string",
"format": "string",
"power_type": "string",
"status": "string",
"max_voltage": 0,
"max_amperage": 0,
"max_electric_power": 0,
"tariff_ids": [
"string"
],
"terms_and_conditions": "string",
"last_updated": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PUT /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
PUT/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
Create or replace a connector
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
connector_idstring · pathrequired
Request body
idstringoptional
standardstringoptional
formatstringoptional
power_typestringoptional
statusstringoptional
max_voltageinteger · int32optional
max_amperageinteger · int32optional
max_electric_powerinteger · int32optional
tariff_idsarray of stringoptional
terms_and_conditionsstringoptional
last_updatedobject · date-timeoptional
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PUT /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}OCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PATCH /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
PATCH/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}
Partially update a connector
Path & query parameters
location_idstring · pathrequired
evse_uidstring · pathrequired
connector_idstring · pathrequired
Response — 200
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PATCH /ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}OCPI Token
curl -X PATCH 'https://api.proranked.com/ocpi/cpo/2.2/locations/{location_id}/{evse_uid}/{connector_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/sessions
GET/ocpi/cpo/2.2/sessions
Query parameters
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
Response — 200
dataarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
totalCountinteger · int32optional
offsetinteger · int32optional
limitinteger · int32optional
GET /ocpi/cpo/2.2/sessionsOCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/sessions' \ -H 'Authorization: Token <your-ocpi-token>'
Response · 200
{
"data": [
{
"country_code": "string",
"party_id": "string",
"id": "string",
"start_date_time": null,
"end_date_time": null,
"kwh": 0,
"cdr_token": {
"uid": "string",
"type": "AD_HOC_USER",
"contract_id": "string"
},
"auth_method": "AUTH_REQUEST",
"authorization_reference": "string",
"location_id": "string",
"evse_uid": "string",
"connector_id": "string",
"meter_id": "string",
"currency": "string",
"charging_periods": [
{
"start_date_time": null,
"dimensions": [
null
],
"tariff_id": "string"
}
],
"total_cost": {
"excl_vat": 0,
"incl_vat": 0
},
"total_time": 0,
"total_parking_time": 0,
"status": "ACTIVE",
"max_cost": 0,
"max_duration": 0,
"max_power": 0,
"current_power": 0,
"idle_fees": 0,
"is_in_idle_state": true,
"idle_start_time_utc": null,
"grace_period_end_time_utc": null,
"grace_period_minutes": 0,
"idle_rate_per_minute": 0,
"charging_ended_at": null,
"last_updated": null
}
],
"status_code": 0,
"status_message": "string",
"timestamp": null,
"totalCount": 0,
"offset": 0,
"limit": 0
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}
GET/ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}
Path & query parameters
country_codestring · pathrequired
party_idstring · pathrequired
session_idstring · pathrequired
Response — 200
dataobjectoptional
country_codestringoptional
party_idstringoptional
idstringoptional
start_date_timeobject · date-timeoptional
end_date_timeobject · date-timeoptional
kwhnumber · doubleoptional
cdr_tokenobjectoptional
uidstringoptional
typeenum (AD_HOC_USER, APP_USER, OTHER, RFID)optional
contract_idstringoptional
auth_methodenum (AUTH_REQUEST, COMMAND, WHITELIST)optional
authorization_referencestringoptional
location_idstringoptional
evse_uidstringoptional
connector_idstringoptional
meter_idstringoptional
currencystringoptional
charging_periodsarray of objectoptional
total_costobjectoptional
excl_vatnumber · doubleoptional
incl_vatnumber · doubleoptional
total_timenumber · doubleoptional
total_parking_timenumber · doubleoptional
statusenum (ACTIVE, COMPLETED, INVALID, PENDING, RESERVATION)optional
max_costnumber · doubleoptional
max_durationinteger · int32optional
max_powernumber · doubleoptional
current_powernumber · doubleoptional
idle_feesnumber · doubleoptional
is_in_idle_statebooleanoptional
idle_start_time_utcobject · date-timeoptional
grace_period_end_time_utcobject · date-timeoptional
grace_period_minutesinteger · int32optional
idle_rate_per_minutenumber · doubleoptional
charging_ended_atobject · date-timeoptional
last_updatedobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"country_code": "string",
"party_id": "string",
"id": "string",
"start_date_time": null,
"end_date_time": null,
"kwh": 0,
"cdr_token": {
"uid": "string",
"type": "AD_HOC_USER",
"contract_id": "string"
},
"auth_method": "AUTH_REQUEST",
"authorization_reference": "string",
"location_id": "string",
"evse_uid": "string",
"connector_id": "string",
"meter_id": "string",
"currency": "string",
"charging_periods": [
{
"start_date_time": null,
"dimensions": [
{
"type": null,
"volume": null
}
],
"tariff_id": "string"
}
],
"total_cost": {
"excl_vat": 0,
"incl_vat": 0
},
"total_time": 0,
"total_parking_time": 0,
"status": "ACTIVE",
"max_cost": 0,
"max_duration": 0,
"max_power": 0,
"current_power": 0,
"idle_fees": 0,
"is_in_idle_state": true,
"idle_start_time_utc": null,
"grace_period_end_time_utc": null,
"grace_period_minutes": 0,
"idle_rate_per_minute": 0,
"charging_ended_at": null,
"last_updated": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
PATCH /ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}
PATCH/ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}
Path & query parameters
country_codestring · pathrequired
party_idstring · pathrequired
session_idstring · pathrequired
Request body
kWhnumber · doubleoptional
endDateTimeobject · date-timeoptional
authMethodstringoptional
authorizationReferencestringoptional
meterIdstringoptional
currencystringoptional
statusstringoptional
lastUpdatedobject · date-timeoptional
Response — 200
dataobjectoptional
country_codestringoptional
party_idstringoptional
idstringoptional
start_date_timeobject · date-timeoptional
end_date_timeobject · date-timeoptional
kwhnumber · doubleoptional
cdr_tokenobjectoptional
uidstringoptional
typeenum (AD_HOC_USER, APP_USER, OTHER, RFID)optional
contract_idstringoptional
auth_methodenum (AUTH_REQUEST, COMMAND, WHITELIST)optional
authorization_referencestringoptional
location_idstringoptional
evse_uidstringoptional
connector_idstringoptional
meter_idstringoptional
currencystringoptional
charging_periodsarray of objectoptional
total_costobjectoptional
excl_vatnumber · doubleoptional
incl_vatnumber · doubleoptional
total_timenumber · doubleoptional
total_parking_timenumber · doubleoptional
statusenum (ACTIVE, COMPLETED, INVALID, PENDING, RESERVATION)optional
max_costnumber · doubleoptional
max_durationinteger · int32optional
max_powernumber · doubleoptional
current_powernumber · doubleoptional
idle_feesnumber · doubleoptional
is_in_idle_statebooleanoptional
idle_start_time_utcobject · date-timeoptional
grace_period_end_time_utcobject · date-timeoptional
grace_period_minutesinteger · int32optional
idle_rate_per_minutenumber · doubleoptional
charging_ended_atobject · date-timeoptional
last_updatedobject · date-timeoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
PATCH /ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}OCPI Token
curl -X PATCH 'https://api.proranked.com/ocpi/cpo/2.2/sessions/{country_code}/{party_id}/{session_id}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"country_code": "string",
"party_id": "string",
"id": "string",
"start_date_time": null,
"end_date_time": null,
"kwh": 0,
"cdr_token": {
"uid": "string",
"type": "AD_HOC_USER",
"contract_id": "string"
},
"auth_method": "AUTH_REQUEST",
"authorization_reference": "string",
"location_id": "string",
"evse_uid": "string",
"connector_id": "string",
"meter_id": "string",
"currency": "string",
"charging_periods": [
{
"start_date_time": null,
"dimensions": [
{
"type": null,
"volume": null
}
],
"tariff_id": "string"
}
],
"total_cost": {
"excl_vat": 0,
"incl_vat": 0
},
"total_time": 0,
"total_parking_time": 0,
"status": "ACTIVE",
"max_cost": 0,
"max_duration": 0,
"max_power": 0,
"current_power": 0,
"idle_fees": 0,
"is_in_idle_state": true,
"idle_start_time_utc": null,
"grace_period_end_time_utc": null,
"grace_period_minutes": 0,
"idle_rate_per_minute": 0,
"charging_ended_at": null,
"last_updated": null
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/cpo/2.2/tariffs
GET/ocpi/cpo/2.2/tariffs
Query parameters
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
GET /ocpi/cpo/2.2/tariffsOCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/tariffs' \ -H 'Authorization: Token <your-ocpi-token>'
Try itruns against your network · response is live
GET /ocpi/cpo/2.2/tariffs/{tariff_id}
GET/ocpi/cpo/2.2/tariffs/{tariff_id}
Path & query parameters
tariff_idstring · pathrequired
GET /ocpi/cpo/2.2/tariffs/{tariff_id}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/tariffs/{tariff_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/2.2.1/tariffs
GET/ocpi/2.2.1/tariffs
Query parameters
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
GET /ocpi/2.2.1/tariffsOCPI Token
curl 'https://api.proranked.com/ocpi/2.2.1/tariffs' \ -H 'Authorization: Token <your-ocpi-token>'
Try itruns against your network · response is live
GET /ocpi/2.2.1/tariffs/{tariff_id}
GET/ocpi/2.2.1/tariffs/{tariff_id}
Path & query parameters
tariff_idstring · pathrequired
GET /ocpi/2.2.1/tariffs/{tariff_id}OCPI Token
curl 'https://api.proranked.com/ocpi/2.2.1/tariffs/{tariff_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/2.2/tariffs
GET/ocpi/2.2/tariffs
Query parameters
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
GET /ocpi/2.2/tariffsOCPI Token
curl 'https://api.proranked.com/ocpi/2.2/tariffs' \ -H 'Authorization: Token <your-ocpi-token>'
Try itruns against your network · response is live
GET /ocpi/2.2/tariffs/{tariff_id}
GET/ocpi/2.2/tariffs/{tariff_id}
Path & query parameters
tariff_idstring · pathrequired
GET /ocpi/2.2/tariffs/{tariff_id}OCPI Token
curl 'https://api.proranked.com/ocpi/2.2/tariffs/{tariff_id}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/cpo/2.2/tokens
GET/ocpi/cpo/2.2/tokens
Query parameters
offsetinteger · int32 · queryoptional
limitinteger · int32 · queryoptional
date_fromobject · date-time · queryoptional
date_toobject · date-time · queryoptional
GET /ocpi/cpo/2.2/tokensOCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/tokens' \ -H 'Authorization: Token <your-ocpi-token>'
Try itruns against your network · response is live
GET /ocpi/cpo/2.2/tokens/{token_uid}
GET/ocpi/cpo/2.2/tokens/{token_uid}
Path & query parameters
token_uidstring · pathrequired
GET /ocpi/cpo/2.2/tokens/{token_uid}OCPI Token
curl 'https://api.proranked.com/ocpi/cpo/2.2/tokens/{token_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
PUT /ocpi/cpo/2.2/tokens/{country_code}/{party_id}/{token_uid}
PUT/ocpi/cpo/2.2/tokens/{country_code}/{party_id}/{token_uid}
Path & query parameters
country_codestring · pathrequired
party_idstring · pathrequired
token_uidstring · pathrequired
PUT /ocpi/cpo/2.2/tokens/{country_code}/{party_id}/{token_uid}OCPI Token
curl -X PUT 'https://api.proranked.com/ocpi/cpo/2.2/tokens/{country_code}/{party_id}/{token_uid}' \
-H 'Authorization: Token <your-ocpi-token>'Try itruns against your network · response is live
GET /ocpi/versions
GET/ocpi/versions
Get all supported OCPI versions
Response — 200
dataarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/versionsOCPI Token
curl 'https://api.proranked.com/ocpi/versions' \ -H 'Authorization: Token <your-ocpi-token>'
Response · 200
{
"data": [
{
"version": "string",
"url": "string"
}
],
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live
GET /ocpi/{version}
GET/ocpi/{version}
Get details for a specific OCPI version including available endpoints
Path & query parameters
versionstring · pathrequired
Response — 200
dataobjectoptional
versionstringoptional
endpointsarray of objectoptional
status_codeinteger · int32optional
status_messagestringoptional
timestampobject · date-timeoptional
GET /ocpi/{version}OCPI Token
curl 'https://api.proranked.com/ocpi/{version}' \
-H 'Authorization: Token <your-ocpi-token>'Response · 200
{
"data": {
"version": "string",
"endpoints": [
{
"identifier": "string",
"role": "string",
"url": "string"
}
]
},
"status_code": 0,
"status_message": "string",
"timestamp": null
}Try itruns against your network · response is live