Account

GET 
/account

Returns the data related to an account. To retrieve it, sign the request or send the legacy account secret in the x-sideshift-secret header.

warning

Authenticate by signing the request or with the legacy x-sideshift-secret header. Your Ed25519 secret key and your account secret each grant full access to your account. Never share them.

Request

Header Parameters

x-sideshift-key string

Your Ed25519 public key, hex encoded. Required when signing the request. See Authentication.

x-sideshift-timestamp string

Current Unix time in milliseconds, the same value used in the signed message. Must be within 60 seconds of server time. Required when signing the request.

x-sideshift-signature string

Ed25519 signature of timestamp + METHOD + path + body, hex encoded. Required when signing the request. See Authentication.

x-sideshift-secret string

Legacy account secret. Not needed when the request is signed with the x-sideshift-key, x-sideshift-timestamp and x-sideshift-signature headers. See Authentication.

Responses

200

OK

application/json

Schema

Schema

idstringrequired
lifetimeStakingRewardsstringrequired
unstakingstringrequired
stakedstringrequired
availablestringrequired
totalBalancestringrequired

Example

{
  "id": "YQMi62XMb",
  "lifetimeStakingRewards": "89190.63",
  "unstaking": "0",
  "staked": "1079394.1646",
  "available": "43034.51598382",
  "totalBalance": "1122428.68058382"
}

401

Unauthorized

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired

Example

{
  "error": {
      "message": "Account required. Sign with registered Auth key, or add x-sideshift-secret header",
      "code": "SESSION_REQUIRED"
  }
}

404

Not Found

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired

Example

{
  "error": {
      "message": "Account not found",
      "code": "NOT_FOUND"
  }
}