List Stake Keys

GET /wallets/{walletId}/stake-keys

status: Experimental

List stake-keys relevant to the wallet, and how much ada is associated with each.

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

Responses

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • ours array[object] Required

      Stake keys belonging to the wallet.

      Hide ours attributes Show ours attributes object
      • index integer Required

        A soft derivation index.

        Minimum value is 0, maximum value is 2147483647.

      • key string(bech32) Required
      • stake object Required

        Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

        Hide stake attributes Show stake attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is lovelace.

      • reward_balance object Required

        Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

        Hide reward_balance attributes Show reward_balance attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is lovelace.

      • delegation object Required

        Delegation settings

        Hide delegation attributes Show delegation attributes object
        • active object Required

          Currently active delegation status.

          Hide active attributes Show active attributes object
        • next array[object] Required
          Hide next attributes Show next attributes object
    • foreign array[object] Required

      Stake keys found in the wallet's UTxO, but does not belong to the wallet.

      Hide foreign attributes Show foreign attributes object
      • key string(bech32) Required
      • stake object Required

        Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

        Hide stake attributes Show stake attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is lovelace.

      • reward_balance object Required

        Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

        Hide reward_balance attributes Show reward_balance attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is lovelace.

    • none object Required

      The absence of a stake key. The stake field shows how much of the wallet funds are not associated with an identifiable stake key.

      Most likely, these funds are associated with enterprise addresses lacking staking rights. But they /could/ also be associate with more rare types of addresses like pointer addresses.

      Hide none attribute Show none attribute object
      • stake object Required

        Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

        Hide stake attributes Show stake attributes object
        • quantity integer Required

          Minimum value is 0.

        • unit string Required

          Value is lovelace.

GET /wallets/{walletId}/stake-keys
curl \
 --request GET https://localhost:8090/v2/wallets/{walletId}/stake-keys
Response examples (200)
{
  "ours": [
    {
      "index": 42,
      "key": "stake1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2x",
      "stake": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "reward_balance": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "delegation": {
        "active": {
          "status": "delegating",
          "target": "1423856bc91c49e928f6f30f4e8d665d53eb4ab6028bd0ac971809d514c92db1"
        },
        "next": [
          {
            "status": "not_delegating",
            "changes_at": {
              "epoch_number": 14,
              "epoch_start_time": "2020-01-22T10:06:39Z"
            }
          }
        ]
      }
    }
  ],
  "foreign": [
    {
      "key": "stake1sjck9mdmfyhzvjhydcjllgj9vjvl522w0573ncustrrr2rg7h9azg4cyqd36yyd48t5ut72hgld0fg2x",
      "stake": {
        "quantity": 42000000,
        "unit": "lovelace"
      },
      "reward_balance": {
        "quantity": 42000000,
        "unit": "lovelace"
      }
    }
  ],
  "none": {
    "stake": {
      "quantity": 42000000,
      "unit": "lovelace"
    }
  }
}