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>"
  }
}
'
import requests

url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate"

payload = {
"idempotency_key": "<string>",
"currency_symbol": "<string>",
"amount": "<string>",
"metadata": { "external_id": "<string>" }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
idempotency_key: '<string>',
currency_symbol: '<string>',
amount: '<string>',
metadata: {external_id: '<string>'}
})
};

fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotency_key' => '<string>',
'currency_symbol' => '<string>',
'amount' => '<string>',
'metadata' => [
'external_id' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate"

payload := strings.NewReader("{\n \"idempotency_key\": \"<string>\",\n \"currency_symbol\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {\n \"external_id\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate")
.header("Content-Type", "application/json")
.body("{\n \"idempotency_key\": \"<string>\",\n \"currency_symbol\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {\n \"external_id\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/staking/initiate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotency_key\": \"<string>\",\n \"currency_symbol\": \"<string>\",\n \"amount\": \"<string>\",\n \"metadata\": {\n \"external_id\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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