Get all available products¶
Returns all the available products.
Authentication not required
products does not require authentication.
-
Arguments
- id:
ID
- displayName:
String - basedOnTimeOfUse:
Boolean - availableAt:
DateTime - prepay:
Boolean
- id:
-
Returns
Example¶
import pprint
import requests
# API_URL = "https://api.oeus-kraken.energy/v1/graphql/" # Prod
API_URL = "https://api.oeus-kraken.systems/v1/graphql/" # Test
HEADERS = {}
QUERY = """
query getAllAvailableProducts{
products{
id
availableFrom
availableTo
availabilityStatus
autoTopUpDefaultAmount
autoTopUpMinimumAmount
basedOnTimeOfUse
code
description
displayName
fullName
generationCredit
isWholesale
marketName
notes
prepay
term
termsContractType
}
}
"""
VARIABLES = {}
session = requests.Session()
session.headers.update(HEADERS)
response = session.post(
url=API_URL,
json={"query": QUERY, "variables": VARIABLES}
)
pprint.pprint(response.json())
const axios = require("axios")
// const API_URL = "https://api.oeus-kraken.energy/v1/graphql/" // Prod
const apiUrl = "https://api.oeus-kraken.systems/v1/graphql/" // Test
let headers = {'content-type': 'application/json'}
const query = `
query getAllAvailableProducts{
products{
id
availableFrom
availableTo
availabilityStatus
autoTopUpDefaultAmount
autoTopUpMinimumAmount
basedOnTimeOfUse
code
description
displayName
fullName
generationCredit
isWholesale
marketName
notes
prepay
term
termsContractType
}
}
`
const variables = {}
axios({
url: apiUrl,
method: "post",
data: {
query: query,
variables: variables,
},
headers: headers,
}).then((response) => {
console.log(JSON.stringify(response.data, null, 4));
});
import axios from 'axios';
// const API_URL = "https://api.oeus-kraken.energy/v1/graphql/" // Prod
export const apiUrl = "https://api.oeus-kraken.systems/v1/graphql/" // Test
let headers = {'content-type': 'application/json'}
export const query = `
query getAllAvailableProducts{
products{
id
availableFrom
availableTo
availabilityStatus
autoTopUpDefaultAmount
autoTopUpMinimumAmount
basedOnTimeOfUse
code
description
displayName
fullName
generationCredit
isWholesale
marketName
notes
prepay
term
termsContractType
}
}
`
export const variables = {}
axios({
url: apiUrl,
method: "post",
data: {
query: query,
variables: variables,
},
headers: headers,
}).then((response) => {
console.log(JSON.stringify(response.data, null, 4));
});
{
"data": {
"products": [
{
"id": "16",
"availableFrom": "2021-06-01T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPUS-MONTH-TO-MONTH",
"description": "Postpay Month-to-month rates, no contract",
"displayName": "Octopus Energy MTM",
"fullName": "Octopus Energy MTM",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 1,
"termsContractType": ""
},
{
"id": "2",
"availableFrom": "2021-03-24T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": 7500,
"autoTopUpMinimumAmount": 5000,
"basedOnTimeOfUse": false,
"code": "ERCOT-PREPAY-WHOLESALE-30-2021",
"description": "Wholesale rate for 30 days",
"displayName": "30-Day Wholesale Rate",
"fullName": "30-day Pre-Pay Wholesale Rate",
"generationCredit": true,
"isWholesale": true,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "Initial load of products for Texas - wholesale rate",
"prepay": true,
"term": 30,
"termsContractType": ""
},
{
"id": "20",
"availableFrom": "2021-08-26T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPUS-EXTRA-365-DAY-FIXED",
"description": "12 month fixed rate",
"displayName": "OctoExtra 365 Day Fixed",
"fullName": "OctoExtra 365 Day Fixed",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 12,
"termsContractType": ""
},
{
"id": "21",
"availableFrom": "2021-08-26T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPUS-EXTRA-90-DAY-FIXED",
"description": "90 day fixed rate.",
"displayName": "OctoExtra 90 Day Fixed",
"fullName": "OctoExtra 90 Day Fixed",
"generationCredit": false,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 3,
"termsContractType": ""
},
{
"id": "19",
"availableFrom": "2021-08-01T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPLUS-90-DAY-FIXED",
"description": "90 day fixed rate.",
"displayName": "OctoPlus 90 Day Fixed",
"fullName": "OctoPlus 90 Day Fixed",
"generationCredit": false,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 3,
"termsContractType": ""
},
{
"id": "39",
"availableFrom": "2021-12-10T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": 7500,
"autoTopUpMinimumAmount": 5000,
"basedOnTimeOfUse": false,
"code": "OCTOGO-12M",
"description": "Prepaid 12 Month Fixed Rate with no exit fees.",
"displayName": "OctoGo 12M",
"fullName": "OctoGo 12M",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": true,
"term": 12,
"termsContractType": ""
},
{
"id": "32",
"availableFrom": "2021-11-16T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": 7500,
"autoTopUpMinimumAmount": 5000,
"basedOnTimeOfUse": false,
"code": "OCTOGO-30-DAY-FIXED",
"description": "30 Day Fixed Rate",
"displayName": "OctoGo 30",
"fullName": "OctoGo 30",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": true,
"term": 1,
"termsContractType": ""
},
{
"id": "33",
"availableFrom": "2021-11-16T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": 7500,
"autoTopUpMinimumAmount": 5000,
"basedOnTimeOfUse": false,
"code": "OCTOGO-90-DAY-FIXED",
"description": "90 Day Fixed Rate",
"displayName": "OctoGo 90",
"fullName": "OctoGo 90",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": true,
"term": 1,
"termsContractType": ""
},
{
"id": "34",
"availableFrom": "2021-11-16T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": 7500,
"autoTopUpMinimumAmount": 5000,
"basedOnTimeOfUse": false,
"code": "OCTOGO-MTM-FIXED",
"description": "Month-to-month fixed rate",
"displayName": "OctoGo MTM",
"fullName": "OctoGo MTM",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": true,
"term": 1,
"termsContractType": ""
},
{
"id": "36",
"availableFrom": "2021-12-10T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPLUS-24M",
"description": "24 Month Fixed Rate with no exit fees.",
"displayName": "OctoPlus 24M",
"fullName": "OctoPlus 24M",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 24,
"termsContractType": ""
},
{
"id": "37",
"availableFrom": "2021-12-06T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPLUS-36M",
"description": "36 Month Fixed Rate with no exit fees.",
"displayName": "OctoPlus 36M",
"fullName": "OctoPlus 36M",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 36,
"termsContractType": ""
},
{
"id": "38",
"availableFrom": "2021-12-15T00:00:00-06:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": false,
"code": "OCTOPLUS-12M",
"description": "12 Month Fixed Rate with no exit fees.",
"displayName": "OctoPlus 12M",
"fullName": "OctoPlus 12M",
"generationCredit": true,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 12,
"termsContractType": ""
},
{
"id": "22",
"availableFrom": "2021-09-15T00:00:00-05:00",
"availableTo": null,
"availabilityStatus": "PUBLIC",
"autoTopUpDefaultAmount": null,
"autoTopUpMinimumAmount": null,
"basedOnTimeOfUse": true,
"code": "OCTOPUS-DRIVE-365-DAY-FIXED",
"description": "12 month Time-of-Use fixed rate",
"displayName": "OctoDrive 365 Day Fixed",
"fullName": "OctoDrive 365 Day Fixed",
"generationCredit": false,
"isWholesale": false,
"marketName": "USA_ERCOT_ELECTRICITY",
"notes": "",
"prepay": false,
"term": 12,
"termsContractType": ""
}
]
}
}