Get balance for portfolio/asset

GET

api

portfolios

{portfolio}

balances

{asset}

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/balances/{asset} \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'

{
  "asset_id": "14thr7fc-1-1",
  "asset_name": "BTC",
  "asset_uuid": "d92669ba-8a04-46d8-9b28-a2bbaeee3b9a",
  "quantity": 1.75,
  "hold": 0.5,
  "hold_available_for_collateral": 0.5,
  "transfer_hold": 0.25,
  "collateral_value": 0.9,
  "max_withdraw_amount": 0.9,
  "loan": 1,
  "loan_collateral_requirement": 0,
  "pledged_collateral_quantity": 0.5,
  "loan_initial_margin_contribution": 0.07,
  "collateral_backed_overdraft_loan": 100.5,
  "user_requested_loan": 548.5
}

PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
GetBalanceForPortfolioAssetRequest request = new GetBalanceForPortfolioAssetRequest.Builder()
    .portfolio("portfolio_id")
    .asset("BTC")
    .build();
GetBalanceForPortfolioAssetResponse response = portfoliosService.getBalanceForPortfolioAsset(request);

For more information, please visit the INTX Java SDK.

PortfoliosService portfoliosService = IntxServiceFactory.createPortfoliosService(client);
GetBalanceForPortfolioAssetRequest request = new GetBalanceForPortfolioAssetRequest.Builder()
    .portfolio("portfolio_id")
    .asset("BTC")
    .build();
GetBalanceForPortfolioAssetResponse response = portfoliosService.getBalanceForPortfolioAsset(request);

For more information, please visit the INTX Java SDK.

var portfoliosService = new PortfoliosService(client);
var request = new GetBalanceForPortfolioAssetRequest(
    Portfolio: "portfolio_id",
    Asset: "BTC",
);
var response = portfoliosService.GetBalanceForPortfolioAsset(request);

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

portfoliosSvc := portfolios.NewPortfoliosService(client)
request := &portfolios.GetAssetBalanceRequest{
    Portfolio: "portfolio_id",
    Asset: "BTC",
}
response, err := portfoliosSvc.GetAssetBalance(context.Background(), request)

For more information, please visit the INTX Go SDK.

client = IntxClient()
request = GetBalanceForPortfolioAssetRequest(
    portfolio="portfolio_id",
    asset="BTC",
)
response = client.get_balance_for_portfolio_asset(request)

For more information, please visit the INTX Python SDK.

const portfoliosService = new PortfoliosService(client);

portfoliosService.getAssetBalance({
    portfolio: 'PORTFOLIO_ID_HERE',
    asset: 'ETH',
}).then(async (response) => {
    console.log('Portfolio Asset Balance: ', response);
})

For more information, please visit the INTX TS SDK.

intxctl get-balance-for-asset --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)

asset

string

required

Identifies the asset by name (e.g., BTC), UUID (e.g., 291efb0f-2396-4d41-ad03-db3b2311cb2c), or asset ID (e.g., 1482439423963469)

Response

200

application/json

Balance information

The response is of type object.

Enable/Disable portfolio cross collateral

Get fund transfer limit between portfolios

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/portfolios/{portfolio}/balances/{asset} \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>'

{
  "asset_id": "14thr7fc-1-1",
  "asset_name": "BTC",
  "asset_uuid": "d92669ba-8a04-46d8-9b28-a2bbaeee3b9a",
  "quantity": 1.75,
  "hold": 0.5,
  "hold_available_for_collateral": 0.5,
  "transfer_hold": 0.25,
  "collateral_value": 0.9,
  "max_withdraw_amount": 0.9,
  "loan": 1,
  "loan_collateral_requirement": 0,
  "pledged_collateral_quantity": 0.5,
  "loan_initial_margin_contribution": 0.07,
  "collateral_backed_overdraft_loan": 100.5,
  "user_requested_loan": 548.5
}

REST API

FIX API

WEBSOCKET FEED

Get balance for portfolio/asset

Authorizations

Path Parameters

Response