Forbind til API

En stor del af Carnot platformens data kan til gåes ved brug af ens personlige API nøgle. Hvis du endnu ikke har fået din så følg linket herunder til 'Få adgang til API':

GitBook

Få adgang til API

Endpoints

/get_predict - seneste prognoser

Få de seneste prognoser på en tilgængelig energikilde, forbrug eller spotpris

GET https://openapi.carnot.dk/openapi/get_predict

Query Parameters

Name	Type	Description
energysource*	string	Begrænset til [offshorewindpower, onshorewindpower, solarpower, consumption, spotprice]
region*	string	Begrænset til [dk1,dk2]
daysahead*	int	Antal af dage frem. Imellem 1 og 7

Headers

Name	Type	Description
apikey*	string	Den personlige API nøgle
username*	string	Din email adresse der er knyttet til Carnot

200: OK

{
  "predictions": [
    {
      "id": 2362551,
      "dktime": "2022-08-15T17:00:00+00:00",
      "utctime": "2022-08-15T17:00:00+00:00",
      "latest": true,
      "pricearea": "dk1",
      "energysource": "offshorewindpower",
      "prediction": 128.79006411199998, // DKK hvis det er spotpris ellers MWh
      "addedtime": "2022-08-15T16:49:02.727329" // prognosens opdaterings tidspunkt
    },
  ]
}

Request

curl -X 'GET' \
  'https://openapi.carnot.dk/openapi/get_predict?energysource=offshorewindpower&region=dk1&daysahead=7' \
  -H 'accept: application/json' \
  -H 'apikey: {{ APIKEY }}' \
  -H 'username: {{ CARNOT EMAIL }}'

/get_users_cars - hent dine oprettede biler

Hent dine oprettede biler

GET https://openapi.carnot.dk/openapi/get_users_cars

Headers

Name	Type	Description
apikey*	string	Den personlige API nøgle
username*	string	Din email adresse der er knyttet til Carnot

200: OK

[
  {
    "username": "[e-mail]",
    "maxrange": 256,
    "bottombuffer": 0.2,
    "topbuffer": 0.2,
    "manufacturer": "VW",
    "year": 2018,
    "currentrange": 128,
    "id": 15,
    "chargetime": 3,
    "model": "e-up!",
    "name": "e-up!"
  },
  {
    "username": "[e-mail]",
    "maxrange": 354,
    "bottombuffer": 0.2,
    "topbuffer": 0.2,
    "manufacturer": "Tesla",
    "year": 2020,
    "currentrange": 280,
    "id": 21,
    "chargetime": 3,
    "model": "Model 3",
    "name": "Teslaen 3"
  }
]

Request

// Some code

curl -X 'GET' \
  'https://openapi.carnot.dk/openapi/get_user_cars' \
  -H 'accept: application/json' \
  -H 'apikey: {{ APIKEY }}' \
  -H 'username: {{ CARNOT EMAIL }}'

/get_commuteplan_for_car - hent opladningsplan for en specifik bil

Hent opladningsplan for en specifik bil

GET https://openapi.carnot.dk/openapi/get_commuteplan_for_car

Query Parameters

Name	Type	Description
region	string	Begrænset til [dk1,dk2]
includetoday	boolean	Styrer om hvor vidt dagens behov skal inkluderes i optimeringen
endonfull	boolean	Styrer om hvor vidt planen skal ende med et fyldt batteri
carid	int	id for din bil

Headers

Name	Type	Description
apikey	string	Den personlige API nøgle
username	string	Din email adresse der er knyttet til Carnot

200: OK

{
  "best_schedule": [
    {
      "used": 1,
      "start_charge_point": "2022-08-15T16:00:00+00:00",
      "end_charge_point": "2022-08-16T06:00:00+00:00",
      "best_charge_point": "2022-08-16T00:00:00+00:00",
      "battery_charge_level": 180,
      "demands": 100,
      "reminder_demand": 100,
      "demandstart": "08:00:00",
      "demandend": "18:00:00",
      "charge_price_charge_point": 3.1481932780000004,
      "extra_charging": 0
    },
  ],
  "solution_value": 323.6342689784001,
  "improvement": 0.648722941036366
}on

Request

// Some code
curl -X 'GET' \
  'https://openapi.carnot.dk/openapi/get_commuteplan_for_car?region=dk1&includetoday=true&endonfull=false&carid=21' \
  -H 'accept: application/json' \
  -H 'apikey: {{ APIKEY }}' \
  -H 'username: {{ CARNOT EMAIL }}'

/get_users_electricitycompany - hent energiselskab knyttet til din konto

Hent brugerens energiselskab

GET https://openapi.carnot.dk/openapi/get_users_electricitycompany

Headers

Name	Type	Description
apikey	string	Den personlige API nøgle
username	string	Din email adresse der er knyttet til Carnot

200: OK

{
  "name": "andel energi - Variabel pris",
  "charge": 0.004,
  "id": 16,
  "link": "https://andelenergi.dk/"
}

Request

curl -X 'GET' \
  'https://openapi.carnot.dk/openapi/get_users_electricitycompany' \
  -H 'accept: application/json' \
  -H 'apikey: {{ APIKEY }}' \
  -H 'username: {{ CARNOT EMAIL }}'

/get_users_gridcompany- hent specifikt netselskaber knyttet til din konto

Hent brugerens netselskab

GET https://openapi.carnot.dk/openapi/get_users_gridcompany

Headers

Name	Type	Description
apikey	string	Den personlige API nøgle
username	string	Din email adresse der er knyttet til Carnot

200: OK

{
  "charge_nonpeak": 0.3003,
  "id": 1,
  "link": null,
  "charge_peak": 0.7651,
  "name": "Radius C"
}

Request

curl -X 'GET' \
  'https://openapi.carnot.dk/openapi/get_users_gridcompany' \
  -H 'accept: application/json' \
  -H 'apikey: {{ APIKEY }}' \
  -H 'username: {{ CARNOT EMAIL }}'

UNDER OPBYGNING

/structured_dmi - hent struktureret DMI og energidataservice datasæt

Parametre

• apikey

  • Din personlige API nøgle

• username

  • Din email adresse der er knyttet til Carnot

Request

Returneret skema

Alle åbne endpoints kan findes her:

FastAPI - Swagger UI