List Portfolio Balances
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balancesimport requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances', 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}/balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"balances": [
{
"symbol": "BTC",
"amount": "109.42",
"holds": "2",
"bonded_amount": "109.42",
"reserved_amount": "109.42",
"unbonding_amount": "109.42",
"unvested_amount": "109.42",
"pending_rewards_amount": "109.42",
"past_rewards_amount": "109.42",
"bondable_amount": "109.42",
"withdrawable_amount": "109.42",
"fiat_amount": "109.42",
"unbondable_amount": "109.42",
"claimable_rewards_amount": "0.241437903"
}
],
"type": "TRADING_BALANCES",
"trading_balances": {
"total": "<string>",
"holds": "<string>"
},
"vault_balances": {
"total": "<string>",
"holds": "<string>"
},
"prime_custody_balances": {
"total": "<string>",
"holds": "<string>"
}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"subcode": "PORTFOLIO_ID_REQUIRED",
"trace_id": "<string>"
}{
"code": "PERMISSION_DENIED",
"message": "<string>",
"subcode": "AUTH_RESOURCE_ACCESS_DENIED",
"trace_id": "<string>"
}{
"code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"subcode": "AUTH_RESOURCE_NOT_FOUND",
"trace_id": "<string>"
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "<string>",
"subcode": "SERVER_RATE_LIMIT_EXCEEDED",
"trace_id": "<string>"
}{
"code": "SERVICE_UNAVAILABLE",
"message": "<string>",
"subcode": "SERVER_MAINTENANCE_MODE_ACTIVE",
"trace_id": "<string>"
}Balances
List Portfolio Balances
List all balances for a specific portfolio.
GET
/
v1
/
portfolios
/
{portfolio_id}
/
balances
List Portfolio Balances
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balancesimport requests
url = "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances', 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}/balances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/balances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"balances": [
{
"symbol": "BTC",
"amount": "109.42",
"holds": "2",
"bonded_amount": "109.42",
"reserved_amount": "109.42",
"unbonding_amount": "109.42",
"unvested_amount": "109.42",
"pending_rewards_amount": "109.42",
"past_rewards_amount": "109.42",
"bondable_amount": "109.42",
"withdrawable_amount": "109.42",
"fiat_amount": "109.42",
"unbondable_amount": "109.42",
"claimable_rewards_amount": "0.241437903"
}
],
"type": "TRADING_BALANCES",
"trading_balances": {
"total": "<string>",
"holds": "<string>"
},
"vault_balances": {
"total": "<string>",
"holds": "<string>"
},
"prime_custody_balances": {
"total": "<string>",
"holds": "<string>"
}
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"subcode": "PORTFOLIO_ID_REQUIRED",
"trace_id": "<string>"
}{
"code": "PERMISSION_DENIED",
"message": "<string>",
"subcode": "AUTH_RESOURCE_ACCESS_DENIED",
"trace_id": "<string>"
}{
"code": "RESOURCE_NOT_FOUND",
"message": "<string>",
"subcode": "AUTH_RESOURCE_NOT_FOUND",
"trace_id": "<string>"
}{
"code": "RATE_LIMIT_EXCEEDED",
"message": "<string>",
"subcode": "SERVER_RATE_LIMIT_EXCEEDED",
"trace_id": "<string>"
}{
"code": "SERVICE_UNAVAILABLE",
"message": "<string>",
"subcode": "SERVER_MAINTENANCE_MODE_ACTIVE",
"trace_id": "<string>"
}Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples
For more information, please visit the Prime Java SDK.For more information, please visit the Prime .NET SDK.For more information, please visit the Prime Go SDK.For more information, please visit the Prime Python SDK.For more information, please visit the Prime CLI.For more information, please visit the Prime TS SDK.
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
BalancesService balancesService = PrimeServiceFactory.createBalancesService(client);
ListPortfolioBalancesRequest request = new ListPortfolioBalancesRequest.Builder("PORTFOLIO_ID_HERE").build();
ListPortfolioBalancesResponse response = balancesService.listPortfolioBalances(request);
var balancesService = new BalancesService(client);
var request = new ListPortfolioBalancesRequest("PORTFOLIO_ID_HERE");
var response = balancesService.ListPortfolioBalances(request);
balancesService := balances.NewBalancesService(client)
request := &balances.ListPortfolioBalancesRequest{
PortfolioId: "PORTFOLIO_ID_HERE",
}
response, err := balancesService.ListPortfolioBalances(context.Background(), request)
prime_client = PrimeClient(credentials)
request = ListPortfolioBalancesRequest(
portfolio_id="PORTFOLIO_ID_HERE",
)
response = prime_client.list_portfolio_balances(request)
primectl list-portfolio-balances --help
const balancesService = new BalancesService(client);
balancesService.listPortfolioBalances({
portfolioId: 'PORTFOLIO_ID_HERE',
symbols: 'ETH'
}).then(async (response) => {
console.log('Balances: ', response);
})
Path Parameters
The portfolio ID
Query Parameters
A list of symbols by which to filter the response
A type by which to filter balances
- UNKNOWN_BALANCE_TYPE: nil
- TRADING_BALANCES: Trading balances
- VAULT_BALANCES: Vault balances
- TOTAL_BALANCES: Total balances (The sum of vault and trading + prime custody)
- PRIME_CUSTODY_BALANCES: Prime custody balances
- UNIFIED_TOTAL_BALANCES: Unified total balance across networks and wallet types (vault + trading + prime custody)
Available options:
TRADING_BALANCES, VAULT_BALANCES, TOTAL_BALANCES, PRIME_CUSTODY_BALANCES, UNIFIED_TOTAL_BALANCES Response
A successful response.
A list of balances.
Show child attributes
Show child attributes
Available options:
TRADING_BALANCES, VAULT_BALANCES, TOTAL_BALANCES, PRIME_CUSTODY_BALANCES, UNIFIED_TOTAL_BALANCES Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?