Customer Migrations Guide: Requesting Data

In the previous section, we walked through the steps of validating, staging, and creating an account in Kraken. Throughout this process, you may find it necessary to retrieve information about the ongoing state of the migration, such as which accounts have been successfully imported, which are pending import etc. For such inquiries, the following endpoints are at your disposal.

Retrieving Account Import Status
List all account imports
List pending imports
List all imported accounts
List meterpoint statuses

Retrieving Account Import Status

Use this endpoint to find out the status of a single account import process.

Possible statuses:

UNKNOWN - No account found in Kraken for the external account number and import supplier code. Either a previous process attempt has failed, or the import has never been attempted to be processed.
COMPLETED - An account has been created in Kraken for the external account number and import supplier code.
IN_PROGRESS - There is currently a migration process attempting to create this account.

GET https://api.octopus.energy/v1/data-import/account-transfer-status/<import-supplier-code>/<external-account-number>/

The following responses may be returned from the API.

docs--rest--api-guides--data-import--requesting-data--account-import-status--api-responses--html

Status code	Description

List all account imports

Use this endpoint to list all accounts for import, whether they are pending (their data has been staged) or have had a Kraken account created.

GET https://api.octopus.energy/v1/data-import/all-account-import-processes/<import-supplier-code>/

The following responses may be returned from the API.

docs--rest--api-guides--data-import--requesting-data--list-all-import-processes--api-responses--html

Status code	Description

List pending imports

Use this endpoint to list all accounts pending import (their data has been staged).

GET https://api.octopus.energy/v1/data-import/pending-account-import-processes/<import-supplier-code>/

The following responses may be returned from the API.

docs--rest--api-guides--data-import--requesting-data--list-pending-import-processes--api-responses--html

Status code	Description

List all imported accounts

Use this endpoint to list all accounts that have been imported and now have a Kraken account.

GET https://api.octopus.energy/v1/data-import/imported-account-import-processes/<import-supplier-code>/

The following responses may be returned from the API.

docs--rest--api-guides--data-import--requesting-data--list-all-imported-accounts--html

Status code	Description

List meterpoint statuses

Use this endpoint to list the status of all meter points for an already imported account in Kraken.

GET https://api.octopus.energy/v1/data-import/meterpoint-statuses-for-account/<import-supplier-code>/<external-account-number>/

The following responses may be returned from the API.

docs--rest--api-guides--data-import--additional-endpoints--meter-point-statuses--api-responses--html

Status code	Description