Update portfolio - Coinbase Developer Documentation

Update portfolio

curl --request PUT \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio} \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.international.coinbase.com/api/v1/portfolios/{portfolio}"

payload = { "name": "<string>" }
headers = {
    "CB-ACCESS-KEY": "<api-key>",
    "CB-ACCESS-PASSPHRASE": "<api-key>",
    "CB-ACCESS-SIGN": "<api-key>",
    "CB-ACCESS-TIMESTAMP": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'CB-ACCESS-KEY': '<api-key>',
    'CB-ACCESS-PASSPHRASE': '<api-key>',
    'CB-ACCESS-SIGN': '<api-key>',
    'CB-ACCESS-TIMESTAMP': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.international.coinbase.com/api/v1/portfolios/{portfolio}', 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.international.coinbase.com/api/v1/portfolios/{portfolio}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "CB-ACCESS-KEY: <api-key>",
    "CB-ACCESS-PASSPHRASE: <api-key>",
    "CB-ACCESS-SIGN: <api-key>",
    "CB-ACCESS-TIMESTAMP: <api-key>",
    "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.international.coinbase.com/api/v1/portfolios/{portfolio}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("CB-ACCESS-KEY", "<api-key>")
	req.Header.Add("CB-ACCESS-PASSPHRASE", "<api-key>")
	req.Header.Add("CB-ACCESS-SIGN", "<api-key>")
	req.Header.Add("CB-ACCESS-TIMESTAMP", "<api-key>")
	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.put("https://api.international.coinbase.com/api/v1/portfolios/{portfolio}")
  .header("CB-ACCESS-KEY", "<api-key>")
  .header("CB-ACCESS-PASSPHRASE", "<api-key>")
  .header("CB-ACCESS-SIGN", "<api-key>")
  .header("CB-ACCESS-TIMESTAMP", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.international.coinbase.com/api/v1/portfolios/{portfolio}")

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

request = Net::HTTP::Put.new(url)
request["CB-ACCESS-KEY"] = '<api-key>'
request["CB-ACCESS-PASSPHRASE"] = '<api-key>'
request["CB-ACCESS-SIGN"] = '<api-key>'
request["CB-ACCESS-TIMESTAMP"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "portfolio_id": "14thr7ft-1-0",
  "portfolio_uuid": "3d50e347-6a59-4965-a4cd-b25934d84126",
  "name": "Investment Account",
  "user_uuid": "f67de785-60a7-45ea-b87a-07e83eae7c12",
  "maker_fee_rate": 0.02,
  "taker_fee_rate": 0.04,
  "trading_lock": true,
  "borrow_disabled": true,
  "is_lsp": true,
  "is_default": true,
  "cross_collateral_enabled": true,
  "pre_launch_trading_enabled": true,
  "disable_overdraft_protection": true
}

PUT

api

portfolios

{portfolio}

Update portfolio

curl --request PUT \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio} \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

import requests

url = "https://api.international.coinbase.com/api/v1/portfolios/{portfolio}"

payload = { "name": "<string>" }
headers = {
    "CB-ACCESS-KEY": "<api-key>",
    "CB-ACCESS-PASSPHRASE": "<api-key>",
    "CB-ACCESS-SIGN": "<api-key>",
    "CB-ACCESS-TIMESTAMP": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'CB-ACCESS-KEY': '<api-key>',
    'CB-ACCESS-PASSPHRASE': '<api-key>',
    'CB-ACCESS-SIGN': '<api-key>',
    'CB-ACCESS-TIMESTAMP': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.international.coinbase.com/api/v1/portfolios/{portfolio}', 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.international.coinbase.com/api/v1/portfolios/{portfolio}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "CB-ACCESS-KEY: <api-key>",
    "CB-ACCESS-PASSPHRASE: <api-key>",
    "CB-ACCESS-SIGN: <api-key>",
    "CB-ACCESS-TIMESTAMP: <api-key>",
    "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.international.coinbase.com/api/v1/portfolios/{portfolio}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\n}")

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

	req.Header.Add("CB-ACCESS-KEY", "<api-key>")
	req.Header.Add("CB-ACCESS-PASSPHRASE", "<api-key>")
	req.Header.Add("CB-ACCESS-SIGN", "<api-key>")
	req.Header.Add("CB-ACCESS-TIMESTAMP", "<api-key>")
	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.put("https://api.international.coinbase.com/api/v1/portfolios/{portfolio}")
  .header("CB-ACCESS-KEY", "<api-key>")
  .header("CB-ACCESS-PASSPHRASE", "<api-key>")
  .header("CB-ACCESS-SIGN", "<api-key>")
  .header("CB-ACCESS-TIMESTAMP", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.international.coinbase.com/api/v1/portfolios/{portfolio}")

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

request = Net::HTTP::Put.new(url)
request["CB-ACCESS-KEY"] = '<api-key>'
request["CB-ACCESS-PASSPHRASE"] = '<api-key>'
request["CB-ACCESS-SIGN"] = '<api-key>'
request["CB-ACCESS-TIMESTAMP"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "portfolio_id": "14thr7ft-1-0",
  "portfolio_uuid": "3d50e347-6a59-4965-a4cd-b25934d84126",
  "name": "Investment Account",
  "user_uuid": "f67de785-60a7-45ea-b87a-07e83eae7c12",
  "maker_fee_rate": 0.02,
  "taker_fee_rate": 0.04,
  "trading_lock": true,
  "borrow_disabled": true,
  "is_lsp": true,
  "is_default": true,
  "cross_collateral_enabled": true,
  "pre_launch_trading_enabled": true,
  "disable_overdraft_protection": true
}

PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
UpdatePortfolioRequest request = new UpdatePortfolioRequest.Builder()
    .portfolioId("portfolio_id")
    .name("new_portfolio_name")
    .build();
UpdatePortfolioResponse response = portfoliosService.updatePortfolio(request);

For more information, please visit the INTX Java SDK.

var portfoliosService = new PortfoliosService(client);
var request = new UpdatePortfolioRequest(
    Portfolio: "portfolio_id",
    Name: "new_portfolio_name",
);
var response = portfoliosService.UpdatePortfolio(request);

For more information, please visit the INTX .NET SDK.

portfoliosSvc := portfolios.NewPortfoliosService(client)
request := &portfolios.UpdatePortfolioRequest{
    Portfolio: "portfolio_id",
    Name: "new_portfolio_name",
}
response, err := portfoliosSvc.UpdatePortfolio(context.Background(), request)

For more information, please visit the INTX Go SDK.

client = IntxClient()
request = UpdatePortfolioRequest(
    portfolio="portfolio_id",
    name="new_portfolio_name",
)
response = client.update_portfolio(request)

For more information, please visit the INTX Python SDK.

const portfoliosService = new PortfoliosService(client);

portfoliosService.updatePortfolio({
    portfolio: 'PORTFOLIO_ID_HERE',
    name: 'new portfolio name',
}).then(async (response) => {
    console.log('Updated Portfolio: ', response);
})

For more information, please visit the INTX TS SDK.

intxctl update-portfolio --help

For more information, please visit the INTX CLI.

Authorizations

CB-ACCESS-KEY

string

header

required

The Client ID that owns the API Key for the request

CB-ACCESS-PASSPHRASE

string

header

required

The pass phrase affiliated with the API Key

CB-ACCESS-SIGN

string

header

required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

CB-ACCESS-TIMESTAMP

string

header

required

The timestamp of when the request is being made

Path Parameters

portfolio

string

required

Identifies the portfolio by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175)

Body

application/json

name

string

required

A unique name for the portfolio

Response

Portfolio

portfolio_id

string

A unique identifier for the portfolio

Example:

"14thr7ft-1-0"

portfolio_uuid

string<uuid>

A UUID for the portfolio

Example:

"3d50e347-6a59-4965-a4cd-b25934d84126"

name

string

A human readable name for the portfolio

Example:

"Investment Account"

user_uuid

string<uuid>

A user UUID for brokers that attribute a single user per portfolio

Example:

"f67de785-60a7-45ea-b87a-07e83eae7c12"

maker_fee_rate

string

The fee rate charged for order making liquidity

Example:

0.02

taker_fee_rate

string

The fee rate charged for orders taking liquidity

Example:

0.04

trading_lock

boolean

Indicates if the portfolio has been locked from trading

borrow_disabled

boolean

Indicates whether or not the portfolio can borrow

is_lsp

boolean

Indicates if the portfolio is setup to take liquidation assignments

is_default

boolean

Indicates if the portfolio is the account default portfolio

cross_collateral_enabled

boolean

Indicates if the cross collateral is enabled for the portfolio

pre_launch_trading_enabled

boolean

Indicates if pre-launch trading is enabled for the portfolio

disable_overdraft_protection

boolean

Indicates if loan overdraft protection is disabled for the portfolio

Transfer positions between portfolios

View max loan availability

⌘I