Skip to main content
GET
/
stakings
import cobo_waas2
from cobo_waas2.models.list_stakings200_response import ListStakings200Response
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.StakingsApi(api_client)
    pool_id = "babylon_btc"
    statuses = "Active,StakeInProgress,"
    wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    token_id = "ETH_USDT"
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List staking positions
        api_response = api_instance.list_stakings(
            pool_id=pool_id,
            statuses=statuses,
            wallet_id=wallet_id,
            token_id=token_id,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of StakingsApi->list_stakings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StakingsApi->list_stakings: %s\n" % e)


{
  "data": [
    {
      "id": "0011039d-27fb-49ba-b172-6e0aa80e37ec",
      "wallet_id": "0111039d-27fb-49ba-b172-6e0aa80e37ec",
      "address": "0xAbCdE123456789aBcDeF123456789aBcDeF12345",
      "amounts": [
        {
          "status": "Active",
          "amount": "100.00"
        }
      ],
      "pool_id": "babylon_btc_signet",
      "token_id": "BTC",
      "rewards_info": {},
      "created_timestamp": 1640995200000,
      "updated_timestamp": 1640995200000,
      "validator_info": {
        "pool_type": "Babylon",
        "icon_url": "https://example.com/icon.png",
        "name": "Cobo",
        "priority": 0,
        "public_key": "eca1b104dce16c30705f4147a9c4a373ac88646c5d1bcda6a89c018940cb96a0",
        "commission_rate": 0.1,
        "supported_pos_chains": [
          "Babylon",
          "Cosmos",
          "Ethereum"
        ]
      },
      "extra": {
        "pool_type": "Babylon",
        "pos_chain": "Babylon Chain",
        "unlock_timestamp": 1640995200000,
        "unlock_block_height": 871234,
        "stake_address": "tb1pgmpawe2rkrzuuflu8yw564lerfalhw8td36dha49yz4l99xvm3psteh393",
        "unbond_address": "tb1pzcn4hmsfq32vyfnckvrtyjhdh0cf2hsm2nr6m8034x4lnrx3ry4q2nyzqv"
      }
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.list_stakings200_response import ListStakings200Response
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.StakingsApi(api_client)
    pool_id = "babylon_btc"
    statuses = "Active,StakeInProgress,"
    wallet_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    token_id = "ETH_USDT"
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List staking positions
        api_response = api_instance.list_stakings(
            pool_id=pool_id,
            statuses=statuses,
            wallet_id=wallet_id,
            token_id=token_id,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of StakingsApi->list_stakings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StakingsApi->list_stakings: %s\n" % e)

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Query Parameters

​
pool_id
string

The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. You can call List staking pools to retrieve a list of staking pools.

​
statuses
string

The statuses of the staking amounts, separated by comma. Possible values include:

  • StakeInProgress: The staking request is submitted and is waiting to be confirmed by the staking protocol.
  • Active: The amount has been staked.
  • Rejected: The staking request has been rejected because the signer refuses to sign the transaction.
  • LimitExceeded: The total staking cap of the staking protocol has been reached.
  • Invalid: The staking request is invalid. This is often due to the failure to broadcast the transaction.
  • UnstakeInProgress: The unstaking request is submitted and is waiting to be confirmed by the staking protocol.
  • Withdrawable: The tokens have been unstaked and are ready to be withdrawn.
  • WithdrawInProgress: The withdrawal request is submitted and is waiting to be confirmed on the chain network.
  • Closed: The staking position is closed.
​
wallet_id
string<uuid>

The wallet ID.

​
token_id
string

The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling List enabled tokens.

​
limit
integer
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

Response

A list of staking positions has been successfully retrieved.

​
data
object[]
​
pagination
object

The pagination information of the returned data.