Charges

Charge related endpoints

Retrieve a list of charges.

GET

https://public-api.monta.com

/api/v1/charges

Required scope: charge-transactions

Retrieve a list of charges. › query Parameters

chargePointId

integer · int64

Filter to retrieve charges with specified chargePointId

state

string · enum

Filter to retrieve charges by state

Enum values:

reserved

starting

charging

stopping

paused

scheduled

stopped

completed

fromDate

string · date-time

Filter to retrieve charges where createdAt >= fromDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example: 2022-05-22T09:30:03Z

toDate

string · date-time

Filter to retrieve charges where createdAt <= toDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Example: 2022-05-22T09:30:03Z

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve a list of charges. › Responses

List of charges that match the criteria

MontaPage_ChargeDto_

Charge[] · required

MontaPage.Meta · required

GET/api/v1/charges

curl https://public-api.monta.com/api/v1/charges \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "chargePointId": 21,
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "cablePluggedInAt": "2022-05-12T15:56:45.99Z",
      "startedAt": "2022-05-12T15:56:45.99Z",
      "stoppedAt": "2022-05-12T15:56:45.99Z",
      "fullyChargedAt": "2022-05-12T15:56:45.99Z",
      "failedAt": "2022-05-12T15:56:45.91Z",
      "timeoutAt": "2022-05-12T15:56:45.91Z",
      "state": "charging",
      "consumedKwh": 20.4,
      "kwhLimit": 21,
      "startMeterKwh": 123.45,
      "endMeterKwh": 163.85,
      "cost": 22.4,
      "price": 122.4,
      "priceLimit": 212,
      "averagePricePerKwh": 6,
      "averageCo2PerKwh": 100,
      "averageRenewablePerKwh": 72.5,
      "failureReason": "Some reason why we couldn't charge.",
      "stopReason": "Some reason why the charge stopped.",
      "note": "Lorem Ipsum",
      "currency": {
        "identifier": "DKK",
        "name": "Danish krone",
        "decimals": 2
      },
      "soc": "42",
      "socLimit": 80,
      "humanReadableId": "0000-0000-0005M"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Start a charge.

POST

https://public-api.monta.com

/api/v1/charges

Required scope: control-charging

Start a charge. › Request Body

StartChargeRequest

chargePointId

integer · int64 · required

Id of the charge point used for this charge

Example: 21

Start a charge. › Responses

Charge successfully started

Charge

createdAt

string · date-time · required

Creation date

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Update date

Example: 2022-05-12T16:56:45.99Z

state

string · enum · required

State of the charge

Enum values:

reserved

starting

charging

stopping

paused

scheduled

stopped

completed

Example: charging

humanReadableId

string · required

The human readable id for this charge

Example: 0000-0000-0005M

id

integer · int64

Id of the charge

Example: 1

chargePointId

integer · int64

Id of the charge point related to this charge

Example: 21

cablePluggedInAt

string | null · date-time

Date when cable was plugged in

Example: 2022-05-12T15:56:45.99Z

startedAt

string | null · date-time

Date when charge started

Example: 2022-05-12T15:56:45.99Z

stoppedAt

string | null · date-time

Date when charge stopped

Example: 2022-05-12T15:56:45.99Z

fullyChargedAt

string | null · date-time

Date when EV was fully charged

Example: 2022-05-12T15:56:45.99Z

failedAt

string | null · date-time

Date when charge failed

Example: 2022-05-12T15:56:45.91Z

timeoutAt

string | null · date-time

Date when charge timed out

Example: 2022-05-12T15:56:45.91Z

consumedKwh

number | null · double

Consumed Kwh

Example: 20.4

kwhLimit

number | null · double

Configured Kwh limit for this charge

Example: 21

startMeterKwh

number | null · double

Kwh of the meter before charging started

Example: 123.45

endMeterKwh

number | null · double

Kwh of the meter after charging stopped

Example: 163.85

cost

number | null

Cost for this charge (if configured)

Example: 22.4

price

number | null

Price for this charge

Example: 122.4

priceLimit

number | null

Configured price limit for this charge

Example: 212

averagePricePerKwh

number | null

Average price per Kwh

Example: 6

averageCo2PerKwh

number | null · double

Average CO2 consumption per Kwh

Example: 100

averageRenewablePerKwh

number | null · double

Average percentage of renewable energy per Kwh

Example: 72.5

failureReason

string | null

Failure reason for this charge

Example: Some reason why we couldn't charge.

stopReason

string | null

Reason why this charge stopped

Example: Some reason why the charge stopped.

note

string | null

A note taken for this charge

Example: Lorem Ipsum

object

Currency used for payment.

object

Information about the state of charge if available

Example: 42

socLimit

number | null · double

Configured SoC limit for this charge

Example: 80

POST/api/v1/charges

curl https://public-api.monta.com/api/v1/charges \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "chargePointId": 21
}'

Example Request Body

{
  "chargePointId": 21
}

json

Example Responses

{
  "id": 1,
  "chargePointId": 21,
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "cablePluggedInAt": "2022-05-12T15:56:45.99Z",
  "startedAt": "2022-05-12T15:56:45.99Z",
  "stoppedAt": "2022-05-12T15:56:45.99Z",
  "fullyChargedAt": "2022-05-12T15:56:45.99Z",
  "failedAt": "2022-05-12T15:56:45.91Z",
  "timeoutAt": "2022-05-12T15:56:45.91Z",
  "state": "charging",
  "consumedKwh": 20.4,
  "kwhLimit": 21,
  "startMeterKwh": 123.45,
  "endMeterKwh": 163.85,
  "cost": 22.4,
  "price": 122.4,
  "priceLimit": 212,
  "averagePricePerKwh": 6,
  "averageCo2PerKwh": 100,
  "averageRenewablePerKwh": 72.5,
  "failureReason": "Some reason why we couldn't charge.",
  "stopReason": "Some reason why the charge stopped.",
  "note": "Lorem Ipsum",
  "currency": {
    "identifier": "DKK",
    "name": "Danish krone",
    "decimals": 2
  },
  "soc": "42",
  "socLimit": 80,
  "humanReadableId": "0000-0000-0005M"
}

json

application/json

Retrieve a single charge.

GET

https://public-api.monta.com

/api/v1/charges/{chargeId}

Required scope: charge-transactions

Retrieve a single charge. › path Parameters

chargeId

integer · int64 · required

Retrieve a single charge. › Responses

Charge with provided id

Charge

createdAt

string · date-time · required

Creation date

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Update date

Example: 2022-05-12T16:56:45.99Z

state

string · enum · required

State of the charge

Enum values:

reserved

starting

charging

stopping

paused

scheduled

stopped

completed

Example: charging

humanReadableId

string · required

The human readable id for this charge

Example: 0000-0000-0005M

id

integer · int64

Id of the charge

Example: 1

chargePointId

integer · int64

Id of the charge point related to this charge

Example: 21

cablePluggedInAt

string | null · date-time

Date when cable was plugged in

Example: 2022-05-12T15:56:45.99Z

startedAt

string | null · date-time

Date when charge started

Example: 2022-05-12T15:56:45.99Z

stoppedAt

string | null · date-time

Date when charge stopped

Example: 2022-05-12T15:56:45.99Z

fullyChargedAt

string | null · date-time

Date when EV was fully charged

Example: 2022-05-12T15:56:45.99Z

failedAt

string | null · date-time

Date when charge failed

Example: 2022-05-12T15:56:45.91Z

timeoutAt

string | null · date-time

Date when charge timed out

Example: 2022-05-12T15:56:45.91Z

consumedKwh

number | null · double

Consumed Kwh

Example: 20.4

kwhLimit

number | null · double

Configured Kwh limit for this charge

Example: 21

startMeterKwh

number | null · double

Kwh of the meter before charging started

Example: 123.45

endMeterKwh

number | null · double

Kwh of the meter after charging stopped

Example: 163.85

cost

number | null

Cost for this charge (if configured)

Example: 22.4

price

number | null

Price for this charge

Example: 122.4

priceLimit

number | null

Configured price limit for this charge

Example: 212

averagePricePerKwh

number | null

Average price per Kwh

Example: 6

averageCo2PerKwh

number | null · double

Average CO2 consumption per Kwh

Example: 100

averageRenewablePerKwh

number | null · double

Average percentage of renewable energy per Kwh

Example: 72.5

failureReason

string | null

Failure reason for this charge

Example: Some reason why we couldn't charge.

stopReason

string | null

Reason why this charge stopped

Example: Some reason why the charge stopped.

note

string | null

A note taken for this charge

Example: Lorem Ipsum

object

Currency used for payment.

object

Information about the state of charge if available

Example: 42

socLimit

number | null · double

Configured SoC limit for this charge

Example: 80

GET/api/v1/charges/{chargeId}

curl https://public-api.monta.com/api/v1/charges/:chargeId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "chargePointId": 21,
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "cablePluggedInAt": "2022-05-12T15:56:45.99Z",
  "startedAt": "2022-05-12T15:56:45.99Z",
  "stoppedAt": "2022-05-12T15:56:45.99Z",
  "fullyChargedAt": "2022-05-12T15:56:45.99Z",
  "failedAt": "2022-05-12T15:56:45.91Z",
  "timeoutAt": "2022-05-12T15:56:45.91Z",
  "state": "charging",
  "consumedKwh": 20.4,
  "kwhLimit": 21,
  "startMeterKwh": 123.45,
  "endMeterKwh": 163.85,
  "cost": 22.4,
  "price": 122.4,
  "priceLimit": 212,
  "averagePricePerKwh": 6,
  "averageCo2PerKwh": 100,
  "averageRenewablePerKwh": 72.5,
  "failureReason": "Some reason why we couldn't charge.",
  "stopReason": "Some reason why the charge stopped.",
  "note": "Lorem Ipsum",
  "currency": {
    "identifier": "DKK",
    "name": "Danish krone",
    "decimals": 2
  },
  "soc": "42",
  "socLimit": 80,
  "humanReadableId": "0000-0000-0005M"
}

json

application/json

Retrieve a charge kwh consumption breakdown.

GET

https://public-api.monta.com

/api/v1/charges/{chargeId}/kwh-consumption

Required scope: charge-transactions. Note: Only available for charges performed on a Monta-connected (via OCPP) charge point.

Retrieve a charge kwh consumption breakdown. › path Parameters

chargeId

integer · int64 · required

Retrieve a charge kwh consumption breakdown. › query Parameters

consumptionPeriodSizeInSeconds

integer | null · enum · int64

Filter to retrieve kWh consumption by a given consumptionPeriodSize interval in seconds

Enum values:

3600

1800

900

600

300

3600

1800

900

Example: 3600

Default: 3600

Retrieve a charge kwh consumption breakdown. › Responses

Charge kwh consumption breakdown for the given id

ChargeKwhConsumption

chargeId

integer · int64

Id of the charge

Example: 1

consumptionPeriodSizeInSeconds

integer · int64

Specifies the time interval, in seconds

Example: 3600

array | null

Detailed breakdown of the kwh consumption in time interval of 5, 10, 15, 30 and 60 minutes
Note: Representation is in seconds

Default: 3600

Stop a charge.

POST

https://public-api.monta.com

/api/v1/charges/{chargeId}/stop

Required scope: control-charging

Stop a charge. › path Parameters

chargeId

integer · int64 · required

Stop a charge. › Responses

Successfully stopped a charge

Charge

createdAt

string · date-time · required

Creation date

Example: 2022-05-12T15:56:45.99Z

updatedAt

string · date-time · required

Update date

Example: 2022-05-12T16:56:45.99Z

state

string · enum · required

State of the charge

Enum values:

reserved

starting

charging

stopping

paused

scheduled

stopped

completed

Example: charging

humanReadableId

string · required

The human readable id for this charge

Example: 0000-0000-0005M

id

integer · int64

Id of the charge

Example: 1

chargePointId

integer · int64

Id of the charge point related to this charge

Example: 21

cablePluggedInAt

string | null · date-time

Date when cable was plugged in

Example: 2022-05-12T15:56:45.99Z

startedAt

string | null · date-time

Date when charge started

Example: 2022-05-12T15:56:45.99Z

stoppedAt

string | null · date-time

Date when charge stopped

Example: 2022-05-12T15:56:45.99Z

fullyChargedAt

string | null · date-time

Date when EV was fully charged

Example: 2022-05-12T15:56:45.99Z

failedAt

string | null · date-time

Date when charge failed

Example: 2022-05-12T15:56:45.91Z

timeoutAt

string | null · date-time

Date when charge timed out

Example: 2022-05-12T15:56:45.91Z

consumedKwh

number | null · double

Consumed Kwh

Example: 20.4

kwhLimit

number | null · double

Configured Kwh limit for this charge

Example: 21

startMeterKwh

number | null · double

Kwh of the meter before charging started

Example: 123.45

endMeterKwh

number | null · double

Kwh of the meter after charging stopped

Example: 163.85

cost

number | null

Cost for this charge (if configured)

Example: 22.4

price

number | null

Price for this charge

Example: 122.4

priceLimit

number | null

Configured price limit for this charge

Example: 212

averagePricePerKwh

number | null

Average price per Kwh

Example: 6

averageCo2PerKwh

number | null · double

Average CO2 consumption per Kwh

Example: 100

averageRenewablePerKwh

number | null · double

Average percentage of renewable energy per Kwh

Example: 72.5

failureReason

string | null

Failure reason for this charge

Example: Some reason why we couldn't charge.

stopReason

string | null

Reason why this charge stopped

Example: Some reason why the charge stopped.

note

string | null

A note taken for this charge

Example: Lorem Ipsum

object

Currency used for payment.

object

Information about the state of charge if available

Example: 42

socLimit

number | null · double

Configured SoC limit for this charge

Example: 80

POST/api/v1/charges/{chargeId}/stop

curl https://public-api.monta.com/api/v1/charges/:chargeId/stop \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "chargePointId": 21,
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "cablePluggedInAt": "2022-05-12T15:56:45.99Z",
  "startedAt": "2022-05-12T15:56:45.99Z",
  "stoppedAt": "2022-05-12T15:56:45.99Z",
  "fullyChargedAt": "2022-05-12T15:56:45.99Z",
  "failedAt": "2022-05-12T15:56:45.91Z",
  "timeoutAt": "2022-05-12T15:56:45.91Z",
  "state": "charging",
  "consumedKwh": 20.4,
  "kwhLimit": 21,
  "startMeterKwh": 123.45,
  "endMeterKwh": 163.85,
  "cost": 22.4,
  "price": 122.4,
  "priceLimit": 212,
  "averagePricePerKwh": 6,
  "averageCo2PerKwh": 100,
  "averageRenewablePerKwh": 72.5,
  "failureReason": "Some reason why we couldn't charge.",
  "stopReason": "Some reason why the charge stopped.",
  "note": "Lorem Ipsum",
  "currency": {
    "identifier": "DKK",
    "name": "Danish krone",
    "decimals": 2
  },
  "soc": "42",
  "socLimit": 80,
  "humanReadableId": "0000-0000-0005M"
}

json

application/json

Charge Points AFIR