Get Portfolio Credit Information

GET

portfolios

{portfolio_id}

credit

curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/credit

{
  "post_trade_credit": {
    "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
    "currency": "USD",
    "limit": "100000",
    "utilized": "4000",
    "available": "96000",
    "frozen": true,
    "frozen_reason": "Portfolio frozen manually by admin",
    "amounts_due": [
      {
        "currency": "BTC",
        "amount": "4000",
        "due_date": "2021-05-31T09:59:59.000Z"
      }
    ],
    "enabled": true,
    "adjusted_credit_utilized": "5000",
    "adjusted_portfolio_equity": "2000"
  }
}

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

PortfoliosService portfoliosService = PrimeServiceFactory.createPortfoliosService(client);

GetPortfolioCreditInformationRequest request = new GetPortfolioCreditInformationRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .build();

GetPortfolioCreditInformationResponse response = portfoliosService.getPortfolioCreditInformation(request);

For more information, please visit the Prime Java SDK.

PortfoliosService portfoliosService = PrimeServiceFactory.createPortfoliosService(client);

GetPortfolioCreditInformationRequest request = new GetPortfolioCreditInformationRequest.Builder()
    .portfolioId("PORTFOLIO_ID_HERE")
    .build();

GetPortfolioCreditInformationResponse response = portfoliosService.getPortfolioCreditInformation(request);

For more information, please visit the Prime Java SDK.

var portfoliosService = new PortfoliosService(client);

var request = new GetPortfolioCreditInformationRequest("PORTFOLIO_ID_HERE");

var response = portfoliosService.GetPortfolioCreditInformation(request);

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

portfoliosService := portfolios.NewPortfoliosService(client)

request := &portfolios.GetPortfolioCreditInformationRequest{
    PortfolioId: "PORTFOLIO_ID_HERE",
}

response, err := portfoliosService.GetPortfolioCreditInformation(context.Background(), request)

For more information, please visit the Prime Go SDK.

prime_client = PrimeClient(credentials)

request = GetPortfolioCreditInformationRequest(
    portfolio_id="PORTFOLIO_ID_HERE",
)

response = prime_client.get_portfolio_credit_information(request)

For more information, please visit the Prime Python SDK.

primectl get-credit --help

For more information, please visit the Prime CLI.

const portfoliosService = new PortfoliosService(client);

portfoliosService.getPortfolioCredit({
    portfolioId: 'PORTFOLIO_ID_HERE'
}).then(async (response) => {
    console.log('Portfolio Credit: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id

string

required

The portfolio ID

Response

200

application/json

A successful response.

The response is of type object.

Get Portfolio Buying Power

Get Portfolio Withdrawal Power

curl --request GET \
  --url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/credit

{
  "post_trade_credit": {
    "portfolio_id": "e8bbed13-fa33-41de-86d5-4335d8f08166",
    "currency": "USD",
    "limit": "100000",
    "utilized": "4000",
    "available": "96000",
    "frozen": true,
    "frozen_reason": "Portfolio frozen manually by admin",
    "amounts_due": [
      {
        "currency": "BTC",
        "amount": "4000",
        "due_date": "2021-05-31T09:59:59.000Z"
      }
    ],
    "enabled": true,
    "adjusted_credit_utilized": "5000",
    "adjusted_portfolio_equity": "2000"
  }
}

REST API

FIX API

Websocket Feed

Get Portfolio Credit Information

Path Parameters

Response