Get chargeboxes

Description#

This endpoint is used to get your chargeboxes general registry.

Request format#

Method: GET

Endpoint: https://api.thor.tools/latest/integration/chargeboxes

Querystring parameters:

Name	Default value	Accepted values	Description
onlyactive	true	true false 1 0	Returns only information related to chargeboxes set as active in the administration dashboard.
cnelat	null	Any valid north-east latitude value	Returns only the chargeboxes in the given coordinates boundary. Must be given along with cnelng,cswlat and cswlng.
cnelng	null	Any valid north-east longitude value	Returns only the chargeboxes in the given coordinates boundary. Must be given along with cnelat,cswlat and cswlng.
cswlat	null	Any valid south-west latitude value	Returns only the chargeboxes in the given coordinates boundary. Must be given along with cnelat,cnelng and cswlng.
cswlng	null	Any valid south-west longitude value	Returns only the chargeboxes in the given coordinates boundary. Must be given along with cnelat,cnelng and cswlat.
type	null	Any valid type of connector type	Returns only the chargeboxes with the connectors with given type

Response format#

The response is an array of chargeboxes, each containing the following fields:

Field name	Type	Description
active	Boolean	The chargebox is set as active in the administration dashboard.
alias	String	The chargebox name.
connected	Boolean	The chargebox is currently connected with Thor.
public	Boolean	The chargebox is set as public in the administration dashboard.
reservable	Boolean	The chargebox can be reserved or not.
connectors	Array	The list of chargebox's connectors.
connectors[].power	Integer	The connector's power in Wh.
connectors[].type	Type	The connector type.
connectors[].format	String	The type of the connector. The value can be `CABLE` or `SOCKET`.
connectors[].max_amperage	Integer	The max current of the conenctor.
connectors[].power_type	String	The type of power source. The value can be `AC_1_PHASE`, `AC_3_PHASE` or `DC`.
connectors[].terminal_id	String	The id of the Nayax device attached to the connector.
connectors[].token	String	The token used to call Nayax's API.
coordinates	Object	The chargebox coordinates.
coordinates.latitude	Float	The chargebox latitude.
coordinates.longitude	Float	The chargebox longitude.
id	String	The unique chargebox identifier.
last_heartbeat	Integer	The time in ms epoch format of the last heartbeat message received.
timezone	String	The timezone of the chargebox (based on the coordinates).
type	Object	The chargebox type.
type.vehicle	Vehicle	The vehicle type that the chargebox can serve.
type.msg	OCPP message format	The format used by the chargebox to send data.
type.version	OCPP version	The OCPP version implemented by the chargebox.

A succesful response is returned with an HTTP status code 200 - OK

Example response#

[
    {
        "active": true,
        "alias": "Turin 1",
        "connected": true,
        "reservable": false,
        "connectors": [
            {
                "power": 22000,
                "type": "type_2",
                "max_amperage": 32,
                "format": "CABLE",
                "power_type": "AC_3_PHASE",
                "terminal_id": "1894563789435672",
                "token": "E_X67bbrtfW--7hgj5l8Tn4DbmY32789289922-abP-pO04"
            },
            {
                "power": 22000,
                "type": "type_2",
                "max_amperage": 32,
                "format": "CABLE",
                "power_type": "AC_3_PHASE",
                "terminal_id": "9564673856378138",
                "token": "E_X67bbrtfW--7hgj5l8Tn4DbmY32789289922-abP-pO04"
            },
            {
                "power": 7000,
                "type": "type_2",
                "max_amperage": 32,
                "format": "CABLE",
                "power_type": "AC_3_PHASE",
                "terminal_id": "0345674814378592",
                "token": "E_X67bbrtfW--7hgj5l8Tn4DbmY32789289922-abP-pO04"
            },
            {
                "power": 7000,
                "type": "type_2",
                "max_amperage": 32,
                "format": "CABLE",
                "power_type": "AC_3_PHASE",
                "terminal_id": "0134564862345679",
                "token": "E_X67bbrtfW--7hgj5l8Tn4DbmY32789289922-abP-pO04"
            }
        ],
        "coordinates": {
            "latitude": 41.889451,
            "longitude": 12.4898773
        },
        "id": "EaJ7cU9NJ3YkTNgy",
        "last_heartbeat": 1599654456237,
        "timezone": "Europe/Rome",
        "type": {
            "msg": "json",
            "vehicle": "bicycle",
            "version": "1.6"
        }
    },
    {
        "active": true,
        "alias": "Rome 4",
        "connected": false,
        "reservable": false,        
        "connectors": [
            {
                "power": 300,
                "type": "schuko",
                "max_amperage": 16,
                "format": "SOCKET",
                "power_type": "AC_1_PHASE"
            },
            {
                "power": 300,
                "type": "schuko",
                "max_amperage": 16,
                "format": "SOCKET",
                "power_type": "AC_1_PHASE"
            }
        ],
        "coordinates": {
            "latitude": 45.593821,
            "longitude": 11.9444289
        },
        "id": "XPHiIU27EFMViHat",
        "last_heartbeat": 1599732073243,
        "timezone": "Europe/Rome",
        "type": {
            "msg": "json",
            "vehicle": "bicycle",
            "version": "1.6"
        }
    }
]

Error response#

The following errors are returned if something went wrong while processing the request:

HTTP status code	Message	Description
400	BoundsTooBig	The coordinates bounds given in the querystring are too big. The latitude and longitude ranges must be less than or equal to 2.
403	APIKeyNotFound	An invalid API key was given in the header of the request.
403	RestAPINotEnabled	REST API integration is set as disabled in the administration dashboard.
403	InvalidSourceIPAddr	The request comes from an IP address that is different from the one given in the REST API integration configuration.
500	InternalServerError	Something unexpected went wrong while executing the request.

Enums#

Connector type#

Type: String

These are the possible types of the connectors:

ccs CCS (DC)
chademo Chademo (DC)
commando Commando (AC)
type_1 Type 1 (AC)
type_2 Type 2 (AC)
type_3a Type 3A (AC)
type_3c Type 3C (AC)
schuko Schuko standard EU (AC)

Vehicle#

Type: String

These are the possible values of the chargebox.type.vehicle field:

car
bicycle

Chargebox OCPP version#

Type: String

These are the possible values of the chargebox.type.version field:

1.5
1.6

Chargebox OCPP message format#

Type: String

These are the possible values of the chargebox.type.msg field:

json
soap