Create a meter reading

curl --request POST \
  --url https://api.nomos.energy/subscriptions/{id}/meter_readings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 150,
  "timestamp": "2024-03-14T12:00:00Z",
  "message": "Reading to start the subscription"
}
'

import requests

url = "https://api.nomos.energy/subscriptions/{id}/meter_readings"

payload = {
    "value": 150,
    "timestamp": "2024-03-14T12:00:00Z",
    "message": "Reading to start the subscription"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    value: 150,
    timestamp: '2024-03-14T12:00:00Z',
    message: 'Reading to start the subscription'
  })
};

fetch('https://api.nomos.energy/subscriptions/{id}/meter_readings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/subscriptions/{id}/meter_readings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => 150,
    'timestamp' => '2024-03-14T12:00:00Z',
    'message' => 'Reading to start the subscription'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/subscriptions/{id}/meter_readings"

	payload := strings.NewReader("{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nomos.energy/subscriptions/{id}/meter_readings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/subscriptions/{id}/meter_readings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "meter_reading",
  "id": "read_k3n9x2v7q1m8p4t6w0z5c2bd",
  "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_rocbrf1u5e48mm0reeqoag90",
  "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
  "value": 150,
  "timestamp": "2024-03-13T23:00:00.000Z",
  "type": "customer_report",
  "created_at": "2024-03-14T12:00:03.512Z"
}

POST

subscriptions

{id}

meter_readings

Create a meter reading

curl --request POST \
  --url https://api.nomos.energy/subscriptions/{id}/meter_readings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 150,
  "timestamp": "2024-03-14T12:00:00Z",
  "message": "Reading to start the subscription"
}
'

import requests

url = "https://api.nomos.energy/subscriptions/{id}/meter_readings"

payload = {
    "value": 150,
    "timestamp": "2024-03-14T12:00:00Z",
    "message": "Reading to start the subscription"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    value: 150,
    timestamp: '2024-03-14T12:00:00Z',
    message: 'Reading to start the subscription'
  })
};

fetch('https://api.nomos.energy/subscriptions/{id}/meter_readings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/subscriptions/{id}/meter_readings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => 150,
    'timestamp' => '2024-03-14T12:00:00Z',
    'message' => 'Reading to start the subscription'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/subscriptions/{id}/meter_readings"

	payload := strings.NewReader("{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.nomos.energy/subscriptions/{id}/meter_readings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/subscriptions/{id}/meter_readings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": 150,\n  \"timestamp\": \"2024-03-14T12:00:00Z\",\n  \"message\": \"Reading to start the subscription\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "meter_reading",
  "id": "read_k3n9x2v7q1m8p4t6w0z5c2bd",
  "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_rocbrf1u5e48mm0reeqoag90",
  "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
  "value": 150,
  "timestamp": "2024-03-13T23:00:00.000Z",
  "type": "customer_report",
  "created_at": "2024-03-14T12:00:03.512Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Example:

"sub_ig1f5x45789r3ax7dlfff4q4"

Body

application/json

Meter reading input

value

number

required

Cumulative meter value in kWh. A freshly exchanged meter may report 0.

Required range: x >= 0

Example:

150

timestamp

string<date-time>

required

Timestamp of the reading in UTC

Example:

"2024-03-14T12:00:00Z"

message

string

Optional message from the submitter

Maximum string length: 500

Example:

"Reading to start the subscription"

Response

Meter reading accepted

object

enum<string>

required

Available options:

meter_reading

string

required

The unique identifier for the meter reading

Example:

"read_k3n9x2v7q1m8p4t6w0z5c2bd"

customer

string

required

The unique identifier for the customer

Example:

"cus_a8n8ol7yd4h0wohx824f0bui"

subscription

string

required

The unique identifier for the subscription

Example:

"sub_rocbrf1u5e48mm0reeqoag90"

meter

string

required

The unique identifier for the meter

Example:

"mtr_azk4zue2ijx4ff1dbjt14m5h"

value

number

required

The value of the meter reading

Example:

150

timestamp

string<date-time>

required

Timestamp get's always adjusted to the start of the day in Europe/Berlin

Example:

"2024-03-13T23:00:00.000Z"

type

enum<string>

required

The type of the meter reading

Available options:

customer_report,

grid_reading,

grid_estimation

Example:

"customer_report"

created_at

string<date-time>

required

Example:

"2024-03-14T12:00:03.512Z"