Skip to main content
POST
/
v1
/
portfolios
/
{portfolio_id}
/
wallets
/
{wallet_id}
/
staking
/
unstake
Request to unstake a wallet
curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/unstake \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotency_key": "<string>",
  "inputs": {
    "amount": "<string>",
    "validator_allocations": [
      {
        "validator_address": "<string>",
        "amount": "<string>"
      }
    ]
  },
  "metadata": {
    "external_id": "<string>"
  }
}
'
{
  "wallet_id": "<string>",
  "transaction_id": "<string>",
  "activity_id": "<string>"
}

Path Parameters

​
portfolio_id
string
required

The portfolio ID

​
wallet_id
string
required

The wallet ID

Body

application/json

StakingUnstakeRequest represents a request to initiate an unstaking operation.

​
idempotency_key
string
required

The client generated idempotency key for requested execution. Subsequent requests using the same key will fail

​
inputs
object

WalletUnstakeInputs contains the custom inputs for unstaking operations on a wallet. Requirements and supported fields vary by asset type.

​
metadata
object

WalletStakingMetadata contains optional metadata for wallet staking requests. external_id tags the discrete TWS transaction stake/unstake create; automatic reward crediting (e.g. SOL inflation) does not produce one. StakingClaimRewardsRequest intentionally omits this field; add metadata to claim rewards only if a supported network's claim flow creates a discrete TWS transaction clients need to tag.

Response

200 - application/json

A successful response.

StakingUnstakeResponse contains the response data from initiating an unstaking operation.

​
wallet_id
string
required

The wallet ID

​
transaction_id
string
required

ID of the newly created transaction, can be used to fetch details of the current state of execution

​
activity_id
string
required

The ID for the activity generated for this request