> ## Documentation Index > Fetch the complete documentation index at: https://cobo.com/developers/llms.txt > Use this file to discover all available pages before exploring further. # List staking positions > This operation retrieves a list of staking positions. Try [Cobo WaaS Skill](/v2/guides/overview/cobo-waas-skill) in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀 ```python Python theme={null} 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 `` with your private key api_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) ``` ```java Java theme={null} // Import classes: import com.cobo.waas2.ApiClient; import com.cobo.waas2.ApiException; import com.cobo.waas2.Configuration; import com.cobo.waas2.Env; import com.cobo.waas2.api.StakingsApi; import com.cobo.waas2.model.*; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Select the development environment. To use the production environment, replace `Env.DEV` with // `Env.PROD defaultClient.setEnv(Env.DEV); // Replace `` with your private key defaultClient.setPrivKey(""); StakingsApi apiInstance = new StakingsApi(); String poolId = "babylon_btc"; String statuses = "Active,StakeInProgress,"; UUID walletId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479"); String tokenId = "ETH_USDT"; Integer limit = 10; String before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"; String after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"; try { ListStakings200Response result = apiInstance.listStakings(poolId, statuses, walletId, tokenId, limit, before, after); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling StakingsApi#listStakings"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ```go Go theme={null} package main import ( "context" "fmt" coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2" "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto" "os" ) func main() { poolId := "babylon_btc" statuses := "Active,StakeInProgress," walletId := "f47ac10b-58cc-4372-a567-0e02b2c3d479" tokenId := "ETH_USDT" limit := int32(10) before := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1" after := "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk" configuration := coboWaas2.NewConfiguration() // Initialize the API client apiClient := coboWaas2.NewAPIClient(configuration) ctx := context.Background() // Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv) // Replace `` with your private key ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{ Secret: "", }) resp, r, err := apiClient.StakingsAPI.ListStakings(ctx). PoolId(poolId). Statuses(statuses). WalletId(walletId). TokenId(tokenId). Limit(limit). Before(before). After(after). Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `StakingsAPI.ListStakings``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `ListStakings`: ListStakings200Response fmt.Fprintf(os.Stdout, "Response from `StakingsAPI.ListStakings`: %v\n", resp) } ``` ```javascript JavaScript theme={null} const CoboWaas2 = require("@cobo/cobo-waas2"); // Initialize the API client const apiClient = CoboWaas2.ApiClient.instance; // Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD` apiClient.setEnv(CoboWaas2.Env.DEV); // Replace `` with your private key apiClient.setPrivateKey(""); // Call the API const apiInstance = new CoboWaas2.StakingsApi(); const opts = { pool_id: "babylon_btc", statuses: "Active,StakeInProgress,", wallet_id: "f47ac10b-58cc-4372-a567-0e02b2c3d479", token_id: "ETH_USDT", limit: 10, before: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1", after: "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk", }; apiInstance.listStakings(opts).then( (data) => { console.log("API called successfully. Returned data: " + data); }, (error) => { console.error(error); }, ); ``` ## OpenAPI ````yaml get /stakings openapi: 3.0.3 info: title: Cobo Wallet as a Service 2.0 description: > The Cobo Wallet-as-a-Service (WaaS) 2.0 API is the latest version of Cobo's WaaS API offering. It enables you to access Cobo's full suite of crypto wallet technologies with powerful and flexible access controls. By encapsulating complex security protocols and streamlining blockchain interactions, this API allows you to concentrate on your core business activities without worrying about the safety of your assets. The WaaS 2.0 API presents the following key features: - A unified API for Cobo's [all four wallet types](https://manuals.cobo.com/en/portal/introduction#an-all-in-one-wallet-platform) - Support for 80+ chains and 3000+ tokens - A comprehensive selection of webhook events - Flexible usage models for MPC Wallets, including [Organization-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/introduction) and [User-Controlled Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/ucw/introduction) - Programmatic control of smart contract wallets such as Safe{Wallet} with fine-grained access controls - Seamlessly transfer funds across multiple exchanges, including Binance, OKX, Bybit, Deribit, and more For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](https://www.cobo.com/developers/v2/guides/overview/introduction). termsOfService: https://cobo.com/waas/tos/ license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html contact: name: Cobo WaaS url: https://www.cobo.com/waas email: help@cobo.com version: 1.0.0 servers: - url: https://api.dev.cobo.com/v2 description: Development environment - url: https://api.cobo.com/v2 description: Production environment security: - CoboAuth: [] tags: - name: Organizations description: Operations related to Organizations. - name: Wallets description: Operations related to all wallets. - name: Wallets - MPC Wallets description: Operations related to mpc wallet. - name: Wallets - Exchange Wallet description: Operations related to exchange wallet. - name: Wallets - Smart Contract Wallets description: Operations related to smart contract wallet. - name: Transactions description: Operations related to all transactions. - name: Developers - Webhooks description: Operations related to webhooks. - name: Stakings description: Operations related to staking. - name: OAuth description: Operations related to OAuth. - name: Developers description: Operations related to developers. - name: AddressBooks description: Operations related to address books. - name: TravelRule description: Operations related to travel rule. - name: GraphQL description: Operations related to executing GraphQL queries and mutations. - name: PrimeBroker description: Operations related to prime broker. - name: AppWorkflows description: Operations related to app workflow. - name: FeeStation description: Operations related to fee station. - name: Payment description: Operations related to payment. - name: Batch Payouts description: Operations related to batch payouts. - name: Tokenization description: Operations related to tokenization. - name: AutoSweep description: Operations related to auto sweep. - name: Compliance description: Operations related to compliance. paths: /stakings: get: tags: - Stakings summary: List staking positions description: | This operation retrieves a list of staking positions. operationId: list_stakings parameters: - $ref: '#/components/parameters/poolIdOptionalParam' - name: statuses in: query required: false description: > 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. schema: type: string example: Active,StakeInProgress, - $ref: '#/components/parameters/optionalWalletIdParam' - $ref: '#/components/parameters/optionalTokenIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/beforeParam' - $ref: '#/components/parameters/afterParam' responses: '200': $ref: '#/components/responses/listStakingsResponse' 4XX: $ref: '#/components/responses/badRequestError' 5XX: $ref: '#/components/responses/internalServerError' security: - CoboAuth: [] - OAuth2: - wallet.read components: parameters: poolIdOptionalParam: name: pool_id in: query required: false description: >- 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](https://www.cobo.com/developers/v2/api-references/stakings/list-staking-pools) to retrieve a list of staking pools. schema: type: string example: babylon_btc optionalWalletIdParam: name: wallet_id in: query required: false description: The wallet ID. schema: type: string format: uuid example: f47ac10b-58cc-4372-a567-0e02b2c3d479 optionalTokenIdParam: name: token_id in: query required: false description: >- 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](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). schema: type: string example: ETH_USDT limitParam: name: limit in: query description: >- The maximum number of objects to return. For most operations, the value range is [1, 50]. required: false schema: type: integer format: int32 default: 10 example: 10 beforeParam: name: before in: query description: > 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. required: false schema: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1 afterParam: name: after in: query description: > 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. required: false schema: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk responses: listStakingsResponse: description: A list of staking positions has been successfully retrieved. content: application/json: schema: type: object properties: data: items: $ref: '#/components/schemas/Stakings' type: array pagination: $ref: '#/components/schemas/Pagination' badRequestError: description: >- Bad request. Your request contains malformed syntax or invalid parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' internalServerError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: Stakings: type: object description: The information about a staking position. required: - id - wallet_id - address - pool_id - token_id - amounts - created_timestamp - updated_timestamp properties: id: description: The ID of the staking position. type: string example: 0011039d-27fb-49ba-b172-6e0aa80e37ec wallet_id: type: string example: 0111039d-27fb-49ba-b172-6e0aa80e37ec description: The staker's wallet ID. address: type: string example: '0xAbCdE123456789aBcDeF123456789aBcDeF12345' description: The staker's wallet address. amounts: $ref: '#/components/schemas/AmountDetails' pool_id: $ref: '#/components/schemas/StakingPoolId' token_id: type: string example: BTC description: The token ID. rewards_info: description: The information about the staking rewards. type: object example: {} created_timestamp: description: The time when the staking position was created. type: integer format: int64 example: 1640995200000 updated_timestamp: description: The time when the staking position was last updated. type: integer format: int64 example: 1640995200000 validator_info: $ref: '#/components/schemas/BabylonValidator' validators: type: array items: $ref: '#/components/schemas/BabylonValidator' extra: oneOf: - $ref: '#/components/schemas/BabylonStakingExtra' - $ref: '#/components/schemas/EthStakingExtra' - $ref: '#/components/schemas/CoreStakingExtra' discriminator: propertyName: pool_type mapping: Babylon: $ref: '#/components/schemas/BabylonStakingExtra' ETHBeacon: $ref: '#/components/schemas/EthStakingExtra' CoreBTC: $ref: '#/components/schemas/CoreStakingExtra' Pagination: type: object description: The pagination information of the returned data. required: - before - after - total_count properties: before: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1 description: > An object ID used to retrieve records before the specified object, indicating earlier or smaller records relative to the current dataset. You can use it to paginate backwards. If empty, it means you have reached the start of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. after: type: string example: RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk description: > An object ID used to retrieve records after the specified object, indicating newer or larger records relative to the current dataset. You can use it to paginate forwards. If empty, it means you have reached the end of the data. Most API endpoints sort by object ID, but some use other fields depending on the endpoint. total_count: type: integer example: 10000 description: >- The total number of records that match the query criteria, unaffected by the pagination parameters (`before` , `after`, and `limit`). ErrorResponse: type: object description: The response of a failed request. required: - error_code - error_message - error_id properties: error_code: type: integer description: >- The error code. Refer to [Error codes and status codes](https://www.cobo.com/developers/v2/api-references/error-codes) for more details. error_message: type: string description: The error description. error_id: type: string description: >- The error log ID. You can provide the error ID when submitting a ticket to help Cobo to locate the issue. example: 0b6ddf19083c4bd1a9ca01bec44b24dd AmountDetails: type: array description: The details about the staking amount. items: type: object required: - status - amount properties: status: $ref: '#/components/schemas/AmountStatus' amount: type: string example: '100.00' description: The staking amount. StakingPoolId: type: string enum: - babylon_btc_signet - babylon_btc - beacon_eth - beacon_eth_holesky - core_btc - core_xtn - sky_farm_eth_usdc - bithive_signet - bithive - beacon_bera - beacon_bera_testnet - berachain_bgt - berachain_bgt_testnet example: babylon_btc_signet description: >- The ID of the staking pool. A staking pool is a pairing of a staking protocol and a specific type of token. Currently, `berachain_bgt` and `berachain_bgt_testnet` are not supported. BabylonValidator: allOf: - $ref: '#/components/schemas/BaseStakeExtra' - type: object description: The information about the Babylon validator. required: - name properties: icon_url: description: The URL of the validator's icon. type: string format: url example: https://example.com/icon.png name: description: The validator's name. type: string example: Cobo priority: description: This property can be ignored. type: integer example: 0 public_key: description: The public key of the validator. type: string example: eca1b104dce16c30705f4147a9c4a373ac88646c5d1bcda6a89c018940cb96a0 commission_rate: description: The commission rate of the validator. type: number format: float example: 0.1 supported_pos_chains: description: A list of supported Proof-of-Stake (PoS) chains. type: array items: type: string enum: - Babylon - Cosmos - Ethereum example: - Babylon - Cosmos - Ethereum BabylonStakingExtra: title: Babylon allOf: - $ref: '#/components/schemas/BaseStakeExtra' - type: object description: The information about the Babylon protocol. required: - pos_chain properties: pos_chain: description: The Proof-of-Stake (PoS) chain. type: string example: Babylon Chain unlock_timestamp: description: >- The estimated time when the bitcoins will be unlocked, in Unix timestamp format, measured in milliseconds. type: integer format: int64 example: 1640995200000 unlock_block_height: description: The block height at which the bitcoins will be unlocked. type: integer format: int64 example: 871234 stake_address: description: The address receiving the staked bitcoins. type: string example: tb1pgmpawe2rkrzuuflu8yw564lerfalhw8td36dha49yz4l99xvm3psteh393 unbond_address: description: The address receiving the unlocked bitcoins. type: string example: tb1pzcn4hmsfq32vyfnckvrtyjhdh0cf2hsm2nr6m8034x4lnrx3ry4q2nyzqv EthStakingExtra: title: Ethereum Beacon Chain allOf: - $ref: '#/components/schemas/BaseStakeExtra' - type: object description: The information about the Ethereum Beacon Chain. required: - pos_chain properties: pos_chain: description: The Proof-of-Stake (PoS) chain. type: string example: Ethereum beacon_validators: description: The list of validator information. type: array items: type: object properties: pubkey: description: The public key of the validator. type: string example: '0x123456789abcdef' status: $ref: '#/components/schemas/AmountStatus' apy: description: The annual percentage yield (APY) of the validator. type: number example: 0.02 staked_amount: description: The staked amount. type: string example: '100.00' rewards_received: description: The rewards received. type: string example: '10.00' updated_timestamp: description: >- The time when the validator's status was last updated, in Unix timestamp format and measured in milliseconds. type: integer format: int64 example: 1640995200000 CoreStakingExtra: title: CORE allOf: - $ref: '#/components/schemas/BaseStakeExtra' - type: object description: The information about staking in the CORE staking protocol. required: - pos_chain - staker_address - validator_address - reward_address - timelock properties: pos_chain: description: The Proof-of-Stake (PoS) chain. type: string example: Ethereum staker_address: description: The staker's Bitcoin address. type: string example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh validator_address: description: The validator's EVM address. type: string example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' reward_address: description: The EVM address to receive staking rewards. type: string example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' timelock: description: >- The Unix timestamp (in seconds) when the staking position will be unlocked and available for withdrawal. type: integer example: 1704067200 AmountStatus: type: string enum: - StakeInProgress - Active - Rejected - LimitExceeded - Invalid - UnstakeInProgress - Withdrawable - WithdrawInProgress - Closed example: Active description: > The status of the staking amount. 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. BaseStakeExtra: type: object description: The base information about a staking protocol. required: - pool_type properties: pool_type: $ref: '#/components/schemas/StakingPoolType' StakingPoolType: type: string enum: - Babylon - ETHBeacon - CoreBTC - SkyFarm - BitHive - BERABeacon - BeraChainBGT example: Babylon description: | The type of the staking pool. Possible values are: - `Babylon`: Babylon staking pool - `ETHBeacon`: Ethereum Beacon Chain staking pool - `CoreBTC`: Core BTC staking pool - `SkyFarm`: SKY farm staking pool - `BitHive`: BitHive staking pool - `BERABeacon`: BERA Beacon Chain staking pool - `BeraChainBGT`: Bera Chain BGT staking pool securitySchemes: CoboAuth: type: apiKey in: header name: BIZ-API-KEY description: > The API key. For more details, refer to [API key](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-key). In the API playground, enter your [API secret](https://www.cobo.com/developers/v2/guides/overview/cobo-auth#api-secret), and your API key will be accordingly calculated. OAuth2: type: oauth2 description: >- The [Org Access Token](https://www.cobo.com/developers/v2/apps/org-access-tokens). Use this authorization method only if you are developing Cobo Portal Apps for installation and use across different organizations. flows: authorizationCode: authorizationUrl: https://auth.cobo.com/authorize tokenUrl: https://auth.cobo.com/oauth/token scopes: address_book.read: Read address book api_key.read: Read API key information callback.read: Read callback message callback.resend: Resend callback message wallet.create: Create wallet wallet.read: Read wallet information wallet.update: Update wallet information wallet.delete: Delete wallet information wallet.create_address: Create wallet address wallet.manage_utxo: Manage UTXO mpc_project.create: Create MPC project mpc_project.read: Read MPC project information mpc_project.update: Update MPC project information mpc_vault.create: Create MPC Vault mpc_vault.read: Read MPC Vault information mpc_vault.update: Update MPC Vault information mpc_key_group.create: Create MPC key group mpc_key_group.read: Read MPC key group information mpc_key_group.update: Update MPC key group information mpc_key_group.delete: Delete MPC key group information transaction.read: Read transaction information transaction.withdraw: Make withdrawals transaction.estimate_fee: Estimate transaction fee transaction.contract_call: Initiate contract calls transaction.message_sign: Initiate message signings transaction.stake: Stake assets transaction.unstake: Unstake assets transaction.unstake_withdraw: Withdraw unstaked assets transaction.manage: Manage ongoing transactions transaction.update: Update transaction notes travel_rule.read: Read travel rule information travel_rule.edit: Edit travel rule information webhook.read: Read webhook URLs/events webhook.edit: Edit webhook URLs webhook.resend: Resend webhook events payment_orders_payin.create: Create pay-in order payment_orders_payin.read: Read pay-in order information payment_orders_payin.update: Update pay-in order payment_orders_refund.create: Create payment refund order payment_orders_refund.read: Read payment refund order information payment_settlement.create: Create payment settlement request payment_settlement.read: Read payment settlement request information payment_merchant.create: Create payment merchant payment_merchant.read: Read payment merchant information payment_merchant.update: Update payment merchant payment_forced_sweep.create: Create payment force sweep request payment_forced_sweep.read: Read payment force sweep request information compliance_funds.refund: Refund compliance funds request compliance_funds.isolate: Isolate compliance funds request compliance_funds.unfreeze: Unfreeze compliance funds request compliance_funds.read: Read compliance funds request information compliance_kyt_review.update: Update KYT review status compliance_kyt_decisions.update: Update KYT decision status compliance_kyt_status.read: Read KYT screening status compliance_kya_screenings.create: Create KYA address screening requests compliance_kya_screenings.read: Read KYA address screening results ````