Staking

Staking enables clients to earn rewards by participating in blockchain consensus. With Prime’s Staking APIs, clients can stake supported assets directly from eligible wallets and initiate unstaking when desired. While many assets are available for staking through the Prime UI, the Stake and Unstake APIs currently support Ethereum (ETH) only, with additional assets to be supported over time. Reward accrual, stake and unstake activity, and associated balance states can all be monitored through existing API endpoints for all stakable assets on Prime.

Staking a Wallet

To stake from a Vault wallet, use Create Stake. Instead of requiring a public address, this endpoint operates using Wallet IDs. For a refresher on Vault wallets and Wallet IDs, refer to the Wallets page.

Once the request is successfully submitted, the response will include an activity_id. As with other sensitive operations in Prime, this request must be approved in the Prime UI or Mobile App before it is processed. Once approved, the ETH selected for staking will begin the bonding process.

Coinbase Prime supports both partial staking and multiple concurrent staking operations from the same wallet. In practice, this means you can stake a specific amount (e.g. 64 ETH) without needing to stake the entire wallet balance, and you can initiate multiple stakes without waiting for earlier ones to complete.

To learn about how to track balance subtypes that are specific to staking, e.g. bonded_amount, bondable_amount, and pending_rewards_amount, please visit the Balances page.


stakingService := staking.NewStakingService(client)  
  
request := &staking.CreateStakeRequest{  
    PortfolioId:   "PORTFOLIO_ID_HERE",  
    WalletId:      "WALLET_ID_HERE",  
    IdempotencyKey: uuid.New().String(),  
    Inputs:         &staking.CreateStakeInputs{  
        Amount: '32'  
    }  
}  
  
response, err := stakingService.CreateStake(context.Background(), request)

For more information, please visit the Prime Go SDK.


stakingService := staking.NewStakingService(client)  
  
request := &staking.CreateStakeRequest{  
    PortfolioId:   "PORTFOLIO_ID_HERE",  
    WalletId:      "WALLET_ID_HERE",  
    IdempotencyKey: uuid.New().String(),  
    Inputs:         &staking.CreateStakeInputs{  
        Amount: '32'  
    }  
}  
  
response, err := stakingService.CreateStake(context.Background(), request)

For more information, please visit the Prime Go SDK.



from prime_sdk.credentials import Credentials  
from prime_sdk.create_stake import PrimeClient, CreateStakeRequest, Inputs  
import uuid  
  
def main():  
    credentials = Credentials.from_env("PRIME_CREDENTIALS")  
    prime_client = PrimeClient(credentials)  
  
    request = CreateStakeRequest(  
        portfolio_id="PORTFOLIO_ID_HERE",  
        wallet_id="WALLET_ID_HERE",  
        idempotency_key=str(uuid.uuid4()),  
        inputs=Inputs(  
            amount="32",  
        ),  
    )  
    try:  
        response = prime_client.create_stake(request)  
        print(response)  
    except Exception as e:  
        print(f"failed to create stake: {e}")  
  
if __name__ == "__main__":  
    main()

For more information, please visit the Prime Python SDK.



require('dotenv').config();  
const {  
    CoinbasePrimeClient,  
    CoinbasePrimeCredentials,  
    StakingService,  
} = require('@coinbase-sample/prime-sdk-ts');  
  
const creds = JSON.parse(process.env.PRIME_CREDENTIALS);  
const portfolioId = process.env.PORTFOLIO_ID;  
const walletId = process.env.WALLET_ID;  
  
const createStake = async (service) => {  
    const request = {  
        portfolioId,  
        walletId,  
        idempotency_key: crypto.randomUUID(),  
        inputs: {  
            amount: '32',  
        },  
    };  
  
    console.log('submitting stake: ', request);  
    const response = await service.createStake(request);  
    return response;  
};  
  
const credentials = new CoinbasePrimeCredentials(  
    creds.AccessKey,  
    creds.SecretKey,  
    creds.Passphrase  
);  
  
const client = new CoinbasePrimeClient(credentials);  
  
const service = new StakingService(client);  
  
createStake(service).then(console.log).catch(console.error);

For more information, please visit the Prime TS SDK.

Unstaking a wallet

The process for unstaking is nearly identical to staking. As with staking, partial unstaking is supported. For example, if a wallet has 320 ETH staked, an unstake request can be submitted for just 96 ETH.

Unstaking is not immediate. After initiating the request and approving it in the Prime UI, ETH enters the Ethereum exit queue and becomes withdrawable only once the network finalizes the exit.


stakingService := staking.NewStakingService(client)  
  
request := &staking.CreateUnstakeRequest{  
    PortfolioId:   "PORTFOLIO_ID_HERE",  
    WalletId:      "WALLET_ID_HERE",  
    IdempotencyKey: uuid.New().String(),  
    Inputs:         &staking.CreateUnstakeInputs{  
        Amount: '1'  
    }  
}  
response, err := stakingService.CreateUnstake(context.Background(), request)

For more information, please visit the Prime Go SDK.


stakingService := staking.NewStakingService(client)  
  
request := &staking.CreateUnstakeRequest{  
    PortfolioId:   "PORTFOLIO_ID_HERE",  
    WalletId:      "WALLET_ID_HERE",  
    IdempotencyKey: uuid.New().String(),  
    Inputs:         &staking.CreateUnstakeInputs{  
        Amount: '1'  
    }  
}  
response, err := stakingService.CreateUnstake(context.Background(), request)

For more information, please visit the Prime Go SDK.



from prime_sdk.credentials import Credentials  
from prime_sdk.create_stake import PrimeClient, CreateStakeRequest, Inputs  
import uuid  
  
def main():  
    credentials = Credentials.from_env("PRIME_CREDENTIALS")  
    prime_client = PrimeClient(credentials)  
  
    request = CreateStakeRequest(  
        portfolio_id="PORTFOLIO_ID_HERE",  
        wallet_id="WALLET_ID_HERE",  
        idempotency_key=str(uuid.uuid4()),  
        inputs=Inputs(  
            amount="32",  
        ),  
    )  
    try:  
        response = prime_client.create_stake(request)  
        print(response)  
    except Exception as e:  
        print(f"failed to create stake: {e}")  
  
if __name__ == "__main__":  
    main()

For more information, please visit the Prime Python SDK.




require('dotenv').config();  
const {  
    CoinbasePrimeClient,  
    CoinbasePrimeCredentials,  
    StakingService,  
} = require('@coinbase-sample/prime-sdk-ts');  
  
const creds = JSON.parse(process.env.PRIME_CREDENTIALS);  
const portfolioId = process.env.PORTFOLIO_ID;  
const walletId = process.env.WALLET_ID;  
  
const createUnstake = async (service) => {  
    const request = {  
        portfolioId,  
        walletId,  
        idempotency_key: crypto.randomUUID(),  
        inputs: {  
            amount: '1',  
        },  
    };  
  
    console.log('submitting unstake: ', request);  
    const response = await service.createUnstake(request);  
    return response;  
};  
  
const credentials = new CoinbasePrimeCredentials(  
    creds.AccessKey,  
    creds.SecretKey,  
    creds.Passphrase  
);  
  
const client = new CoinbasePrimeClient(credentials);  
  
const service = new StakingService(client);  
  
createUnstake(service).then(console.log).catch(console.error);

For more information, please visit the Prime TS SDK.

Tracking staking events and rewards

Staking-related transaction events can be tracked using either the List Portfolio Transactions or List Wallet Transactions endpoints. Both endpoints return identical response structures; the wallet-level endpoint simply scopes the results to a single wallet.

You can use these APIs to monitor staking lifecycle events (e.g., initiation, bonding, exit) and to track reward distribution over time. Below is an example of querying for staking rewards at the portfolio level.

TransactionsService transactionsService = PrimeServiceFactory.createTransactionsService(client);  
  
ListPortfolioTransactionsRequest request = new ListPortfolioTransactionsRequest.Builder()  
.portfolioId("PORTFOLIO_ID_HERE")  
.types("REWARD")  
.build();  
  
ListPortfolioTransactionsResponse response = transactionsService.listPortfolioTransactions(request);

To learn more about this SDK, please visit the Prime Java SDK.

TransactionsService transactionsService = PrimeServiceFactory.createTransactionsService(client);  
  
ListPortfolioTransactionsRequest request = new ListPortfolioTransactionsRequest.Builder()  
.portfolioId("PORTFOLIO_ID_HERE")  
.types("REWARD")  
.build();  
  
ListPortfolioTransactionsResponse response = transactionsService.listPortfolioTransactions(request);

To learn more about this SDK, please visit the Prime Java SDK.

var transactionsService = new TransactionsService(client);  
  
var request = new ListPortfolioTransactionsRequest("PORTFOLIO_ID_HERE", "REWARD");  
  
var response = transactionsService.ListPortfolioTransactions(request);

To learn more about this SDK, please visit the Prime .NET SDK.

    
transactionsService := transactions.NewTransactionsService(client)  
  
request := &transactions.ListPortfolioTransactionsRequest{  
PortfolioId: "PORTFOLIO_ID_HERE",  
Types: "REWARD"  
}  
  
response, err := transactionsService.ListPortfolioTransactions(context.Background(), request)

To learn more about this SDK, please visit the Prime Go SDK.


prime_client = PrimeClient(credentials)  
  
request = ListPortfolioTransactionsRequest(  
portfolio_id="PORTFOLIO_ID_HERE",  
types="REWARD",  
)  
  
response = prime_client.list_portfolio_transactions(request)

To learn more about this SDK, please visit the Prime Python SDK.



const transactionsService = new TransactionsService(client);  
  
transactionsService.listPortfolioTransactions({  
portfolioId: 'PORTFOLIO_ID_HERE'  
types: 'REWARD'  
}).then(async (response) => {  
console.log('Transactions: ', response);  
})

To learn more about this SDK, please visit the Prime TS SDK.

primectl list-portfolio-transactions --help

Staking events may also be tracked using Prime activities. For more information, visit the Activities page.

GET STARTED

WALLETS

PAYMENTS

SWAPS

BASE TOOLS

DATA

AI

FAUCET

CONSUMER APIS

INSTITUTIONAL APIS

Staking

Staking a Wallet

Unstaking a wallet

Tracking staking events and rewards

GET STARTED

WALLETS

PAYMENTS

SWAPS

BASE TOOLS

DATA

AI

STAKING

FAUCET

CONSUMER APIS

INSTITUTIONAL APIS

​Staking a Wallet

​Unstaking a wallet

​Tracking staking events and rewards

Staking a Wallet

Unstaking a wallet

Tracking staking events and rewards