List Supplier Switches
curl --request GET \
--url https://api.engrate.io/market-access/v1alpha1/supplier-switches \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/market-access/v1alpha1/supplier-switches"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/market-access/v1alpha1/supplier-switches', 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.engrate.io/market-access/v1alpha1/supplier-switches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.engrate.io/market-access/v1alpha1/supplier-switches"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engrate.io/market-access/v1alpha1/supplier-switches")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/market-access/v1alpha1/supplier-switches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"accounting_point_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accounting_point_market_identifier": "26611699793",
"created_at": "2023-11-07T05:31:56Z",
"declared": {
"accounting_point_type": "consumption",
"balance_group": {
"kind": "eic",
"value": "46X000000000245K"
},
"customer": {
"city": "<string>",
"country_code": "DE",
"house_number": "<string>",
"name": "<string>",
"postcode": "<string>",
"street": "<string>"
},
"enfg_eligibility": {
"kind": "customer_qualifies",
"privilege_reasons": [
"ZU5"
]
},
"grid_operator": {
"kind": "eic",
"value": "46X000000000245K"
}
},
"effective_date": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"market": "DE",
"requests": [
{
"market_message": {
"delivery_status": "delivered",
"references": {
"interchange_control_reference": "<string>",
"message_reference": "<string>",
"transaction_reference": "<string>"
}
},
"requested_at": "2023-11-07T05:31:56Z",
"outcome": {
"decided_at": "2023-11-07T05:31:56Z",
"kind": "accepted"
}
}
],
"state": {
"kind": "pending",
"block": {
"reason": "request failed: answer_timeout"
}
},
"state_updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Supplier switches
List Supplier Switches
List the supplier switches of your organization, oldest first.
Each switch shows its state, the data you declared, and each request that Engrate made to the market. Every filter you give must match. Engrate reads state as of today on the calendar of the market: an accepted switch is accepted before its effective date and effected from that date.
Errors:
-
404: your organization is not set up for market communication. Contact Engrate. -
422: a filter is not valid. For example,stateis not a switch state.
GET
/
market-access
/
v1alpha1
/
supplier-switches
List Supplier Switches
curl --request GET \
--url https://api.engrate.io/market-access/v1alpha1/supplier-switches \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/market-access/v1alpha1/supplier-switches"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/market-access/v1alpha1/supplier-switches', 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.engrate.io/market-access/v1alpha1/supplier-switches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.engrate.io/market-access/v1alpha1/supplier-switches"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engrate.io/market-access/v1alpha1/supplier-switches")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/market-access/v1alpha1/supplier-switches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"accounting_point_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accounting_point_market_identifier": "26611699793",
"created_at": "2023-11-07T05:31:56Z",
"declared": {
"accounting_point_type": "consumption",
"balance_group": {
"kind": "eic",
"value": "46X000000000245K"
},
"customer": {
"city": "<string>",
"country_code": "DE",
"house_number": "<string>",
"name": "<string>",
"postcode": "<string>",
"street": "<string>"
},
"enfg_eligibility": {
"kind": "customer_qualifies",
"privilege_reasons": [
"ZU5"
]
},
"grid_operator": {
"kind": "eic",
"value": "46X000000000245K"
}
},
"effective_date": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"market": "DE",
"requests": [
{
"market_message": {
"delivery_status": "delivered",
"references": {
"interchange_control_reference": "<string>",
"message_reference": "<string>",
"transaction_reference": "<string>"
}
},
"requested_at": "2023-11-07T05:31:56Z",
"outcome": {
"decided_at": "2023-11-07T05:31:56Z",
"kind": "accepted"
}
}
],
"state": {
"kind": "pending",
"block": {
"reason": "request failed: answer_timeout"
}
},
"state_updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Query Parameters
Was this page helpful?