Skip to main content
POST
/
v1
/
portfolios
/
{portfolio_id}
/
staking
/
initiate
Request to stake currency in a portfolio
curl --request POST \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotency_key": "<string>",
  "currency_symbol": "<string>",
  "amount": "<string>",
  "metadata": {
    "external_id": "<string>"
  }
}
'
{
  "activity_id": "<string>",
  "transaction_id": "<string>"
}

Path Parameters

​
portfolio_id
string
required

The portfolio ID

Body

application/json
​
idempotency_key
string
required

The client generated idempotency key (uuid required) for requested execution. Subsequent requests using the same key will not create new transactions.

​
currency_symbol
string
required

The currency symbol to stake

​
amount
string
required

The quantity of the chosen currency to stake

​
metadata
object

Response

200 - application/json

A successful response.

​
activity_id
string

The ID for the created activity

​
transaction_id
string

The ID for the created transaction