Skip to main content
POST
/
v1
/
report
Submit performance report
curl --request POST \
  --url https://example-supplier.co.uk/v1/report \
  --header 'Content-Type: application/json' \
  --header 'X-Supplier-API-Key: <api-key>' \
  --data '
{
  "reporting_period_start": "2026-11-01T10:00:00.000Z",
  "reporting_period_end": "2026-11-01T10:00:00.000Z",
  "tariff_requests": 4823100,
  "tariff_changes": 12,
  "availability_pct": 99.97,
  "success_pct": 99.82,
  "response_time_ms": {
    "p50": 120,
    "p95": 820,
    "p99": 1450
  }
}
'
import requests

url = "https://example-supplier.co.uk/v1/report"

payload = {
    "reporting_period_start": "2026-11-01T10:00:00.000Z",
    "reporting_period_end": "2026-11-01T10:00:00.000Z",
    "tariff_requests": 4823100,
    "tariff_changes": 12,
    "availability_pct": 99.97,
    "success_pct": 99.82,
    "response_time_ms": {
        "p50": 120,
        "p95": 820,
        "p99": 1450
    }
}
headers = {
    "X-Supplier-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-Supplier-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reporting_period_start: '2026-11-01T10:00:00.000Z',
    reporting_period_end: '2026-11-01T10:00:00.000Z',
    tariff_requests: 4823100,
    tariff_changes: 12,
    availability_pct: 99.97,
    success_pct: 99.82,
    response_time_ms: {p50: 120, p95: 820, p99: 1450}
  })
};

fetch('https://example-supplier.co.uk/v1/report', 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://example-supplier.co.uk/v1/report",
  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([
    'reporting_period_start' => '2026-11-01T10:00:00.000Z',
    'reporting_period_end' => '2026-11-01T10:00:00.000Z',
    'tariff_requests' => 4823100,
    'tariff_changes' => 12,
    'availability_pct' => 99.97,
    'success_pct' => 99.82,
    'response_time_ms' => [
        'p50' => 120,
        'p95' => 820,
        'p99' => 1450
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Supplier-API-Key: <api-key>"
  ],
]);

$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://example-supplier.co.uk/v1/report"

	payload := strings.NewReader("{\n  \"reporting_period_start\": \"2026-11-01T10:00:00.000Z\",\n  \"reporting_period_end\": \"2026-11-01T10:00:00.000Z\",\n  \"tariff_requests\": 4823100,\n  \"tariff_changes\": 12,\n  \"availability_pct\": 99.97,\n  \"success_pct\": 99.82,\n  \"response_time_ms\": {\n    \"p50\": 120,\n    \"p95\": 820,\n    \"p99\": 1450\n  }\n}")

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

	req.Header.Add("X-Supplier-API-Key", "<api-key>")
	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://example-supplier.co.uk/v1/report")
  .header("X-Supplier-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reporting_period_start\": \"2026-11-01T10:00:00.000Z\",\n  \"reporting_period_end\": \"2026-11-01T10:00:00.000Z\",\n  \"tariff_requests\": 4823100,\n  \"tariff_changes\": 12,\n  \"availability_pct\": 99.97,\n  \"success_pct\": 99.82,\n  \"response_time_ms\": {\n    \"p50\": 120,\n    \"p95\": 820,\n    \"p99\": 1450\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://example-supplier.co.uk/v1/report")

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

request = Net::HTTP::Post.new(url)
request["X-Supplier-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reporting_period_start\": \"2026-11-01T10:00:00.000Z\",\n  \"reporting_period_end\": \"2026-11-01T10:00:00.000Z\",\n  \"tariff_requests\": 4823100,\n  \"tariff_changes\": 12,\n  \"availability_pct\": 99.97,\n  \"success_pct\": 99.82,\n  \"response_time_ms\": {\n    \"p50\": 120,\n    \"p95\": 820,\n    \"p99\": 1450\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "code": "tariff_not_found",
  "message": "No tariff found for the given tariff_id and supplier MPID.",
  "details": "tariff_id a1b2c3d4-e5f6-7890-abcd-ef1234567890 does not exist for supplier SEBD."
}
{
  "code": "tariff_not_found",
  "message": "No tariff found for the given tariff_id and supplier MPID.",
  "details": "tariff_id a1b2c3d4-e5f6-7890-abcd-ef1234567890 does not exist for supplier SEBD."
}
{
  "code": "tariff_not_found",
  "message": "No tariff found for the given tariff_id and supplier MPID.",
  "details": "tariff_id a1b2c3d4-e5f6-7890-abcd-ef1234567890 does not exist for supplier SEBD."
}

Authorizations

X-Supplier-API-Key
string
header
required

API key issued to TI Energy Suppliers for accessing restricted register data and submitting performance reports. Credentials are valid for 2 years and are distributed via a one-time URL from the Code Manager.

Body

application/json

Performance metrics submitted by a supplier to RECCo each reporting period.

reporting_period_start
string<date-time>
required

ISO 8601 datetime with millisecond precision.

Example:

"2026-11-01T10:00:00.000Z"

reporting_period_end
string<date-time>
required

ISO 8601 datetime with millisecond precision.

Example:

"2026-11-01T10:00:00.000Z"

tariff_requests
integer
required

Total tariff pricing data requests received during the period.

Required range: x >= 0
Example:

4823100

tariff_changes
integer
required

Number of tariff change notifications issued during the period.

Required range: x >= 0
Example:

12

availability_pct
number<float>
required

API availability during the period as a percentage. SLA target is 99.9%.

Required range: 0 <= x <= 100
Example:

99.97

success_pct
number<float>
required

Percentage of requests that returned a 2xx response.

Required range: 0 <= x <= 100
Example:

99.82

response_time_ms
object
required

API response times in milliseconds, broken down by percentile.

Response

Report accepted.

Last modified on March 28, 2026