Skip to main content

Queries

In this section

About Queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

API Site

account

Type:AccountType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about an account.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

Query

query Account($accountNumber: String!) {
  account(accountNumber: $accountNumber) {
    id
    number
    status
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    users {
      ...AccountUserTypeFragment
    }
    consentData
    brand
    balance
    overdueBalance
    urn
    billingName
    billingSubName
    billingEmail
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    splitBillingAddress
    address {
      ...RichAddressTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    ledgers {
      ...LedgerTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    canRequestRefund
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentForecast {
      ...PaymentForecastTypeFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    rewards {
      ...RewardTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    bill {
      ...BillInterfaceFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    accountType
    businessType
    business {
      ...BusinessTypeFragment
    }
    commsDeliveryPreference
    communicationDeliveryPreference
    documentAccessibility
    references {
      ...AccountReferenceTypeFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    isInHardship
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    createdAt
    preferredLanguageForComms
    consents {
      ...ConsentTypeFragment
    }
    properties {
      ...PropertyTypeFragment
    }
    meterPointStatus
    isShellAccount
    isEligibleForIntelligentOctopus
    agreements {
      ...AgreementTypeFragment
    }
    isOnSupply
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "account": {
      "id": "abc123",
      "number": "abc123",
      "status": "PENDING",
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "users": AccountUserType,
      "consentData": {"key": "value"},
      "brand": "abc123",
      "balance": 1,
      "overdueBalance": 1,
      "urn": "abc123",
      "billingName": "abc123",
      "billingSubName": "abc123",
      "billingEmail": "abc123",
      "billingAddress": "abc123",
      "billingAddressLine1": "abc123",
      "billingAddressLine2": "abc123",
      "billingAddressLine3": "abc123",
      "billingAddressLine4": "abc123",
      "billingAddressLine5": "abc123",
      "billingAddressPostcode": "abc123",
      "billingCountryCode": "abc123",
      "billingDeliveryPointIdentifier": "abc123",
      "splitBillingAddress": ["abc123"],
      "address": RichAddressType,
      "portfolio": PortfolioType,
      "ledgers": [LedgerType],
      "metadata": [Metadata],
      "canRequestRefund": true,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "payments": AccountPaymentConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentForecast": [PaymentForecastType],
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 1,
      "rewards": [RewardType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "transactions": TransactionConnectionTypeConnection,
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "bills": BillConnectionTypeConnection,
      "billingOptions": BillingOptionsType,
      "bill": BillInterface,
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "events": AccountEventConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "accountType": "BUSINESS",
      "businessType": "SOLE_TRADER",
      "business": BusinessType,
      "commsDeliveryPreference": "EMAIL",
      "communicationDeliveryPreference": "abc123",
      "documentAccessibility": "LARGE_PRINT",
      "references": [AccountReferenceType],
      "fileAttachments": [AccountFileAttachment],
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "maximumRefund": MaximumRefundType,
      "campaigns": [AccountCampaignType],
      "isInHardship": true,
      "activeHardshipAgreements": [HardshipAgreementType],
      "notes": [AccountNoteType],
      "contributionAgreements": [ContributionAgreementType],
      "assistanceAgreements": [AssistanceAgreementType],
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "createdAt": "2020-01-01T00:00:00.000Z",
      "preferredLanguageForComms": "abc123",
      "consents": ConsentType,
      "properties": [PropertyType],
      "meterPointStatus": "abc123",
      "isShellAccount": true,
      "isEligibleForIntelligentOctopus": true,
      "agreements": [AgreementType],
      "isOnSupply": true
    }
  }
}

accountChargeReasons

Type:[ChargeReasonType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Available reasons for use in account charge mutations.

Query

query AccountChargeReasons {
  accountChargeReasons {
    code
    display
    isDeprecated
    isTaxExempt
    isHidden
    group
  }
}

Response

{
  "data": {
    "accountChargeReasons": [
      {
        "code": "abc123",
        "display": "abc123",
        "isDeprecated": true,
        "isTaxExempt": true,
        "isHidden": true,
        "group": "abc123"
      }
    ]
  }
}

accountContract

Type:Contract

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about an account contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10005: Missing required parameter: either identifier or accountNumber must be provided.
  • KT-CT-10006: Account not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

identifier (String)

The identifier of the contract.

accountNumber (String)

The account number to find the contract for.

version (Int)

The version of the contract.

Query

query AccountContract(
  $identifier: String,
  $accountNumber: String,
  $version: Int
) {
  accountContract(
    identifier: $identifier,
    accountNumber: $accountNumber,
    version: $version
  ) {
    identifier
    title
    party {
      ... on AccountType {
        ...AccountTypeFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    subject {
      ...AccountTypeFragment
    }
    status
    validFrom
    validTo
    signedAt
    cancelledAt
    lifecycle {
      ...ContractVersionFragment
    }
    terms {
      ...TermInterfaceFragment
    }
  }
}

Variables

{
  "identifier": "abc123",
  "accountNumber": "abc123",
  "version": 1
}

Response

{
  "data": {
    "accountContract": {
      "identifier": NonEmptyString,
      "title": "abc123",
      "party": AccountType,
      "subject": [AccountType],
      "status": "REVOKED",
      "validFrom": "2020-01-01T00:00:00.000Z",
      "validTo": "2020-01-01T00:00:00.000Z",
      "signedAt": "2020-01-01T00:00:00.000Z",
      "cancelledAt": "2020-01-01T00:00:00.000Z",
      "lifecycle": ContractVersion,
      "terms": TermInterface
    }
  }
}

accountCreditReasons

Type:[CreditReasonType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Available reasons for use in account credit mutations.

Query

query AccountCreditReasons {
  accountCreditReasons {
    code
    display
    isDeprecated
    isTaxExempt
    isHidden
    group
  }
}

Response

{
  "data": {
    "accountCreditReasons": [
      {
        "code": "abc123",
        "display": "abc123",
        "isDeprecated": true,
        "isTaxExempt": true,
        "isHidden": true,
        "group": "abc123"
      }
    ]
  }
}

accountIoEligibility

Type:AccountIoEligibility

URL:https://api.oeus-kraken.energy/v1/graphql/

Determines whether an account is eligible to register devices with Intelligent Octopus.

Arguments

NameDescription

accountNumber (String!)

Account number.

Query

query AccountIoEligibility($accountNumber: String!) {
  accountIoEligibility(accountNumber: $accountNumber) {
    isEligibleForIo
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "accountIoEligibility": {
      "isEligibleForIo": true
    }
  }
}

accountReference

Type:[AccountReferenceType]

URL:https://api.oeus-kraken.energy/v1/graphql/

List of matching account references.

The possible errors that can be raised are:

  • KT-CT-8310: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

value (String)

Query

query AccountReference($value: String) {
  accountReference(value: $value) {
    namespace
    value
    createdAt
    updatedAt
    account {
      ...AccountTypeFragment
    }
  }
}

Variables

{
  "value": "abc123"
}

Response

{
  "data": {
    "accountReference": [
      {
        "namespace": "abc123",
        "value": "abc123",
        "createdAt": "2020-01-01T00:00:00.000Z",
        "updatedAt": "2020-01-01T00:00:00.000Z",
        "account": AccountType
      }
    ]
  }
}

accounts

Type:[AccountType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about multiple accounts.

Arguments

NameDescription

phoneNumber (String)

A phone number to find accounts associated with.

portfolioNumber (String)

A portfolio number to find accounts associated with.

Query

query Accounts(
  $phoneNumber: String,
  $portfolioNumber: String
) {
  accounts(
    phoneNumber: $phoneNumber,
    portfolioNumber: $portfolioNumber
  ) {
    id
    number
    status
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    users {
      ...AccountUserTypeFragment
    }
    consentData
    brand
    balance
    overdueBalance
    urn
    billingName
    billingSubName
    billingEmail
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    splitBillingAddress
    address {
      ...RichAddressTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    ledgers {
      ...LedgerTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    canRequestRefund
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentForecast {
      ...PaymentForecastTypeFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    rewards {
      ...RewardTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    bill {
      ...BillInterfaceFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    accountType
    businessType
    business {
      ...BusinessTypeFragment
    }
    commsDeliveryPreference
    communicationDeliveryPreference
    documentAccessibility
    references {
      ...AccountReferenceTypeFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    isInHardship
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    createdAt
    preferredLanguageForComms
    consents {
      ...ConsentTypeFragment
    }
    properties {
      ...PropertyTypeFragment
    }
    meterPointStatus
    isShellAccount
    isEligibleForIntelligentOctopus
    agreements {
      ...AgreementTypeFragment
    }
    isOnSupply
  }
}

Variables

{
  "phoneNumber": "abc123",
  "portfolioNumber": "abc123"
}

Response

{
  "data": {
    "accounts": [
      {
        "id": "abc123",
        "number": "abc123",
        "status": "PENDING",
        "paymentSchedules": PaymentScheduleConnectionTypeConnection,
        "users": AccountUserType,
        "consentData": {"key": "value"},
        "brand": "abc123",
        "balance": 1,
        "overdueBalance": 1,
        "urn": "abc123",
        "billingName": "abc123",
        "billingSubName": "abc123",
        "billingEmail": "abc123",
        "billingAddress": "abc123",
        "billingAddressLine1": "abc123",
        "billingAddressLine2": "abc123",
        "billingAddressLine3": "abc123",
        "billingAddressLine4": "abc123",
        "billingAddressLine5": "abc123",
        "billingAddressPostcode": "abc123",
        "billingCountryCode": "abc123",
        "billingDeliveryPointIdentifier": "abc123",
        "splitBillingAddress": ["abc123"],
        "address": RichAddressType,
        "portfolio": PortfolioType,
        "ledgers": [LedgerType],
        "metadata": [Metadata],
        "canRequestRefund": true,
        "requestRefundEligibility": RequestRefundEligibilityType,
        "payments": AccountPaymentConnectionTypeConnection,
        "repayments": AccountRepaymentConnectionTypeConnection,
        "paymentPlans": PaymentPlanConnectionTypeConnection,
        "paymentForecast": [PaymentForecastType],
        "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
        "referrals": ReferralConnectionTypeConnection,
        "referralsCreated": 1,
        "rewards": [RewardType],
        "activeReferralSchemes": ReferralSchemeTypes,
        "transactions": TransactionConnectionTypeConnection,
        "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
        "annualStatements": AnnualStatementConnectionTypeConnection,
        "bills": BillConnectionTypeConnection,
        "billingOptions": BillingOptionsType,
        "bill": BillInterface,
        "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
        "paymentMethods": PaymentInstructionConnectionTypeConnection,
        "events": AccountEventConnectionTypeConnection,
        "applications": AccountApplicationConnectionTypeConnection,
        "accountType": "BUSINESS",
        "businessType": "SOLE_TRADER",
        "business": BusinessType,
        "commsDeliveryPreference": "EMAIL",
        "communicationDeliveryPreference": "abc123",
        "documentAccessibility": "LARGE_PRINT",
        "references": [AccountReferenceType],
        "fileAttachments": [AccountFileAttachment],
        "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
        "maximumRefund": MaximumRefundType,
        "campaigns": [AccountCampaignType],
        "isInHardship": true,
        "activeHardshipAgreements": [HardshipAgreementType],
        "notes": [AccountNoteType],
        "contributionAgreements": [ContributionAgreementType],
        "assistanceAgreements": [AssistanceAgreementType],
        "debtCollectionProceedings": [DebtCollectionProceedingType],
        "createdAt": "2020-01-01T00:00:00.000Z",
        "preferredLanguageForComms": "abc123",
        "consents": ConsentType,
        "properties": [PropertyType],
        "meterPointStatus": "abc123",
        "isShellAccount": true,
        "isEligibleForIntelligentOctopus": true,
        "agreements": [AgreementType],
        "isOnSupply": true
      }
    ]
  }
}

activeAffiliateReferralScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Return the current active referral reward scheme of a given affiliate organisation, if any exists.

Arguments

NameDescription

subdomain (String!)

The affiliate link subdomain.

Query

query ActiveAffiliateReferralScheme($subdomain: String!) {
  activeAffiliateReferralScheme(subdomain: $subdomain) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Variables

{
  "subdomain": "abc123"
}

Response

{
  "data": {
    "activeAffiliateReferralScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

activeDomesticSignupRewardScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Return the current active signup referral reward scheme with the given code, if any exists.

Query

query ActiveDomesticSignupRewardScheme {
  activeDomesticSignupRewardScheme {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Response

{
  "data": {
    "activeDomesticSignupRewardScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

Arguments

NameDescription

esiId (String)

address (String)

address2 (String)

city (String)

postCode (String)

state (String)

Query

query AddressLookup(
  $esiId: String,
  $address: String,
  $address2: String,
  $city: String,
  $postCode: String,
  $state: String
) {
  addressLookup(
    esiId: $esiId,
    address: $address,
    address2: $address2,
    city: $city,
    postCode: $postCode,
    state: $state
  ) {
    esiId
    houseNumber
    address
    address2
    city
    postCode
    state
    serviceProvider
    loadZone
    isCustomer {
      ...OeCustomerOutputFragment
    }
    meterType
    premiseType
  }
}

Variables

{
  "esiId": "abc123",
  "address": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "postCode": "abc123",
  "state": "abc123"
}

Response

{
  "data": {
    "addressLookup": [
      {
        "esiId": "abc123",
        "houseNumber": "abc123",
        "address": "abc123",
        "address2": "abc123",
        "city": "abc123",
        "postCode": "abc123",
        "state": "abc123",
        "serviceProvider": "AEP_TCC",
        "loadZone": "LZ_HOUSTON",
        "isCustomer": OeCustomerOutput,
        "meterType": "AMSM",
        "premiseType": "RESIDENTIAL"
      }
    ]
  }
}

Arguments

NameDescription

search (String!)

Query

query AddressLookupUsingEsSearch($search: String!) {
  addressLookupUsingEsSearch(search: $search) {
    esiId
    houseNumber
    address
    address2
    city
    postCode
    state
    serviceProvider
    loadZone
    isCustomer {
      ...OeCustomerOutputFragment
    }
    meterType
    premiseType
  }
}

Variables

{
  "search": "abc123"
}

Response

{
  "data": {
    "addressLookupUsingEsSearch": [
      {
        "esiId": "abc123",
        "houseNumber": "abc123",
        "address": "abc123",
        "address2": "abc123",
        "city": "abc123",
        "postCode": "abc123",
        "state": "abc123",
        "serviceProvider": "AEP_TCC",
        "loadZone": "LZ_HOUSTON",
        "isCustomer": OeCustomerOutput,
        "meterType": "AMSM",
        "premiseType": "RESIDENTIAL"
      }
    ]
  }
}

availableProductSwitchDates

Type:[Date]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get available dates for product switch.

The possible errors that can be raised are:

  • KT-CT-1501: Agreement not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

agreementId (Int!)

Agreement ID.

maxRange (Int)

The maximum number of days to look for available dates.

Query

query AvailableProductSwitchDates(
  $agreementId: Int!,
  $maxRange: Int
) {
  availableProductSwitchDates(
    agreementId: $agreementId,
    maxRange: $maxRange
  )
}

Variables

{
  "agreementId": 1,
  "maxRange": 1
}

Response

{
  "data": {
    "availableProductSwitchDates": ["2020-01-01"]
  }
}

availableServiceDates

Type:[Date]

URL:https://api.oeus-kraken.energy/v1/graphql/

List of available dates for move-in/switch/other service orders.

Arguments

NameDescription

esiId (String!)

ESI ID of meter point.

Query

query AvailableServiceDates($esiId: String!) {
  availableServiceDates(esiId: $esiId)
}

Variables

{
  "esiId": "abc123"
}

Response

{
  "data": {
    "availableServiceDates": ["2020-01-01"]
  }
}

backendScreen

Type:BackendScreenType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get mobile screen details to render.

The possible errors that can be raised are:

  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

screenId (ID!)

The ID of the screen to return.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

maxVersionSupported (Int)

The maximum version of backend screens supported by the client.

Query

query BackendScreen(
  $screenId: ID!,
  $params: [BackendScreenParamInputType],
  $maxVersionSupported: Int
) {
  backendScreen(
    screenId: $screenId,
    params: $params,
    maxVersionSupported: $maxVersionSupported
  ) {
    ... on ComponentListType {
      ...ComponentListTypeFragment
    }
    ... on GenericBackendScreen {
      ...GenericBackendScreenFragment
    }
    ... on Dashboard {
      ...DashboardFragment
    }
  }
}

Variables

{
  "screenId": "abc123",
  "params": BackendScreenParamInputType,
  "maxVersionSupported": 1
}

Response

{
  "data": {
    "backendScreen": ComponentListType
  }
}

backendScreenEventIds

Type:[String]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all registered backend screen event IDs.

Query

query BackendScreenEventIds {
  backendScreenEventIds
}

Response

{
  "data": {
    "backendScreenEventIds": ["abc123"]
  }
}

backendScreenIds

Type:[String]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all registered backend screen IDs.

Query

query BackendScreenIds {
  backendScreenIds
}

Response

{
  "data": {
    "backendScreenIds": ["abc123"]
  }
}

batteryDevice

Type:BatteryDeviceType

URL:https://api.oeus-kraken.energy/v1/graphql/

The currently active battery device.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

propertyId (Int!)

Query

query BatteryDevice(
  $accountNumber: String!,
  $propertyId: Int!
) {
  batteryDevice(
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    krakenflexDeviceId
    deviceType
    provider
    params {
      ...BatteryParamsTypeFragment
    }
    deviceStatus {
      ...DeviceStatusTypeFragment
    }
    chargingPreferences {
      ...BatteryChargingPreferencesTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "propertyId": 1
}

Response

{
  "data": {
    "batteryDevice": {
      "krakenflexDeviceId": "abc123",
      "deviceType": "BATTERIES",
      "provider": "BYD",
      "params": BatteryParamsType,
      "deviceStatus": DeviceStatusType,
      "chargingPreferences": BatteryChargingPreferencesType
    }
  }
}

Arguments

NameDescription

make (String)

Only return batteries of a specific make.

Query

query BatteryVariants($make: String) {
  batteryVariants(make: $make) {
    make
    models {
      ...BatteryVariantModelsTypeFragment
    }
  }
}

Variables

{
  "make": "abc123"
}

Response

{
  "data": {
    "batteryVariants": [
      {
        "make": "abc123",
        "models": [BatteryVariantModelsType]
      }
    ]
  }
}

business

Type:BusinessType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about a business.

The possible errors that can be raised are:

  • KT-CT-11101: The viewer is not authorized to execute the query/mutation. Check the ownership/permissions of provided data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

id (ID!)

The business ID.

Query

query Business($id: ID!) {
  business(id: $id) {
    name
    number
    businessType
    details {
      ...BusinessDetailTypeFragment
    }
    billingAddress {
      ...RichAddressTypeFragment
    }
    linkedAccountNumber
    linkedAccountNumbers
    segmentName
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "id": "abc123"
}

Response

{
  "data": {
    "business": {
      "name": "abc123",
      "number": "abc123",
      "businessType": "SOLE_TRADER",
      "details": [BusinessDetailType],
      "billingAddress": RichAddressType,
      "linkedAccountNumber": "abc123",
      "linkedAccountNumbers": "abc123",
      "segmentName": "abc123",
      "paymentMethods": PaymentInstructionConnectionTypeConnection
    }
  }
}

businessContract

Type:Contract

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about an account contract.

The possible errors that can be raised are:

  • KT-CT-10003: Contract not found.
  • KT-CT-10005: Missing required parameter: either identifier or accountNumber must be provided.
  • KT-CT-10006: Account not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

identifier (String)

The identifier of the contract.

accountNumber (String)

The account number to find the business contract for.

version (Int)

The version of the contract.

Query

query BusinessContract(
  $identifier: String,
  $accountNumber: String,
  $version: Int
) {
  businessContract(
    identifier: $identifier,
    accountNumber: $accountNumber,
    version: $version
  ) {
    identifier
    title
    party {
      ... on AccountType {
        ...AccountTypeFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    subject {
      ...AccountTypeFragment
    }
    status
    validFrom
    validTo
    signedAt
    cancelledAt
    lifecycle {
      ...ContractVersionFragment
    }
    terms {
      ...TermInterfaceFragment
    }
  }
}

Variables

{
  "identifier": "abc123",
  "accountNumber": "abc123",
  "version": 1
}

Response

{
  "data": {
    "businessContract": {
      "identifier": NonEmptyString,
      "title": "abc123",
      "party": AccountType,
      "subject": [AccountType],
      "status": "REVOKED",
      "validFrom": "2020-01-01T00:00:00.000Z",
      "validTo": "2020-01-01T00:00:00.000Z",
      "signedAt": "2020-01-01T00:00:00.000Z",
      "cancelledAt": "2020-01-01T00:00:00.000Z",
      "lifecycle": ContractVersion,
      "terms": TermInterface
    }
  }
}

call

Type:CallInterface!

URL:https://api.oeus-kraken.energy/v1/graphql/

Get a call for a given ID.

The possible errors that can be raised are:

  • KT-CT-11802: Call not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

id (ID!)

The call ID.

Query

query Call($id: ID!) {
  call(id: $id) {
    id
    account {
      ...AccountTypeFragment
    }
    metadata {
      ...CallMetadataItemTypeFragment
    }
  }
}

Variables

{
  "id": "abc123"
}

Response

{
  "data": {
    "call": {
      "id": "abc123",
      "account": AccountType,
      "metadata": CallMetadataItemType
    }
  }
}

Arguments

NameDescription

accountNumber (String!)

The account number.

before (String)

after (String)

first (Int)

last (Int)

Query

query Campaigns(
  $accountNumber: String!,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  campaigns(
    accountNumber: $accountNumber,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...AccountCampaignConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "abc123",
  "before": "abc123",
  "after": "abc123",
  "first": 1,
  "last": 1
}

Response

{
  "data": {
    "campaigns": {
      "pageInfo": PageInfo,
      "edges": AccountCampaignConnectionTypeEdge,
      "totalCount": 1,
      "edgeCount": 1
    }
  }
}

chargePointDevices

Type:[ChargePointDevicesType]

URL:https://api.oeus-kraken.energy/v1/graphql/

All charge point devices.

Deprecated

The 'chargePointDevices' field is deprecated.

Please use chargePointVariants instead of this query.

- Marked as deprecated on 2023-05-10.
- Scheduled for removal on or after 2024-01-01.

Query

query ChargePointDevices {
  chargePointDevices {
    make
    models {
      ...ChargePointModelsTypeFragment
    }
  }
}

Response

{
  "data": {
    "chargePointDevices": [
      {
        "make": "abc123",
        "models": [ChargePointModelsType]
      }
    ]
  }
}

Query

query ChargePointVariants {
  chargePointVariants {
    make
    models {
      ...ChargePointVariantModelTypeFragment
    }
  }
}

Response

{
  "data": {
    "chargePointVariants": [
      {
        "make": "abc123",
        "models": [ChargePointVariantModelType]
      }
    ]
  }
}

completedDispatches

Type:[UpsideDispatchType]

URL:https://api.oeus-kraken.energy/v1/graphql/

All completed device dispatches 12 hours behind, in reverse time order.

Arguments

NameDescription

accountNumber (String!)

Query

query CompletedDispatches($accountNumber: String!) {
  completedDispatches(accountNumber: $accountNumber) {
    start
    end
    startDt
    endDt
    deltaKwh
    delta
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "completedDispatches": [
      {
        "start": "2020-01-01T00:00:00.000Z",
        "end": "2020-01-01T00:00:00.000Z",
        "startDt": "abc123",
        "endDt": "abc123",
        "deltaKwh": 1,
        "delta": 1.0,
        "meta": UpsideDispatchMetaType
      }
    ]
  }
}

Query

query ContributionSchemes {
  contributionSchemes {
    id
    code
    displayName
    taxable
    acceptingContributions
  }
}

Response

{
  "data": {
    "contributionSchemes": [
      {
        "id": "abc123",
        "code": "abc123",
        "displayName": "abc123",
        "taxable": true,
        "acceptingContributions": true
      }
    ]
  }
}

costOfCharge

Type:[CostOfChargeType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Aggregated cost of charge for an EV device.

Deprecated

The 'costOfCharge' field is deprecated.

Use `cost` field on `SmartFlexChargingSession` instead.

- Marked as deprecated on 2025-05-13.
- Scheduled for removal on or after 2025-08-13.

Arguments

NameDescription

accountNumber (String!)

frequency (DataFrequency!)

Frequency by day, week, month or year.

reportDate (Date)

The date up to which data should be relative to.

startDate (Date)

The start date of the results required. Overrides report date (end date) if provided.

Query

query CostOfCharge(
  $accountNumber: String!,
  $frequency: DataFrequency!,
  $reportDate: Date,
  $startDate: Date
) {
  costOfCharge(
    accountNumber: $accountNumber,
    frequency: $frequency,
    reportDate: $reportDate,
    startDate: $startDate
  ) {
    costOfChargeId
    krakenflexDeviceId
    reportDate
    isSmartCharge
    totalConsumption
    totalCostExclTax
    totalCostInclTax
  }
}

Variables

{
  "accountNumber": "abc123",
  "frequency": "DAILY",
  "reportDate": "2020-01-01",
  "startDate": "2020-01-01"
}

Response

{
  "data": {
    "costOfCharge": [
      {
        "costOfChargeId": "abc123",
        "krakenflexDeviceId": "abc123",
        "reportDate": "2020-01-01",
        "isSmartCharge": true,
        "totalConsumption": 1.0,
        "totalCostExclTax": 1.0,
        "totalCostInclTax": 1.0
      }
    ]
  }
}

currentAndHistoricalProductPriceHistory

Type:[CurrentAndHistoricalProductPricingHistoryOutput]

URL:https://api.oeus-kraken.energy/v1/graphql/

    Get current and historical electricity products' price history for the given period.
    Note: period should be less than or equal to last thirteen months.

Arguments

NameDescription

filterBy (CurrentAndHistoricalProductPricingHistoryInput!)

Query

query CurrentAndHistoricalProductPriceHistory($filterBy: CurrentAndHistoricalProductPricingHistoryInput!) {
  currentAndHistoricalProductPriceHistory(filterBy: $filterBy) {
    fullName
    displayName
    priceHistory {
      ...PricingHistoryFragment
    }
  }
}

Response

{
  "data": {
    "currentAndHistoricalProductPriceHistory": [
      {
        "fullName": "abc123",
        "displayName": "abc123",
        "priceHistory": [PricingHistory]
      }
    ]
  }
}

Arguments

NameDescription

input (DailyReadingInput!)

Query

query DailyReadings($input: DailyReadingInput!) {
  dailyReadings(input: $input) {
    meterPointId
    readAt
    meterReading
    dailyUsage
    source
  }
}

Variables

{
  "input": DailyReadingInput
}

Response

{
  "data": {
    "dailyReadings": [
      {
        "meterPointId": 1,
        "readAt": "abc123",
        "meterReading": 1.0,
        "dailyUsage": 1.0,
        "source": "abc123"
      }
    ]
  }
}

dashboardScreen

Type:Dashboard

URL:https://api.oeus-kraken.energy/v1/graphql/

Get a dashboard screen to render in the form of a json list of sections containing cards or grouped cards each with an order attribute.

The possible errors that can be raised are:

  • KT-CT-3820: Received both ledger ID and number.
  • KT-CT-8001: No backend screen available.
  • KT-CT-8005: Backend screen does not support parameters.
  • KT-CT-8008: Incorrect or missing data necessary to build the screen.
  • KT-CT-8006: Error applying parameters to backend screen.
  • KT-CT-8009: Error translating screen content.
  • KT-CT-8010: Invalid step ID.
  • KT-CT-8011: Cannot rewind past a previous irreversible step.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

dashboardId (ID!)

The ID of the dashboard type screen to return.

accountNumber (String!)

The account number of the user.

maxVersionSupported (Int!)

The maximum version of dahshboard type screens supported by the client.

ledgerId (String)

The ledger id associated to the account.

ledgerNumber (String)

The ledger number associated to the account.

propertyId (String)

The property id associated to the account.

params ([BackendScreenParamInputType])

List of key-value pairs (strings) to pass as parameters to the screen.

Query

query DashboardScreen(
  $dashboardId: ID!,
  $accountNumber: String!,
  $maxVersionSupported: Int!,
  $ledgerId: String,
  $ledgerNumber: String,
  $propertyId: String,
  $params: [BackendScreenParamInputType]
) {
  dashboardScreen(
    dashboardId: $dashboardId,
    accountNumber: $accountNumber,
    maxVersionSupported: $maxVersionSupported,
    ledgerId: $ledgerId,
    ledgerNumber: $ledgerNumber,
    propertyId: $propertyId,
    params: $params
  ) {
    id
    typename
    dashboardItems {
      ...SectionTypeFragment
    }
    serialisedDashboardItems
  }
}

Variables

{
  "dashboardId": "abc123",
  "accountNumber": "abc123",
  "maxVersionSupported": 1,
  "ledgerId": "abc123",
  "ledgerNumber": "abc123",
  "propertyId": "abc123",
  "params": BackendScreenParamInputType
}

Response

{
  "data": {
    "dashboardScreen": {
      "id": "abc123",
      "typename": "abc123",
      "dashboardItems": SectionType,
      "serialisedDashboardItems": "abc123"
    }
  }
}

defaultPaymentInstruction

Type:PaymentInstructionType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the default payment instruction for the account's main ledger.

Arguments

NameDescription

accountNumber (String!)

The account number.

instructionType (PaymentType)

Provide an option to get either a CARD or DIRECT_DEBIT instruction.

Query

query DefaultPaymentInstruction(
  $accountNumber: String!,
  $instructionType: PaymentType
) {
  defaultPaymentInstruction(
    accountNumber: $accountNumber,
    instructionType: $instructionType
  ) {
    id
    status
    sortCode
    iban
    accountHolder
    instructionType
    cardPaymentNetwork
    cardExpiryMonth
    cardExpiryYear
    supplementaryLedger {
      ...SupplementaryLedgerTypeFragment
    }
    bankCode
    accountType
    validFrom
    vendor
    cardNumber
    cardType
    maskedAccountIdentifier
    owners {
      ...PaymentInstructionOwnerTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "instructionType": "BPAY"
}

Response

{
  "data": {
    "defaultPaymentInstruction": {
      "id": "abc123",
      "status": "abc123",
      "sortCode": "abc123",
      "iban": "abc123",
      "accountHolder": "abc123",
      "instructionType": "abc123",
      "cardPaymentNetwork": "abc123",
      "cardExpiryMonth": 1,
      "cardExpiryYear": 1,
      "supplementaryLedger": SupplementaryLedgerType,
      "bankCode": "abc123",
      "accountType": "abc123",
      "validFrom": "2020-01-01T00:00:00.000Z",
      "vendor": "abc123",
      "cardNumber": "abc123",
      "cardType": "abc123",
      "maskedAccountIdentifier": "abc123",
      "owners": [PaymentInstructionOwnerType]
    }
  }
}

defaultRawScore

Type:Int

URL:https://api.oeus-kraken.energy/v1/graphql/

Get default raw score for a customer feedback form.

The possible errors that can be raised are:

  • KT-CT-5513: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

formId (Int!)

Query

query DefaultRawScore($formId: Int!) {
  defaultRawScore(formId: $formId)
}

Variables

{
  "formId": 1
}

Response

{
  "data": {
    "defaultRawScore": 1
  }
}

devices

Type:[SmartFlexDeviceInterface!]

URL:https://api.oeus-kraken.energy/v1/graphql/

A list of devices registered to an account.

Arguments

NameDescription

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (ID)

Only list devices registered to this property.

deviceId (String)

Only list the device with this ID.

integrationDeviceId (String)

Only list the device with this integration device ID.

Query

query Devices(
  $accountNumber: String!,
  $propertyId: ID,
  $deviceId: String,
  $integrationDeviceId: String
) {
  devices(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    deviceId: $deviceId,
    integrationDeviceId: $integrationDeviceId
  ) {
    id
    name
    deviceType
    provider
    integrationDeviceId
    status {
      ...SmartFlexDeviceStatusInterfaceFragment
    }
    propertyId
    alerts {
      ...SmartFlexDeviceAlertInterfaceFragment
    }
    onboardingWizard {
      ...SmartFlexOnboardingWizardFragment
    }
    preferences {
      ...SmartFlexDevicePreferencesInterfaceFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "propertyId": "abc123",
  "deviceId": "abc123",
  "integrationDeviceId": "abc123"
}

Response

{
  "data": {
    "devices": [
      {
        "id": "abc123",
        "name": "abc123",
        "deviceType": "BATTERIES",
        "provider": "BYD",
        "integrationDeviceId": "abc123",
        "status": SmartFlexDeviceStatusInterface,
        "propertyId": "abc123",
        "alerts": SmartFlexDeviceAlertInterface,
        "onboardingWizard": SmartFlexOnboardingWizard,
        "preferences": SmartFlexDevicePreferencesInterface
      }
    ]
  }
}

domesticAccountReferralRewardScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Return a referral reward scheme for the given account referral code.

Arguments

NameDescription

code (String!)

Friend referral code.

Query

query DomesticAccountReferralRewardScheme($code: String!) {
  domesticAccountReferralRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Variables

{
  "code": "abc123"
}

Response

{
  "data": {
    "domesticAccountReferralRewardScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

domesticJoiningRewardScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Return a joining reward scheme with the given code, if it's active. A joining reward can be a signup reward or a promotional reward.

Arguments

NameDescription

code (String!)

Reward code for the scheme.

Query

query DomesticJoiningRewardScheme($code: String!) {
  domesticJoiningRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Variables

{
  "code": "abc123"
}

Response

{
  "data": {
    "domesticJoiningRewardScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

domesticSignupRewardScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Return a signup referral reward scheme with the given code, if it's active.

Arguments

NameDescription

code (String!)

Reward code for the scheme.

Query

query DomesticSignupRewardScheme($code: String!) {
  domesticSignupRewardScheme(code: $code) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Variables

{
  "code": "abc123"
}

Response

{
  "data": {
    "domesticSignupRewardScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

efls

Type:[EflType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all active Electricity Facts Label (EFLs).

By default, the query will return active EFLs for all service providers in both English (EN) and Spanish (ES) versions.

Query can be filtered by the given service provider, product id, and language.

Arguments

NameDescription

productId (ID)

Retrieve EFLs for the given product id.

serviceProvider (ServiceProvider)

Retrieve EFLs for the given service provider.

loadZone (LoadZone)

Retrieve EFLs applicable in the given load zone.

language (EFLLanguage)

Retrieve EFLs for the given language.

Query

query Efls(
  $productId: ID,
  $serviceProvider: ServiceProvider,
  $loadZone: LoadZone,
  $language: EFLLanguage
) {
  efls(
    productId: $productId,
    serviceProvider: $serviceProvider,
    loadZone: $loadZone,
    language: $language
  ) {
    id
    serviceProvider
    loadZone
    language
    version
    url
    productDisplayName
    productCode
  }
}

Variables

{
  "productId": "abc123",
  "serviceProvider": "AEP_TCC",
  "loadZone": "LZ_HOUSTON",
  "language": "EN"
}

Response

{
  "data": {
    "efls": [
      {
        "id": "abc123",
        "serviceProvider": "AEP_TCC",
        "loadZone": "LZ_HOUSTON",
        "language": "abc123",
        "version": "abc123",
        "url": "abc123",
        "productDisplayName": "abc123",
        "productCode": "abc123"
      }
    ]
  }
}

electricVehicles

Type:[ElectricVehicleType]

URL:https://api.oeus-kraken.energy/v1/graphql/

All electric vehicle types and their details.

Arguments

NameDescription

make (String)

Only return vehicle types for the specified make.

supportedProvider (ProviderChoices)

Only return vehicle types supported by the specified provider, e.g. Tesla.

isIntegrationLive (Boolean)

Only return vehicles that are currently integrated.

Query

query ElectricVehicles(
  $make: String,
  $supportedProvider: ProviderChoices,
  $isIntegrationLive: Boolean
) {
  electricVehicles(
    make: $make,
    supportedProvider: $supportedProvider,
    isIntegrationLive: $isIntegrationLive
  ) {
    make
    models {
      ...ElectricVehicleModelTypeFragment
    }
  }
}

Variables

{
  "make": "abc123",
  "supportedProvider": "BYD",
  "isIntegrationLive": true
}

Response

{
  "data": {
    "electricVehicles": [
      {
        "make": "abc123",
        "models": [ElectricVehicleModelType]
      }
    ]
  }
}

eligibleDeviceTypes

Type:[KrakenFlexDeviceTypes]

URL:https://api.oeus-kraken.energy/v1/graphql/

A list of device types that are eligible for registration.

Arguments

NameDescription

accountNumber (String!)

The account number, e.g. A-12345678.

Query

query EligibleDeviceTypes($accountNumber: String!) {
  eligibleDeviceTypes(accountNumber: $accountNumber)
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "eligibleDeviceTypes": "BATTERIES"
  }
}

Arguments

NameDescription

id (ID!)

Query

query EmbeddedNetwork($id: ID!) {
  embeddedNetwork(id: $id) {
    id
    name
    embeddedProperties {
      ...EmbeddedPropertyTypeFragment
    }
  }
}

Variables

{
  "id": "abc123"
}

Response

{
  "data": {
    "embeddedNetwork": {
      "id": "abc123",
      "name": "abc123",
      "embeddedProperties": [EmbeddedPropertyType]
    }
  }
}

Query

query EnergyMixData {
  energyMixData {
    carbonIntensityIndex
  }
}

Response

{
  "data": {
    "energyMixData": {
      "carbonIntensityIndex": "abc123"
    }
  }
}

enodeLinkSession

Type:EnodeLinkSessionType

URL:https://api.oeus-kraken.energy/v1/graphql/

The user specific Enode link session details.

The possible errors that can be raised are:

  • KT-CT-4328: Invalid data.
  • KT-CT-1111: Unauthorized.
  • KT-CT-4319: Unable to get Enode link session.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String)

vendor (EnodeVendors)

Query

query EnodeLinkSession(
  $accountNumber: String,
  $vendor: EnodeVendors
) {
  enodeLinkSession(
    accountNumber: $accountNumber,
    vendor: $vendor
  ) {
    linkState
    linkUrl
  }
}

Variables

{
  "accountNumber": "abc123",
  "vendor": "AUDI"
}

Response

{
  "data": {
    "enodeLinkSession": {
      "linkState": "abc123",
      "linkUrl": "abc123"
    }
  }
}

getAccountCreatedAt

Type:AccountCreatedAtOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

NameDescription

accountNumber (String!)

Query

query GetAccountCreatedAt($accountNumber: String!) {
  getAccountCreatedAt(accountNumber: $accountNumber) {
    createdAt
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "getAccountCreatedAt": {
      "createdAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

getAccountReferralScheme

Type:ReferralSchemeType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get active domestic referral scheme for the given account number.

Arguments

NameDescription

accountNumber (String!)

Query

query GetAccountReferralScheme($accountNumber: String!) {
  getAccountReferralScheme(accountNumber: $accountNumber) {
    referralUrl
    referralDisplayUrl
    referrerRewardAmount
    referredRewardAmount
    combinedRewardAmount
    loyaltyPointsBonus
    canBeReferred
    code
    referrerGivenName
    referrerFamilyName
    schemeType
    isUsageAtCapacity
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "getAccountReferralScheme": {
      "referralUrl": "abc123",
      "referralDisplayUrl": "abc123",
      "referrerRewardAmount": 1,
      "referredRewardAmount": 1,
      "combinedRewardAmount": 1,
      "loyaltyPointsBonus": 1,
      "canBeReferred": true,
      "code": "abc123",
      "referrerGivenName": "abc123",
      "referrerFamilyName": "abc123",
      "schemeType": "abc123",
      "isUsageAtCapacity": true
    }
  }
}

getAccountWithUrn

Type:AccountType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get an account using a urn.

The possible errors that can be raised are:

  • KT-US-4114: URN must be a non-empty string.
  • KT-CT-4120: Invalid urn.
  • KT-US-4115: Multiple objects returned.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

urn (String!)

Query

query GetAccountWithUrn($urn: String!) {
  getAccountWithUrn(urn: $urn) {
    id
    number
    status
    paymentSchedules {
      ...PaymentScheduleConnectionTypeConnectionFragment
    }
    users {
      ...AccountUserTypeFragment
    }
    consentData
    brand
    balance
    overdueBalance
    urn
    billingName
    billingSubName
    billingEmail
    billingAddress
    billingAddressLine1
    billingAddressLine2
    billingAddressLine3
    billingAddressLine4
    billingAddressLine5
    billingAddressPostcode
    billingCountryCode
    billingDeliveryPointIdentifier
    splitBillingAddress
    address {
      ...RichAddressTypeFragment
    }
    portfolio {
      ...PortfolioTypeFragment
    }
    ledgers {
      ...LedgerTypeFragment
    }
    metadata {
      ...MetadataFragment
    }
    canRequestRefund
    requestRefundEligibility {
      ...RequestRefundEligibilityTypeFragment
    }
    payments {
      ...AccountPaymentConnectionTypeConnectionFragment
    }
    repayments {
      ...AccountRepaymentConnectionTypeConnectionFragment
    }
    paymentPlans {
      ...PaymentPlanConnectionTypeConnectionFragment
    }
    paymentForecast {
      ...PaymentForecastTypeFragment
    }
    paginatedPaymentForecast {
      ...PaymentForecastConnectionTypeConnectionFragment
    }
    referrals {
      ...ReferralConnectionTypeConnectionFragment
    }
    referralsCreated
    rewards {
      ...RewardTypeFragment
    }
    activeReferralSchemes {
      ...ReferralSchemeTypesFragment
    }
    transactions {
      ...TransactionConnectionTypeConnectionFragment
    }
    provisionalTransactions {
      ...ProvisionalTransactionConnectionTypeConnectionFragment
    }
    annualStatements {
      ...AnnualStatementConnectionTypeConnectionFragment
    }
    bills {
      ...BillConnectionTypeConnectionFragment
    }
    billingOptions {
      ...BillingOptionsTypeFragment
    }
    bill {
      ...BillInterfaceFragment
    }
    directDebitInstructions {
      ...DirectDebitInstructionConnectionTypeConnectionFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    events {
      ...AccountEventConnectionTypeConnectionFragment
    }
    applications {
      ...AccountApplicationConnectionTypeConnectionFragment
    }
    accountType
    businessType
    business {
      ...BusinessTypeFragment
    }
    commsDeliveryPreference
    communicationDeliveryPreference
    documentAccessibility
    references {
      ...AccountReferenceTypeFragment
    }
    fileAttachments {
      ...AccountFileAttachmentFragment
    }
    paginatedFileAttachments {
      ...AccountFileAttachmentConnectionTypeConnectionFragment
    }
    maximumRefund {
      ...MaximumRefundTypeFragment
    }
    campaigns {
      ...AccountCampaignTypeFragment
    }
    isInHardship
    activeHardshipAgreements {
      ...HardshipAgreementTypeFragment
    }
    notes {
      ...AccountNoteTypeFragment
    }
    contributionAgreements {
      ...ContributionAgreementTypeFragment
    }
    assistanceAgreements {
      ...AssistanceAgreementTypeFragment
    }
    debtCollectionProceedings {
      ...DebtCollectionProceedingTypeFragment
    }
    createdAt
    preferredLanguageForComms
    consents {
      ...ConsentTypeFragment
    }
    properties {
      ...PropertyTypeFragment
    }
    meterPointStatus
    isShellAccount
    isEligibleForIntelligentOctopus
    agreements {
      ...AgreementTypeFragment
    }
    isOnSupply
  }
}

Variables

{
  "urn": "abc123"
}

Response

{
  "data": {
    "getAccountWithUrn": {
      "id": "abc123",
      "number": "abc123",
      "status": "PENDING",
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "users": AccountUserType,
      "consentData": {"key": "value"},
      "brand": "abc123",
      "balance": 1,
      "overdueBalance": 1,
      "urn": "abc123",
      "billingName": "abc123",
      "billingSubName": "abc123",
      "billingEmail": "abc123",
      "billingAddress": "abc123",
      "billingAddressLine1": "abc123",
      "billingAddressLine2": "abc123",
      "billingAddressLine3": "abc123",
      "billingAddressLine4": "abc123",
      "billingAddressLine5": "abc123",
      "billingAddressPostcode": "abc123",
      "billingCountryCode": "abc123",
      "billingDeliveryPointIdentifier": "abc123",
      "splitBillingAddress": ["abc123"],
      "address": RichAddressType,
      "portfolio": PortfolioType,
      "ledgers": [LedgerType],
      "metadata": [Metadata],
      "canRequestRefund": true,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "payments": AccountPaymentConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentForecast": [PaymentForecastType],
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 1,
      "rewards": [RewardType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "transactions": TransactionConnectionTypeConnection,
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "bills": BillConnectionTypeConnection,
      "billingOptions": BillingOptionsType,
      "bill": BillInterface,
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "events": AccountEventConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "accountType": "BUSINESS",
      "businessType": "SOLE_TRADER",
      "business": BusinessType,
      "commsDeliveryPreference": "EMAIL",
      "communicationDeliveryPreference": "abc123",
      "documentAccessibility": "LARGE_PRINT",
      "references": [AccountReferenceType],
      "fileAttachments": [AccountFileAttachment],
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "maximumRefund": MaximumRefundType,
      "campaigns": [AccountCampaignType],
      "isInHardship": true,
      "activeHardshipAgreements": [HardshipAgreementType],
      "notes": [AccountNoteType],
      "contributionAgreements": [ContributionAgreementType],
      "assistanceAgreements": [AssistanceAgreementType],
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "createdAt": "2020-01-01T00:00:00.000Z",
      "preferredLanguageForComms": "abc123",
      "consents": ConsentType,
      "properties": [PropertyType],
      "meterPointStatus": "abc123",
      "isShellAccount": true,
      "isEligibleForIntelligentOctopus": true,
      "agreements": [AgreementType],
      "isOnSupply": true
    }
  }
}

getAllRealTimeLmpData

Type:[ErcotMarketData]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get Real-Time LMPs for Load Zones and Trading Hubs.

Query

query GetAllRealTimeLmpData {
  getAllRealTimeLmpData {
    SettlementPoint
    LMP
    LMP5MinuteDifference
    RtorpaRtordpaLmp
    RtorpaRtordpaLmp5MinDifference
    lastUpdatedAt
    lastUpdatedAtDatetime
  }
}

Response

{
  "data": {
    "getAllRealTimeLmpData": [
      {
        "SettlementPoint": "HB_BUSAVG",
        "LMP": 1.0,
        "LMP5MinuteDifference": 1.0,
        "RtorpaRtordpaLmp": 1.0,
        "RtorpaRtordpaLmp5MinDifference": 1.0,
        "lastUpdatedAt": CustomGrapheneDateTime,
        "lastUpdatedAtDatetime": "2020-01-01T00:00:00.000Z"
      }
    ]
  }
}

getFanClubDiscount

Type:FanClubDiscountOutput

URL:https://api.oeus-kraken.energy/v1/graphql/

Get whether the percentage of wind power on the grid is sufficient for an energy discount to apply.

Query

query GetFanClubDiscount {
  getFanClubDiscount {
    windGenerationPercentage
    discountAmount
  }
}

Response

{
  "data": {
    "getFanClubDiscount": {
      "windGenerationPercentage": 1.0,
      "discountAmount": 1.0
    }
  }
}

getFanClubWindPowerProjections

Type:FanClubWindPowerProjections

URL:https://api.oeus-kraken.energy/v1/graphql/

Future wind power projections recieved from ERCOT. Updates every four hours.

The possible errors that can be raised are:

  • KT-US-4518: Cannot query projections with given input.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

hoursIntoFuture (Int)

Returns predictions for this many hours into the future. Defaults to 48 yeidling two days.

Query

query GetFanClubWindPowerProjections($hoursIntoFuture: Int) {
  getFanClubWindPowerProjections(hoursIntoFuture: $hoursIntoFuture) {
    windPowerProjections {
      ...WindPowerProjectionFragment
    }
  }
}

Variables

{
  "hoursIntoFuture": 1
}

Response

{
  "data": {
    "getFanClubWindPowerProjections": {
      "windPowerProjections": [WindPowerProjection]
    }
  }
}

getLmpValue

Type:[ErcotMarketData]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get Real-Time LMPs for Load Zones based on the given LMP value and sort option.

Arguments

NameDescription

value (Float)

sort (SortByOptions)

Query

query GetLmpValue(
  $value: Float,
  $sort: SortByOptions
) {
  getLmpValue(
    value: $value,
    sort: $sort
  ) {
    SettlementPoint
    LMP
    LMP5MinuteDifference
    RtorpaRtordpaLmp
    RtorpaRtordpaLmp5MinDifference
    lastUpdatedAt
    lastUpdatedAtDatetime
  }
}

Variables

{
  "value": 1.0,
  "sort": "GREATER_THAN"
}

Response

{
  "data": {
    "getLmpValue": [
      {
        "SettlementPoint": "HB_BUSAVG",
        "LMP": 1.0,
        "LMP5MinuteDifference": 1.0,
        "RtorpaRtordpaLmp": 1.0,
        "RtorpaRtordpaLmp5MinDifference": 1.0,
        "lastUpdatedAt": CustomGrapheneDateTime,
        "lastUpdatedAtDatetime": "2020-01-01T00:00:00.000Z"
      }
    ]
  }
}

getQuote

Type:GetQuoteOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns a quote request including all quoted products.

The possible errors that can be raised are:

  • KT-CT-4619: Quote with given code not found.
  • KT-CT-4620: Badly formed hexadecimal UUID string.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

code (String!)

The selected quote's UUID code.

Query

query GetQuote($code: String!) {
  getQuote(code: $code) {
    quoteId
    code
    quotedProducts {
      ...QuotedProductsFragment
    }
    isExpired
  }
}

Variables

{
  "code": "abc123"
}

Response

{
  "data": {
    "getQuote": {
      "quoteId": "abc123",
      "code": "abc123",
      "quotedProducts": [QuotedProducts],
      "isExpired": true
    }
  }
}

getReferralCodeStatus

Type:ReferralCodeStatusType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the status of a referral code.

The possible errors that can be raised are:

  • KT-CT-6724: Referral claim code not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

code (String!)

The referral code to check.

Query

query GetReferralCodeStatus($code: String!) {
  getReferralCodeStatus(code: $code) {
    isValid
    description
    descriptionInSpanish
    maxRecurrence
    codeType
  }
}

Variables

{
  "code": "abc123"
}

Response

{
  "data": {
    "getReferralCodeStatus": {
      "isValid": true,
      "description": "abc123",
      "descriptionInSpanish": "abc123",
      "maxRecurrence": "abc123",
      "codeType": "REFERRAL_CODE"
    }
  }
}

getReferralCompetitionStats

Type:[ReferralCompetitionStats]

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns the referral competition stats.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

Query

query GetReferralCompetitionStats($accountNumber: String!) {
  getReferralCompetitionStats(accountNumber: $accountNumber) {
    referralCode
    numOfReferrals
    numOfPersonalConnectedDevices
    numOfReferredConnectedDevices
    numOfEntries
    rank
    customIdentifier
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "getReferralCompetitionStats": [
      {
        "referralCode": "abc123",
        "numOfReferrals": 1,
        "numOfPersonalConnectedDevices": 1,
        "numOfReferredConnectedDevices": 1,
        "numOfEntries": 1,
        "rank": 1,
        "customIdentifier": "abc123"
      }
    ]
  }
}

getSettlementPoint

Type:ErcotMarketData

URL:https://api.oeus-kraken.energy/v1/graphql/

Get Real-Time LMPs for Load Zones based on the given settlement point.

Arguments

NameDescription

settlementPoint (SettlementPointOptions!)

Returns pricing for the given settlement point.

Query

query GetSettlementPoint($settlementPoint: SettlementPointOptions!) {
  getSettlementPoint(settlementPoint: $settlementPoint) {
    SettlementPoint
    LMP
    LMP5MinuteDifference
    RtorpaRtordpaLmp
    RtorpaRtordpaLmp5MinDifference
    lastUpdatedAt
    lastUpdatedAtDatetime
  }
}

Variables

{
  "settlementPoint": "HB_BUSAVG"
}

Response

{
  "data": {
    "getSettlementPoint": {
      "SettlementPoint": "HB_BUSAVG",
      "LMP": 1.0,
      "LMP5MinuteDifference": 1.0,
      "RtorpaRtordpaLmp": 1.0,
      "RtorpaRtordpaLmp5MinDifference": 1.0,
      "lastUpdatedAt": CustomGrapheneDateTime,
      "lastUpdatedAtDatetime": "2020-01-01T00:00:00.000Z"
    }
  }
}

getSolarContestStats

Type:SolarContestStats

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns stats for the top solar exporters along with the given account's export data. The results are ranked from the highest to lowest exporters.

The possible errors that can be raised are:

  • KT-CT-4177: Unauthorized.
  • KT-US-9101: No solar stats found.
  • KT-US-9102: Unable to find solar contest stats for the given account.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

The account number to calculate stats for.

Query

query GetSolarContestStats($accountNumber: String!) {
  getSolarContestStats(accountNumber: $accountNumber) {
    statsFetchedAt
    solarContestStats {
      ...SolarContestStatFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "getSolarContestStats": {
      "statsFetchedAt": "2020-01-01T00:00:00.000Z",
      "solarContestStats": [SolarContestStat]
    }
  }
}

getSolarForecastedData

Type:AllSolarForecastedData

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns solar forecasted data.

The possible errors that can be raised are:

  • KT-US-9103: Unable to find solar forecasted data.
  • KT-CT-1113: Disabled GraphQL field requested.

Query

query GetSolarForecastedData {
  getSolarForecastedData {
    solarForecastedData {
      ...SolarForecastedDataFragment
    }
    lastUpdatedAt
  }
}

Response

{
  "data": {
    "getSolarForecastedData": {
      "solarForecastedData": [SolarForecastedData],
      "lastUpdatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

getSystemWideDayAheadPrices

Type:AllSystemWidePriceData

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns the system wide day ahead prices.

The possible errors that can be raised are:

  • KT-US-9104: Unable to get system wide day ahead forecasted prices.
  • KT-CT-1113: Disabled GraphQL field requested.

Query

query GetSystemWideDayAheadPrices {
  getSystemWideDayAheadPrices {
    systemWidePriceData {
      ...SystemWidePriceFragment
    }
    lastUpdatedAt
  }
}

Response

{
  "data": {
    "getSystemWideDayAheadPrices": {
      "systemWidePriceData": [SystemWidePrice],
      "lastUpdatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

getThermostatDetails

Type:GetThermostatDetailsOutput

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-7223: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'getThermostatDetails' field is deprecated.

Please use 'devices' query with `... on SmartFlexThermostatStatus` instead.

- Marked as deprecated on 2024-10-08.
- Scheduled for removal on or after 2025-02-01.

Arguments

NameDescription

accountNumber (String!)

Query

query GetThermostatDetails($accountNumber: String!) {
  getThermostatDetails(accountNumber: $accountNumber) {
    thermostats {
      ...GetThermostatDetailsTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "getThermostatDetails": {
      "thermostats": [GetThermostatDetailsType]
    }
  }
}

Arguments

NameDescription

marketName (String!)

Market name of the products to list.

productType ([String])

Types of the products to filter by.

code ([String])

Code of the products to filter by.

before (String)

after (String)

first (Int)

last (Int)

Query

query GoodsProducts(
  $marketName: String!,
  $productType: [String],
  $code: [String],
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  goodsProducts(
    marketName: $marketName,
    productType: $productType,
    code: $code,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...GoodsProductConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "marketName": "abc123",
  "productType": ["abc123"],
  "code": ["abc123"],
  "before": "abc123",
  "after": "abc123",
  "first": 1,
  "last": 1
}

Response

{
  "data": {
    "goodsProducts": {
      "pageInfo": PageInfo,
      "edges": GoodsProductConnectionTypeEdge,
      "totalCount": 1,
      "edgeCount": 1
    }
  }
}

Arguments

NameDescription

accountNumber (String!)

The account number.

Query

query GoodsPurchases($accountNumber: String!) {
  goodsPurchases(accountNumber: $accountNumber) {
    code
    ledgerId
    ledgerNumber
    goodsSaleItems {
      ...GoodsSaleItemFragment
    }
    goodsGrants {
      ...GoodsGrantFragment
    }
    marketName
    marketParams
    clientParams
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "goodsPurchases": [
      {
        "code": "abc123",
        "ledgerId": "abc123",
        "ledgerNumber": "abc123",
        "goodsSaleItems": [GoodsSaleItem],
        "goodsGrants": [GoodsGrant],
        "marketName": "abc123",
        "marketParams": {"key": "value"},
        "clientParams": {"key": "value"}
      }
    ]
  }
}

goodsQuotes

Type:[GoodsQuote]

URL:https://api.oeus-kraken.energy/v1/graphql/

List quotes given an account number or retrieve a Goods quote given a quote code.

Arguments

NameDescription

accountNumber (String)

The account number.

quoteCode (String)

The quote code.

Query

query GoodsQuotes(
  $accountNumber: String,
  $quoteCode: String
) {
  goodsQuotes(
    accountNumber: $accountNumber,
    quoteCode: $quoteCode
  ) {
    id
    code
    totalNetAmount
    quotedAt
    goodsQuotedProducts {
      ...GoodsQuotedProductFragment
    }
    hasQuoteExpired
  }
}

Variables

{
  "accountNumber": "abc123",
  "quoteCode": "abc123"
}

Response

{
  "data": {
    "goodsQuotes": [
      {
        "id": "abc123",
        "code": "abc123",
        "totalNetAmount": 1,
        "quotedAt": "2020-01-01T00:00:00.000Z",
        "goodsQuotedProducts": [GoodsQuotedProduct],
        "hasQuoteExpired": true
      }
    ]
  }
}

inkConversation

Type:InkConversation!

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the Ink conversation for a given account.

The possible errors that can be raised are:

  • KT-CT-7612: The Ink conversation was not found.
  • KT-CT-4177: Unauthorized.
  • KT-CT-7610: No Ink conversation for account.
  • KT-CT-7617: Must supply account number or relay id to get a conversation.
  • KT-CT-7638: Invalid conversation ID.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String)

The account number.

conversationRelayId (String)

The conversation's relay id.

Query

query InkConversation(
  $accountNumber: String,
  $conversationRelayId: String
) {
  inkConversation(
    accountNumber: $accountNumber,
    conversationRelayId: $conversationRelayId
  ) {
    id
    status
    contactChannelIdentities {
      ...InkContactChannelIdentitiesFragment
    }
    accountUsers {
      ...AccountUserTypeFragment
    }
    events {
      ...InkConversationEventsConnectionFragment
    }
    buckets {
      ...InkBucketFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "conversationRelayId": "abc123"
}

Response

{
  "data": {
    "inkConversation": {
      "id": "abc123",
      "status": "OPEN",
      "contactChannelIdentities": InkContactChannelIdentities,
      "accountUsers": [AccountUserType],
      "events": InkConversationEventsConnection,
      "buckets": [InkBucket]
    }
  }
}

inkMessage

Type:InkMessage!

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the content for a given message.

The possible errors that can be raised are:

  • KT-CT-7611: The message was not found.
  • KT-CT-7638: Invalid conversation ID.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

messageRelayId (String!)

The message's relay id.

Query

query InkMessage($messageRelayId: String!) {
  inkMessage(messageRelayId: $messageRelayId) {
    ... on InkEmail {
      ...InkEmailFragment
    }
    ... on InkSMS {
      ...InkSMSFragment
    }
    ... on InkLine {
      ...InkLineFragment
    }
    ... on InkWhatsApp {
      ...InkWhatsAppFragment
    }
    ... on InkTwilioWhatsApp {
      ...InkTwilioWhatsAppFragment
    }
    ... on InkPost {
      ...InkPostFragment
    }
    ... on InkGenericMessage {
      ...InkGenericMessageFragment
    }
  }
}

Variables

{
  "messageRelayId": "abc123"
}

Response

{
  "data": {
    "inkMessage": InkEmail
  }
}

intervalReadings

Type:[IntervalReadingOutput]

URL:https://api.oeus-kraken.energy/v1/graphql/

15 minute interval readings for a meter point.

Arguments

NameDescription

input (IntervalReadingInput!)

Query

query IntervalReadings($input: IntervalReadingInput!) {
  intervalReadings(input: $input) {
    meterPointId
    fromDatetime
    toDatetime
    consumption
    price
  }
}

Variables

Response

{
  "data": {
    "intervalReadings": [
      {
        "meterPointId": 1,
        "fromDatetime": "2020-01-01T00:00:00.000Z",
        "toDatetime": "2020-01-01T00:00:00.000Z",
        "consumption": 1.0,
        "price": 1.0
      }
    ]
  }
}

isAutopayEnabled

Type:AutoPayOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns whether autopay is enabled for the given account.

Arguments

NameDescription

accountNumber (String!)

considerFutureSchedule (Boolean)

Consider future schedules that are not yet active.

Query

query IsAutopayEnabled(
  $accountNumber: String!,
  $considerFutureSchedule: Boolean
) {
  isAutopayEnabled(
    accountNumber: $accountNumber,
    considerFutureSchedule: $considerFutureSchedule
  ) {
    isEnabled
  }
}

Variables

{
  "accountNumber": "abc123",
  "considerFutureSchedule": true
}

Response

{
  "data": {
    "isAutopayEnabled": {
      "isEnabled": true
    }
  }
}

isPasswordResetTokenValid

Type:Boolean

URL:https://api.oeus-kraken.energy/v1/graphql/

Check validity of a password reset token.

Arguments

NameDescription

userId (String!)

Base64 encoded user id.

token (String!)

Password reset token to check.

Query

query IsPasswordResetTokenValid(
  $userId: String!,
  $token: String!
) {
  isPasswordResetTokenValid(
    userId: $userId,
    token: $token
  )
}

Variables

{
  "userId": "abc123",
  "token": "abc123"
}

Response

{
  "data": {
    "isPasswordResetTokenValid": true
  }
}

isPostCodeQuotable

Type:IsQuotableOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

Returns whether a post code is quotable and has multiple TDSPs or load zones.

Arguments

NameDescription

postcode (String!)

The post code to check.

Query

query IsPostCodeQuotable($postcode: String!) {
  isPostCodeQuotable(postcode: $postcode) {
    isQuotable
    hasMultipleTdspsOrLoadZones
  }
}

Variables

{
  "postcode": "abc123"
}

Response

{
  "data": {
    "isPostCodeQuotable": {
      "isQuotable": true,
      "hasMultipleTdspsOrLoadZones": true
    }
  }
}

Arguments

NameDescription

subdomain (String!)

Subdomain to check.

Query

query IsValidSubdomain($subdomain: String!) {
  isValidSubdomain(subdomain: $subdomain) {
    isValid
  }
}

Variables

{
  "subdomain": "abc123"
}

Response

{
  "data": {
    "isValidSubdomain": {
      "isValid": true
    }
  }
}

Query

query KrakenVersion {
  krakenVersion {
    number
    SHA
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "number": "abc123",
      "SHA": "abc123"
    }
  }
}

languagePreference

Type:LanguagePreferenceChoices

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

NameDescription

accountNumber (String!)

Query

query LanguagePreference($accountNumber: String!) {
  languagePreference(accountNumber: $accountNumber)
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "languagePreference": "ENGLISH"
  }
}

latestMoveOutDate

Type:LatestMoveOutDateOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

For on-supply accounts, return the latest requested MVO (Move out) date, or return None if there are no MVO events scheduled for the account.

The possible errors that can be raised are:

  • KT-CT-6623: Unauthorized.
  • KT-CT-4922: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

Query

query LatestMoveOutDate($accountNumber: String!) {
  latestMoveOutDate(accountNumber: $accountNumber) {
    latestMoveOutDate
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "latestMoveOutDate": {
      "latestMoveOutDate": "2020-01-01T00:00:00.000Z"
    }
  }
}

leaveSupplierProcess

Type:LeaveSupplierProcessType

URL:https://api.oeus-kraken.energy/v1/graphql/

Details associated with a LeaveSupplier process.

The possible errors that can be raised are:

  • KT-CT-10302: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

leaveSupplierProcessId (ID!)

The leave supplier process ID.

Query

query LeaveSupplierProcess($leaveSupplierProcessId: ID!) {
  leaveSupplierProcess(leaveSupplierProcessId: $leaveSupplierProcessId) {
    id
    status
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "leaveSupplierProcessId": "abc123"
}

Response

{
  "data": {
    "leaveSupplierProcess": {
      "id": "abc123",
      "status": "PENDING",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

legalDocuments

Type:LegalDocumentsOutput

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

NameDescription

language (LegalDocumentLanguageOption!)

Query

query LegalDocuments($language: LegalDocumentLanguageOption!) {
  legalDocuments(language: $language) {
    prepaidDisclosureStatement {
      ...LinkFragment
    }
    termsOfService {
      ...LinkFragment
    }
    termsOfUse {
      ...LinkFragment
    }
    yourRightsAsACustomer {
      ...LinkFragment
    }
  }
}

Variables

{
  "language": "ENGLISH"
}

Response

{
  "data": {
    "legalDocuments": {
      "prepaidDisclosureStatement": Link,
      "termsOfService": Link,
      "termsOfUse": Link,
      "yourRightsAsACustomer": Link
    }
  }
}

lifecycleProcesses

Type:LifecycleProcessesType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all lifecycle processes associated with an account.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

onlyActive (Boolean)

A flag to filter out only active/current processes.

sortOrder (LifecycleProcessesSortOrder)

The chronological order in which the lifecycle processes are sorted.

accountNumber (String!)

The account number, e.g. A-12345678.

Query

query LifecycleProcesses(
  $onlyActive: Boolean,
  $sortOrder: LifecycleProcessesSortOrder,
  $accountNumber: String!
) {
  lifecycleProcesses(
    onlyActive: $onlyActive,
    sortOrder: $sortOrder,
    accountNumber: $accountNumber
  ) {
    leaveSupplierProcesses {
      ...LeaveSupplierProcessConnectionTypeConnectionFragment
    }
    joinSupplierProcesses {
      ...JoinSupplierProcessConnectionTypeConnectionFragment
    }
    occupyPropertyProcesses {
      ...OccupyPropertyProcessConnectionTypeConnectionFragment
    }
    leavePropertyProcesses {
      ...LeavePropertyProcessConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "onlyActive": true,
  "sortOrder": "ASC",
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "lifecycleProcesses": {
      "leaveSupplierProcesses": LeaveSupplierProcessConnectionTypeConnection,
      "joinSupplierProcesses": JoinSupplierProcessConnectionTypeConnection,
      "occupyPropertyProcesses": OccupyPropertyProcessConnectionTypeConnection,
      "leavePropertyProcesses": LeavePropertyProcessConnectionTypeConnection
    }
  }
}

livePaymentAdequacyCalculation

Type:LivePaymentAdequacyCalculation

URL:https://api.oeus-kraken.energy/v1/graphql/

Get payment adequacy data with an up to date calculation.

The possible errors that can be raised are:

  • KT-CT-3963: Could not calculate live PA data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

ledgerNumber (String!)

Kraken ledger number.

Query

query LivePaymentAdequacyCalculation($ledgerNumber: String!) {
  livePaymentAdequacyCalculation(ledgerNumber: $ledgerNumber) {
    suggestedNewMonthlyAmount
    consumption {
      ...ConsumptionBreakdownConnectionTypeConnectionFragment
    }
    averageMonthlyCharge
    existingMonthlyAmount
    balanceAdjustment
    currentBalance
    targetBalance
    reviewedOn
  }
}

Variables

{
  "ledgerNumber": "abc123"
}

Response

{
  "data": {
    "livePaymentAdequacyCalculation": {
      "suggestedNewMonthlyAmount": 1,
      "consumption": ConsumptionBreakdownConnectionTypeConnection,
      "averageMonthlyCharge": 1,
      "existingMonthlyAmount": 1,
      "balanceAdjustment": 1,
      "currentBalance": 1,
      "targetBalance": 1,
      "reviewedOn": "2020-01-01"
    }
  }
}

loyaltyPointLedgers

Type:[LoyaltyPointLedgerEntryType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the Loyalty Point ledger entries for the passed user.

Query

query LoyaltyPointLedgers {
  loyaltyPointLedgers {
    id
    ledgerType
    value
    balanceBroughtForward
    balanceCarriedForward
    reasonCode
    postedAt
    accountNumber
  }
}

Response

{
  "data": {
    "loyaltyPointLedgers": [
      {
        "id": "abc123",
        "ledgerType": "abc123",
        "value": "abc123",
        "balanceBroughtForward": "abc123",
        "balanceCarriedForward": "abc123",
        "reasonCode": "abc123",
        "postedAt": "2020-01-01T00:00:00.000Z",
        "accountNumber": "abc123"
      }
    ]
  }
}

loyaltyPointsBalance

Type:AccountLoyaltyPointsType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the loyalty points balance for an account.

The possible errors that can be raised are:

  • KT-CT-9218: Unauthorized.
  • KT-CT-9217: Unauthorized.
  • KT-CT-9215: Loyalty points balance query disabled.
  • KT-CT-9216: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

The account number.

Query

query LoyaltyPointsBalance($accountNumber: String!) {
  loyaltyPointsBalance(accountNumber: $accountNumber) {
    loyaltyPoints
    totalMonetaryAmount
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "loyaltyPointsBalance": {
      "loyaltyPoints": 1,
      "totalMonetaryAmount": 1
    }
  }
}

Arguments

NameDescription

linkedObjectType (LinkedObjectType)

identifier (String!)

Query

query Metadata(
  $linkedObjectType: LinkedObjectType,
  $identifier: String!
) {
  metadata(
    linkedObjectType: $linkedObjectType,
    identifier: $identifier
  ) {
    key
    value
  }
}

Variables

{
  "linkedObjectType": "ACCOUNT",
  "identifier": "abc123"
}

Response

{
  "data": {
    "metadata": [
      {
        "key": "abc123",
        "value": {"key": "value"}
      }
    ]
  }
}

metadataForKey

Type:Metadata

URL:https://api.oeus-kraken.energy/v1/graphql/

Metadata for a linked object with key.

The possible errors that can be raised are:

  • KT-CT-4123: Unauthorized.
  • KT-CT-4124: Unauthorized.
  • KT-CT-8411: Invalid data.
  • KT-CT-4179: No metadata found with given key.
  • KT-CT-4155: Invalid data.
  • KT-CT-4177: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

linkedObjectType (LinkedObjectType)

identifier (String!)

key (String!)

Query

query MetadataForKey(
  $linkedObjectType: LinkedObjectType,
  $identifier: String!,
  $key: String!
) {
  metadataForKey(
    linkedObjectType: $linkedObjectType,
    identifier: $identifier,
    key: $key
  ) {
    key
    value
  }
}

Variables

{
  "linkedObjectType": "ACCOUNT",
  "identifier": "abc123",
  "key": "abc123"
}

Response

{
  "data": {
    "metadataForKey": {
      "key": "abc123",
      "value": {"key": "value"}
    }
  }
}

Arguments

NameDescription

id (ID!)

The ID of the object

Query

query Node($id: ID!) {
  node(id: $id) {
    id
  }
}

Variables

{
  "id": "abc123"
}

Response

{
  "data": {
    "node": {
      "id": "abc123"
    }
  }
}

ocppConnection

Type:OCPPConnectionType

URL:https://api.oeus-kraken.energy/v1/graphql/

To confirm whether a device is connected to OCPP.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4311: Unable to confirm OCPP connection.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

Query

query OcppConnection($accountNumber: String!) {
  ocppConnection(accountNumber: $accountNumber) {
    isConnected
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "ocppConnection": {
      "isConnected": true
    }
  }
}

ocppDetails

Type:OCPPDetailsType

URL:https://api.oeus-kraken.energy/v1/graphql/

The user specific generated OCPP details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

accountNumber (String!)

Query

query OcppDetails($accountNumber: String!) {
  ocppDetails(accountNumber: $accountNumber) {
    url
    username
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "ocppDetails": {
      "url": "abc123",
      "username": "abc123"
    }
  }
}

opportunityValueByKey

Type:String

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-8903: Unable to update opportunity.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

opportunityId (ID)

The identifier of the opportunity to query.

key (String)

The key the a funnel-specific value you wish to obtain.

Query

query OpportunityValueByKey(
  $opportunityId: ID,
  $key: String
) {
  opportunityValueByKey(
    opportunityId: $opportunityId,
    key: $key
  )
}

Variables

{
  "opportunityId": "abc123",
  "key": "abc123"
}

Response

{
  "data": {
    "opportunityValueByKey": "abc123"
  }
}

passwordValidatorHelpTexts

Type:[String]

URL:https://api.oeus-kraken.energy/v1/graphql/

The help text of all configured password validators as plain-text or html. Defaults to plain-text.

Arguments

NameDescription

asHtml (Boolean)

Return the results as html instead of plain-text. Defaults to False.

Query

query PasswordValidatorHelpTexts($asHtml: Boolean) {
  passwordValidatorHelpTexts(asHtml: $asHtml)
}

Variables

{
  "asHtml": true
}

Response

{
  "data": {
    "passwordValidatorHelpTexts": ["abc123"]
  }
}

paymentRequests

Type:PaymentRequestsType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all payment requests for the given ledger.

Arguments

NameDescription

ledgerNumber (String!)

Kraken ledger number.

Query

query PaymentRequests($ledgerNumber: String!) {
  paymentRequests(ledgerNumber: $ledgerNumber) {
    paymentRequest {
      ...PaymentRequestConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "ledgerNumber": "abc123"
}

Response

{
  "data": {
    "paymentRequests": {
      "paymentRequest": PaymentRequestConnectionTypeConnection
    }
  }
}

plannedDispatches

Type:[UpsideDispatchType]

URL:https://api.oeus-kraken.energy/v1/graphql/

All planned device dispatches 24 hours ahead, (usually) in time order.

Arguments

NameDescription

accountNumber (String!)

Query

query PlannedDispatches($accountNumber: String!) {
  plannedDispatches(accountNumber: $accountNumber) {
    start
    end
    startDt
    endDt
    deltaKwh
    delta
    meta {
      ...UpsideDispatchMetaTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "plannedDispatches": [
      {
        "start": "2020-01-01T00:00:00.000Z",
        "end": "2020-01-01T00:00:00.000Z",
        "startDt": "abc123",
        "endDt": "abc123",
        "deltaKwh": 1,
        "delta": 1.0,
        "meta": UpsideDispatchMetaType
      }
    ]
  }
}

portfolio

Type:PortfolioType

URL:https://api.oeus-kraken.energy/v1/graphql/

Get details about a portfolio.

The possible errors that can be raised are:

  • KT-CT-9403: Received an invalid portfolioId.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

portfolioNumber (String!)

Portfolio number to be retrieved.

Query

query Portfolio($portfolioNumber: String!) {
  portfolio(portfolioNumber: $portfolioNumber) {
    id
    number
    createdAt
    updatedAt
    billingName
    collectiveBilling
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    leadAccountNumber
    brand
    name
    depth
    parent {
      ...PortfolioTypeFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "portfolioNumber": "abc123"
}

Response

{
  "data": {
    "portfolio": {
      "id": "abc123",
      "number": "abc123",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "billingName": "abc123",
      "collectiveBilling": true,
      "operationsTeam": OperationsTeamType,
      "leadAccountNumber": "abc123",
      "brand": "abc123",
      "name": "abc123",
      "depth": 1,
      "parent": PortfolioType,
      "ancestors": PortfolioConnectionTypeConnection,
      "descendants": PortfolioConnectionTypeConnection,
      "accounts": AccountConnectionTypeConnection
    }
  }
}

possibleErrors

Type:PossibleErrorsOutputType

URL:https://api.oeus-kraken.energy/v1/graphql/

Possible errors of the requested query/mutation.

The possible errors that can be raised are:

  • KT-CT-1606: Query/Mutation not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

input (PossibleErrorsInputType!)

Query or Mutation for which to get the possible errors list.

Query

query PossibleErrors($input: PossibleErrorsInputType!) {
  possibleErrors(input: $input) {
    name
    type
    authErrors
    possibleErrors {
      ...PossibleErrorTypeFragment
    }
  }
}

Variables

Response

{
  "data": {
    "possibleErrors": {
      "name": "abc123",
      "type": "query",
      "authErrors": true,
      "possibleErrors": [PossibleErrorType]
    }
  }
}

products

Type:[ProductType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all available electricity products.

Arguments

NameDescription

id (ID)

ID of the product.

displayName (String)

Name of the product. For example: 30-Day Wholesale Rate.

basedOnTimeOfUse (Boolean)

Get products that have the Time of Use flag.

availableAt (DateTime)

Filters products that are available until the given time.

If the available_at argument is not provided, it defaults to the current localtime (America/Chicago).

prepay (Boolean)

Get products that have the Prepay flag.

Query

query Products(
  $id: ID,
  $displayName: String,
  $basedOnTimeOfUse: Boolean,
  $availableAt: DateTime,
  $prepay: Boolean
) {
  products(
    id: $id,
    displayName: $displayName,
    basedOnTimeOfUse: $basedOnTimeOfUse,
    availableAt: $availableAt,
    prepay: $prepay
  ) {
    code
    notes
    fullName
    displayName
    description
    availableFrom
    availableTo
    term
    endsAt
    id
    marketName
    availabilityStatus
    termsContractType
    isWholesale
    generationCredit
    basedOnTimeOfUse
    autoTopUpMinimumAmount
    autoTopUpDefaultAmount
    prepay
    ioDiscountEnabled
    rates {
      ...RatesTypeFragment
    }
  }
}

Variables

{
  "id": "abc123",
  "displayName": "abc123",
  "basedOnTimeOfUse": true,
  "availableAt": "2020-01-01T00:00:00.000Z",
  "prepay": true
}

Response

{
  "data": {
    "products": [
      {
        "code": "abc123",
        "notes": "abc123",
        "fullName": "abc123",
        "displayName": "abc123",
        "description": "abc123",
        "availableFrom": "2020-01-01T00:00:00.000Z",
        "availableTo": "2020-01-01T00:00:00.000Z",
        "term": 1,
        "endsAt": "2020-01-01T00:00:00.000Z",
        "id": "abc123",
        "marketName": "abc123",
        "availabilityStatus": "PUBLIC",
        "termsContractType": "abc123",
        "isWholesale": true,
        "generationCredit": true,
        "basedOnTimeOfUse": true,
        "autoTopUpMinimumAmount": 1,
        "autoTopUpDefaultAmount": 1,
        "prepay": true,
        "ioDiscountEnabled": true,
        "rates": RatesType
      }
    ]
  }
}

productsWithConciseApplicableRates

Type:[ProductWithRatesOutput]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get all available electricity products with concise rates.

Arguments

NameDescription

filterProductsBy (ProductInput)

Query

query ProductsWithConciseApplicableRates($filterProductsBy: ProductInput) {
  productsWithConciseApplicableRates(filterProductsBy: $filterProductsBy) {
    id
    code
    fullName
    displayName
    description
    term
    rates {
      ...ConciseRatesOutputFragment
    }
    consolidatedRates {
      ...ConciseRatesOutputFragment
    }
    prepay
  }
}

Variables

{
  "filterProductsBy": ProductInput
}

Response

{
  "data": {
    "productsWithConciseApplicableRates": [
      {
        "id": "abc123",
        "code": "abc123",
        "fullName": "abc123",
        "displayName": "abc123",
        "description": "abc123",
        "term": 1,
        "rates": [ConciseRatesOutput],
        "consolidatedRates": [ConciseRatesOutput],
        "prepay": true
      }
    ]
  }
}

properties

Type:[PropertyType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Properties linked to the account now and in the future.

Arguments

NameDescription

accountNumber (String!)

activeFrom (DateTime)

Returns properties that have an effective period that ends at or after the given activeFrom datetime.

Query

query Properties(
  $accountNumber: String!,
  $activeFrom: DateTime
) {
  properties(
    accountNumber: $accountNumber,
    activeFrom: $activeFrom
  ) {
    id
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    label
    address
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    measurements {
      ...MeasurementConnectionFragment
    }
    meterPoints {
      ...ElectricityMeterPointTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "activeFrom": "2020-01-01T00:00:00.000Z"
}

Response

{
  "data": {
    "properties": [
      {
        "id": "abc123",
        "addressLine1": "abc123",
        "addressLine2": "abc123",
        "addressLine3": "abc123",
        "addressLine4": "abc123",
        "addressLine5": "abc123",
        "postcode": "abc123",
        "label": "abc123",
        "address": "abc123",
        "richAddress": PropertyRichAddressType,
        "splitAddress": ["abc123"],
        "occupancyPeriods": [OccupancyPeriodType],
        "coordinates": CoordinatesType,
        "embeddedNetwork": EmbeddedNetworkType,
        "measurements": MeasurementConnection,
        "meterPoints": [ElectricityMeterPointType]
      }
    ]
  }
}

propertiesSearch

Type:[PropertySearchResult!]!

URL:https://api.oeus-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Arguments

NameDescription

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertiesSearch($searchTerm: String!) {
  propertiesSearch(searchTerm: $searchTerm) {
    score
    property {
      ...PropertyTypeFragment
    }
  }
}

Variables

{
  "searchTerm": "abc123"
}

Response

{
  "data": {
    "propertiesSearch": {
      "score": 1.0,
      "property": PropertyType
    }
  }
}

property

Type:PropertyType

URL:https://api.oeus-kraken.energy/v1/graphql/

A property with the given ID. Usually associated with supply points.

Arguments

NameDescription

id (ID!)

The property ID.

Query

query Property($id: ID!) {
  property(id: $id) {
    id
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    label
    address
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    measurements {
      ...MeasurementConnectionFragment
    }
    meterPoints {
      ...ElectricityMeterPointTypeFragment
    }
  }
}

Variables

{
  "id": "abc123"
}

Response

{
  "data": {
    "property": {
      "id": "abc123",
      "addressLine1": "abc123",
      "addressLine2": "abc123",
      "addressLine3": "abc123",
      "addressLine4": "abc123",
      "addressLine5": "abc123",
      "postcode": "abc123",
      "label": "abc123",
      "address": "abc123",
      "richAddress": PropertyRichAddressType,
      "splitAddress": ["abc123"],
      "occupancyPeriods": [OccupancyPeriodType],
      "coordinates": CoordinatesType,
      "embeddedNetwork": EmbeddedNetworkType,
      "measurements": MeasurementConnection,
      "meterPoints": [ElectricityMeterPointType]
    }
  }
}

propertySearch

Type:[PropertyType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Search for properties that are already in Kraken and match the search term.

Deprecated

The 'propertySearch' field is deprecated.

This query is being deprecated in favour of `propertiesSearch`. The latter returns not only the matched properties but the level of confidence in the results through the `score` field.

- Marked as deprecated on 2023-05-23.
- Scheduled for removal on or after 2024-01-01.

Arguments

NameDescription

searchTerm (String!)

The search term. It can be an address or a meter point identifier.

Query

query PropertySearch($searchTerm: String!) {
  propertySearch(searchTerm: $searchTerm) {
    id
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    postcode
    label
    address
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    measurements {
      ...MeasurementConnectionFragment
    }
    meterPoints {
      ...ElectricityMeterPointTypeFragment
    }
  }
}

Variables

{
  "searchTerm": "abc123"
}

Response

{
  "data": {
    "propertySearch": [
      {
        "id": "abc123",
        "addressLine1": "abc123",
        "addressLine2": "abc123",
        "addressLine3": "abc123",
        "addressLine4": "abc123",
        "addressLine5": "abc123",
        "postcode": "abc123",
        "label": "abc123",
        "address": "abc123",
        "richAddress": PropertyRichAddressType,
        "splitAddress": ["abc123"],
        "occupancyPeriods": [OccupancyPeriodType],
        "coordinates": CoordinatesType,
        "embeddedNetwork": EmbeddedNetworkType,
        "measurements": MeasurementConnection,
        "meterPoints": [ElectricityMeterPointType]
      }
    ]
  }
}

providerAuthDetails

Type:ProviderAuthDetailsType

URL:https://api.oeus-kraken.energy/v1/graphql/

Auth details (e.g. OAuth 2.0 URI) for the provider (if available).

Arguments

NameDescription

provider (ProviderChoices!)

The provider to get the auth details for.

deviceType (KrakenFlexDeviceTypes!)

The device type to get the auth details for (as providers may support multiple).

clientType (ClientType)

The client type the request originated from. Used when oauth_uri is different between web and app.

accountNumber (String)

The account number that will be associated with the device. Required for some providers.

propertyId (Int)

The ID of the property the device belongs to.

Query

query ProviderAuthDetails(
  $provider: ProviderChoices!,
  $deviceType: KrakenFlexDeviceTypes!,
  $clientType: ClientType,
  $accountNumber: String,
  $propertyId: Int
) {
  providerAuthDetails(
    provider: $provider,
    deviceType: $deviceType,
    clientType: $clientType,
    accountNumber: $accountNumber,
    propertyId: $propertyId
  ) {
    oauthUri
  }
}

Variables

{
  "provider": "BYD",
  "deviceType": "BATTERIES",
  "clientType": "APP",
  "accountNumber": "abc123",
  "propertyId": 1
}

Response

{
  "data": {
    "providerAuthDetails": {
      "oauthUri": "abc123"
    }
  }
}

providerVirtualKeyDetails

Type:ProviderVirtualKeyDetailsType

URL:https://api.oeus-kraken.energy/v1/graphql/

Virtual key details (e.g. certificate public key) for the provider (if available).

Arguments

NameDescription

provider (ProviderChoices!)

The provider to get the virtual key details for.

deviceType (KrakenFlexDeviceTypes!)

The device type to get the virtual key details for (as providers may support multiple).

Query

query ProviderVirtualKeyDetails(
  $provider: ProviderChoices!,
  $deviceType: KrakenFlexDeviceTypes!
) {
  providerVirtualKeyDetails(
    provider: $provider,
    deviceType: $deviceType
  ) {
    virtualKeyName
    virtualKeyUri
  }
}

Variables

{
  "provider": "BYD",
  "deviceType": "BATTERIES"
}

Response

{
  "data": {
    "providerVirtualKeyDetails": {
      "virtualKeyName": "abc123",
      "virtualKeyUri": "abc123"
    }
  }
}

question

Type:String

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the customer feedback survey question.

The possible errors that can be raised are:

  • KT-CT-5513: Invalid data.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

formId (Int!)

Query

query Question($formId: Int!) {
  question(formId: $formId)
}

Variables

{
  "formId": 1
}

Response

{
  "data": {
    "question": "abc123"
  }
}

rateLimitInfo

Type:CombinedRateLimitInformation

URL:https://api.oeus-kraken.energy/v1/graphql/

Combined information about points-allowance rate limiting and request-specific rate limiting.

Query

query RateLimitInfo {
  rateLimitInfo {
    pointsAllowanceRateLimit {
      ...PointsAllowanceRateLimitInformationFragment
    }
    fieldSpecificRateLimits {
      ...FieldSpecificRateLimitInformationConnectionTypeConnectionFragment
    }
  }
}

Response

{
  "data": {
    "rateLimitInfo": {
      "pointsAllowanceRateLimit": PointsAllowanceRateLimitInformation,
      "fieldSpecificRateLimits": FieldSpecificRateLimitInformationConnectionTypeConnection
    }
  }
}

registeredKrakenflexDevice

Type:KrakenFlexDeviceType

URL:https://api.oeus-kraken.energy/v1/graphql/

A device registered with KrakenFlex for a given account.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'registeredKrakenflexDevice' field is deprecated.

Please use 'devices' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2024-11-01.

Arguments

NameDescription

accountNumber (String!)

Query

query RegisteredKrakenflexDevice($accountNumber: String!) {
  registeredKrakenflexDevice(accountNumber: $accountNumber) {
    krakenflexDeviceId
    provider
    vehicleMake
    vehicleModel
    vehicleBatterySizeInKwh
    chargePointMake
    chargePointModel
    chargePointPowerInKw
    status
    suspended
    hasToken
    createdAt
    stateOfChargeLimit {
      ...StateOfChargeLimitFragment
    }
    testDispatchFailureReason
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "registeredKrakenflexDevice": {
      "krakenflexDeviceId": "abc123",
      "provider": "BYD",
      "vehicleMake": "abc123",
      "vehicleModel": "abc123",
      "vehicleBatterySizeInKwh": 1.0,
      "chargePointMake": "abc123",
      "chargePointModel": "abc123",
      "chargePointPowerInKw": 1.0,
      "status": "abc123",
      "suspended": true,
      "hasToken": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "stateOfChargeLimit": StateOfChargeLimit,
      "testDispatchFailureReason": "NONE"
    }
  }
}

registeredThermostats

Type:RegisteredThermostats

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

The possible errors that can be raised are:

  • KT-CT-4323: Unauthorized.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'registeredThermostats' field is deprecated.

Please use 'devices' query with `... on SmartFlexThermostatStatus` instead.

- Marked as deprecated on 2024-10-08.
- Scheduled for removal on or after 2025-02-01.

Arguments

NameDescription

accountNumber (String!)

Query

query RegisteredThermostats($accountNumber: String!) {
  registeredThermostats(accountNumber: $accountNumber) {
    thermostats {
      ...ThermostatDeviceTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "registeredThermostats": {
      "thermostats": [ThermostatDeviceType]
    }
  }
}

smartFlexOnboardingWizards

Type:[SmartFlexOnboardingWizard!]

URL:https://api.oeus-kraken.energy/v1/graphql/

A list of wizards for onboarding devices for an account and property.

Arguments

NameDescription

accountNumber (String!)

The account number, e.g. A-12345678.

propertyId (Int)

Only list wizards for this property.

wizardId (ID)

To get a specific wizard by ID, if it exists.

includeCancelled (Boolean)

Include cancelled wizards.

includeCompleted (Boolean)

Include completed wizards.

Query

query SmartFlexOnboardingWizards(
  $accountNumber: String!,
  $propertyId: Int,
  $wizardId: ID,
  $includeCancelled: Boolean,
  $includeCompleted: Boolean
) {
  smartFlexOnboardingWizards(
    accountNumber: $accountNumber,
    propertyId: $propertyId,
    wizardId: $wizardId,
    includeCancelled: $includeCancelled,
    includeCompleted: $includeCompleted
  ) {
    id
    backendScreen {
      ... on ComponentListType {
        ...ComponentListTypeFragment
      }
      ... on GenericBackendScreen {
        ...GenericBackendScreenFragment
      }
      ... on Dashboard {
        ...DashboardFragment
      }
    }
    currentStep {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
    completedSteps {
      ...SmartFlexOnboardingStepInterfaceFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "propertyId": 1,
  "wizardId": "abc123",
  "includeCancelled": true,
  "includeCompleted": true
}

Response

{
  "data": {
    "smartFlexOnboardingWizards": [
      {
        "id": "abc123",
        "backendScreen": ComponentListType,
        "currentStep": SmartFlexOnboardingStepInterface,
        "completedSteps": SmartFlexOnboardingStepInterface
      }
    ]
  }
}

Arguments

NameDescription

accountNumber (String)

Filter meter points by account.

portfolioNumber (String)

Filter meter points by portfolio.

before (String)

after (String)

first (Int)

last (Int)

Query

query SupplyPoints(
  $accountNumber: String,
  $portfolioNumber: String,
  $before: String,
  $after: String,
  $first: Int,
  $last: Int
) {
  supplyPoints(
    accountNumber: $accountNumber,
    portfolioNumber: $portfolioNumber,
    before: $before,
    after: $after,
    first: $first,
    last: $last
  ) {
    pageInfo {
      ...PageInfoFragment
    }
    edges {
      ...SupplyPointConnectionTypeEdgeFragment
    }
    totalCount
    edgeCount
  }
}

Variables

{
  "accountNumber": "abc123",
  "portfolioNumber": "abc123",
  "before": "abc123",
  "after": "abc123",
  "first": 1,
  "last": 1
}

Response

{
  "data": {
    "supplyPoints": {
      "pageInfo": PageInfo,
      "edges": SupplyPointConnectionTypeEdge,
      "totalCount": 1,
      "edgeCount": 1
    }
  }
}

taskResult

Type:TaskResult

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the status of a background task.

The possible errors that can be raised are:

  • KT-CT-10401: Task not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

NameDescription

taskId (String!)

accountNumber (String!)

Query

query TaskResult(
  $taskId: String!,
  $accountNumber: String!
) {
  taskResult(
    taskId: $taskId,
    accountNumber: $accountNumber
  ) {
    status
    result
    error
  }
}

Variables

{
  "taskId": "abc123",
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "taskResult": {
      "status": "STARTED",
      "result": {"key": "value"},
      "error": "abc123"
    }
  }
}

Arguments

NameDescription

postalCode (String!)

The ZIP code to retrieve service providers for.

Full ZIP codes are accepted with or without hyphen but only the first 5 digits are used.

Query

query TdspByPostalcode($postalCode: String!) {
  tdspByPostalcode(postalCode: $postalCode) {
    id
    postcode
    serviceProvider
    loadZone
  }
}

Variables

{
  "postalCode": "abc123"
}

Response

{
  "data": {
    "tdspByPostalcode": [
      {
        "id": "abc123",
        "postcode": "abc123",
        "serviceProvider": "AEP_TCC",
        "loadZone": "LZ_HOUSTON"
      }
    ]
  }
}

termsAndConditionsForProduct

Type:[TermsAndConditionsType]

URL:https://api.oeus-kraken.energy/v1/graphql/

Get the active terms and conditions for a market supply product.

Arguments

NameDescription

productCode (String!)

The product code of the market supply product.

Query

query TermsAndConditionsForProduct($productCode: String!) {
  termsAndConditionsForProduct(productCode: $productCode) {
    name
    pdfUrl
    brandCode
    markdown
    html
    version
    effectiveFrom
  }
}

Variables

{
  "productCode": "abc123"
}

Response

{
  "data": {
    "termsAndConditionsForProduct": [
      {
        "name": "abc123",
        "pdfUrl": "abc123",
        "brandCode": "abc123",
        "markdown": "abc123",
        "html": "abc123",
        "version": "abc123",
        "effectiveFrom": "2020-01-01T00:00:00.000Z"
      }
    ]
  }
}

userVehicles

Type:[UserVehiclesType]

URL:https://api.oeus-kraken.energy/v1/graphql/

A list of vehicles available to the user.

Note: If the API returns an empty list, there might be a delay between the vehicle being registered in the provider's system, and data being fetched from the vehicle's manufacturer. In such cases, the query should be retried after a few seconds.

Arguments

NameDescription

accountNumber (String)

supportedProvider (ProviderChoices)

The provider used to authenticate the device (default Enode).

authentication (AuthenticationInput)

The authentication details required given the chosen provider.

Query

query UserVehicles(
  $accountNumber: String,
  $supportedProvider: ProviderChoices,
  $authentication: AuthenticationInput
) {
  userVehicles(
    accountNumber: $accountNumber,
    supportedProvider: $supportedProvider,
    authentication: $authentication
  ) {
    vehicleId
    information {
      ...VehicleInformationTypeFragment
    }
  }
}

Variables

{
  "accountNumber": "abc123",
  "supportedProvider": "BYD",
  "authentication": AuthenticationInput
}

Response

{
  "data": {
    "userVehicles": [
      {
        "vehicleId": "abc123",
        "information": VehicleInformationType
      }
    ]
  }
}

validPhoneNumber

Type:PhoneNumberOutput

URL:https://api.oeus-kraken.energy/v1/graphql/

Override Field to add additional attributes and extend description with possible_errors

Arguments

NameDescription

phoneNumber (String!)

Query

query ValidPhoneNumber($phoneNumber: String!) {
  validPhoneNumber(phoneNumber: $phoneNumber) {
    isValidPhoneNumber
  }
}

Variables

{
  "phoneNumber": "abc123"
}

Response

{
  "data": {
    "validPhoneNumber": {
      "isValidPhoneNumber": true
    }
  }
}

vehicleChargingPreferences

Type:VehicleChargingPreferencesType

URL:https://api.oeus-kraken.energy/v1/graphql/

Vehicle charging preference details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-4339: Your device charging preferences could not be fetched.
  • KT-CT-1113: Disabled GraphQL field requested.

Deprecated

The 'vehicleChargingPreferences' field is deprecated.

Please use 'devices.preferences' instead.

- Marked as deprecated on 2024-04-23.
- Scheduled for removal on or after 2024-11-01.

Arguments

NameDescription

accountNumber (String!)

Query

query VehicleChargingPreferences($accountNumber: String!) {
  vehicleChargingPreferences(accountNumber: $accountNumber) {
    weekdayTargetTime
    weekdayTargetSoc
    weekendTargetTime
    weekendTargetSoc
    minimumSocPercentage
    maximumSocPercentage
  }
}

Variables

{
  "accountNumber": "abc123"
}

Response

{
  "data": {
    "vehicleChargingPreferences": {
      "weekdayTargetTime": "abc123",
      "weekdayTargetSoc": 1,
      "weekendTargetTime": "abc123",
      "weekendTargetSoc": 1,
      "minimumSocPercentage": 1,
      "maximumSocPercentage": 1
    }
  }
}

viewer

Type:AccountUserType

URL:https://api.oeus-kraken.energy/v1/graphql/

The currently authenticated user.

This field requires the Authorization header to be set.

Query

query Viewer {
  viewer {
    id
    number
    accounts {
      ...AccountInterfaceFragment
    }
    givenName
    familyName
    email
    mobile
    landline
    title
    pronouns
    isDeceased
    liveSecretKey
    displayName
    firstName
    lastName
    fullName
    preferredName
    portfolioId
    portfolioIds
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    dateOfBirth
    landlinePhoneNumber
    alternativePhoneNumbers
    hasFamilyIssues
    isInHardship
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    details {
      ...AccountUserDetailTypeFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
  }
}

Response

{
  "data": {
    "viewer": {
      "id": "abc123",
      "number": "abc123",
      "accounts": AccountInterface,
      "givenName": "abc123",
      "familyName": "abc123",
      "email": "abc123",
      "mobile": "abc123",
      "landline": "abc123",
      "title": "abc123",
      "pronouns": "abc123",
      "isDeceased": true,
      "liveSecretKey": "abc123",
      "displayName": "abc123",
      "firstName": "abc123",
      "lastName": "abc123",
      "fullName": "abc123",
      "preferredName": "abc123",
      "portfolioId": "abc123",
      "portfolioIds": ["abc123"],
      "portfolios": PortfolioConnectionTypeConnection,
      "specialCircumstances": SpecialCircumstancesType,
      "preferences": AccountUserCommsPreferences,
      "dateOfBirth": "2020-01-01",
      "landlinePhoneNumber": "abc123",
      "alternativePhoneNumbers": ["abc123"],
      "hasFamilyIssues": true,
      "isInHardship": true,
      "accountUserRoles": [AccountUserRoleType],
      "portfolioUserRoles": [PortfolioUserRoleType],
      "details": [AccountUserDetailType],
      "consents": ConsentType,
      "paymentMethods": PaymentInstructionConnectionTypeConnection
    }
  }
}

Authentication Server

authorizedApplications

Type:[AuthorizedApplication]

URL:https://auth.oeus-kraken.energy/graphql/

Get all the confidential-client applications the current user has authorized.

Query

query AuthorizedApplications {
  authorizedApplications {
    name
    clientId
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "name": "abc123",
        "clientId": "abc123"
      }
    ]
  }
}

Query

query KrakenVersion {
  krakenVersion {
    number
    SHA
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "number": "abc123",
      "SHA": "abc123"
    }
  }
}

mfaDevices

Type:[MfaDevice]

URL:https://auth.oeus-kraken.energy/graphql/

Get all MFA devices for the current user.

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "abc123",
        "isConfirmed": true
      }
    ]
  }
}