Get Stakes

Retrieve the details of a specific stake.

GET /staking/stakes/{stakeId}

Get Stakes

cURL

curl --request GET \
  --url https://api.dfns.io/staking/stakes/{stakeId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "walletId": "<string>",
  "status": "Active",
  "requester": {
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
  },
  "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>",
      "kind": "Stake",
      "requester": {
        "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
        "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
      },
      "requestBody": {
        "protocol": "Babylon",
        "walletId": "<string>",
        "provider": "Figment",
        "amount": "<string>",
        "duration": 123,
        "externalId": "<string>"
      },
      "dateCreated": "<string>",
      "transactionId": "<string>",
      "signatureId": "<string>",
      "transactionHash": "<string>",
      "failureReason": "<string>"
    }
  ],
  "provider": "Figment"
}

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 string 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 string length: 1

Response

200 - application/json

Success

Babylon

Iota

Ethereum

id · string · required

walletId · string · required

status · enum<string> · required

Available options: Active, Failed, Staking, Unbonding, Unbond, Withdrawing, Withdrawn

requester · object · required

The user who initiated the request.

Show child attributes

requestBody · Babylon · object · required

Babylon

Ethereum

Iota

Show child attributes

dateCreated · string · required

protocol · enum<string> · required

Available options: Babylon

data · object · required

Show child attributes

actions · object[] · required

Show child attributes

provider · enum<string>

Available options: Figment