Skip to main content
GET
/
staking
/
stakes
/
{stakeId}
Get Stakes
curl --request GET \
  --url https://api.dfns.io/staking/stakes/{stakeId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "provider": "Figment",
  "walletId": "<string>",
  "status": "Active",
  "requester": {
    "userId": "<string>",
    "tokenId": "<string>"
  },
  "requestBody": {
    "protocol": "Babylon",
    "walletId": "<string>",
    "provider": "Figment",
    "amount": "<string>",
    "duration": 123,
    "externalId": "<string>"
  },
  "dateCreated": "<string>",
  "protocol": "Babylon",
  "data": {
    "finalityProviders": [
      "<string>"
    ],
    "covenantPubkeys": [
      "<string>"
    ],
    "magicBytes": "<string>",
    "covenantThreshold": 123,
    "minUnbondingTime": 123,
    "lockHeight": 123
  },
  "actions": [
    {
      "id": "<string>",
      "stakeId": "<string>",
      "transactionId": "<string>",
      "signatureId": "<string>",
      "transactionHash": "<string>",
      "kind": "Stake",
      "requester": {
        "userId": "<string>",
        "tokenId": "<string>"
      },
      "requestBody": {
        "protocol": "Babylon",
        "walletId": "<string>",
        "provider": "Figment",
        "amount": "<string>",
        "duration": 123,
        "externalId": "<string>"
      },
      "failureReason": "<string>",
      "dateCreated": "<string>"
    }
  ]
}

​
Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Stakes:Read: Always required.

Authorizations

​
Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

​
stakeId
string
required
Minimum length: 1

Query Parameters

​
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 500
​
paginationToken
string

Opaque token used to retrieve the next page. Returned as nextPageToken from the previous request.

Minimum length: 1

Response

200 - application/json

Success

  • Babylon
  • Iota
  • Ethereum
​
actions
object[]
required
​
id
string
required
​
walletId
string
required
​
status
enum<string>
required
Available options:
Active,
Failed,
Staking,
Unbonding,
Unbond,
Withdrawing,
Withdrawn
​
requester
object
required
​
requestBody
object
required
  • Babylon
  • Ethereum
  • Iota
​
dateCreated
string
required
​
protocol
enum<string>
required
Available options:
Babylon
​
data
object
required
​
provider
enum<string>
Available options:
Figment