v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Prices Forecast

Retrieve prices forecast.

Prices can be forecasted for a charge point and optionally a price group, when priceGroupId is not provided the charge point price group will be used. </br> Note: This endpoint is in BETA phase and is subject to changes in a near future release</br> </br>Required scope: prices-forecast:read </br>Organization authorization: supported

get/api/v1/prices/forecast

Query parameters

chargePointIdinteger

Filter to retrieve prices forecast for the specified chargePointId

Example:13
priceGroupIdinteger nullable

Filter to retrieve prices forecast for the specified priceGroupId

Example:130
teamMemberIdinteger nullable

Filter to retrieve prices forecast for the specified teamMemberId

Example:13

Response

Prices Forecast for the given filter

Example response

{
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "currency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "priceGroup": {
    "id": 522,
    "teamId": 12,
    "name": "Public Price Group",
    "masterPrice": {
      "id": 1,
      "description": "Starting Fee",
      "master": true,
      "percentage": 10.2,
      "tariffId": 5,
      "updatedAt": "2023-03-16T15:37:23Z",
      "applyAfterMinutes": 30,
      "price": {
        "amount": 12312,
        "currency": {
          "id": 1,
          "master": true,
          "identifier": "DKK",
          "name": "Danish krone",
          "decimals": 2
        },
        "locale": "en"
      },
      "priceMin": {
        "amount": 12312,
        "currency": {
          "id": 1,
          "master": true,
          "identifier": "DKK",
          "name": "Danish krone",
          "decimals": 2
        },
        "locale": "en"
      },
      "priceMax": {
        "amount": 12312,
        "currency": {
          "id": 1,
          "master": true,
          "identifier": "DKK",
          "name": "Danish krone",
          "decimals": 2
        },
        "locale": "en"
      },
      "feePriceMax": {
        "amount": 12312,
        "currency": {
          "id": 1,
          "master": true,
          "identifier": "DKK",
          "name": "Danish krone",
          "decimals": 2
        },
        "locale": "en"
      },
      "additional": [
        {
          "value": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          }
        }
      ],
      "from": "2023-03-16T15:37:23Z",
      "to": "2023-03-16T15:37:23Z",
      "tagId": 109,
      "gracePeriods": [
        {
          "startTime": "09:00:00",
          "endTime": "17:00:00"
        }
      ]
    },
    "tariffs": [
      {
        "id": 1,
        "description": "Starting Fee",
        "master": true,
        "percentage": 10.2,
        "tariffId": 5,
        "updatedAt": "2023-03-16T15:37:23Z",
        "applyAfterMinutes": 30,
        "price": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMin": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "feePriceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "additional": [
          {
            "value": {
              "amount": 12312,
              "currency": {
                "id": 1,
                "master": true,
                "identifier": "DKK",
                "name": "Danish krone",
                "decimals": 2
              },
              "locale": "en"
            }
          }
        ],
        "from": "2023-03-16T15:37:23Z",
        "to": "2023-03-16T15:37:23Z",
        "tagId": 109,
        "gracePeriods": [
          {
            "startTime": "09:00:00",
            "endTime": "17:00:00"
          }
        ]
      }
    ],
    "fees": [
      {
        "id": 1,
        "description": "Starting Fee",
        "master": true,
        "percentage": 10.2,
        "tariffId": 5,
        "updatedAt": "2023-03-16T15:37:23Z",
        "applyAfterMinutes": 30,
        "price": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMin": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "feePriceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "additional": [
          {
            "value": {
              "amount": 12312,
              "currency": {
                "id": 1,
                "master": true,
                "identifier": "DKK",
                "name": "Danish krone",
                "decimals": 2
              },
              "locale": "en"
            }
          }
        ],
        "from": "2023-03-16T15:37:23Z",
        "to": "2023-03-16T15:37:23Z",
        "tagId": 109,
        "gracePeriods": [
          {
            "startTime": "09:00:00",
            "endTime": "17:00:00"
          }
        ]
      }
    ],
    "createdAt": "2023-03-16T15:37:23Z",
    "updatedAt": "2023-03-16T15:37:23Z"
  },
  "forecasts": [
    {
      "time": "2023-11-29T18:00:00Z",
      "pricePerKwh": 5978,
      "name": "0.60 DKK/kWh"
    }
  ]
}