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.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

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:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-C69267FB"
}

Response

{
  "data": {
    "account": {
      "accountType": "BUSINESS",
      "activeHardshipAgreements": [HardshipAgreementType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "address": RichAddressType,
      "agreements": [AgreementType],
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "assistanceAgreements": [AssistanceAgreementType],
      "balance": 42,
      "bill": BillInterface,
      "billingAddress": "leader-degree-also-phone-draw",
      "billingAddressLine1": "upon-make-return-effect-suggest",
      "billingAddressLine2": "sometimes-partner-development-yeah-say",
      "billingAddressLine3": "Republican-hand-site-magazine-there",
      "billingAddressLine4": "star-whole-trip-take-near",
      "billingAddressLine5": "from-movement-fish-behind-however",
      "billingAddressPostcode": "pass-space-low-student-training",
      "billingCountryCode": "use-reality-former-create-forget",
      "billingDeliveryPointIdentifier": "20782469",
      "billingEmail": "officer-soldier-those-I-finish",
      "billingName": "exactly-treat-several-account-consumer",
      "billingOptions": BillingOptionsType,
      "billingSubName": "PM-family-certainly-manager-boy",
      "bills": BillConnectionTypeConnection,
      "brand": "large-consumer-certain-military-might",
      "business": BusinessType,
      "campaigns": [AccountCampaignType],
      "canModifyPayments": CanModifyPaymentsType,
      "canRequestRefund": true,
      "commsDeliveryPreference": "EMAIL",
      "complaints": ComplaintConnectionTypeConnection,
      "consentData": {"key": "value"},
      "consents": ConsentType,
      "contributionAgreements": [ContributionAgreementType],
      "createdAt": "1996-05-15T18:40:01.695524+00:00",
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "documentAccessibility": "LARGE_PRINT",
      "events": AccountEventConnectionTypeConnection,
      "fileAttachments": [AccountFileAttachment],
      "id": "24141846",
      "isEligibleForIntelligentOctopus": true,
      "isInHardship": true,
      "isOnSupply": true,
      "isShellAccount": true,
      "ledgers": [LedgerType],
      "marketSupplyAgreements": AgreementConnection,
      "maximumRefund": MaximumRefundType,
      "metadata": [Metadata],
      "meterPointStatus": "factor-specific-deal-per-Republican",
      "notes": [AccountNoteType],
      "number": "general-detail-figure-his-rule",
      "overdueBalance": 69,
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "payments": AccountPaymentConnectionTypeConnection,
      "portfolio": PortfolioType,
      "preferredLanguageForComms": "voice-field-should-actually-summer",
      "properties": [PropertyType],
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "references": [AccountReferenceType],
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 54,
      "reminders": AccountReminderConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "rewards": [RewardType],
      "splitBillingAddress": ["particular-true-family-safe-explain"],
      "status": "PENDING",
      "transactions": TransactionConnectionTypeConnection,
      "urn": "PM-man-protect-successful-send",
      "users": AccountUserType
    }
  }
}

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
    group
    isDeprecated
    isHidden
    isTaxExempt
  }
}

Response

{
  "data": {
    "accountChargeReasons": [
      {
        "code": "box-girl-budget-court-possible",
        "display": "through-evening-level-particular-group",
        "group": "story-one-admit-include-wish",
        "isDeprecated": true,
        "isHidden": true,
        "isTaxExempt": true
      }
    ]
  }
}

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:

Arguments

Name Description

accountNumber (String)

The account number to find the contract for.

identifier (String)

The identifier of the contract.

version (Int)

The version of the contract.

Query

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

Variables

{
  "accountNumber": "A-3D1975AE",
  "identifier": "15965129",
  "version": 42
}

Response

{
  "data": {
    "accountContract": {
      "cancelledAt": "1977-02-17T00:34:54.549380+00:00",
      "identifier": "61382122",
      "lifecycle": ContractVersion,
      "notes": [ContractNoteType],
      "party": AccountType,
      "signedAt": "2020-11-09T23:45:25.832968+00:00",
      "status": "REVOKED",
      "subject": [AccountType],
      "terms": TermInterface,
      "title": "yeah-account-organization-news-front",
      "validFrom": "1983-08-25T06:52:03.845179+00:00",
      "validTo": "2003-05-05T23:49:10.795476+00:00"
    }
  }
}

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
    group
    isDeprecated
    isHidden
    isTaxExempt
  }
}

Response

{
  "data": {
    "accountCreditReasons": [
      {
        "code": "through-than-our-brother-world",
        "display": "character-hold-field-court-like",
        "group": "already-if-represent-sometimes-PM",
        "isDeprecated": true,
        "isHidden": true,
        "isTaxExempt": true
      }
    ]
  }
}

accountInfoPrechecksValidation

Type: PrechecksValidationOutputType

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

Returns whether the given data passes pre-check validation.

Arguments

Name Description

precheckData (PrechecksValidationInputType!)

Data for pre-check validation.

Query

query AccountInfoPrechecksValidation($precheckData: PrechecksValidationInputType!) {
  accountInfoPrechecksValidation(precheckData: $precheckData) {
    denyEnrollment
    email {
      ...PrecheckEmailValidationOutputFragment
    }
  }
}

Variables

{
  "precheckData": PrechecksValidationInputType
}

Response

{
  "data": {
    "accountInfoPrechecksValidation": {
      "denyEnrollment": true,
      "email": PrecheckEmailValidationOutput
    }
  }
}

accountIoEligibility

Type: AccountIoEligibility

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

Determines whether an account is eligible to register devices with SmartFlex.

Arguments

Name Description

accountNumber (String!)

Account number.

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligibility checks will be dependent on the property id and
            it will be a required input.

Query

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

Variables

{
  "accountNumber": "A-8C5880DF",
  "propertyId": 86108458
}

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:

Arguments

Name Description

value (String)

Filter account references by this value.

Query

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

Variables

{
  "value": "eight-require-fire-risk-nice"
}

Response

{
  "data": {
    "accountReference": [
      {
        "account": AccountType,
        "createdAt": "2019-06-30T22:35:27.314597+00:00",
        "namespace": "speech-where-adult-some-TV",
        "updatedAt": "1993-12-27T19:07:52.324756+00:00",
        "value": "find-upon-however-point-floor"
      }
    ]
  }
}

accountUser

Type: AccountUserType

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

Retrieve an account user.

The possible errors that can be raised are:

Arguments

Name Description

email (String)

Email associated with an account user.

externalId (ID)

External ID associated with an account user.

number (ID)

Kraken number associated with an account user.

Query

query AccountUser(
  $email: String,
  $externalId: ID,
  $number: ID
) {
  accountUser(
    email: $email,
    externalId: $externalId,
    number: $number
  ) {
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    accounts {
      ...AccountInterfaceFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    familyName
    fullName
    givenName
    hasFamilyIssues
    id
    isActive
    isDeceased
    isInHardship
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

Variables

{
  "email": "direction-music-particularly-pull-kind",
  "externalId": "44479272",
  "number": "60905247"
}

Response

{
  "data": {
    "accountUser": {
      "accountUserRoles": [AccountUserRoleType],
      "accounts": AccountInterface,
      "address": RichAddressType,
      "alternativePhoneNumbers": ["whole-feeling-relationship-news-across"],
      "businesses": BusinessConnectionTypeConnection,
      "consents": ConsentType,
      "createdAt": "1983-12-15T05:13:36.594060+00:00",
      "dateOfBirth": "1994-10-08",
      "details": [AccountUserDetailType],
      "email": "economy-fine-off-process-citizen",
      "familyName": "Proctor",
      "fullName": "letter-adult-stage-make-feel",
      "givenName": "Donald",
      "hasFamilyIssues": true,
      "id": "12610443",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "label": "majority-determine-past-the-feeling",
      "landline": "especially-rest-political-able-scene",
      "liveSecretKey": "brother-through-hold-movement-any",
      "mobile": "agree-song-safe-resource-under",
      "number": "improve-Democrat-dark-according-what",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": ["10206385"],
      "portfolioUserRoles": [PortfolioUserRoleType],
      "portfolios": PortfolioConnectionTypeConnection,
      "preferences": AccountUserCommsPreferences,
      "preferredName": "under-south-unit-war-why",
      "pronouns": "brother-card-industry-alone-your",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "age-security-opportunity-through-someone"
    }
  }
}

accounts

Type: [AccountType]

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

Get details about multiple accounts.

The possible errors that can be raised are:

  • KT-CT-4184: Exactly one of phoneNumber or portfolioNumber must be provided.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

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

Variables

{
  "phoneNumber": "camera-employee-well-grow-tree",
  "portfolioNumber": "P-064977A1"
}

Response

{
  "data": {
    "accounts": [
      {
        "accountType": "BUSINESS",
        "activeHardshipAgreements": [HardshipAgreementType],
        "activeReferralSchemes": ReferralSchemeTypes,
        "address": RichAddressType,
        "agreements": [AgreementType],
        "annualStatements": AnnualStatementConnectionTypeConnection,
        "applications": AccountApplicationConnectionTypeConnection,
        "assistanceAgreements": [AssistanceAgreementType],
        "balance": 70,
        "bill": BillInterface,
        "billingAddress": "police-former-pull-decade-carry",
        "billingAddressLine1": "race-our-gun-find-blood",
        "billingAddressLine2": "write-moment-rock-base-general",
        "billingAddressLine3": "tell-protect-enough-likely-education",
        "billingAddressLine4": "go-weight-natural-me-light",
        "billingAddressLine5": "security-with-stay-our-again",
        "billingAddressPostcode": "improve-us-popular-ball-public",
        "billingCountryCode": "professor-environment-evening-central-still",
        "billingDeliveryPointIdentifier": "40251784",
        "billingEmail": "physical-see-put-area-power",
        "billingName": "middle-town-nor-keep-quality",
        "billingOptions": BillingOptionsType,
        "billingSubName": "born-own-process-past-store",
        "bills": BillConnectionTypeConnection,
        "brand": "either-attention-seem-poor-teacher",
        "business": BusinessType,
        "campaigns": [AccountCampaignType],
        "canModifyPayments": CanModifyPaymentsType,
        "canRequestRefund": true,
        "commsDeliveryPreference": "EMAIL",
        "complaints": ComplaintConnectionTypeConnection,
        "consentData": {"key": "value"},
        "consents": ConsentType,
        "contributionAgreements": [ContributionAgreementType],
        "createdAt": "2020-03-20T12:37:14.291593+00:00",
        "debtCollectionProceedings": [DebtCollectionProceedingType],
        "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
        "documentAccessibility": "LARGE_PRINT",
        "events": AccountEventConnectionTypeConnection,
        "fileAttachments": [AccountFileAttachment],
        "id": "77580980",
        "isEligibleForIntelligentOctopus": true,
        "isInHardship": true,
        "isOnSupply": true,
        "isShellAccount": true,
        "ledgers": [LedgerType],
        "marketSupplyAgreements": AgreementConnection,
        "maximumRefund": MaximumRefundType,
        "metadata": [Metadata],
        "meterPointStatus": "east-necessary-pattern-along-Congress",
        "notes": [AccountNoteType],
        "number": "happy-son-past-month-treatment",
        "overdueBalance": 17,
        "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
        "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
        "paymentMethods": PaymentInstructionConnectionTypeConnection,
        "paymentPlans": PaymentPlanConnectionTypeConnection,
        "paymentSchedules": PaymentScheduleConnectionTypeConnection,
        "payments": AccountPaymentConnectionTypeConnection,
        "portfolio": PortfolioType,
        "preferredLanguageForComms": "without-major-rich-type-food",
        "properties": [PropertyType],
        "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
        "references": [AccountReferenceType],
        "referrals": ReferralConnectionTypeConnection,
        "referralsCreated": 37,
        "reminders": AccountReminderConnectionTypeConnection,
        "repayments": AccountRepaymentConnectionTypeConnection,
        "requestRefundEligibility": RequestRefundEligibilityType,
        "rewards": [RewardType],
        "splitBillingAddress": ["wrong-consumer-entire-man-top"],
        "status": "PENDING",
        "transactions": TransactionConnectionTypeConnection,
        "urn": "child-wide-majority-religious-crime",
        "users": AccountUserType
      }
    ]
  }
}

accountsSearch

Type: [AccountSearchItemType]

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

Search for account that are already in Kraken and match the search terms.

The possible errors that can be raised are:

  • KT-CT-4183: One of more search terms failed validations.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

maxResults (Int)

The maximum number of results to return.

searchTerms (AccountSearchInputType)

Search operators.

Query

query AccountsSearch(
  $maxResults: Int,
  $searchTerms: AccountSearchInputType
) {
  accountsSearch(
    maxResults: $maxResults,
    searchTerms: $searchTerms
  ) {
    account {
      ...AccountTypeFragment
    }
    score
  }
}

Variables

{
  "maxResults": 84,
  "searchTerms": AccountSearchInputType
}

Response

{
  "data": {
    "accountsSearch": [
      {
        "account": AccountType,
        "score": "1.0"
      }
    ]
  }
}

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

Name Description

accountType (ReferralSchemeAccountTypeOptions)

The account type for which to get the referral scheme.

subdomain (String!)

The affiliate link subdomain.

Query

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

Variables

{
  "accountType": "DOMESTIC",
  "subdomain": "area-stage-save-morning-everything"
}

Response

{
  "data": {
    "activeAffiliateReferralScheme": {
      "canBeReferred": true,
      "code": "hit-there-likely-including-lawyer",
      "combinedRewardAmount": 10,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 63,
      "maxRecurrence": 95,
      "referralDisplayUrl": "determine-reality-together-someone-training",
      "referralUrl": "community-seat-blue-purpose-be",
      "referredRewardAmount": 83,
      "referrerGivenName": "Beverly",
      "referrerRewardAmount": 58,
      "schemeType": "fact-second-safe-sister-give"
    }
  }
}

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 {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Response

{
  "data": {
    "activeDomesticSignupRewardScheme": {
      "canBeReferred": true,
      "code": "only-agree-fill-off-why",
      "combinedRewardAmount": 18,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 8,
      "maxRecurrence": 56,
      "referralDisplayUrl": "yard-soon-opportunity-collection-son",
      "referralUrl": "admit-election-I-space-oil",
      "referredRewardAmount": 32,
      "referrerGivenName": "Tiffany",
      "referrerRewardAmount": 62,
      "schemeType": "whose-one-experience-nice-woman"
    }
  }
}

activeSalesChannels

Type: [SalesChannelType]

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

A list of active sales channels.

The possible errors that can be raised are:

Arguments

Name Description

activeFrom (DateTime)

The datetime from which to filter active sales channels.

activeTo (DateTime)

The datetime up to which to filter active sales channels.

Query

query ActiveSalesChannels(
  $activeFrom: DateTime,
  $activeTo: DateTime
) {
  activeSalesChannels(
    activeFrom: $activeFrom,
    activeTo: $activeTo
  ) {
    code
    description
    hierarchicalName
    name
  }
}

Variables

{
  "activeFrom": "1982-09-10T21:08:40.943121+00:00",
  "activeTo": "1980-11-23T07:25:46.757337+00:00"
}

Response

{
  "data": {
    "activeSalesChannels": [
      {
        "code": "body-board-special-short-option",
        "description": "air-ok-institution-serious-than",
        "hierarchicalName": "impact-friend-early-good-not",
        "name": "age-institution-share-foreign-issue"
      }
    ]
  }
}

addressLookup

Type: [AddressTdspMappingOutputType]

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

Get address mapping by providing ESI ID or address details.

The possible errors that can be raised are:

Arguments

Name Description

address (String)

The street address.

address2 (String)

The second line of the street address.

city (String)

The city of the address.

esiId (String)

The ESI ID of the meter point at the address.

postCode (String)

The postal code of the address.

state (String)

The state of the address.

Query

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

Variables

{
  "address": "collection-or-such-by-other",
  "address2": "specific-walk-sing-movement-pass",
  "city": "skin-century-tree-them-computer",
  "esiId": "51616004",
  "postCode": "happen-beautiful-maybe-play-could",
  "state": "certainly-sometimes-believe-according-movement"
}

Response

{
  "data": {
    "addressLookup": [
      {
        "address": "want-audience-they-act-good",
        "address2": "financial-material-find-strong-campaign",
        "city": "throw-protect-energy-strategy-control",
        "esiId": "76344782",
        "houseNumber": "enough-admit-moment-hold-clear",
        "isKrakenCustomer": IsKrakenCustomerOutput,
        "loadZone": "LZ_HOUSTON",
        "meterType": "AMSM",
        "postCode": "available-book-plant-somebody-bank",
        "premiseType": "RESIDENTIAL",
        "serviceProvider": "AEP_TCC",
        "state": "mean-treat-after-move-attack"
      }
    ]
  }
}

Arguments

Name Description

search (String!)

Query

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

Variables

{
  "search": "anyone-recent-reality-special-bed"
}

Response

{
  "data": {
    "addressLookupUsingEsSearch": [
      {
        "address": "address-stock-follow-star-wind",
        "address2": "wide-through-seek-strategy-rise",
        "city": "kitchen-good-someone-bar-doctor",
        "esiId": "39709927",
        "houseNumber": "former-of-lead-player-number",
        "isKrakenCustomer": IsKrakenCustomerOutput,
        "loadZone": "LZ_HOUSTON",
        "meterType": "AMSM",
        "postCode": "administration-general-red-he-remember",
        "premiseType": "RESIDENTIAL",
        "serviceProvider": "AEP_TCC",
        "state": "structure-total-forget-store-direction"
      }
    ]
  }
}

Type: AffiliateLinkType!

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

Link object for an affiliate organization.

The possible errors that can be raised are:

Arguments

Name Description

subdomain (String!)

The affiliate link subdomain.

Query

query AffiliateLink($subdomain: String!) {
  affiliateLink(subdomain: $subdomain) {
    contactEmail
    contactName
    id
    isBusiness
    landingUrl
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
  }
}

Variables

{
  "subdomain": "throw-beyond-culture-not-right"
}

Response

{
  "data": {
    "affiliateLink": {
      "contactEmail": "should-degree-law-military-gun",
      "contactName": "rest-into-Democrat-reduce-manage",
      "id": "84368053",
      "isBusiness": true,
      "landingUrl": "act-article-charge-now-skin",
      "organisation": AffiliateOrganisationType,
      "subdomain": "mission-exactly-part-let-series",
      "trainingStatus": "NOT_APPLICABLE"
    }
  }
}

Type: [AffiliateLinkType!]!

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

Links (urls) for the affiliate organizations.

Arguments

Name Description

agentContactEmail (String!)

Email address of the affiliate agent.

Query

query AffiliateLinks($agentContactEmail: String!) {
  affiliateLinks(agentContactEmail: $agentContactEmail) {
    contactEmail
    contactName
    id
    isBusiness
    landingUrl
    organisation {
      ...AffiliateOrganisationTypeFragment
    }
    subdomain
    trainingStatus
  }
}

Variables

{
  "agentContactEmail": "rock-maintain-kitchen-front-customer"
}

Response

{
  "data": {
    "affiliateLinks": [
      {
        "contactEmail": "television-born-attorney-change-school",
        "contactName": "industry-add-food-cup-foot",
        "id": "10129990",
        "isBusiness": true,
        "landingUrl": "technology-require-interesting-or-let",
        "organisation": AffiliateOrganisationType,
        "subdomain": "allow-material-ten-common-himself",
        "trainingStatus": "NOT_APPLICABLE"
      }
    ]
  }
}

affiliateOrganisation

Type: AffiliateOrganisationType

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

Return the details of a given affiliate organization, if any exists.

The possible errors that can be raised are:

  • KT-CT-7701: The affiliate organisation was not found.
  • KT-CT-7702: Either id or number must be provided.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

id (Int)

The affiliate organisation ID.

number (String)

The affiliate organisation number.

Query

query AffiliateOrganisation(
  $id: Int,
  $number: String
) {
  affiliateOrganisation(
    id: $id,
    number: $number
  ) {
    allowAlternativePaymentMethods
    canRegisterBusinessMeterPoints
    canRegisterCustomersWithoutEmailAddress
    canRegisterPortfolioAccounts
    canRenewTariffs
    canUseIvrSupportApi
    contactEmail
    defaultAccountType
    id
    isFieldSalesOnlyProduct
    name
    number
    salesChannelCode
    skipMeterPointAddressValidation
  }
}

Variables

{
  "id": 60771906,
  "number": "pull-imagine-federal-watch-watch"
}

Response

{
  "data": {
    "affiliateOrganisation": {
      "allowAlternativePaymentMethods": true,
      "canRegisterBusinessMeterPoints": true,
      "canRegisterCustomersWithoutEmailAddress": true,
      "canRegisterPortfolioAccounts": true,
      "canRenewTariffs": true,
      "canUseIvrSupportApi": true,
      "contactEmail": "increase-yet-serious-their-sort",
      "defaultAccountType": "BUSINESS",
      "id": "66756537",
      "isFieldSalesOnlyProduct": true,
      "name": "number-citizen-spend-form-management",
      "number": "on-call-responsibility-several-thus",
      "salesChannelCode": "behavior-here-spend-computer-minute",
      "skipMeterPointAddressValidation": true
    }
  }
}

agentCallCenterStatus

Type: AgentCallCenterStatusType!

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

Get the call center status for a given agent.

The possible errors that can be raised are:

  • KT-CT-7813: Support user not found with that username.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

supportUserName (String!)

The support user name.

Query

query AgentCallCenterStatus($supportUserName: String!) {
  agentCallCenterStatus(supportUserName: $supportUserName) {
    id
    mostRecentCallId
    status
    updatedAt
  }
}

Variables

{
  "supportUserName": "win-good-box-tend-beyond"
}

Response

{
  "data": {
    "agentCallCenterStatus": {
      "id": "83747743",
      "mostRecentCallId": 26836262,
      "status": "some-rest-project-although-seat",
      "updatedAt": "2021-09-18T22:51:54.250652+00:00"
    }
  }
}

agreement

Type: AgreementType

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

Get an agreement by its ID.

The possible errors that can be raised are:

Arguments

Name Description

id (ID!)

Agreement identifier.

Query

query Agreement($id: ID!) {
  agreement(id: $id) {
    activeProductRates {
      ...RatesTypeFragment
    }
    agreedAt
    autoTopUpAmountSelectedByUser
    earlyTerminationFee
    earlyTerminationFeeExpiration
    efls {
      ...EflTypeFragment
    }
    id
    isEligibleForRenewal
    isExportingGenerationReadings
    outageInformation {
      ...OutageMapOutputTypeFragment
    }
    product {
      ...ProductTypeFragment
    }
    quoteRequest {
      ...GetQuoteOutputTypeFragment
    }
    seasonalRates {
      ...SeasonRatesTypeFragment
    }
    terminatedAt
    totalApplicableDayRate
    totalApplicableNightRate
    totalApplicableRate
    validFrom
    validTo
  }
}

Variables

{
  "id": "68342803"
}

Response

{
  "data": {
    "agreement": {
      "activeProductRates": RatesType,
      "agreedAt": "2013-05-31T02:08:03.232001+00:00",
      "autoTopUpAmountSelectedByUser": 78,
      "earlyTerminationFee": "1.0",
      "earlyTerminationFeeExpiration": "1982-08-18",
      "efls": [EflType],
      "id": "87338515",
      "isEligibleForRenewal": true,
      "isExportingGenerationReadings": true,
      "outageInformation": OutageMapOutputType,
      "product": ProductType,
      "quoteRequest": GetQuoteOutputType,
      "seasonalRates": [SeasonRatesType],
      "terminatedAt": "1987-07-14T13:55:37.932765+00:00",
      "totalApplicableDayRate": "1.0",
      "totalApplicableNightRate": "1.0",
      "totalApplicableRate": "1.0",
      "validFrom": "1983-10-15T21:28:34.211526+00:00",
      "validTo": "1989-03-20T11:01:23.312290+00:00"
    }
  }
}

agreementRollover

Type: AgreementRolloverType

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

Get an agreement rollover by its number.

The possible errors that can be raised are:

Arguments

Name Description

number (String!)

Number of the agreement rollover.

Query

query AgreementRollover($number: String!) {
  agreementRollover(number: $number) {
    actualSendDate
    agreement {
      ...AgreementTypeFragment
    }
    createdAt
    expectedSendDate
    failureReason
    id
    number
    params
    quoteRequests {
      ...MarketSupplyQuoteRequestTypeFragment
    }
    rolledOnTo {
      ...AgreementTypeFragment
    }
    rolloverType
    status
    suppressComms
    tags
    updatedAt
  }
}

Variables

{
  "number": "stay-ten-baby-want-item"
}

Response

{
  "data": {
    "agreementRollover": {
      "actualSendDate": "1971-10-05",
      "agreement": AgreementType,
      "createdAt": "1990-02-19T13:05:56.453523+00:00",
      "expectedSendDate": "1972-01-15",
      "failureReason": "last-agreement-if-institution-boy",
      "id": "27010958",
      "number": "watch-we-western-sure-minute",
      "params": {"key": "value"},
      "quoteRequests": MarketSupplyQuoteRequestType,
      "rolledOnTo": AgreementType,
      "rolloverType": "DEFAULT",
      "status": "PENDING",
      "suppressComms": true,
      "tags": ["size-most-heavy-card-one"],
      "updatedAt": "2015-08-14T21:27:31.695362+00:00"
    }
  }
}

agreementsForRollover

Type: [CommonAgreementType]

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

Get agreements eligible for the rollover process.

Arguments

Name Description

daysBeforeExpiration (Int!)

Days before the agreement expiration.

windowSize (Int!)

Window size in days.

Query

query AgreementsForRollover(
  $daysBeforeExpiration: Int!,
  $windowSize: Int!
) {
  agreementsForRollover(
    daysBeforeExpiration: $daysBeforeExpiration,
    windowSize: $windowSize
  ) {
    account {
      ...AccountTypeFragment
    }
    agreedAt
    agreedFrom
    agreedTo
    characteristicValues {
      ...CharacteristicValueInterfaceFragment
    }
    id
    isActive
    isRevoked
    params
    product {
      ...SupplyProductTypeFragment
    }
    rescissionDeadlineAt
    supplyPoint {
      ...SupplyPointTypeFragment
    }
    terminatedAt
    validFrom
    validTo
  }
}

Variables

{
  "daysBeforeExpiration": 96,
  "windowSize": 74
}

Response

{
  "data": {
    "agreementsForRollover": [
      {
        "account": AccountType,
        "agreedAt": "2024-07-09T04:42:13.955839+00:00",
        "agreedFrom": "1986-08-13T23:00:57.205308+00:00",
        "agreedTo": "2003-12-27T21:24:18.432405+00:00",
        "characteristicValues": CharacteristicValueInterface,
        "id": "44948155",
        "isActive": true,
        "isRevoked": true,
        "params": {"key": "value"},
        "product": SupplyProductType,
        "rescissionDeadlineAt": "1989-06-08T22:51:00.147647+00:00",
        "supplyPoint": SupplyPointType,
        "terminatedAt": "1989-04-27T03:15:54.943696+00:00",
        "validFrom": "1995-05-21T06:47:23.011176+00:00",
        "validTo": "2020-09-30T14:39:54.823504+00:00"
      }
    ]
  }
}

Arguments

Name Description

after (String)

before (String)

first (Int)

input (APIBrownoutInput)

Statuses to filter for. Otherwise return active and upcoming brownouts.

last (Int)

Query

query ApiBrownouts(
  $after: String,
  $before: String,
  $first: Int,
  $input: APIBrownoutInput,
  $last: Int
) {
  apiBrownouts(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last
  ) {
    edgeCount
    edges {
      ...APIBrownoutEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": APIBrownoutInput,
  "last": 10
}

Response

{
  "data": {
    "apiBrownouts": {
      "edgeCount": 61,
      "edges": APIBrownoutEdge,
      "pageInfo": PageInfo,
      "totalCount": 8
    }
  }
}

Arguments

Name Description

after (String)

before (String)

first (Int)

input (APIExceptionQueryInput)

Fields to filter for. Otherwise don't filter at all.

last (Int)

Query

query ApiExceptions(
  $after: String,
  $before: String,
  $first: Int,
  $input: APIExceptionQueryInput,
  $last: Int
) {
  apiExceptions(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last
  ) {
    edgeCount
    edges {
      ...APIExceptionConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": APIExceptionQueryInput,
  "last": 10
}

Response

{
  "data": {
    "apiExceptions": {
      "edgeCount": 58,
      "edges": APIExceptionConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 10
    }
  }
}

appSessions

Type: AppSessionConnectionTypeConnection!

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

App sessions recorded at the specified postcode or for the specified affiliate link subdomain.

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

postcode (String)

The postcode of the address at which the app session was recorded.

subdomain (String)

The affiliate link subdomain to filter app sessions by.

Query

query AppSessions(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $postcode: String,
  $subdomain: String
) {
  appSessions(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    postcode: $postcode,
    subdomain: $subdomain
  ) {
    edgeCount
    edges {
      ...AppSessionConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "postcode": "class-reason-campaign-within-girl",
  "subdomain": "whom-story-man-note-director"
}

Response

{
  "data": {
    "appSessions": {
      "edgeCount": 18,
      "edges": AppSessionConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 90
    }
  }
}

authorizedApplications

Type: [AuthorizedApplication]

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

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

Query

query AuthorizedApplications {
  authorizedApplications {
    clientId
    name
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "clientId": "40276544",
        "name": "change-tree-officer-hotel-success"
      }
    ]
  }
}

availableOfferings

Type: [OfferingType]

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

Get a list of actively available offerings from the catalog.

Query

query AvailableOfferings {
  availableOfferings {
    customerDescription
    customerName
    groups {
      ...GroupTypeFragment
    }
    identifier
    internalName
    isActive
    isAmendable
    isDraft
    isExpired
    isFirstDraft
    isLatestVersion
    isSellable
    lifecycle {
      ...LifecycleTypeFragment
    }
    offeringComponents {
      ...OfferingComponentTypeFragment
    }
    productComponents {
      ...ProductComponentTypeFragment
    }
    tags {
      ...TagTypeFragment
    }
    termTemplateComponents {
      ...TermTemplateComponentTypeFragment
    }
  }
}

Response

{
  "data": {
    "availableOfferings": [
      {
        "customerDescription": "enough-least-late-on-wall",
        "customerName": "fight-they-investment-room-its",
        "groups": [GroupType],
        "identifier": "46917135",
        "internalName": "difference-see-catch-continue-must",
        "isActive": true,
        "isAmendable": true,
        "isDraft": true,
        "isExpired": true,
        "isFirstDraft": true,
        "isLatestVersion": true,
        "isSellable": true,
        "lifecycle": LifecycleType,
        "offeringComponents": [OfferingComponentType],
        "productComponents": [ProductComponentType],
        "tags": [TagType],
        "termTemplateComponents": [TermTemplateComponentType]
      }
    ]
  }
}

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:

Arguments

Name Description

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": 61033247,
  "maxRange": 44
}

Response

{
  "data": {
    "availableProductSwitchDates": ["2018-06-15"]
  }
}

availableProducts

Type: [SupplyProductType]

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

Get available products for the given market.

The possible errors that can be raised are:

Arguments

Name Description

marketName (String!)

Products available for the target market.

Query

query AvailableProducts($marketName: String!) {
  availableProducts(marketName: $marketName) {
    availabilityStatus
    availableFrom
    availableTo
    brandCode
    code
    description
    displayName
    endsAt
    fullName
    id
    isHidden
    marketName
    notes
    params
    tags {
      ...SupplyProductTagTypeFragment
    }
    term
    termsAndConditionsTypes {
      ...TermsAndConditionsTypeFragment
    }
    termsContractType
  }
}

Variables

{
  "marketName": "money-drop-condition-account-teach"
}

Response

{
  "data": {
    "availableProducts": [
      {
        "availabilityStatus": "EVERYONE",
        "availableFrom": "1990-07-30T09:08:07.109061+00:00",
        "availableTo": "1977-10-20T23:52:52.946981+00:00",
        "brandCode": "wait-theory-rather-yard-audience",
        "code": "same-have-TV-near-success",
        "description": "trip-role-able-mention-field",
        "displayName": "range-high-goal-natural-seek",
        "endsAt": "2024-02-14T14:23:50.192709+00:00",
        "fullName": "fact-ok-charge-check-marriage",
        "id": "36949462",
        "isHidden": true,
        "marketName": "you-close-fill-leg-today",
        "notes": "coach-meet-night-store-off",
        "params": {"key": "value"},
        "tags": SupplyProductTagType,
        "term": 55,
        "termsAndConditionsTypes": TermsAndConditionsType,
        "termsContractType": "husband-write-modern-life-skin"
      }
    ]
  }
}

availableServiceDates

Type: [Date]

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

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

The possible errors that can be raised are:

Arguments

Name Description

esiId (String!)

ESI ID of meter point.

Query

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

Variables

{
  "esiId": "39664545"
}

Response

{
  "data": {
    "availableServiceDates": ["2002-08-09"]
  }
}

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

Name Description

maxVersionSupported (Int)

The maximum version of backend screens supported by the client.

params ([BackendScreenParamInputType])

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

screenId (ID!)

The ID of the screen to return.

Query

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

Variables

{
  "maxVersionSupported": 47,
  "params": BackendScreenParamInputType,
  "screenId": "89838374"
}

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": ["American-build-real-close-occur"]
  }
}

backendScreenIds

Type: [String]

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

Get all registered backend screen IDs.

Query

query BackendScreenIds {
  backendScreenIds
}

Response

{
  "data": {
    "backendScreenIds": ["city-something-glass-positive-alone"]
  }
}

Arguments

Name Description

iban (NonEmptyString!)

The IBAN of the bank account.

Query

query BankDetailsValidation($iban: NonEmptyString!) {
  bankDetailsValidation(iban: $iban) {
    areValid
    message
  }
}

Variables

{
  "iban": "key-purpose-anything-daughter-represent"
}

Response

{
  "data": {
    "bankDetailsValidation": {
      "areValid": true,
      "message": "yeah-least-remember-truth-protect"
    }
  }
}

batteryDevice

Type: BatteryDeviceType

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

The currently active battery device.

The possible errors that can be raised are:

Deprecated

The 'batteryDevice' field is deprecated.

Use `SmartFlexInverter` on `devices` query instead.

- Marked as deprecated on 2025-09-08.
- Scheduled for removal on or after 2026-03-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/676/

Arguments

Name Description

accountNumber (String!)

propertyId (Int!)

Query

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

Variables

{
  "accountNumber": "A-9E2F671F",
  "propertyId": 18741445
}

Response

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

batteryVariants

Type: [BatteryVariantsType]

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

All supported batteries and their details.

Arguments

Name Description

make (String)

Only return batteries of a specific make.

Query

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

Variables

{
  "make": "season-term-team-under-off"
}

Response

{
  "data": {
    "batteryVariants": [
      {
        "make": "natural-stop-question-edge-including",
        "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-11107: Unauthorized.
  • KT-CT-1605: Invalid input.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

details ([BusinessDetailInput])

List of business detail key-value pairs to filter by.

id (ID)

The business ID.

Query

query Business(
  $details: [BusinessDetailInput],
  $id: ID
) {
  business(
    details: $details,
    id: $id
  ) {
    billingAddress {
      ...RichAddressTypeFragment
    }
    businessType
    details {
      ...BusinessDetailTypeFragment
    }
    id
    legalAddress {
      ...RichAddressTypeFragment
    }
    linkedAccountNumbers
    name
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    sectors
    segmentName
  }
}

Variables

{
  "details": BusinessDetailInput,
  "id": "39717910"
}

Response

{
  "data": {
    "business": {
      "billingAddress": RichAddressType,
      "businessType": "SOLE_TRADER",
      "details": [BusinessDetailType],
      "id": "79212115",
      "legalAddress": RichAddressType,
      "linkedAccountNumbers": "86340553",
      "name": "rate-huge-training-mention-instead",
      "number": "behind-because-national-student-tax",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "sectors": None,
      "segmentName": "century-outside-forward-budget-back"
    }
  }
}

businessAccountReferralRewardScheme

Type: ReferralSchemeType

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

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

Arguments

Name Description

code (String!)

Friend referral code.

Query

query BusinessAccountReferralRewardScheme($code: String!) {
  businessAccountReferralRewardScheme(code: $code) {
    canBeReferred
    code
    combinedRewardAmount
    isUsageAtCapacity
    loyaltyPointsBonus
    maxRecurrence
    referralDisplayUrl
    referralUrl
    referredRewardAmount
    referrerGivenName
    referrerRewardAmount
    schemeType
  }
}

Variables

{
  "code": "hear-listen-care-glass-behavior"
}

Response

{
  "data": {
    "businessAccountReferralRewardScheme": {
      "canBeReferred": true,
      "code": "show-land-feel-watch-improve",
      "combinedRewardAmount": 9,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 30,
      "maxRecurrence": 39,
      "referralDisplayUrl": "tell-name-floor-when-scene",
      "referralUrl": "popular-under-own-yard-surface",
      "referredRewardAmount": 58,
      "referrerGivenName": "Jason",
      "referrerRewardAmount": 84,
      "schemeType": "check-purpose-including-population-weight"
    }
  }
}

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:

Arguments

Name Description

accountNumber (String)

The account number to find the business contract for.

identifier (String)

The identifier of the contract.

version (Int)

The version of the contract.

Query

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

Variables

{
  "accountNumber": "A-C8286E3B",
  "identifier": "51437645",
  "version": 65
}

Response

{
  "data": {
    "businessContract": {
      "cancelledAt": "1977-07-31T22:27:19.000892+00:00",
      "identifier": "41622340",
      "lifecycle": ContractVersion,
      "notes": [ContractNoteType],
      "party": AccountType,
      "signedAt": "1996-09-23T16:19:56.516711+00:00",
      "status": "REVOKED",
      "subject": [AccountType],
      "terms": TermInterface,
      "title": "set-performance-behind-health-nor",
      "validFrom": "2009-10-28T04:48:08.666876+00:00",
      "validTo": "2022-08-29T20:33:02.905542+00:00"
    }
  }
}

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:

Arguments

Name Description

id (ID!)

The call ID.

Query

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

Variables

{
  "id": "44981992"
}

Response

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

callTag

Type: CallTagType!

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

Get the call tag for a given ID.

The possible errors that can be raised are:

Arguments

Name Description

id (ID!)

The call tag ID.

Query

query CallTag($id: ID!) {
  callTag(id: $id) {
    id
    isActive
    name
  }
}

Variables

{
  "id": "47135286"
}

Response

{
  "data": {
    "callTag": {
      "id": "48989962",
      "isActive": true,
      "name": "question-painting-wait-us-popular"
    }
  }
}

Arguments

Name Description

after (String)

before (String)

first (Int)

isActive (Boolean)

Filter by active status.

last (Int)

name (String)

Filter by call tag name.

Query

query CallTags(
  $after: String,
  $before: String,
  $first: Int,
  $isActive: Boolean,
  $last: Int,
  $name: String
) {
  callTags(
    after: $after,
    before: $before,
    first: $first,
    isActive: $isActive,
    last: $last,
    name: $name
  ) {
    edgeCount
    edges {
      ...CallTagConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "isActive": true,
  "last": 10,
  "name": "team-drug-also-pay-society"
}

Response

{
  "data": {
    "callTags": {
      "edgeCount": 25,
      "edges": CallTagConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 43
    }
  }
}

Arguments

Name Description

accountNumber (String!)

The account number.

after (String)

before (String)

first (Int)

last (Int)

Query

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

Variables

{
  "accountNumber": "A-98CDDB75",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

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

canRescindAgreement

Type: Boolean

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

Check if an agreement can be rescinded.

The possible errors that can be raised are:

Arguments

Name Description

agreementId (Int!)

The ID of the agreement to check.

Query

query CanRescindAgreement($agreementId: Int!) {
  canRescindAgreement(agreementId: $agreementId)
}

Variables

{
  "agreementId": 79171284
}

Response

{
  "data": {
    "canRescindAgreement": true
  }
}

Query

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

Response

{
  "data": {
    "chargePointVariants": [
      {
        "make": "upon-police-change-charge-politics",
        "models": [ChargePointVariantModelType]
      }
    ]
  }
}

collectionProcessDetails

Type: CollectionProcessDetailsType

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

Collection process record details.

The possible errors that can be raised are:

  • KT-CT-1111: Unauthorized.
  • KT-CT-11201: No Collection Process Records associated with id.
  • KT-CT-11206: Unable to retrieve disconnection related data for collection process.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

collectionProcessRecordNumber (String!)

The collection process record number.

Query

query CollectionProcessDetails($collectionProcessRecordNumber: String!) {
  collectionProcessDetails(collectionProcessRecordNumber: $collectionProcessRecordNumber) {
    associatedItems {
      ...CollectionProcessRecordAssociatedItemTypeFragment
    }
    collectionProcessRecordNumber
    collectionProcessType
    completionType
    isActive
    isComplete
    isPaused
    pausedDays
    targetObjectIdentifier
  }
}

Variables

{
  "collectionProcessRecordNumber": "tend-participant-whom-film-thus"
}

Response

{
  "data": {
    "collectionProcessDetails": {
      "associatedItems": [CollectionProcessRecordAssociatedItemType],
      "collectionProcessRecordNumber": "responsibility-board-onto-range-information",
      "collectionProcessType": "ACCOUNT",
      "completionType": "center-back-wish-set-matter",
      "isActive": true,
      "isComplete": true,
      "isPaused": true,
      "pausedDays": 32,
      "targetObjectIdentifier": "76695719"
    }
  }
}

complaint

Type: ComplaintType

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

Get a complaint.

The possible errors that can be raised are:

Arguments

Name Description

complaintId (Int!)

Query

query Complaint($complaintId: Int!) {
  complaint(complaintId: $complaintId) {
    assigneeId
    contacts {
      ...ComplaintContactConnectionTypeConnectionFragment
    }
    creationDate
    id
    resolutionDate
    subtype
    type
  }
}

Variables

{
  "complaintId": 28967058
}

Response

{
  "data": {
    "complaint": {
      "assigneeId": "89346199",
      "contacts": ComplaintContactConnectionTypeConnection,
      "creationDate": "2000-04-11",
      "id": "87846751",
      "resolutionDate": "2020-11-08",
      "subtype": "very-man-same-reach-radio",
      "type": "summer-industry-detail-professional-half"
    }
  }
}

completedDispatches

Type: [UpsideDispatchType]

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

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

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-BBFAB0B6"
}

Response

{
  "data": {
    "completedDispatches": [
      {
        "delta": "1.0",
        "end": "2022-01-26T16:48:47.724737+00:00",
        "meta": UpsideDispatchMetaType,
        "start": "1996-01-05T08:48:50.144858+00:00"
      }
    ]
  }
}

consentTypes

Type: [ConsentTypeType]

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

A list of the consent types available.

Query

query ConsentTypes {
  consentTypes {
    code
    defaultValue
    description
    name
  }
}

Response

{
  "data": {
    "consentTypes": [
      {
        "code": "avoid-matter-near-drug-yard",
        "defaultValue": "ACCEPTED",
        "description": "what-statement-sing-page-weight",
        "name": "trouble-community-foreign-health-simply"
      }
    ]
  }
}

contractCreationJourney

Type: ContractCreationJourneyType

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

Get details about a contract creation journey.

The possible errors that can be raised are:

Arguments

Name Description

number (String!)

The number of the contract journey.

Query

query ContractCreationJourney($number: String!) {
  contractCreationJourney(number: $number) {
    context {
      ...ContractCreationContextFragment
    }
    contractDetails {
      ...ContractDetailsFragment
    }
    journeyType
    notes {
      ...ContractNoteTypeFragment
    }
    number
    orderReference
    requestedAt
    status
  }
}

Variables

{
  "number": "compare-oil-where-room-rather"
}

Response

{
  "data": {
    "contractCreationJourney": {
      "context": ContractCreationContext,
      "contractDetails": ContractDetails,
      "journeyType": "CONTRACT_CREATION",
      "notes": [ContractNoteType],
      "number": "difficult-civil-reflect-when-value",
      "orderReference": "go-once-cup-own-less",
      "requestedAt": "1989-08-23T02:02:22.240155+00:00",
      "status": "IN_PROGRESS"
    }
  }
}

contractNoteReasons

Type: [ContractNoteReasonType]

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

Get a list of contract note reasons, optionally filtered by activity types.

Arguments

Name Description

activityTypes ([ContractActivityTypeOptions])

Filter reasons applicable to any of the given contract activity types.

Query

query ContractNoteReasons($activityTypes: [ContractActivityTypeOptions]) {
  contractNoteReasons(activityTypes: $activityTypes) {
    activityTypes
    description
    slug
  }
}

Variables

{
  "activityTypes": "ALL_ACTIVITY_TYPES"
}

Response

{
  "data": {
    "contractNoteReasons": [
      {
        "activityTypes": "ALL_ACTIVITY_TYPES",
        "description": "help-accept-break-million-human",
        "slug": "represent-how-example-cultural-me"
      }
    ]
  }
}

contracts

Type: [Contract]

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

Get a list of contracts filtered by party or subject.

The possible errors that can be raised are:

Arguments

Name Description

filters (ContractFiltersInput!)

Filters to apply when querying contracts. At least one filter must be provided.

Query

query Contracts($filters: ContractFiltersInput!) {
  contracts(filters: $filters) {
    cancelledAt
    identifier
    lifecycle {
      ...ContractVersionFragment
    }
    notes {
      ...ContractNoteTypeFragment
    }
    party {
      ... on AccountType {
        ...AccountTypeFragment
      }
      ... on BusinessType {
        ...BusinessTypeFragment
      }
    }
    signedAt
    status
    subject {
      ...AccountTypeFragment
    }
    terms {
      ...TermInterfaceFragment
    }
    title
    validFrom
    validTo
  }
}

Variables

{
  "filters": ContractFiltersInput
}

Response

{
  "data": {
    "contracts": [
      {
        "cancelledAt": "1975-06-16T19:01:39.432057+00:00",
        "identifier": "90353289",
        "lifecycle": ContractVersion,
        "notes": [ContractNoteType],
        "party": AccountType,
        "signedAt": "1990-04-13T09:57:35.160000+00:00",
        "status": "REVOKED",
        "subject": [AccountType],
        "terms": TermInterface,
        "title": "during-coach-southern-professor-situation",
        "validFrom": "1999-02-22T03:14:19.085739+00:00",
        "validTo": "1998-02-09T17:32:35.643975+00:00"
      }
    ]
  }
}

Query

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

Response

{
  "data": {
    "contributionSchemes": [
      {
        "acceptingContributions": true,
        "code": "fight-now-parent-start-he",
        "displayName": "hand-assume-north-since-care",
        "id": "91928391",
        "taxable": true
      }
    ]
  }
}

costOfCharge

Type: [CostOfChargeType]

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

Aggregated cost of charge for an EV device.

The possible errors that can be raised are:

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 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/605/

Arguments

Name Description

accountNumber (String!)

frequency (DataFrequency!)

Frequency by day, week, month or year.

startDate (Date)

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

Query

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

Variables

{
  "accountNumber": "A-9F9C946F",
  "frequency": "DAILY",
  "startDate": "2026-01-22"
}

Response

{
  "data": {
    "costOfCharge": [
      {
        "costOfChargeId": "67225061",
        "isSmartCharge": true,
        "krakenflexDeviceId": "62645614",
        "reportDate": "2003-07-25",
        "totalConsumption": 513.8,
        "totalCostExclTax": 736.1,
        "totalCostInclTax": 153.1
      }
    ]
  }
}

creditCheckStatus

Type: CreditCheckOutputType

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

Returns the credit check status for the given account.

The possible errors that can be raised are:

  • KT-US-4111: You are not authorized to view this account's credit score status.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountNumber (String!)

Query

query CreditCheckStatus($accountNumber: String!) {
  creditCheckStatus(accountNumber: $accountNumber) {
    status
  }
}

Variables

{
  "accountNumber": "A-0457270D"
}

Response

{
  "data": {
    "creditCheckStatus": {
      "status": "PASSED"
    }
  }
}

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.

The possible errors that can be raised are:

  • KT-US-4515: Period should be less than thirteen months.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

filterBy (CurrentAndHistoricalProductPricingHistoryInput!)

Query

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

Response

{
  "data": {
    "currentAndHistoricalProductPriceHistory": [
      {
        "displayName": "sell-local-report-against-sister",
        "fullName": "chance-staff-material-audience-product",
        "priceHistory": [PricingHistory]
      }
    ]
  }
}

customerFeedbackForms

Type: CustomerFeedbackFormConnectionTypeConnection

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

Returns all active customer feedback forms for the account's brand.

Arguments

Name Description

accountNumber (String!)

The account number.

after (String)

before (String)

feedbackSource (CustomerFeedbackSourceChoices)

Feedback sources currently supported.

first (Int)

last (Int)

Query

query CustomerFeedbackForms(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $feedbackSource: CustomerFeedbackSourceChoices,
  $first: Int,
  $last: Int
) {
  customerFeedbackForms(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    feedbackSource: $feedbackSource,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...CustomerFeedbackFormConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-706BB1B1",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "feedbackSource": "FEEDBACK_SOURCE_PHONE_CALL_FOLLOW_UP",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "customerFeedbackForms": {
      "edgeCount": 83,
      "edges": CustomerFeedbackFormConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 92
    }
  }
}

dailyReadings

Type: [DailyReadingOutput]

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

Get daily readings for a meter point.

The possible errors that can be raised are:

  • KT-US-6411: Please correct the datetimes. The from_datetime argument is later than the to_datetime.
  • KT-CT-6423: Unauthorized.
  • KT-US-4010: No meter points found with the given ESI ID.
  • KT-US-4711: This account cannot access this meter point.
  • KT-US-6412: No daily readings found for the given period.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (DailyReadingInput!)

Query

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

Variables

{
  "input": DailyReadingInput
}

Response

{
  "data": {
    "dailyReadings": [
      {
        "dailyUsage": "1.0",
        "meterPointId": 11271828,
        "meterReading": "1.0",
        "readAt": "condition-help-including-particular-later",
        "source": "very-ground-interest-program-few"
      }
    ]
  }
}

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

Name Description

accountNumber (String!)

The account number of the user.

dashboardId (ID!)

The ID of the dashboard type screen to return.

ledgerNumber (String)

The ledger number associated to the account.

maxVersionSupported (Int!)

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

params ([BackendScreenParamInputType])

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

propertyId (String)

The property id associated to the account.

Query

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

Variables

{
  "accountNumber": "A-63788EF2",
  "dashboardId": "81743258",
  "ledgerNumber": "student-week-reach-share-thank",
  "maxVersionSupported": 39,
  "params": BackendScreenParamInputType,
  "propertyId": "58603117"
}

Response

{
  "data": {
    "dashboardScreen": {
      "dashboardItems": SectionType,
      "id": "26517451",
      "serialisedDashboardItems": "role-employee-have-trip-difficult",
      "typename": "important-young-call-nation-budget"
    }
  }
}

defaultPaymentInstruction

Type: PaymentInstructionType

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

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

Deprecated

The 'defaultPaymentInstruction' field is deprecated.

Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2026-07-28.

Arguments

Name Description

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
  ) {
    accountHolder
    accountType
    bankCode
    cardExpiryMonth
    cardExpiryYear
    cardNumber
    cardPaymentNetwork
    cardType
    iban
    id
    instructionType
    maskedAccountIdentifier
    owners {
      ...PaymentInstructionOwnerTypeFragment
    }
    sortCode
    status
    supplementaryLedger {
      ...SupplementaryLedgerTypeFragment
    }
    validFrom
    vendor
  }
}

Variables

{
  "accountNumber": "A-2218F254",
  "instructionType": "BPAY"
}

Response

{
  "data": {
    "defaultPaymentInstruction": {
      "accountHolder": "court-weight-decide-identify-defense",
      "accountType": "usually-result-understand-plant-leader",
      "bankCode": "without-third-resource-possible-human",
      "cardExpiryMonth": 24,
      "cardExpiryYear": 88,
      "cardNumber": "trial-until-probably-drive-bag",
      "cardPaymentNetwork": "shake-take-any-him-seat",
      "cardType": "subject-when-heavy-have-support",
      "iban": "reach-treatment-forward-indeed-different",
      "id": "21390962",
      "instructionType": "lay-between-land-serve-with",
      "maskedAccountIdentifier": "52200629",
      "owners": [PaymentInstructionOwnerType],
      "sortCode": "guy-practice-TV-almost-play",
      "status": "dream-matter-skin-she-economy",
      "supplementaryLedger": SupplementaryLedgerType,
      "validFrom": "2013-08-27T18:32:50.137894+00:00",
      "vendor": "want-value-specific-stock-certain"
    }
  }
}

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:

Arguments

Name Description

formId (Int!)

Query

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

Variables

{
  "formId": 25597086
}

Response

{
  "data": {
    "defaultRawScore": 95
  }
}

depositAgreements

Type: [DepositAgreementOutput]

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

Get deposit agreements for a given account.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Query

query DepositAgreements($accountNumber: String!) {
  depositAgreements(accountNumber: $accountNumber) {
    acceptedAt
    collectionDate
    currentEligibilityStatus {
      ...CurrentEligibilityStatusOutputFragment
    }
    depositAmount
    depositKey
    dueDate
    fulfilledAt
    returnStrategy
  }
}

Variables

{
  "accountNumber": "A-167963E2"
}

Response

{
  "data": {
    "depositAgreements": [
      {
        "acceptedAt": "2021-02-25T06:41:59.646065+00:00",
        "collectionDate": "1992-06-30",
        "currentEligibilityStatus": CurrentEligibilityStatusOutput,
        "depositAmount": 10,
        "depositKey": "late-threat-relate-about-trip",
        "dueDate": "1984-06-18",
        "fulfilledAt": "1992-04-30T22:42:30.145028+00:00",
        "returnStrategy": "it-visit-event-serve-let"
      }
    ]
  }
}

devices

Type: [SmartFlexDeviceInterface!]

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

A list of devices registered to an account.

Arguments

Name Description

accountNumber (String!)

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

deviceId (String)

Only list the device with this ID.

integrationDeviceId (String)

Only list the device with this integration device ID.

propertyId (ID)

Only list devices registered to this property.

Query

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

Variables

{
  "accountNumber": "A-E706A0AF",
  "deviceId": "33298135",
  "integrationDeviceId": "84973448",
  "propertyId": "72127672"
}

Response

{
  "data": {
    "devices": [
      {
        "alerts": SmartFlexDeviceAlertInterface,
        "deviceType": "BATTERIES",
        "id": "68081843",
        "integrationDeviceId": "31124756",
        "name": "writer-store-general-western-responsibility",
        "onboardingWizard": SmartFlexOnboardingWizard,
        "preferenceSetting": FlexDevicePreferenceSettingInterface,
        "preferences": SmartFlexDevicePreferencesInterface,
        "propertyId": "44698473",
        "provider": "BYD",
        "reAuthenticationState": DeviceReAuthenticationInterface,
        "status": SmartFlexDeviceStatusInterface
      }
    ]
  }
}

domesticAccountReferralRewardScheme

Type: ReferralSchemeType

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

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

Arguments

Name Description

code (String!)

Friend referral code.

Query

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

Variables

{
  "code": "reveal-red-important-someone-low"
}

Response

{
  "data": {
    "domesticAccountReferralRewardScheme": {
      "canBeReferred": true,
      "code": "tend-best-draw-share-send",
      "combinedRewardAmount": 84,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 19,
      "maxRecurrence": 81,
      "referralDisplayUrl": "century-doctor-former-during-heart",
      "referralUrl": "music-so-reality-season-type",
      "referredRewardAmount": 9,
      "referrerGivenName": "Daniel",
      "referrerRewardAmount": 42,
      "schemeType": "catch-hour-their-baby-there"
    }
  }
}

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

Name Description

code (String!)

Reward code for the scheme.

Query

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

Variables

{
  "code": "when-commercial-development-up-marriage"
}

Response

{
  "data": {
    "domesticJoiningRewardScheme": {
      "canBeReferred": true,
      "code": "action-deal-industry-treatment-bar",
      "combinedRewardAmount": 70,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 61,
      "maxRecurrence": 28,
      "referralDisplayUrl": "car-particularly-garden-bed-source",
      "referralUrl": "article-moment-scene-later-particularly",
      "referredRewardAmount": 25,
      "referrerGivenName": "Barbara",
      "referrerRewardAmount": 70,
      "schemeType": "purpose-mind-in-summer-policy"
    }
  }
}

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

Name Description

code (String!)

Reward code for the scheme.

Query

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

Variables

{
  "code": "message-peace-spend-eight-rise"
}

Response

{
  "data": {
    "domesticSignupRewardScheme": {
      "canBeReferred": true,
      "code": "ten-charge-necessary-edge-half",
      "combinedRewardAmount": 31,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 21,
      "maxRecurrence": 3,
      "referralDisplayUrl": "central-discuss-data-state-establish",
      "referralUrl": "assume-religious-condition-wife-along",
      "referredRewardAmount": 57,
      "referrerGivenName": "Jeanette",
      "referrerRewardAmount": 28,
      "schemeType": "phone-talk-represent-tree-week"
    }
  }
}

eflSnapshots

Type: [EFLSnapshotType]

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

Retrieve EFL snapshots.

This query returns EFL snapshots containing all data needed to render an Electricity Facts Label without additional calculations.

Usage: - Query by version to get a specific snapshot (other filters are ignored) - Or provide productCode (required) with optional filters (serviceProvider, loadZone, activeAt) - Use activeAt to find snapshots that were active at a specific date/time - If activeAt is not provided, only currently active snapshots are returned

Returns an empty list if no snapshots match the criteria (unless version is specified, which raises an error if not found).

The possible errors that can be raised are:

  • KT-US-6513: No EFL snapshot found with the given version.
  • KT-US-6514: productCode is required when version is not provided.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

activeAt (DateTime)

Filter snapshots active at this date/time (ISO-8601 format). If not provided, returns currently active snapshots.

loadZone (LoadZone)

Filter by load zone.

productCode (String)

Filter by product code. Required when version is not provided.

serviceProvider (ServiceProvider)

Filter by TDSP (Transmission/Distribution Service Provider).

version (String)

Retrieve the EFL snapshot with this exact version identifier. If provided, other filters are ignored.

Query

query EflSnapshots(
  $activeAt: DateTime,
  $loadZone: LoadZone,
  $productCode: String,
  $serviceProvider: ServiceProvider,
  $version: String
) {
  eflSnapshots(
    activeAt: $activeAt,
    loadZone: $loadZone,
    productCode: $productCode,
    serviceProvider: $serviceProvider,
    version: $version
  ) {
    activeFrom
    activeTo
    id
    loadZone
    productCode
    serviceProvider
    snapshotData {
      ...EFLSnapshotDataTypeFragment
    }
    templateVersion
    version
  }
}

Variables

{
  "activeAt": "1998-09-25T07:42:10.746404+00:00",
  "loadZone": "LZ_HOUSTON",
  "productCode": "effect-since-development-resource-military",
  "serviceProvider": "AEP_TCC",
  "version": "later-wife-enough-control-old"
}

Response

{
  "data": {
    "eflSnapshots": [
      {
        "activeFrom": "1988-03-05T16:28:52.139003+00:00",
        "activeTo": "1992-03-18T12:58:25.244469+00:00",
        "id": "10769111",
        "loadZone": "LZ_HOUSTON",
        "productCode": "despite-anything-occur-get-protect",
        "serviceProvider": "AEP_TCC",
        "snapshotData": EFLSnapshotDataType,
        "templateVersion": "treat-marriage-yet-dream-unit",
        "version": "option-war-get-dinner-argue"
      }
    ]
  }
}

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.

The possible errors that can be raised are:

Arguments

Name Description

language (EFLLanguage)

Retrieve EFLs for the given language.

loadZone (LoadZone)

Retrieve EFLs applicable in the given load zone.

productId (ID)

Retrieve EFLs for the given product id.

serviceProvider (ServiceProvider)

Retrieve EFLs for the given service provider.

Query

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

Variables

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

Response

{
  "data": {
    "efls": [
      {
        "id": "39306434",
        "language": "condition-hour-before-various-member",
        "loadZone": "LZ_HOUSTON",
        "productCode": "arm-cut-however-key-ever",
        "productDisplayName": "approach-among-relationship-down-top",
        "serviceProvider": "AEP_TCC",
        "url": "area-expert-economy-yourself-out",
        "version": "meeting-federal-southern-store-meeting"
      }
    ]
  }
}

electricVehicles

Type: [ElectricVehicleType]

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

All electric vehicle types and their details.

The possible errors that can be raised are:

  • KT-CT-4343: Unable to fetch electric vehicles list for make.
  • KT-CT-4344: Make is not supported by provider.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

isIntegrationLive (Boolean)

Only return vehicles that are currently integrated.

make (String)

Only return vehicle types for the specified make.

supportedProvider (ProviderChoices)

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

Query

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

Variables

{
  "isIntegrationLive": true,
  "make": "person-hear-task-pattern-note",
  "supportedProvider": "BYD"
}

Response

{
  "data": {
    "electricVehicles": [
      {
        "make": "prevent-together-audience-wide-range",
        "models": [ElectricVehicleModelType]
      }
    ]
  }
}

eligibilityToJoinLoyaltyPointsProgram

Type: LoyaltyPointsProgramEligibilityType

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

Check if an account is eligible to join the loyalty points program.

The possible errors that can be raised are:

Arguments

Name Description

input (LoyaltyPointsProgramEligibilityInput!)

Query

query EligibilityToJoinLoyaltyPointsProgram($input: LoyaltyPointsProgramEligibilityInput!) {
  eligibilityToJoinLoyaltyPointsProgram(input: $input) {
    isEligible
    primaryIneligibilityReason
  }
}

Variables

Response

{
  "data": {
    "eligibilityToJoinLoyaltyPointsProgram": {
      "isEligible": true,
      "primaryIneligibilityReason": "entire-everyone-game-must-interesting"
    }
  }
}

eligibleDeviceTypes

Type: [KrakenFlexDeviceTypes]

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

A list of device types that are eligible for registration.

Arguments

Name Description

accountNumber (String!)

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

propertyId (Int)

            The property's id where the device will be registered to.
            Note: in future, eligible device types will be dependent on the property id and
            it will be a required input.

Query

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

Variables

{
  "accountNumber": "A-FE0B986C",
  "propertyId": 11235812
}

Response

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

embeddedNetwork

Type: EmbeddedNetworkType

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

Get details about an embedded network.

Arguments

Name Description

id (ID!)

Query

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

Variables

{
  "id": "18800734"
}

Response

{
  "data": {
    "embeddedNetwork": {
      "embeddedProperties": [EmbeddedPropertyType],
      "id": "12200621",
      "name": "another-red-toward-green-until"
    }
  }
}

Query

query EnergyMixData {
  energyMixData {
    carbonIntensityIndex
  }
}

Response

{
  "data": {
    "energyMixData": {
      "carbonIntensityIndex": "middle-get-technology-individual-serve"
    }
  }
}

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:

Deprecated

The 'enodeLinkSession' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

accountNumber (String)

vendor (EnodeVendors)

Query

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

Variables

{
  "accountNumber": "A-279747A7",
  "vendor": "AUDI"
}

Response

{
  "data": {
    "enodeLinkSession": {
      "linkState": "design-child-alone-become-party",
      "linkUrl": "reduce-my-total-himself-offer"
    }
  }
}

externalAccountEvents

Type: ExternalAccountEventConnectionTypeConnection

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

Get a list of audit account events, of type external, for a given account.

Arguments

Name Description

accountNumber (String!)

Account number to filter by.

after (String)

before (String)

first (Int)

last (Int)

Query

query ExternalAccountEvents(
  $accountNumber: String!,
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  externalAccountEvents(
    accountNumber: $accountNumber,
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...ExternalAccountEventConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-126E48C1",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "externalAccountEvents": {
      "edgeCount": 71,
      "edges": ExternalAccountEventConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 22
    }
  }
}

flexPlannedDispatches

Type: [SmartFlexDispatch]

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

All planned device dispatches in time order.

The possible errors that can be raised are:

Arguments

Name Description

deviceId (String!)

The SmartFlex device ID to get the planned dispatches for.

Query

query FlexPlannedDispatches($deviceId: String!) {
  flexPlannedDispatches(deviceId: $deviceId) {
    end
    energyAddedKwh
    start
    type
  }
}

Variables

{
  "deviceId": "12441437"
}

Response

{
  "data": {
    "flexPlannedDispatches": [
      {
        "end": "2017-02-19T16:59:26.387830+00:00",
        "energyAddedKwh": "1.0",
        "start": "1972-06-27T03:03:01.572066+00:00",
        "type": "SMART"
      }
    ]
  }
}

flexSupportedDevices

Type: FlexSupportedDevices

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

Devices capable of being registered with SmartFlex.

Arguments

Name Description

deviceType (KrakenFlexDeviceTypes!)

The device type to get the supported devices for.

Query

query FlexSupportedDevices($deviceType: KrakenFlexDeviceTypes!) {
  flexSupportedDevices(deviceType: $deviceType) {
    deviceType
    supportedMakes {
      ...FlexSupportedMakeFragment
    }
  }
}

Variables

{
  "deviceType": "BATTERIES"
}

Response

{
  "data": {
    "flexSupportedDevices": {
      "deviceType": "BATTERIES",
      "supportedMakes": FlexSupportedMake
    }
  }
}

fraudMeterPointChecks

Type: FraudMeterPointCheckType

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

Check if a given meter point ID is in suspicious meter point IDs list.

Arguments

Name Description

meterPointId (String!)

The meter point ID.

Query

query FraudMeterPointChecks($meterPointId: String!) {
  fraudMeterPointChecks(meterPointId: $meterPointId) {
    isInSuspiciousList
    meterPointId
  }
}

Variables

{
  "meterPointId": "97291877"
}

Response

{
  "data": {
    "fraudMeterPointChecks": {
      "isInSuspiciousList": true,
      "meterPointId": "97341568"
    }
  }
}

fraudRiskLevel

Type: FinancialRiskLevelType

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

Check if a given ID and type have a financial risk level.

Arguments

Name Description

identifierType (String!)

The type of object the ID represents.

identifierValue (String!)

The ID to be checked.

Query

query FraudRiskLevel(
  $identifierType: String!,
  $identifierValue: String!
) {
  fraudRiskLevel(
    identifierType: $identifierType,
    identifierValue: $identifierValue
  ) {
    identifierType
    identifierValue
    isInRiskList
    riskLevel
  }
}

Variables

{
  "identifierType": "cover-imagine-number-top-kitchen",
  "identifierValue": "player-mind-center-run-alone"
}

Response

{
  "data": {
    "fraudRiskLevel": {
      "identifierType": "age-American-positive-left-trouble",
      "identifierValue": "47789037",
      "isInRiskList": true,
      "riskLevel": "1.0"
    }
  }
}

getAccountCheckoutInformation

Type: AccountCheckoutInformationOutput

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

Returns basic product information to finalize checkout.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountCheckoutInformationInput!)

Query

query GetAccountCheckoutInformation($input: AccountCheckoutInformationInput!) {
  getAccountCheckoutInformation(input: $input) {
    depositRequiredForPrepayProduct
    isPrepayProduct
    prepayProductBalanceThreshold
    pricePerKwh
    productId
    productName
  }
}

Variables

Response

{
  "data": {
    "getAccountCheckoutInformation": {
      "depositRequiredForPrepayProduct": true,
      "isPrepayProduct": true,
      "prepayProductBalanceThreshold": 44,
      "pricePerKwh": "1.0",
      "productId": "34659713",
      "productName": "prevent-ago-mention-central-answer"
    }
  }
}

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-4BE104B1"
}

Response

{
  "data": {
    "getAccountCreatedAt": {
      "createdAt": "1970-10-24T06:02:47.560232+00:00"
    }
  }
}

getAccountCreatedByAffiliate

Type: AccountCreatedByAffiliateOutput

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

Returns basic account information.

The possible errors that can be raised are:

Arguments

Name Description

input (AccountCreatedByAffiliateInput!)

Query

query GetAccountCreatedByAffiliate($input: AccountCreatedByAffiliateInput!) {
  getAccountCreatedByAffiliate(input: $input) {
    accountNumber
    emailAddress
    meterPointStatus
  }
}

Variables

Response

{
  "data": {
    "getAccountCreatedByAffiliate": {
      "accountNumber": "A-E3D4E7EB",
      "emailAddress": "tend-bed-bill-practice-explain",
      "meterPointStatus": "ON_SUPPLY"
    }
  }
}

getAccountReferralScheme

Type: ReferralSchemeType

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

Get active domestic referral scheme for the given account number.

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-F17E77A3"
}

Response

{
  "data": {
    "getAccountReferralScheme": {
      "canBeReferred": true,
      "code": "statement-like-mind-term-live",
      "combinedRewardAmount": 95,
      "isUsageAtCapacity": true,
      "loyaltyPointsBonus": 88,
      "maxRecurrence": 47,
      "referralDisplayUrl": "maybe-whom-north-music-check",
      "referralUrl": "suffer-professional-enjoy-hold-heavy",
      "referredRewardAmount": 34,
      "referrerGivenName": "Michael",
      "referrerRewardAmount": 65,
      "schemeType": "peace-customer-establish-table-responsibility"
    }
  }
}

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:

Arguments

Name Description

urn (String!)

Query

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

Variables

{
  "urn": "firm-glass-three-image-quite"
}

Response

{
  "data": {
    "getAccountWithUrn": {
      "accountType": "BUSINESS",
      "activeHardshipAgreements": [HardshipAgreementType],
      "activeReferralSchemes": ReferralSchemeTypes,
      "address": RichAddressType,
      "agreements": [AgreementType],
      "annualStatements": AnnualStatementConnectionTypeConnection,
      "applications": AccountApplicationConnectionTypeConnection,
      "assistanceAgreements": [AssistanceAgreementType],
      "balance": 80,
      "bill": BillInterface,
      "billingAddress": "they-start-same-him-everybody",
      "billingAddressLine1": "white-environment-coach-policy-easy",
      "billingAddressLine2": "discover-however-herself-center-open",
      "billingAddressLine3": "election-range-few-player-activity",
      "billingAddressLine4": "star-natural-discover-pretty-maintain",
      "billingAddressLine5": "author-truth-foreign-practice-chance",
      "billingAddressPostcode": "manager-trade-talk-somebody-war",
      "billingCountryCode": "standard-we-away-increase-deal",
      "billingDeliveryPointIdentifier": "39734246",
      "billingEmail": "individual-well-star-course-town",
      "billingName": "this-center-color-hotel-figure",
      "billingOptions": BillingOptionsType,
      "billingSubName": "experience-world-table-state-people",
      "bills": BillConnectionTypeConnection,
      "brand": "beautiful-property-view-hospital-economic",
      "business": BusinessType,
      "campaigns": [AccountCampaignType],
      "canModifyPayments": CanModifyPaymentsType,
      "canRequestRefund": true,
      "commsDeliveryPreference": "EMAIL",
      "complaints": ComplaintConnectionTypeConnection,
      "consentData": {"key": "value"},
      "consents": ConsentType,
      "contributionAgreements": [ContributionAgreementType],
      "createdAt": "2018-02-14T17:55:29.829935+00:00",
      "debtCollectionProceedings": [DebtCollectionProceedingType],
      "directDebitInstructions": DirectDebitInstructionConnectionTypeConnection,
      "documentAccessibility": "LARGE_PRINT",
      "events": AccountEventConnectionTypeConnection,
      "fileAttachments": [AccountFileAttachment],
      "id": "43911814",
      "isEligibleForIntelligentOctopus": true,
      "isInHardship": true,
      "isOnSupply": true,
      "isShellAccount": true,
      "ledgers": [LedgerType],
      "marketSupplyAgreements": AgreementConnection,
      "maximumRefund": MaximumRefundType,
      "metadata": [Metadata],
      "meterPointStatus": "now-war-down-people-bill",
      "notes": [AccountNoteType],
      "number": "speak-particular-for-put-there",
      "overdueBalance": 78,
      "paginatedFileAttachments": AccountFileAttachmentConnectionTypeConnection,
      "paginatedPaymentForecast": PaymentForecastConnectionTypeConnection,
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "paymentPlans": PaymentPlanConnectionTypeConnection,
      "paymentSchedules": PaymentScheduleConnectionTypeConnection,
      "payments": AccountPaymentConnectionTypeConnection,
      "portfolio": PortfolioType,
      "preferredLanguageForComms": "care-center-goal-law-drop",
      "properties": [PropertyType],
      "provisionalTransactions": ProvisionalTransactionConnectionTypeConnection,
      "references": [AccountReferenceType],
      "referrals": ReferralConnectionTypeConnection,
      "referralsCreated": 21,
      "reminders": AccountReminderConnectionTypeConnection,
      "repayments": AccountRepaymentConnectionTypeConnection,
      "requestRefundEligibility": RequestRefundEligibilityType,
      "rewards": [RewardType],
      "splitBillingAddress": ["tell-message-city-artist-already"],
      "status": "PENDING",
      "transactions": TransactionConnectionTypeConnection,
      "urn": "sport-bad-stay-direction-leader",
      "users": AccountUserType
    }
  }
}

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 {
    LMP
    SettlementPoint
    lastUpdatedAtDatetime
  }
}

Response

{
  "data": {
    "getAllRealTimeLmpData": [
      {
        "LMP": 484.98,
        "SettlementPoint": "HB_BUSAVG",
        "lastUpdatedAtDatetime": "2023-01-05T07:16:59.878369+00:00"
      }
    ]
  }
}

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 {
    discountAmount
    windGenerationPercentage
  }
}

Response

{
  "data": {
    "getFanClubDiscount": {
      "discountAmount": "1.0",
      "windGenerationPercentage": "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

Name Description

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": 49
}

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

Name Description

sort (SortByOptions)

value (Float)

Query

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

Variables

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

Response

{
  "data": {
    "getLmpValue": [
      {
        "LMP": 566.99,
        "SettlementPoint": "HB_BUSAVG",
        "lastUpdatedAtDatetime": "1980-01-10T04:47:02.245922+00:00"
      }
    ]
  }
}

Arguments

Name Description

agent (OnSiteJobsAgent!)

The agent for the appointment.

externalReference (String!)

The external reference of the appointment to return.

Query

query GetOnSiteJobsAppointmentByExternalReference(
  $agent: OnSiteJobsAgent!,
  $externalReference: String!
) {
  getOnSiteJobsAppointmentByExternalReference(
    agent: $agent,
    externalReference: $externalReference
  ) {
    agent
    appointmentActions {
      ...OnSiteJobsAppointmentActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    cancellationCategory
    cancellationSubCategory
    comments
    commsStrategy
    createdAt
    deadlineDate
    endAt
    externalJobTypeMapping {
      ...OnSiteJobsExternalJobTypeMappingTypeFragment
    }
    externalReference
    id
    jobDetails
    jobNotes
    krakenWorkCategory
    preferredStartDate
    startAt
    status
  }
}

Variables

{
  "agent": "GENERIC_AGENT",
  "externalReference": "watch-clear-job-security-mission"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentByExternalReference": {
      "agent": "GENERIC_AGENT",
      "appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "cancellationCategory": "CANCELLED_BY_CUSTOMER",
      "cancellationSubCategory": "everything-factor-second-people-one",
      "comments": "mouth-by-catch-treatment-leave",
      "commsStrategy": "SEND_ALL",
      "createdAt": "2005-05-22T02:37:09.957617+00:00",
      "deadlineDate": "2012-03-19",
      "endAt": "1972-06-26T20:53:51.450870+00:00",
      "externalJobTypeMapping": OnSiteJobsExternalJobTypeMappingType,
      "externalReference": "run-project-with-dog-work",
      "id": "305f8518-b0e0-49e4-893d-fd5020922f99",
      "jobDetails": {"key": "value"},
      "jobNotes": {"key": "value"},
      "krakenWorkCategory": "EXCHANGE",
      "preferredStartDate": "1985-02-25",
      "startAt": "2013-07-14T15:27:34.010567+00:00",
      "status": "PENDING"
    }
  }
}

Arguments

Name Description

appointmentId (UUID)

The Kraken ID of the appointment to return.

Query

query GetOnSiteJobsAppointmentById($appointmentId: UUID) {
  getOnSiteJobsAppointmentById(appointmentId: $appointmentId) {
    agent
    appointmentActions {
      ...OnSiteJobsAppointmentActionConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    cancellationCategory
    cancellationSubCategory
    comments
    commsStrategy
    createdAt
    deadlineDate
    endAt
    externalJobTypeMapping {
      ...OnSiteJobsExternalJobTypeMappingTypeFragment
    }
    externalReference
    id
    jobDetails
    jobNotes
    krakenWorkCategory
    preferredStartDate
    startAt
    status
  }
}

Variables

{
  "appointmentId": "ca1cbca8-5116-4055-9aa0-c228d32533b2"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentById": {
      "agent": "GENERIC_AGENT",
      "appointmentActions": OnSiteJobsAppointmentActionConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "cancellationCategory": "CANCELLED_BY_CUSTOMER",
      "cancellationSubCategory": "model-meeting-no-market-upon",
      "comments": "stand-lot-major-whether-impact",
      "commsStrategy": "SEND_ALL",
      "createdAt": "2003-01-11T06:17:49.581007+00:00",
      "deadlineDate": "1993-01-06",
      "endAt": "1990-11-02T08:10:37.362736+00:00",
      "externalJobTypeMapping": OnSiteJobsExternalJobTypeMappingType,
      "externalReference": "decade-region-money-certain-fire",
      "id": "06468342-8833-46f7-933b-d2f234f0a7d1",
      "jobDetails": {"key": "value"},
      "jobNotes": {"key": "value"},
      "krakenWorkCategory": "EXCHANGE",
      "preferredStartDate": "2022-08-12",
      "startAt": "1990-01-06T23:44:51.310108+00:00",
      "status": "PENDING"
    }
  }
}

getOnSiteJobsAppointmentSlots

Type: OnSiteJobsAppointmentSlotResultsType

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

Get appointment slot results using appointment booking session ID.

Arguments

Name Description

appointmentBookingSessionId (UUID!)

Appointment booking session ID to fetch slots for. ID can be obtained via startOnSiteJobsAppointmentBookingSession mutation.

appointmentDate (Date!)

Appointment date (inclusive) to fetch slots from.

Query

query GetOnSiteJobsAppointmentSlots(
  $appointmentBookingSessionId: UUID!,
  $appointmentDate: Date!
) {
  getOnSiteJobsAppointmentSlots(
    appointmentBookingSessionId: $appointmentBookingSessionId,
    appointmentDate: $appointmentDate
  ) {
    isComplete
    slots {
      ...OnSiteJobsAppointmentSlotTypeFragment
    }
  }
}

Variables

{
  "appointmentBookingSessionId": "b3e128fb-39a0-42b2-8ba0-961de552d0f3",
  "appointmentDate": "2012-04-09"
}

Response

{
  "data": {
    "getOnSiteJobsAppointmentSlots": {
      "isComplete": true,
      "slots": OnSiteJobsAppointmentSlotType
    }
  }
}

getOnSiteJobsCheckResults

Type: OnSiteJobsCheckResultsType

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

Get check results for creating requests and appointments.

Arguments

Name Description

jobType (String)

Job type for appointment checks.

supplyPointIdentifierToMarketNameMapping ([SupplyPointIdentifierToMarketNameMappingInput])

Supply point identifier to market name mapping. If this is provided, supplyPointInternalIds cannot be provided. Either one of them must be provided.

supplyPointInternalIds ([Int])

List of internal IDs of supply points. If this is provided, supplyPointIdentifierToMarketNameMapping cannot be provided. Either one of them must be provided.

Query

query GetOnSiteJobsCheckResults(
  $jobType: String,
  $supplyPointIdentifierToMarketNameMapping: [SupplyPointIdentifierToMarketNameMappingInput],
  $supplyPointInternalIds: [Int]
) {
  getOnSiteJobsCheckResults(
    jobType: $jobType,
    supplyPointIdentifierToMarketNameMapping: $supplyPointIdentifierToMarketNameMapping,
    supplyPointInternalIds: $supplyPointInternalIds
  ) {
    appointmentCheckResults {
      ...CheckResultTypeFragment
    }
    canCreateAppointment
    canCreateRequest
    hasAppointmentWarnings
    hasRequestWarnings
    requestCheckResults {
      ...CheckResultTypeFragment
    }
  }
}

Variables

{
  "jobType": "another-student-of-realize-million",
  "supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput,
  "supplyPointInternalIds": [73]
}

Response

{
  "data": {
    "getOnSiteJobsCheckResults": {
      "appointmentCheckResults": [CheckResultType],
      "canCreateAppointment": true,
      "canCreateRequest": true,
      "hasAppointmentWarnings": true,
      "hasRequestWarnings": true,
      "requestCheckResults": [CheckResultType]
    }
  }
}

getOnSiteJobsJobTypes

Type: [OnSiteJobsJobTypeType]

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

Get available job types for an on-site jobs request.

Arguments

Name Description

requestId (UUID!)

The ID of the request for which to fetch available job types.

workCategory (OnSiteJobsWorkCategory)

Work category to filter job types by. If it's left as blank, all job types will be returned.

Query

query GetOnSiteJobsJobTypes(
  $requestId: UUID!,
  $workCategory: OnSiteJobsWorkCategory
) {
  getOnSiteJobsJobTypes(
    requestId: $requestId,
    workCategory: $workCategory
  ) {
    id
    name
  }
}

Variables

{
  "requestId": "02fa1476-8c26-4e0f-b64a-529ee97af40f",
  "workCategory": "EXCHANGE"
}

Response

{
  "data": {
    "getOnSiteJobsJobTypes": [
      {
        "id": "41740676",
        "name": "analysis-south-if-allow-ask"
      }
    ]
  }
}

Arguments

Name Description

requestId (UUID)

The ID of the request to return.

Query

query GetOnSiteJobsRequestById($requestId: UUID) {
  getOnSiteJobsRequestById(requestId: $requestId) {
    account
    agent
    appointments {
      ...OnSiteJobsAppointmentConnectionTypeConnectionFragment
    }
    assets {
      ...OnSiteJobsAssetConnectionTypeConnectionFragment
    }
    comment
    createdBy
    externalReference
    id
    isEmergency
    marketSupplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
    overallActionsStatus
    property {
      ...PropertyTypeFragment
    }
    reason
    requestActions {
      ...OnSiteJobsRequestActionConnectionTypeConnectionFragment
    }
    status
    subReason
  }
}

Variables

{
  "requestId": "0f617f22-04b7-475a-b0ce-7ec99b96e0b5"
}

Response

{
  "data": {
    "getOnSiteJobsRequestById": {
      "account": "teach-adult-identify-mind-organization",
      "agent": "style-next-drive-detail-oil",
      "appointments": OnSiteJobsAppointmentConnectionTypeConnection,
      "assets": OnSiteJobsAssetConnectionTypeConnection,
      "comment": "student-four-political-concern-manage",
      "createdBy": 92,
      "externalReference": "quality-open-country-manager-foreign",
      "id": "a63375b9-37be-45eb-84d9-f5c037df9ac2",
      "isEmergency": true,
      "marketSupplyPoints": SupplyPointConnectionTypeConnection,
      "overallActionsStatus": "SKIPPED",
      "property": PropertyType,
      "reason": "affect-language-himself-yet-send",
      "requestActions": OnSiteJobsRequestActionConnectionTypeConnection,
      "status": "IN_PROGRESS",
      "subReason": "ten-view-note-least-necessary"
    }
  }
}

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

statuses ([OnSiteJobsRequestStatus])

A list of statuses to filter requests by.

supplyPointInternalIds ([Int])

List of internal IDs of supply points to filter requests by. If this is provided, supplyPointsToMarketNamesMapping cannot be provided.

supplyPointsToMarketNamesMapping ([SupplyPointIdentifierToMarketNameMappingInput])

A list of supply point identifiers to filter requests by. If this is provided, supplyPointInternalIds cannot be provided.

Query

query GetOnSiteJobsRequests(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int,
  $statuses: [OnSiteJobsRequestStatus],
  $supplyPointInternalIds: [Int],
  $supplyPointsToMarketNamesMapping: [SupplyPointIdentifierToMarketNameMappingInput]
) {
  getOnSiteJobsRequests(
    after: $after,
    before: $before,
    first: $first,
    last: $last,
    statuses: $statuses,
    supplyPointInternalIds: $supplyPointInternalIds,
    supplyPointsToMarketNamesMapping: $supplyPointsToMarketNamesMapping
  ) {
    edgeCount
    edges {
      ...OnSiteJobsRequestConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "statuses": "IN_PROGRESS",
  "supplyPointInternalIds": [36],
  "supplyPointsToMarketNamesMapping": SupplyPointIdentifierToMarketNameMappingInput
}

Response

{
  "data": {
    "getOnSiteJobsRequests": {
      "edgeCount": 35,
      "edges": OnSiteJobsRequestConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 21
    }
  }
}

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:

Arguments

Name Description

code (String!)

The selected quote's UUID code.

Query

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

Variables

{
  "code": "tend-kitchen-law-improve-better"
}

Response

{
  "data": {
    "getQuote": {
      "code": "thought-indicate-man-glass-step",
      "isExpired": true,
      "quoteId": "25841199",
      "quotedProducts": [QuotedProducts]
    }
  }
}

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:

Arguments

Name Description

code (String!)

The referral code to check.

Query

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

Variables

{
  "code": "information-card-size-imagine-rate"
}

Response

{
  "data": {
    "getReferralCodeStatus": {
      "codeType": "REFERRAL_CODE",
      "description": "place-alone-century-both-kid",
      "descriptionInSpanish": "sound-blue-hear-these-within",
      "isValid": true,
      "maxRecurrence": "view-worker-decide-hear-firm"
    }
  }
}

getReferralCompetitionStats

Type: [ReferralCompetitionStats]

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

Returns the referral competition stats.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-AC2BA543"
}

Response

{
  "data": {
    "getReferralCompetitionStats": [
      {
        "customIdentifier": "16943134",
        "numOfEntries": 850.1,
        "numOfPersonalConnectedDevices": 16,
        "numOfReferrals": 710.47,
        "numOfReferredConnectedDevices": 84,
        "rank": 46,
        "referralCode": "them-animal-upon-long-mention"
      }
    ]
  }
}

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

Name Description

settlementPoint (SettlementPointOptions!)

Returns pricing for the given settlement point.

Query

query GetSettlementPoint($settlementPoint: SettlementPointOptions!) {
  getSettlementPoint(settlementPoint: $settlementPoint) {
    LMP
    SettlementPoint
    lastUpdatedAtDatetime
  }
}

Variables

{
  "settlementPoint": "HB_BUSAVG"
}

Response

{
  "data": {
    "getSettlementPoint": {
      "LMP": 399.59,
      "SettlementPoint": "HB_BUSAVG",
      "lastUpdatedAtDatetime": "2010-04-05T17:20:25.397248+00:00"
    }
  }
}

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:

Arguments

Name Description

accountNumber (String!)

The account number to calculate stats for.

Query

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

Variables

{
  "accountNumber": "A-F539394F"
}

Response

{
  "data": {
    "getSolarContestStats": {
      "solarContestStats": [SolarContestStat],
      "statsFetchedAt": "1987-02-26T13:50:23.974037+00:00"
    }
  }
}

getSolarForecastedData

Type: AllSolarForecastedData

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

Returns solar forecasted data.

The possible errors that can be raised are:

Query

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

Response

{
  "data": {
    "getSolarForecastedData": {
      "lastUpdatedAt": "1978-10-10T22:32:48.705777+00:00",
      "solarForecastedData": [SolarForecastedData]
    }
  }
}

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 {
    lastUpdatedAt
    systemWidePriceData {
      ...SystemWidePriceFragment
    }
  }
}

Response

{
  "data": {
    "getSystemWideDayAheadPrices": {
      "lastUpdatedAt": "2024-02-12T08:31:52.787739+00:00",
      "systemWidePriceData": [SystemWidePrice]
    }
  }
}

getThermostatDetails

Type: GetThermostatDetailsOutput

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

The possible errors that can be raised are:

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-12-01.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/us/octopus-energy/571/

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-5EAB74E2"
}

Response

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

Arguments

Name Description

after (String)

before (String)

code ([String])

Code of the products to filter by.

first (Int)

last (Int)

marketName (String!)

Market name of the products to list.

productType ([String])

Types of the products to filter by.

Query

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

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "code": ["old-not-attention-this-good"],
  "first": 10,
  "last": 10,
  "marketName": "by-tree-increase-change-important",
  "productType": ["meeting-subject-start-address-its"]
}

Response

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

Arguments

Name Description

accountNumber (String!)

The account number.

Query

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

Variables

{
  "accountNumber": "A-9935B989"
}

Response

{
  "data": {
    "goodsPurchases": [
      {
        "clientParams": {"key": "value"},
        "code": "picture-easy-investment-structure-turn",
        "goodsGrants": [GoodsGrant],
        "goodsSaleItems": [GoodsSaleItem],
        "ledgerNumber": "development-important-concern-resource-effort",
        "marketName": "outside-improve-page-story-air",
        "marketParams": {"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.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String)

The account number.

quoteCode (String)

The quote code.

Query

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

Variables

{
  "accountNumber": "A-AE34A6A9",
  "quoteCode": "laugh-now-reach-popular-eat"
}

Response

{
  "data": {
    "goodsQuotes": [
      {
        "code": "majority-travel-position-conference-inside",
        "goodsQuotedProducts": [GoodsQuotedProduct],
        "hasQuoteExpired": true,
        "id": "15949282",
        "quotedAt": "2002-01-28T18:39:15.356112+00:00",
        "totalNetAmount": 51
      }
    ]
  }
}

Query

query InboundCallAverageWaitTime {
  inboundCallAverageWaitTime {
    recent
    yesterday
  }
}

Response

{
  "data": {
    "inboundCallAverageWaitTime": {
      "recent": 99,
      "yesterday": 36
    }
  }
}

inkCommsTemplate

Type: String!

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

Fetch the content of a given comms template name.

The possible errors that can be raised are:

Arguments

Name Description

templateIdentifier (String!)

The identifier of the comms template.

Query

query InkCommsTemplate($templateIdentifier: String!) {
  inkCommsTemplate(templateIdentifier: $templateIdentifier)
}

Variables

{
  "templateIdentifier": "66601173"
}

Response

{
  "data": {
    "inkCommsTemplate": "drive-left-can-box-establish"
  }
}

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:

Arguments

Name Description

accountNumber (String)

The account number.

conversationRelayId (String)

The conversation's relay id.

Query

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

Variables

{
  "accountNumber": "A-39AB57AC",
  "conversationRelayId": "66409066"
}

Response

{
  "data": {
    "inkConversation": {
      "accountNumber": "A-91A42CC6",
      "accountUsers": [AccountUserType],
      "buckets": [InkBucket],
      "contactChannelIdentities": InkContactChannelIdentities,
      "events": InkConversationEventsConnection,
      "id": "69164686",
      "status": "OPEN",
      "tags": [InkTag]
    }
  }
}

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:

Arguments

Name Description

messageRelayId (String!)

The message's relay id.

Query

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

Variables

{
  "messageRelayId": "42314441"
}

Response

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

inkMessageAttributes

Type: InkMessageAttributes!

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

Get attributes of a message at time of query.

The possible errors that can be raised are:

Arguments

Name Description

vendor (String!)

The message's vendor.

vendorId (String!)

The message's vendor id.

Query

query InkMessageAttributes(
  $vendor: String!,
  $vendorId: String!
) {
  inkMessageAttributes(
    vendor: $vendor,
    vendorId: $vendorId
  ) {
    accountType
    accounts
    buckets
    conversationId
    hourOccurredAt
    hoursWaiting
    isAssignedToUserBucket
    isFirstFromContact
    isNewThread
    opsTeam
    recentlyReceivedAutoReplies
    replyToCommsSms
    weekDayOccurredAt
  }
}

Variables

{
  "vendor": "American-wonder-foreign-from-next",
  "vendorId": "25347961"
}

Response

{
  "data": {
    "inkMessageAttributes": {
      "accountType": "change-have-resource-western-conference",
      "accounts": "dinner-shake-order-visit-minute",
      "buckets": ["control-south-different-about-federal"],
      "conversationId": 42827750,
      "hourOccurredAt": 99,
      "hoursWaiting": 35,
      "isAssignedToUserBucket": true,
      "isFirstFromContact": true,
      "isNewThread": true,
      "opsTeam": "travel-interview-risk-but-style",
      "recentlyReceivedAutoReplies": "imagine-pattern-difficult-politics-bag",
      "replyToCommsSms": "father-here-environmental-black-under",
      "weekDayOccurredAt": 4
    }
  }
}

inkMessageTextContent

Type: String!

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

Fetch the text content of a given message.

The possible errors that can be raised are:

Arguments

Name Description

messageId (ID!)

The message's id or relay id.

Query

query InkMessageTextContent($messageId: ID!) {
  inkMessageTextContent(messageId: $messageId)
}

Variables

{
  "messageId": "19843037"
}

Response

{
  "data": {
    "inkMessageTextContent": "main-report-which-two-go"
  }
}

Arguments

Name Description

after (String)

before (String)

first (Int)

last (Int)

Query

query InternalCompanies(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  internalCompanies(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    edgeCount
    edges {
      ...InternalCompanyConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10
}

Response

{
  "data": {
    "internalCompanies": {
      "edgeCount": 73,
      "edges": InternalCompanyConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 93
    }
  }
}

internalCompany

Type: InternalCompanyType

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

Get an internal company by a set of criteria. Criteria will be added as needed, check documentation for the criteria object to see what is currently supported.

The possible errors that can be raised are:

Arguments

Name Description

criteria (SearchCriteriaInput!)

Criteria to identify the internal company.

Query

query InternalCompany($criteria: SearchCriteriaInput!) {
  internalCompany(criteria: $criteria) {
    displayableNumber
    id
    legalAddress {
      ...RichAddressTypeFragment
    }
    name
    primaryRegistrationNumber
    primaryTaxIdentifierNumber
    secondaryRegistrationNumber
  }
}

Variables

{
  "criteria": SearchCriteriaInput
}

Response

{
  "data": {
    "internalCompany": {
      "displayableNumber": "than-perform-rest-value-physical",
      "id": "31616896",
      "legalAddress": RichAddressType,
      "name": "chance-door-stage-catch-stay",
      "primaryRegistrationNumber": "prepare-along-with-trouble-player",
      "primaryTaxIdentifierNumber": "order-hold-imagine-operation-radio",
      "secondaryRegistrationNumber": "crime-ever-throw-camera-create"
    }
  }
}

intervalReadings

Type: [IntervalReadingOutput]

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

15 minute interval readings for a meter point.

The possible errors that can be raised are:

Arguments

Name Description

input (IntervalReadingInput!)

Query

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

Variables

{
  "input": IntervalReadingInput
}

Response

{
  "data": {
    "intervalReadings": [
      {
        "consumption": "1.0",
        "fromDatetime": "2015-03-26T08:56:15.019527+00:00",
        "meterPointId": 37600701,
        "price": "1.0",
        "toDatetime": "1984-07-29T17:40:50.783832+00:00"
      }
    ]
  }
}

isAutopayEnabled

Type: AutoPayOutputType

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

Returns whether autopay is enabled for the given account.

Arguments

Name Description

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": "A-CB067A04",
  "considerFutureSchedule": true
}

Response

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

isCustomerEligibleToGiveFeedbackFollowingCall

Type: Boolean

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

Check if customer is eligible to give feedback following a phone call.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

callId (Int!)

ID of the voice call.

Query

query IsCustomerEligibleToGiveFeedbackFollowingCall(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $callId: Int!
) {
  isCustomerEligibleToGiveFeedbackFollowingCall(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    callId: $callId
  )
}

Variables

{
  "accountNumber": "A-CB89F02D",
  "accountUserNumber": "U-A62488AA",
  "callId": 60597780
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingCall": true
  }
}

isCustomerEligibleToGiveFeedbackFollowingEmail

Type: Boolean

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

Check if customer is eligible to give feedback following an email conversation.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Number of the account.

accountUserNumber (String!)

Number of the account user.

conversationClosedAt (DateTime!)

Datetime when the conversation was closed.

inkConversationId (Int!)

ID of the Ink conversation.

Query

query IsCustomerEligibleToGiveFeedbackFollowingEmail(
  $accountNumber: String!,
  $accountUserNumber: String!,
  $conversationClosedAt: DateTime!,
  $inkConversationId: Int!
) {
  isCustomerEligibleToGiveFeedbackFollowingEmail(
    accountNumber: $accountNumber,
    accountUserNumber: $accountUserNumber,
    conversationClosedAt: $conversationClosedAt,
    inkConversationId: $inkConversationId
  )
}

Variables

{
  "accountNumber": "A-D9630EF7",
  "accountUserNumber": "U-E952AAF0",
  "conversationClosedAt": "2001-07-04T08:14:28.757185+00:00",
  "inkConversationId": 81924124
}

Response

{
  "data": {
    "isCustomerEligibleToGiveFeedbackFollowingEmail": true
  }
}

isPasswordResetTokenValid

Type: Boolean

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

Check validity of a password reset token.

Arguments

Name Description

token (String!)

Password reset token to check.

userId (String!)

Base64 encoded user id.

Query

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

Variables

{
  "token": "toward-seat-style-possible-today",
  "userId": "29114609"
}

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

Name Description

postcode (String!)

The post code to check.

Query

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

Variables

{
  "postcode": "thing-company-population-board-particular"
}

Response

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

isValidSubdomain

Type: SubdomainOutput

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

Returns whether the subdomain is valid.

Arguments

Name Description

subdomain (String!)

Subdomain to check.

Query

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

Variables

{
  "subdomain": "inside-drive-put-market-individual"
}

Response

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

joinSupplierProcess

Type: JoinSupplierProcessType

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

The possible errors that can be raised are:

Arguments

Name Description

number (String!)

The join supplier process number, e.g. JS-12345678.

Query

query JoinSupplierProcess($number: String!) {
  joinSupplierProcess(number: $number) {
    contractIdentifiers
    currentProcessData {
      ...JoinSupplierProcessDataTypeFragment
    }
    id
    ledgerAssignments {
      ...JoinSupplierLedgerAssignmentConnectionTypeConnectionFragment
    }
    number
    status
    subtype
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "number": "choose-child-goal-around-type"
}

Response

{
  "data": {
    "joinSupplierProcess": {
      "contractIdentifiers": ["need-everybody-allow-spend-check"],
      "currentProcessData": JoinSupplierProcessDataType,
      "id": "56471555",
      "ledgerAssignments": JoinSupplierLedgerAssignmentConnectionTypeConnection,
      "number": "modern-project-table-floor-line",
      "status": "PENDING",
      "subtype": "argue-though-mention-kind-budget",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

Query

query KrakenVersion {
  krakenVersion {
    SHA
    isPinned
    number
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "SHA": "artist-parent-beyond-artist-low",
      "isPinned": true,
      "number": "us-group-help-however-task"
    }
  }
}

Arguments

Name Description

accountNumber (String!)

Account number.

Query

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

Variables

{
  "accountNumber": "A-852E78E9"
}

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:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-8ACCFA07"
}

Response

{
  "data": {
    "latestMoveOutDate": {
      "latestMoveOutDate": "2009-01-24T13:12:13.522158+00:00"
    }
  }
}

leadBlocklistValidations

Type: LeadBlockListValidationOutput

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

Run a blocklist validation out of some dynamic client entry types.

Arguments

Name Description

blockListEntries (LeadBlockListValidationInput)

List of client-configured black list entry types.

Query

query LeadBlocklistValidations($blockListEntries: LeadBlockListValidationInput) {
  leadBlocklistValidations(blockListEntries: $blockListEntries) {
    blockListHits
    valid
  }
}

Variables

{
  "blockListEntries": LeadBlockListValidationInput
}

Response

{
  "data": {
    "leadBlocklistValidations": {
      "blockListHits": ["military-heart-realize-success-around"],
      "valid": true
    }
  }
}

leadByNumber

Type: LeadOutput

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

Get lead details by number.

The possible errors that can be raised are:

Arguments

Name Description

number (String)

Lead number.

Query

query LeadByNumber($number: String) {
  leadByNumber(number: $number) {
    accountNumber
    assignedToAffiliateNumber
    assignedToTeam
    assignedToUser
    billingAddress {
      ...AddressOutputFragment
    }
    billingName
    billingRichAddress {
      ...RichAddressTypeFragment
    }
    brand
    consents {
      ...ConsentOutputFragment
    }
    email
    extraDetailItems {
      ...ExtraDetailFragment
    }
    familyName
    funnel {
      ...SalesFunnelFragment
    }
    givenName
    leadId
    leadType
    nationalId
    number
    phoneNumber
    salesChannel
    stage
  }
}

Variables

{
  "number": "ability-produce-clear-four-while"
}

Response

{
  "data": {
    "leadByNumber": {
      "accountNumber": "A-621A38B0",
      "assignedToAffiliateNumber": "yet-style-space-claim-look",
      "assignedToTeam": "discover-how-listen-idea-clearly",
      "assignedToUser": "remember-international-I-enter-about",
      "billingAddress": AddressOutput,
      "billingName": "until-model-too-agent-step",
      "billingRichAddress": RichAddressType,
      "brand": "next-rate-real-bar-second",
      "consents": [ConsentOutput],
      "email": "gun-last-suggest-lose-plant",
      "extraDetailItems": [ExtraDetail],
      "familyName": "Scott",
      "funnel": SalesFunnel,
      "givenName": "Brett",
      "leadId": "21631258",
      "leadType": "cultural-blue-include-easy-share",
      "nationalId": "41985039",
      "number": "capital-win-little-five-investment",
      "phoneNumber": "general-people-establish-defense-drug",
      "salesChannel": "race-discover-store-star-what",
      "stage": "best-country-current-up-again"
    }
  }
}

leads

Type: LeadsConnection

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

Fetch all leads for this Kraken, with optional filtering.

Arguments

Name Description

after (String)

before (String)

first (Int)

input (LeadsQueryInput)

Input fields for retrieving leads.

last (Int)

offset (Int)

Query

query Leads(
  $after: String,
  $before: String,
  $first: Int,
  $input: LeadsQueryInput,
  $last: Int,
  $offset: Int
) {
  leads(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last,
    offset: $offset
  ) {
    edgeCount
    edges {
      ...LeadsEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": LeadsQueryInput,
  "last": 10,
  "offset": 53
}

Response

{
  "data": {
    "leads": {
      "edgeCount": 6,
      "edges": LeadsEdge,
      "pageInfo": PageInfo,
      "totalCount": 45
    }
  }
}

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:

Arguments

Name Description

number (String)

The leave supplier process number, e.g. LS-12345678.

Query

query LeaveSupplierProcess($number: String) {
  leaveSupplierProcess(number: $number) {
    id
    number
    status
    subtype
    supplyPoints {
      ...SupplyPointConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "number": "art-whose-our-blood-usually"
}

Response

{
  "data": {
    "leaveSupplierProcess": {
      "id": "20339382",
      "number": "language-role-old-small-stock",
      "status": "PENDING",
      "subtype": "man-something-record-public-throw",
      "supplyPoints": SupplyPointConnectionTypeConnection
    }
  }
}

legacyOrderDetails

Type: LegacyOrderDetailsType

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

The possible errors that can be raised are:

Arguments

Name Description

identifier (String!)

Order identifier.

Query

query LegacyOrderDetails($identifier: String!) {
  legacyOrderDetails(identifier: $identifier) {
    order {
      ...LegacyOrderTypeFragment
    }
    resources {
      ...LegacyOrderResourceFragment
    }
    status
  }
}

Variables

{
  "identifier": "49398800"
}

Response

{
  "data": {
    "legacyOrderDetails": {
      "order": LegacyOrderType,
      "resources": [LegacyOrderResource],
      "status": "PENDING"
    }
  }
}

Arguments

Name Description

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:

Arguments

Name Description

accountNumber (String!)

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

onlyActive (Boolean)

A flag to filter out only active/current processes.

sortOrder (LifecycleProcessesSortOrder)

The chronological order in which the lifecycle processes are sorted.

Query

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

Variables

{
  "accountNumber": "A-A3350237",
  "onlyActive": true,
  "sortOrder": "ASC"
}

Response

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

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:

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

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

Variables

{
  "ledgerNumber": "vote-be-customer-force-dark"
}

Response

{
  "data": {
    "livePaymentAdequacyCalculation": {
      "averageMonthlyCharge": 23,
      "balanceAdjustment": 61,
      "consumption": ConsumptionBreakdownConnectionTypeConnection,
      "currentBalance": 66,
      "existingMonthlyAmount": 37,
      "reviewedOn": "1988-05-01",
      "suggestedNewMonthlyAmount": 56,
      "targetBalance": 52
    }
  }
}

loyaltyCards

Type: [LoyaltyCardType]

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

Get all loyalty cards for the given account user.

The possible errors that can be raised are:

  • KT-CT-5412: No account user exists with the given id.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

accountUserId (String!)

Account user id.

Query

query LoyaltyCards($accountUserId: String!) {
  loyaltyCards(accountUserId: $accountUserId) {
    id
    number
    scheme
    status
  }
}

Variables

{
  "accountUserId": "99683285"
}

Response

{
  "data": {
    "loyaltyCards": [
      {
        "id": "25079404",
        "number": "a-surface-either-rest-result",
        "scheme": "nearly-cultural-trip-subject-oil",
        "status": "method-cup-hotel-book-discuss"
      }
    ]
  }
}

loyaltyPointLedgerEntry

Type: LoyaltyPointLedgerEntryType

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

Resolve a loyalty point ledger entry.

The possible errors that can be raised are:

Arguments

Name Description

input (LoyaltyPointLedgerEntryInput!)

Query

query LoyaltyPointLedgerEntry($input: LoyaltyPointLedgerEntryInput!) {
  loyaltyPointLedgerEntry(input: $input) {
    accountNumber
    balanceBroughtForward
    balanceCarriedForward
    id
    idempotencyKey
    ledgerType
    postedAt
    reasonCode
    value
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgerEntry": {
      "accountNumber": "A-41A1CD5E",
      "balanceBroughtForward": "strong-level-opportunity-four-choice",
      "balanceCarriedForward": "foreign-form-view-not-necessary",
      "id": "13680560",
      "idempotencyKey": "eabc81e1-ebed-4bde-b5f0-8f2d5df96ce9",
      "ledgerType": "better-enjoy-among-player-enjoy",
      "postedAt": "2002-12-13T20:28:23.545502+00:00",
      "reasonCode": "behind-bit-cell-company-back",
      "value": "parent-hospital-teach-least-help"
    }
  }
}

loyaltyPointLedgers

Type: [LoyaltyPointLedgerEntryType]

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

Get the Loyalty Point ledger entries for the passed user.

The possible errors that can be raised are:

Arguments

Name Description

input (LoyaltyPointLedgersInput)

The input object for retrieving a loyalty point ledger entry.

Query

query LoyaltyPointLedgers($input: LoyaltyPointLedgersInput) {
  loyaltyPointLedgers(input: $input) {
    accountNumber
    balanceBroughtForward
    balanceCarriedForward
    id
    idempotencyKey
    ledgerType
    postedAt
    reasonCode
    value
  }
}

Variables

Response

{
  "data": {
    "loyaltyPointLedgers": [
      {
        "accountNumber": "A-56AD9CE8",
        "balanceBroughtForward": "country-middle-industry-team-democratic",
        "balanceCarriedForward": "finish-market-fine-back-throughout",
        "id": "76866015",
        "idempotencyKey": "41a83d87-014f-43d9-b54f-724daac0f812",
        "ledgerType": "party-bill-team-size-necessary",
        "postedAt": "2002-03-31T21:22:23.146499+00:00",
        "reasonCode": "base-area-almost-item-certain",
        "value": "send-believe-arrive-phone-themselves"
      }
    ]
  }
}

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-9222: Loyalty points balance query requires either accountNumber field (deprecated) or input object (preferred) with account number and optional account user id.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

input (LoyaltyPointsBalanceInput)

Query

query LoyaltyPointsBalance($input: LoyaltyPointsBalanceInput) {
  loyaltyPointsBalance(input: $input) {
    loyaltyPoints
    totalMonetaryAmount
  }
}

Variables

Response

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

metadata

Type: [Metadata]

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

Metadata for a linked object.

The possible errors that can be raised are:

Arguments

Name Description

identifier (String!)

linkedObjectType (LinkedObjectType)

Query

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

Variables

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

Response

{
  "data": {
    "metadata": [
      {
        "key": "debate-gas-only-explain-remain",
        "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:

Arguments

Name Description

identifier (String!)

key (String!)

linkedObjectType (LinkedObjectType)

Query

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

Variables

{
  "identifier": "24700300",
  "key": "nor-space-none-write-often",
  "linkedObjectType": "ACCOUNT"
}

Response

{
  "data": {
    "metadataForKey": {
      "key": "impact-great-move-couple-same",
      "value": {"key": "value"}
    }
  }
}

mfaDevices

Type: [MfaDevice]

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

Get all MFA devices for the current user.

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "break-network-mouth-artist-ever",
        "isConfirmed": true
      }
    ]
  }
}

Arguments

Name Description

id (ID!)

The ID of the object

Query

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

Variables

{
  "id": "92742632"
}

Response

{
  "data": {
    "node": {
      "id": "72918981"
    }
  }
}

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:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-61423AD5"
}

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:

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-95CF7A04"
}

Response

{
  "data": {
    "ocppDetails": {
      "url": "stop-themselves-always-do-environmental",
      "username": "kid-director-believe-just-quite"
    }
  }
}

Arguments

Name Description

identifier (ID)

The identifier of the offer to query.

Query

query OfferForQuoting($identifier: ID) {
  offerForQuoting(identifier: $identifier) {
    acceptedAt
    createdBy {
      ...ActorTypeFragment
    }
    description
    identifier
    quote {
      ...QuoteType_Fragment
    }
    rejectedAt
    validFrom
    validTo
  }
}

Variables

{
  "identifier": "42677502"
}

Response

{
  "data": {
    "offerForQuoting": {
      "acceptedAt": "2013-11-24T22:09:30.696732+00:00",
      "createdBy": ActorType,
      "description": "energy-be-perform-wait-analysis",
      "identifier": "81913709",
      "quote": QuoteType_,
      "rejectedAt": "2009-06-10T23:14:08.275914+00:00",
      "validFrom": "2004-03-17T12:19:45.072140+00:00",
      "validTo": "2016-12-11T03:53:03.727298+00:00"
    }
  }
}

Arguments

Name Description

identifier (ID)

The identifier of the offer group to query.

Query

query OfferGroupForQuoting($identifier: ID) {
  offerGroupForQuoting(identifier: $identifier) {
    createdAt
    createdBy {
      ...ActorTypeFragment
    }
    identifier
    offers {
      ...OfferTypeFragment
    }
  }
}

Variables

{
  "identifier": "75980183"
}

Response

{
  "data": {
    "offerGroupForQuoting": {
      "createdAt": "1992-12-28T21:11:55.736851+00:00",
      "createdBy": ActorType,
      "identifier": "48661271",
      "offers": [OfferType]
    }
  }
}

offering

Type: OfferingType

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

Get details about a product offering.

The possible errors that can be raised are:

  • KT-CT-12001: Product catalogue offering with given identifier not found.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

identifier (String)

The identifier of the offering to query.

Query

query Offering($identifier: String) {
  offering(identifier: $identifier) {
    customerDescription
    customerName
    groups {
      ...GroupTypeFragment
    }
    identifier
    internalName
    isActive
    isAmendable
    isDraft
    isExpired
    isFirstDraft
    isLatestVersion
    isSellable
    lifecycle {
      ...LifecycleTypeFragment
    }
    offeringComponents {
      ...OfferingComponentTypeFragment
    }
    productComponents {
      ...ProductComponentTypeFragment
    }
    tags {
      ...TagTypeFragment
    }
    termTemplateComponents {
      ...TermTemplateComponentTypeFragment
    }
  }
}

Variables

{
  "identifier": "95881478"
}

Response

{
  "data": {
    "offering": {
      "customerDescription": "could-reveal-heavy-early-somebody",
      "customerName": "side-control-it-agreement-board",
      "groups": [GroupType],
      "identifier": "97130504",
      "internalName": "subject-pattern-rather-degree-suffer",
      "isActive": true,
      "isAmendable": true,
      "isDraft": true,
      "isExpired": true,
      "isFirstDraft": true,
      "isLatestVersion": true,
      "isSellable": true,
      "lifecycle": LifecycleType,
      "offeringComponents": [OfferingComponentType],
      "productComponents": [ProductComponentType],
      "tags": [TagType],
      "termTemplateComponents": [TermTemplateComponentType]
    }
  }
}

opportunities

Type: OpportunitiesConnection

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

Fetch all opportunities for this Kraken, with optional filtering.

Arguments

Name Description

after (String)

before (String)

first (Int)

input (OpportunitiesQueryInput)

Input fields for retrieving opportunities.

last (Int)

offset (Int)

Query

query Opportunities(
  $after: String,
  $before: String,
  $first: Int,
  $input: OpportunitiesQueryInput,
  $last: Int,
  $offset: Int
) {
  opportunities(
    after: $after,
    before: $before,
    first: $first,
    input: $input,
    last: $last,
    offset: $offset
  ) {
    edgeCount
    edges {
      ...OpportunitiesEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "input": OpportunitiesQueryInput,
  "last": 10,
  "offset": 57
}

Response

{
  "data": {
    "opportunities": {
      "edgeCount": 17,
      "edges": OpportunitiesEdge,
      "pageInfo": PageInfo,
      "totalCount": 100
    }
  }
}

opportunityByNumber

Type: OpportunityOutput

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

Get opportunity details by number.

The possible errors that can be raised are:

Arguments

Name Description

number (String)

Opportunity number identifier.

Query

query OpportunityByNumber($number: String) {
  opportunityByNumber(number: $number) {
    assignedToAffiliateNumber
    assignedToTeam
    assignedToUser
    attachments {
      ...OpportunityAttachmentFragment
    }
    consents {
      ...ConsentOutputFragment
    }
    email
    extraDetailItems {
      ...ExtraDetailFragment
    }
    funnel {
      ...SalesFunnelFragment
    }
    leadNumber
    leadType
    name
    notes
    number
    offerGroupId
    opportunityAddress {
      ...AddressOutputFragment
    }
    opportunityRichAddress {
      ...RichAddressTypeFragment
    }
    phoneNumber
    productOffering {
      ...OfferingTypeFragment
    }
    productOfferingId
    salesChannel
    stage
    supplyPoints {
      ...LeadSupplyPointTypeFragment
    }
  }
}

Variables

{
  "number": "school-decide-civil-theory-force"
}

Response

{
  "data": {
    "opportunityByNumber": {
      "assignedToAffiliateNumber": "about-experience-else-plant-civil",
      "assignedToTeam": "voice-heavy-let-exactly-the",
      "assignedToUser": "someone-change-safe-land-project",
      "attachments": [OpportunityAttachment],
      "consents": [ConsentOutput],
      "email": "why-model-market-from-market",
      "extraDetailItems": [ExtraDetail],
      "funnel": SalesFunnel,
      "leadNumber": "get-account-up-drop-safe",
      "leadType": "find-hot-my-last-staff",
      "name": "blood-research-probably-can-get",
      "notes": "far-wrong-traditional-little-tough",
      "number": "everybody-side-chair-early-rest",
      "offerGroupId": "49156495",
      "opportunityAddress": AddressOutput,
      "opportunityRichAddress": RichAddressType,
      "phoneNumber": "continue-long-compare-start-strategy",
      "productOffering": OfferingType,
      "productOfferingId": "47192661",
      "salesChannel": "kitchen-continue-character-follow-manager",
      "stage": "really-environment-job-test-practice",
      "supplyPoints": [LeadSupplyPointType]
    }
  }
}

opportunityProductSummary

Type: [OpportunityProductSummary!]!

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

Return summaries of all products in opportunity's accepted offer. Supports multi-product offerings like dual fuel.

The possible errors that can be raised are:

  • KT-CT-8906: Opportunity not found.
  • KT-CT-8923: The opportunity does not have a linked offer group.
  • KT-CT-8922: The opportunity does not have an accepted offer.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

number (String)

Opportunity number.

Query

query OpportunityProductSummary($number: String) {
  opportunityProductSummary(number: $number) {
    market
    productCharacteristics
    productCode
    productIdentifier
    productOfferingIdentifier
  }
}

Variables

{
  "number": "yard-form-area-successful-history"
}

Response

{
  "data": {
    "opportunityProductSummary": [
      {
        "market": "road-local-health-yes-environment",
        "productCharacteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
        "productCode": "college-under-music-decide-happy",
        "productIdentifier": "61454981",
        "productOfferingIdentifier": "20064816"
      }
    ]
  }
}

opportunityValueByKey

Type: String

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

Get the value of a given key that is stored in an opportunity's related JSONFields.

The possible errors that can be raised are:

Arguments

Name Description

key (String)

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

opportunityId (ID)

The identifier of the opportunity to query.

Query

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

Variables

{
  "key": "after-night-whom-whole-decade",
  "opportunityId": "28059981"
}

Response

{
  "data": {
    "opportunityValueByKey": "performance-class-role-hair-debate"
  }
}

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

Name Description

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": ["turn-area-century-believe-week"]
  }
}

paymentFingerprintChecks

Type: PaymentFingerPrintCheckType

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

Check if a given payment fingerprint already exists and/or is risk-listed.

Arguments

Name Description

fingerprint (String!)

Fingerprint.

Query

query PaymentFingerprintChecks($fingerprint: String!) {
  paymentFingerprintChecks(fingerprint: $fingerprint) {
    fingerprint
    isFound
    isRiskListed
  }
}

Variables

{
  "fingerprint": "popular-buy-reveal-mouth-too"
}

Response

{
  "data": {
    "paymentFingerprintChecks": {
      "fingerprint": "traditional-that-recently-education-head",
      "isFound": true,
      "isRiskListed": true
    }
  }
}

paymentRequests

Type: PaymentRequestsType

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

Get all payment requests for the given ledger.

Arguments

Name Description

ledgerNumber (String!)

Kraken ledger number.

Query

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

Variables

{
  "ledgerNumber": "actually-white-think-world-section"
}

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.

The possible errors that can be raised are:

Deprecated

The 'plannedDispatches' field is deprecated.

Please use 'flexPlannedDispatches' instead.

- Marked as deprecated on 2025-05-27.
- Scheduled for removal on or after 2026-01-16.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/604/

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-4803FB65"
}

Response

{
  "data": {
    "plannedDispatches": [
      {
        "delta": "1.0",
        "end": "2020-06-18T23:22:02.944006+00:00",
        "meta": UpsideDispatchMetaType,
        "start": "1996-06-02T11:55:07.962461+00:00"
      }
    ]
  }
}

portfolio

Type: PortfolioType

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

Get details about a portfolio, using its portfolio number.

The possible errors that can be raised are:

Arguments

Name Description

portfolioNumber (String!)

Portfolio number to be retrieved.

Query

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

Variables

{
  "portfolioNumber": "P-37FBA520"
}

Response

{
  "data": {
    "portfolio": {
      "accounts": AccountConnectionTypeConnection,
      "ancestors": PortfolioConnectionTypeConnection,
      "billingName": "degree-goal-leave-box-federal",
      "brand": "model-choose-on-week-fall",
      "collectiveBilling": true,
      "createdAt": "2008-08-16T03:48:59.846324+00:00",
      "depth": 50,
      "descendants": PortfolioConnectionTypeConnection,
      "id": "69190888",
      "leadAccountNumber": "A-428E3D57",
      "name": "instead-college-outside-issue-friend",
      "number": "hear-anyone-common-conference-condition",
      "operationsTeam": OperationsTeamType,
      "parent": PortfolioType,
      "updatedAt": "1983-12-19T18:40:02.795155+00:00"
    }
  }
}

portfolioByReference

Type: PortfolioType

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

Get details about a portfolio, using its reference.

The possible errors that can be raised are:

Arguments

Name Description

portfolioReference (PortfolioReferenceInput!)

Portfolio reference namespace-value pair to filter by.

Query

query PortfolioByReference($portfolioReference: PortfolioReferenceInput!) {
  portfolioByReference(portfolioReference: $portfolioReference) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    ancestors {
      ...PortfolioConnectionTypeConnectionFragment
    }
    billingName
    brand
    collectiveBilling
    createdAt
    depth
    descendants {
      ...PortfolioConnectionTypeConnectionFragment
    }
    id
    leadAccountNumber
    name
    number
    operationsTeam {
      ...OperationsTeamTypeFragment
    }
    parent {
      ...PortfolioTypeFragment
    }
    updatedAt
  }
}

Variables

{
  "portfolioReference": PortfolioReferenceInput
}

Response

{
  "data": {
    "portfolioByReference": {
      "accounts": AccountConnectionTypeConnection,
      "ancestors": PortfolioConnectionTypeConnection,
      "billingName": "claim-pull-fly-whatever-worry",
      "brand": "every-until-system-seat-face",
      "collectiveBilling": true,
      "createdAt": "2003-06-25T07:08:00.648195+00:00",
      "depth": 70,
      "descendants": PortfolioConnectionTypeConnection,
      "id": "11996397",
      "leadAccountNumber": "A-4541E6C7",
      "name": "cold-suffer-management-long-weight",
      "number": "fear-right-ready-her-small",
      "operationsTeam": OperationsTeamType,
      "parent": PortfolioType,
      "updatedAt": "1970-10-10T14:03:27.453330+00:00"
    }
  }
}

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:

Arguments

Name Description

input (PossibleErrorsInputType!)

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

Query

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

Variables

Response

{
  "data": {
    "possibleErrors": {
      "authErrors": true,
      "name": "argue-cultural-room-live-current",
      "possibleErrors": [PossibleErrorType],
      "type": "query"
    }
  }
}

printBatch

Type: PrintBatchType!

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

Get print batch details, including messages in the batch.

The possible errors that can be raised are:

Arguments

Name Description

batchId (ID)

The print batch ID.

Query

query PrintBatch($batchId: ID) {
  printBatch(batchId: $batchId) {
    id
    messages {
      ...PrintMessageTypeConnectionFragment
    }
    status
  }
}

Variables

{
  "batchId": "34232533"
}

Response

{
  "data": {
    "printBatch": {
      "id": "76250540",
      "messages": PrintMessageTypeConnection,
      "status": "OPEN"
    }
  }
}

products

Type: [ProductType]

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

Get all available electricity products.

Arguments

Name Description

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).

basedOnTimeOfUse (Boolean)

Get products that have the Time of Use flag.

displayName (String)

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

id (ID)

ID of the product.

prepay (Boolean)

Get products that have the Prepay flag.

Query

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

Variables

{
  "availableAt": "2006-05-29T23:05:31.005275+00:00",
  "basedOnTimeOfUse": true,
  "displayName": "call-space-they-her-season",
  "id": "31580083",
  "prepay": true
}

Response

{
  "data": {
    "products": [
      {
        "autoTopUpDefaultAmount": 35,
        "autoTopUpMinimumAmount": 51,
        "availabilityStatus": "PUBLIC",
        "availableFrom": "1994-12-24T10:15:45.164789+00:00",
        "availableTo": "1980-02-17T03:27:18.128495+00:00",
        "basedOnTimeOfUse": true,
        "code": "network-sign-technology-can-citizen",
        "description": "effort-result-onto-enough-beautiful",
        "displayName": "positive-line-scientist-number-ever",
        "endsAt": "1973-10-25T18:45:24.585972+00:00",
        "fullName": "season-oil-mention-simply-sit",
        "generationCredit": true,
        "id": "35889814",
        "ioDiscountEnabled": true,
        "isWholesale": true,
        "marketName": "tonight-I-political-success-action",
        "notes": "crime-leader-site-will-also",
        "prepay": true,
        "rates": RatesType,
        "term": 48,
        "termsContractType": "down-structure-describe-nothing-old"
      }
    ]
  }
}

productsWithConciseApplicableRates

Type: [ProductWithRatesOutput]

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

Get all available electricity products with concise rates.

Arguments

Name Description

filterProductsBy (ProductInput)

Query

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

Variables

{
  "filterProductsBy": ProductInput
}

Response

{
  "data": {
    "productsWithConciseApplicableRates": [
      {
        "code": "remember-year-doctor-physical-loss",
        "consolidatedRates": [ConciseRatesOutput],
        "description": "force-apply-good-certainly-sound",
        "displayName": "purpose-family-see-leg-decision",
        "fullName": "for-social-fund-price-spend",
        "id": "41259246",
        "prepay": true,
        "rates": [ConciseRatesOutput],
        "term": 59
      }
    ]
  }
}

properties

Type: [PropertyType]

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

Properties linked to the account now and in the future.

The possible errors that can be raised are:

Arguments

Name Description

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
  ) {
    address
    addressLine1
    addressLine2
    addressLine3
    addressLine4
    addressLine5
    ancestors {
      ...PropertyConnectionFragment
    }
    coordinates {
      ...CoordinatesTypeFragment
    }
    descendants {
      ...PropertyConnectionFragment
    }
    embeddedNetwork {
      ...EmbeddedNetworkTypeFragment
    }
    id
    label
    measurements {
      ...MeasurementConnectionFragment
    }
    meterPoints {
      ...ElectricityMeterPointTypeFragment
    }
    occupancyPeriods {
      ...OccupancyPeriodTypeFragment
    }
    parent {
      ...PropertyInterfaceFragment
    }
    postcode
    richAddress {
      ...PropertyRichAddressTypeFragment
    }
    splitAddress
  }
}

Variables

{
  "accountNumber": "A-77FE49AD",
  "activeFrom": "1985-01-06T22:38:00.546652+00:00"
}

Response

{
  "data": {
    "properties": [
      {
        "address": "purpose-west-prevent-it-do",
        "addressLine1": "bank-my-trouble-far-federal",
        "addressLine2": "never-party-lay-key-wife",
        "addressLine3": "street-Republican-specific-current-admit",
        "addressLine4": "bar-at-effect-lot-risk",
        "addressLine5": "accept-expect-amount-from-step",
        "ancestors": PropertyConnection,
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "embeddedNetwork": EmbeddedNetworkType,
        "id": "32188134",
        "label": "prevent-provide-serious-travel-start",
        "measurements": MeasurementConnection,
        "meterPoints": [ElectricityMeterPointType],
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "have-treatment-total-newspaper-finish",
        "richAddress": PropertyRichAddressType,
        "splitAddress": ["itself-fall-perform-age-game"]
      }
    ]
  }
}

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

Name Description

searchTerm (String!)

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

Query

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

Variables

{
  "searchTerm": "bank-fire-address-goal-become"
}

Response

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

property

Type: PropertyType

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

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

The possible errors that can be raised are:

Arguments

Name Description

id (ID!)

The property ID.

Query

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

Variables

{
  "id": "58539998"
}

Response

{
  "data": {
    "property": {
      "address": "yourself-deep-large-represent-with",
      "addressLine1": "could-believe-evening-moment-arm",
      "addressLine2": "avoid-raise-line-follow-military",
      "addressLine3": "fly-tell-if-major-company",
      "addressLine4": "employee-how-me-line-officer",
      "addressLine5": "drive-voice-Democrat-which-if",
      "ancestors": PropertyConnection,
      "coordinates": CoordinatesType,
      "descendants": PropertyConnection,
      "embeddedNetwork": EmbeddedNetworkType,
      "id": "87286052",
      "label": "customer-participant-government-these-realize",
      "measurements": MeasurementConnection,
      "meterPoints": [ElectricityMeterPointType],
      "occupancyPeriods": [OccupancyPeriodType],
      "parent": PropertyInterface,
      "postcode": "series-physical-blood-ability-put",
      "richAddress": PropertyRichAddressType,
      "splitAddress": ["receive-magazine-pull-without-either"]
    }
  }
}

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

Name Description

searchTerm (String!)

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

Query

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

Variables

{
  "searchTerm": "sea-fast-poor-experience-cell"
}

Response

{
  "data": {
    "propertySearch": [
      {
        "address": "put-over-really-run-culture",
        "addressLine1": "population-yeah-break-until-describe",
        "addressLine2": "area-new-beyond-unit-crime",
        "addressLine3": "figure-note-month-same-president",
        "addressLine4": "not-second-wife-Democrat-daughter",
        "addressLine5": "play-return-than-money-simply",
        "ancestors": PropertyConnection,
        "coordinates": CoordinatesType,
        "descendants": PropertyConnection,
        "embeddedNetwork": EmbeddedNetworkType,
        "id": "68796048",
        "label": "wrong-special-game-general-commercial",
        "measurements": MeasurementConnection,
        "meterPoints": [ElectricityMeterPointType],
        "occupancyPeriods": [OccupancyPeriodType],
        "parent": PropertyInterface,
        "postcode": "natural-sound-wife-benefit-since",
        "richAddress": PropertyRichAddressType,
        "splitAddress": ["wind-letter-section-just-service"]
      }
    ]
  }
}

providerAuthDetails

Type: ProviderAuthDetailsType

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

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

Deprecated

The 'providerAuthDetails' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

accountNumber (String)

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

clientType (ClientType)

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

deviceType (KrakenFlexDeviceTypes!)

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

propertyId (Int)

The ID of the property the device belongs to.

provider (ProviderChoices!)

The provider to get the auth details for.

Query

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

Variables

{
  "accountNumber": "A-6E6CE4ED",
  "clientType": "APP",
  "deviceType": "BATTERIES",
  "propertyId": 44848965,
  "provider": "BYD"
}

Response

{
  "data": {
    "providerAuthDetails": {
      "oauthUri": "game-occur-development-gas-serve"
    }
  }
}

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

Name Description

deviceType (KrakenFlexDeviceTypes!)

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

provider (ProviderChoices!)

The provider to get the virtual key details for.

Query

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

Variables

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

Response

{
  "data": {
    "providerVirtualKeyDetails": {
      "virtualKeyName": "ten-knowledge-treat-couple-more",
      "virtualKeyUri": "stay-treatment-magazine-time-sign"
    }
  }
}

Arguments

Name Description

input (QueryComplexityInputType!)

Query and relevant variables required to calculate the complexity.

Query

query QueryComplexity($input: QueryComplexityInputType!) {
  queryComplexity(input: $input) {
    complexityValue
  }
}

Variables

Response

{
  "data": {
    "queryComplexity": {
      "complexityValue": 100
    }
  }
}

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:

Arguments

Name Description

formId (Int!)

Query

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

Variables

{
  "formId": 23943328
}

Response

{
  "data": {
    "question": "enter-though-remember-third-loss"
  }
}

quotingParamDefinitionsForProductOffering

Type: QuotedOfferingParamsType

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

The possible errors that can be raised are:

Arguments

Name Description

productOfferingIdentifier (ID)

The identifier of the product offering.

Query

query QuotingParamDefinitionsForProductOffering($productOfferingIdentifier: ID) {
  quotingParamDefinitionsForProductOffering(productOfferingIdentifier: $productOfferingIdentifier) {
    offeringComponents {
      ...QuotedOfferingParamsTypeFragment
    }
    offeringIdentifier
    productComponents {
      ...QuotedProductComponentTypeFragment
    }
  }
}

Variables

{
  "productOfferingIdentifier": "79128152"
}

Response

{
  "data": {
    "quotingParamDefinitionsForProductOffering": {
      "offeringComponents": [QuotedOfferingParamsType],
      "offeringIdentifier": "18504589",
      "productComponents": [QuotedProductComponentType]
    }
  }
}

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 {
    fieldSpecificRateLimits {
      ...FieldSpecificRateLimitInformationConnectionTypeConnectionFragment
    }
    pointsAllowanceRateLimit {
      ...PointsAllowanceRateLimitInformationFragment
    }
  }
}

Response

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

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:

Deprecated

The 'registeredKrakenflexDevice' field is deprecated.

Please use 'devices' instead.

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

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/677/

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-E82833F3"
}

Response

{
  "data": {
    "registeredKrakenflexDevice": {
      "chargePointMake": "human-foreign-she-decide-order",
      "chargePointModel": "dinner-possible-whom-especially-military",
      "chargePointPowerInKw": "1.0",
      "createdAt": "2019-01-14T20:42:31.337394+00:00",
      "hasToken": true,
      "krakenflexDeviceId": "48820610",
      "provider": "BYD",
      "stateOfChargeLimit": StateOfChargeLimit,
      "status": "car-body-prove-action-foot",
      "suspended": true,
      "testDispatchFailureReason": "NONE",
      "vehicleBatterySizeInKwh": "1.0",
      "vehicleMake": "strategy-return-ten-easy-against",
      "vehicleModel": "truth-majority-theory-road-paper"
    }
  }
}

returnSchedule

Type: [DepositReturnScheduleOutput]

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

Get deposit agreement related return schedules for a given account.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

Query

query ReturnSchedule($accountNumber: String!) {
  returnSchedule(accountNumber: $accountNumber) {
    amount
    dueDate
    status
  }
}

Variables

{
  "accountNumber": "A-DFE23541"
}

Response

{
  "data": {
    "returnSchedule": [
      {
        "amount": 2,
        "dueDate": "1975-02-01",
        "status": "company-follow-moment-including-society"
      }
    ]
  }
}

routingAttributes

Type: [RoutingAttributeType]!

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

Get routing attributes available for call routing configuration.

The possible errors that can be raised are:

Arguments

Name Description

category (String)

Filter by category (LANGUAGE, OPERATIONS_GROUP, SKILL).

search (String)

Filter by friendly name (case-insensitive).

Query

query RoutingAttributes(
  $category: String,
  $search: String
) {
  routingAttributes(
    category: $category,
    search: $search
  ) {
    category
    friendlyName
    isActive
    ref
    subcategory
  }
}

Variables

{
  "category": "across-win-begin-notice-media",
  "search": "fact-condition-lawyer-my-plan"
}

Response

{
  "data": {
    "routingAttributes": [
      {
        "category": "senior-member-measure-social-work",
        "friendlyName": "a-defense-movement-light-more",
        "isActive": true,
        "ref": "security-leader-society-as-gas",
        "subcategory": "nature-yet-movement-purpose-office"
      }
    ]
  }
}

salesFunnelByCode

Type: SalesFunnel

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

Get the sales funnel by input.

The possible errors that can be raised are:

Arguments

Name Description

input (SalesFunnelInput!)

Input fields for retrieving the sales funnel.

Query

query SalesFunnelByCode($input: SalesFunnelInput!) {
  salesFunnelByCode(input: $input) {
    code
    collections {
      ...CollectionFragment
    }
    funnelType
    name
    rules {
      ...SalesFunnelRuleFragment
    }
    stages {
      ...SalesFunnelStageFragment
    }
    status
    uncollectedFields {
      ...FunnelFieldFragment
    }
  }
}

Variables

{
  "input": SalesFunnelInput
}

Response

{
  "data": {
    "salesFunnelByCode": {
      "code": "course-security-statement-hit-relate",
      "collections": [Collection],
      "funnelType": "LEAD",
      "name": "car-because-like-gun-appear",
      "rules": [SalesFunnelRule],
      "stages": [SalesFunnelStage],
      "status": "DRAFT",
      "uncollectedFields": [FunnelField]
    }
  }
}

Arguments

Name Description

input (SalesFunnelsInput)

Input fields for retrieving the sales funnels.

Query

query SalesFunnels($input: SalesFunnelsInput) {
  salesFunnels(input: $input) {
    code
    collections {
      ...CollectionFragment
    }
    funnelType
    name
    rules {
      ...SalesFunnelRuleFragment
    }
    stages {
      ...SalesFunnelStageFragment
    }
    status
    uncollectedFields {
      ...FunnelFieldFragment
    }
  }
}

Variables

{
  "input": SalesFunnelsInput
}

Response

{
  "data": {
    "salesFunnels": [
      {
        "code": "he-degree-send-film-mean",
        "collections": [Collection],
        "funnelType": "LEAD",
        "name": "American-dinner-crime-top-stuff",
        "rules": [SalesFunnelRule],
        "stages": [SalesFunnelStage],
        "status": "DRAFT",
        "uncollectedFields": [FunnelField]
      }
    ]
  }
}

searchLead

Type: LeadIdType

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

Search and return the identifiers of a lead.

The possible errors that can be raised are:

Arguments

Name Description

filters (SearchLeadFilters!)

Filters to search for leads. All passed filters will be checked against the lead.

Query

query SearchLead($filters: SearchLeadFilters!) {
  searchLead(filters: $filters) {
    number
  }
}

Variables

{
  "filters": SearchLeadFilters
}

Response

{
  "data": {
    "searchLead": {
      "number": "perform-sound-happy-industry-before"
    }
  }
}

siteworksRequests

Type: CoreSiteworksRequestConnectionTypeConnection

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

A query to get a subset of Requests.

Deprecated

The 'siteworksRequests' field is deprecated.

Please use getOnSiteJobsRequests instead.

- Marked as deprecated on 2026-03-01.
- Scheduled for removal on or after 2026-09-01.

Arguments

Name Description

after (String)

before (String)

createdAfter (DateTime)

Only requests created after this datetime will be included.

first (Int)

ids ([UUID])

A list of request IDs. If provided, only these requests will be returned.

last (Int)

statuses ([RequestStatus])

Only requests with a status in this list will be included.

Query

query SiteworksRequests(
  $after: String,
  $before: String,
  $createdAfter: DateTime,
  $first: Int,
  $ids: [UUID],
  $last: Int,
  $statuses: [RequestStatus]
) {
  siteworksRequests(
    after: $after,
    before: $before,
    createdAfter: $createdAfter,
    first: $first,
    ids: $ids,
    last: $last,
    statuses: $statuses
  ) {
    edgeCount
    edges {
      ...CoreSiteworksRequestConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "createdAfter": "2013-04-11T12:42:08.016124+00:00",
  "first": 10,
  "ids": ["82a091a2-fe61-4d7d-9871-a12cfe0a18a7"],
  "last": 10,
  "statuses": "APPROVAL_PENDING"
}

Response

{
  "data": {
    "siteworksRequests": {
      "edgeCount": 53,
      "edges": CoreSiteworksRequestConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 15
    }
  }
}

Arguments

Name Description

smartFlexDeviceId (String)

The SmartFlex device ID to get the supply point details for.

Query

query SmartFlexDeviceSupplyPoint($smartFlexDeviceId: String) {
  smartFlexDeviceSupplyPoint(smartFlexDeviceId: $smartFlexDeviceId) {
    importSupplyPointId
    smartFlexDeviceId
  }
}

Variables

{
  "smartFlexDeviceId": "90693574"
}

Response

{
  "data": {
    "smartFlexDeviceSupplyPoint": {
      "importSupplyPointId": "94707666",
      "smartFlexDeviceId": "60095434"
    }
  }
}

smartFlexOnboardingWizards

Type: [SmartFlexOnboardingWizard!]

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

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

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (String!)

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

includeCancelled (Boolean)

Include cancelled wizards.

includeCompleted (Boolean)

Include completed wizards.

isResumable (Boolean)

Filters for onboarding wizards that can be resumed. List limits to one resumable wizard.

propertyId (Int)

Only list wizards for this property.

wizardId (ID)

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

Query

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

Variables

{
  "accountNumber": "A-ABFDD29F",
  "includeCancelled": true,
  "includeCompleted": true,
  "isResumable": true,
  "propertyId": 31456362,
  "wizardId": "58991699"
}

Response

{
  "data": {
    "smartFlexOnboardingWizards": [
      {
        "backendScreen": ComponentListType,
        "completedSteps": SmartFlexOnboardingStepInterface,
        "currentStep": SmartFlexOnboardingStepInterface,
        "deviceType": "BATTERIES",
        "displayName": "why-others-happen-quite-response",
        "id": "41625226",
        "resumable": SmartFlexResumable
      }
    ]
  }
}

supplyPoint

Type: SupplyPointType

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

Get a supply point by its market specific id.

The possible errors that can be raised are:

  • KT-CT-4722: Supply point readings API not configured.
  • KT-CT-4719: No supply point found for identifier provided.
  • KT-CT-4723: Invalid market name provided.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

externalIdentifier (String!)

The market specific supply point id.

marketName (String!)

The name of the market in which this supply point exists.

Query

query SupplyPoint(
  $externalIdentifier: String!,
  $marketName: String!
) {
  supplyPoint(
    externalIdentifier: $externalIdentifier,
    marketName: $marketName
  ) {
    devices {
      ...DevicesConnectionFragment
    }
    externalIdentifier
    id
    marketName
    property {
      ...PropertyTypeFragment
    }
    readings {
      ...ReadingsFragment
    }
  }
}

Variables

{
  "externalIdentifier": "61365325",
  "marketName": "test-than-box-fill-his"
}

Response

{
  "data": {
    "supplyPoint": {
      "devices": DevicesConnection,
      "externalIdentifier": "25087935",
      "id": "99487606",
      "marketName": "glass-technology-minute-tree-above",
      "property": PropertyType,
      "readings": Readings
    }
  }
}

Arguments

Name Description

accountNumber (String)

Filter meter points by account.

after (String)

before (String)

first (Int)

last (Int)

portfolioNumber (String)

Filter meter points by portfolio.

Query

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

Variables

{
  "accountNumber": "A-7BCD01B5",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "first": 10,
  "last": 10,
  "portfolioNumber": "P-49D9454F"
}

Response

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

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:

Arguments

Name Description

accountNumber (String!)

taskId (String!)

Query

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

Variables

{
  "accountNumber": "A-AF465633",
  "taskId": "45344460"
}

Response

{
  "data": {
    "taskResult": {
      "error": "writer-sure-increase-answer-wear",
      "result": {"key": "value"},
      "status": "STARTED"
    }
  }
}

tdspByPostalcode

Type: [PostcodeZoneMapping]

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

The possible errors that can be raised are:

Arguments

Name Description

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
    loadZone
    postcode
    serviceProvider
  }
}

Variables

{
  "postalCode": "important-per-rock-although-from"
}

Response

{
  "data": {
    "tdspByPostalcode": [
      {
        "id": "13786831",
        "loadZone": "LZ_HOUSTON",
        "postcode": "agent-animal-cold-end-way",
        "serviceProvider": "AEP_TCC"
      }
    ]
  }
}

termsAndConditionsForProduct

Type: [TermsAndConditionsType]

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

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

The possible errors that can be raised are:

  • KT-CT-8501: No active terms and conditions found for product.
  • KT-CT-1113: Disabled GraphQL field requested.

Arguments

Name Description

productCode (String!)

The product code of the market supply product.

Query

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

Variables

{
  "productCode": "want-forget-gun-up-beyond"
}

Response

{
  "data": {
    "termsAndConditionsForProduct": [
      {
        "brandCode": "manage-begin-kid-language-main",
        "effectiveFrom": "1994-10-09T11:17:11.557042+00:00",
        "html": "conference-school-audience-worry-article",
        "markdown": "take-economy-offer-least-crime",
        "name": "TV-building-pass-identify-take",
        "pdfUrl": "few-ability-of-view-statement",
        "version": "government-four-behind-itself-type"
      }
    ]
  }
}

thirdPartyViewer

Type: ThirdPartyOrganizationType

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

The currently authenticated third party.

This field requires the Authorization header to be set.

Query

query ThirdPartyViewer {
  thirdPartyViewer {
    name
    permissions {
      ...ThirdPartyPermissionFragment
    }
  }
}

Response

{
  "data": {
    "thirdPartyViewer": {
      "name": "around-body-cover-church-economy",
      "permissions": [ThirdPartyPermission]
    }
  }
}

trigger

Type: Trigger!

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

Get the details of a published trigger with a given ID.

The possible errors that can be raised are:

Arguments

Name Description

triggerId (ID!)

The ID of the trigger.

Query

query Trigger($triggerId: ID!) {
  trigger(triggerId: $triggerId) {
    accounts {
      ...AccountConnectionTypeConnectionFragment
    }
    accountsLinkedAt
    createdAt
    id
    messages {
      ...MessageConnectionFragment
    }
    processingStatus
    triggerTypeCode
  }
}

Variables

{
  "triggerId": "73685112"
}

Response

{
  "data": {
    "trigger": {
      "accounts": AccountConnectionTypeConnection,
      "accountsLinkedAt": "1971-04-21T11:24:17.441643+00:00",
      "createdAt": "1979-06-08T20:42:43.715874+00:00",
      "id": "79268647",
      "messages": MessageConnection,
      "processingStatus": "UNPROCESSED",
      "triggerTypeCode": "bag-manage-determine-after-deal"
    }
  }
}

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.

The possible errors that can be raised are:

Deprecated

The 'userVehicles' field is deprecated.

Please use 'startSmartFlexOnboarding' instead.

- Marked as deprecated on 2025-10-30.
- Scheduled for removal on or after 2026-04-30.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/608/

Arguments

Name Description

accountNumber (String)

authentication (AuthenticationInput)

The authentication details required given the chosen provider.

supportedProvider (ProviderChoices)

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

Query

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

Variables

{
  "accountNumber": "A-DBAEC8E6",
  "authentication": AuthenticationInput,
  "supportedProvider": "BYD"
}

Response

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

Arguments

Name Description

phoneNumber (String!)

Query

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

Variables

{
  "phoneNumber": "up-think-town-result-story"
}

Response

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

Arguments

Name Description

value (String!)

Referral claim code value.

Query

query ValidateReferralCode($value: String!) {
  validateReferralCode(value: $value) {
    accountReferral {
      ...ReferralTypeFragment
    }
    createdAt
    id
    isValid
    referralScheme {
      ...ReferralSchemeTypeFragment
    }
    value
  }
}

Variables

{
  "value": "final-another-industry-month-difficult"
}

Response

{
  "data": {
    "validateReferralCode": {
      "accountReferral": ReferralType,
      "createdAt": "2009-07-29T15:48:10.587265+00:00",
      "id": 19467027,
      "isValid": true,
      "referralScheme": ReferralSchemeType,
      "value": "no-sometimes-some-open-center"
    }
  }
}

vehicleChargingPreferences

Type: VehicleChargingPreferencesType

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

Vehicle charging preference details.

The possible errors that can be raised are:

Deprecated

The 'vehicleChargingPreferences' field is deprecated.

Please use 'devices.preferences' instead.

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

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/public/675/

Arguments

Name Description

accountNumber (String!)

Query

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

Variables

{
  "accountNumber": "A-089853E8"
}

Response

{
  "data": {
    "vehicleChargingPreferences": {
      "maximumSocPercentage": 34,
      "minimumSocPercentage": 84,
      "weekdayTargetSoc": 36,
      "weekdayTargetTime": "contain-behavior-question-race-say",
      "weekendTargetSoc": 58,
      "weekendTargetTime": "moment-why-because-effort-girl"
    }
  }
}

verificationStatus

Type: EmailVerificationStatus

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

Check the verification status of a given email address.

Arguments

Name Description

email (String!)

The email address to be checked.

Query

query VerificationStatus($email: String!) {
  verificationStatus(email: $email) {
    email
    status
  }
}

Variables

{
  "email": "eat-too-morning-lay-doctor"
}

Response

{
  "data": {
    "verificationStatus": {
      "email": "skin-probably-attack-hair-appear",
      "status": "NOT_SENT"
    }
  }
}

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 {
    accountUserRoles {
      ...AccountUserRoleTypeFragment
    }
    accounts {
      ...AccountInterfaceFragment
    }
    address {
      ...RichAddressTypeFragment
    }
    alternativePhoneNumbers
    businesses {
      ...BusinessConnectionTypeConnectionFragment
    }
    consents {
      ...ConsentTypeFragment
    }
    createdAt
    dateOfBirth
    details {
      ...AccountUserDetailTypeFragment
    }
    email
    familyName
    fullName
    givenName
    hasFamilyIssues
    id
    isActive
    isDeceased
    isInHardship
    label
    landline
    liveSecretKey
    mobile
    number
    paymentMethods {
      ...PaymentInstructionConnectionTypeConnectionFragment
    }
    permissions {
      ...AccountUserPermissionFragment
    }
    portfolioIds
    portfolioUserRoles {
      ...PortfolioUserRoleTypeFragment
    }
    portfolios {
      ...PortfolioConnectionTypeConnectionFragment
    }
    preferences {
      ...AccountUserCommsPreferencesFragment
    }
    preferredName
    pronouns
    specialCircumstances {
      ...SpecialCircumstancesTypeFragment
    }
    title
  }
}

Response

{
  "data": {
    "viewer": {
      "accountUserRoles": [AccountUserRoleType],
      "accounts": AccountInterface,
      "address": RichAddressType,
      "alternativePhoneNumbers": ["control-room-describe-little-better"],
      "businesses": BusinessConnectionTypeConnection,
      "consents": ConsentType,
      "createdAt": "2012-01-24T03:36:57.461793+00:00",
      "dateOfBirth": "2021-06-04",
      "details": [AccountUserDetailType],
      "email": "order-discussion-weight-center-standard",
      "familyName": "Patel",
      "fullName": "direction-people-almost-upon-save",
      "givenName": "Brian",
      "hasFamilyIssues": true,
      "id": "22900161",
      "isActive": true,
      "isDeceased": true,
      "isInHardship": true,
      "label": "fund-attack-fly-little-beautiful",
      "landline": "design-fund-institution-system-after",
      "liveSecretKey": "enter-challenge-process-treatment-soon",
      "mobile": "condition-group-anything-glass-most",
      "number": "newspaper-safe-important-enough-recently",
      "paymentMethods": PaymentInstructionConnectionTypeConnection,
      "permissions": [AccountUserPermission],
      "portfolioIds": ["20440727"],
      "portfolioUserRoles": [PortfolioUserRoleType],
      "portfolios": PortfolioConnectionTypeConnection,
      "preferences": AccountUserCommsPreferences,
      "preferredName": "say-scientist-hope-ask-cell",
      "pronouns": "which-social-data-attention-build",
      "specialCircumstances": SpecialCircumstancesType,
      "title": "window-total-subject-also-assume"
    }
  }
}

voiceCampaign

Type: VoiceCampaignType!

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

Get the voice campaign for a given ID.

The possible errors that can be raised are:

Arguments

Name Description

campaignId (String!)

The campaign ID.

Query

query VoiceCampaign($campaignId: String!) {
  voiceCampaign(campaignId: $campaignId) {
    campaignItems {
      ...VoiceCampaignItemConnectionTypeConnectionFragment
    }
    campaignType
    customOutboundPhoneNumber
    description
    id
    name
    preventDuplicateRecords
    status
    tags {
      ...CallTagConnectionTypeConnectionFragment
    }
  }
}

Variables

{
  "campaignId": "98435298"
}

Response

{
  "data": {
    "voiceCampaign": {
      "campaignItems": VoiceCampaignItemConnectionTypeConnection,
      "campaignType": "PREVIEW",
      "customOutboundPhoneNumber": "policy-fear-kid-current-level",
      "description": "least-memory-actually-person-situation",
      "id": "97210455",
      "name": "memory-nice-professor-art-fast",
      "preventDuplicateRecords": true,
      "status": "ACTIVE",
      "tags": CallTagConnectionTypeConnection
    }
  }
}

Arguments

Name Description

after (String)

before (String)

campaignType (TypeOfVoiceCampaign)

Filter by campaign type.

first (Int)

last (Int)

name (String)

Filter by campaign name.

status (CampaignStatus)

Filter by campaign status.

Query

query VoiceCampaigns(
  $after: String,
  $before: String,
  $campaignType: TypeOfVoiceCampaign,
  $first: Int,
  $last: Int,
  $name: String,
  $status: CampaignStatus
) {
  voiceCampaigns(
    after: $after,
    before: $before,
    campaignType: $campaignType,
    first: $first,
    last: $last,
    name: $name,
    status: $status
  ) {
    edgeCount
    edges {
      ...VoiceCampaignConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "campaignType": "PREVIEW",
  "first": 10,
  "last": 10,
  "name": "receive-administration-find-plan-possible",
  "status": "ACTIVE"
}

Response

{
  "data": {
    "voiceCampaigns": {
      "edgeCount": 59,
      "edges": VoiceCampaignConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 38
    }
  }
}

vouchersBalanceDetail

Type: VouchersBalanceDetail

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

Query the detail of vouchers balance for an account.

The possible errors that can be raised are:

Arguments

Name Description

accountNumber (ID!)

The account number.

Query

query VouchersBalanceDetail($accountNumber: ID!) {
  vouchersBalanceDetail(accountNumber: $accountNumber) {
    redeemableInFuture
    redeemableToday
  }
}

Variables

{
  "accountNumber": "A-A00C3242"
}

Response

{
  "data": {
    "vouchersBalanceDetail": {
      "redeemableInFuture": 29,
      "redeemableToday": 12
    }
  }
}

Arguments

Name Description

accountNumber (ID!)

The account number.

after (String)

availableBeforeDate (Date)

An optional date to limit the response to vouchers that are available before the particular date (exclusive).

availableFromDate (Date)

An optional date to limit the response to vouchers that are available from the particular date (inclusive) onwards.

before (String)

excludeRefunded (Boolean)

Whether to exclude refunded vouchers from the response. By default, refunded vouchers will be included in the response.

first (Int)

last (Int)

purchasedBeforeDate (Date)

An optional date to limit the response to vouchers that have been purchased before the particular date (exclusive).

purchasedFromDate (Date)

An optional date to limit the response to vouchers that have been purchased from the particular date (inclusive) onwards.

redeemableOnly (Boolean!)

Whether to only return vouchers that can be redeemable.

Query

query VouchersForAccount(
  $accountNumber: ID!,
  $after: String,
  $availableBeforeDate: Date,
  $availableFromDate: Date,
  $before: String,
  $excludeRefunded: Boolean,
  $first: Int,
  $last: Int,
  $purchasedBeforeDate: Date,
  $purchasedFromDate: Date,
  $redeemableOnly: Boolean!
) {
  vouchersForAccount(
    accountNumber: $accountNumber,
    after: $after,
    availableBeforeDate: $availableBeforeDate,
    availableFromDate: $availableFromDate,
    before: $before,
    excludeRefunded: $excludeRefunded,
    first: $first,
    last: $last,
    purchasedBeforeDate: $purchasedBeforeDate,
    purchasedFromDate: $purchasedFromDate,
    redeemableOnly: $redeemableOnly
  ) {
    edgeCount
    edges {
      ...VoucherPurchaseConnectionTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "accountNumber": "A-25644466",
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "availableBeforeDate": "1971-11-15",
  "availableFromDate": "1977-04-17",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "excludeRefunded": true,
  "first": 10,
  "last": 10,
  "purchasedBeforeDate": "1996-09-10",
  "purchasedFromDate": "1997-06-10",
  "redeemableOnly": true
}

Response

{
  "data": {
    "vouchersForAccount": {
      "edgeCount": 92,
      "edges": VoucherPurchaseConnectionTypeEdge,
      "pageInfo": PageInfo,
      "totalCount": 45
    }
  }
}

workSchedule

Type: WorkScheduleType!

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

Get the work schedule with the given identifier.

The possible errors that can be raised are:

Arguments

Name Description

identifier (String!)

The identifier of the work schedule (also known as the 'slug').

Query

query WorkSchedule($identifier: String!) {
  workSchedule(identifier: $identifier) {
    identifier
    isOpen
    isPublicHoliday
    name
    openOrClosedReason
  }
}

Variables

{
  "identifier": "88177605"
}

Response

{
  "data": {
    "workSchedule": {
      "identifier": "80383309",
      "isOpen": true,
      "isPublicHoliday": true,
      "name": "animal-college-material-high-as",
      "openOrClosedReason": "CLOSED_DUE_TO_PUBLIC_HOLIDAY"
    }
  }
}

Authentication Server

authorizedApplications

Type: [AuthorizedApplication]

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

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

Deprecated

The 'authorizedApplications' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Query

query AuthorizedApplications {
  authorizedApplications {
    clientId
    name
  }
}

Response

{
  "data": {
    "authorizedApplications": [
      {
        "clientId": "40276544",
        "name": "change-tree-officer-hotel-success"
      }
    ]
  }
}

Query

query KrakenVersion {
  krakenVersion {
    SHA
    isPinned
    number
  }
}

Response

{
  "data": {
    "krakenVersion": {
      "SHA": "artist-parent-beyond-artist-low",
      "isPinned": true,
      "number": "us-group-help-however-task"
    }
  }
}

mfaDevices

Type: [MfaDevice]

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

Get all MFA devices for the current user.

Deprecated

The 'mfaDevices' field is deprecated.

Schema is being removed, but will be available in the main API site.

- Marked as deprecated on 2025-10-15.
- Scheduled for removal on or after 2025-10-30.

Query

query MfaDevices {
  mfaDevices {
    deviceType
    isConfirmed
  }
}

Response

{
  "data": {
    "mfaDevices": [
      {
        "deviceType": "break-network-mouth-artist-ever",
        "isConfirmed": true
      }
    ]
  }
}