REST API
- Overview
- Prime Overview
- Requests
- Rate Limits
- Authentication
- Pagination
- CLI Setup
- SDKs
- Types
- GETGet Cross Margin Overview
- GETGet Entity Locate Availabilities
- GETGet Margin Information
- GETGet Portfolio Buying Power
- GETGet Portfolio Credit Information
- GETGet Portfolio Withdrawal Power
- GETGet Trade Finance Tiered Pricing Fees
- GETList Existing Locates
- GETList Financing Eligible Assets
- GETList Interest Accruals
- GETList Interest Accruals For Portfolio
- GETList Margin Call Summaries
- GETList Margin Conversions
- GETList Trade Finance Obligations
- POSTCreate New Locates
- GET
FIX API
Get Portfolio Credit Information
Copy
Ask AI
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/creditCopy
Ask AI
{
"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"
}
}Financing
Get Portfolio Credit Information
Retrieve a portfolio’s post-trade credit information.
GET
/
v1
/
portfolios
/
{portfolio_id}
/
credit
Get Portfolio Credit Information
Copy
Ask AI
curl --request GET \
--url https://api.prime.coinbase.com/v1/portfolios/{portfolio_id}/creditCopy
Ask AI
{
"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"
}
}Supported Products
- Trade Finance
- Java
- .NET
- Go
- Python
- CLI
- TS/JS
Report incorrect code
Copy
Ask AI
PortfoliosService portfoliosService = PrimeServiceFactory.createPortfoliosService(client);
GetPortfolioCreditInformationRequest request = new GetPortfolioCreditInformationRequest.Builder()
.portfolioId("PORTFOLIO_ID_HERE")
.build();
GetPortfolioCreditInformationResponse response = portfoliosService.getPortfolioCreditInformation(request);
Report incorrect code
Copy
Ask AI
var portfoliosService = new PortfoliosService(client);
var request = new GetPortfolioCreditInformationRequest("PORTFOLIO_ID_HERE");
var response = portfoliosService.GetPortfolioCreditInformation(request);
Report incorrect code
Copy
Ask AI
portfoliosService := portfolios.NewPortfoliosService(client)
request := &portfolios.GetPortfolioCreditInformationRequest{
PortfolioId: "PORTFOLIO_ID_HERE",
}
response, err := portfoliosService.GetPortfolioCreditInformation(context.Background(), request)
Report incorrect code
Copy
Ask AI
prime_client = PrimeClient(credentials)
request = GetPortfolioCreditInformationRequest(
portfolio_id="PORTFOLIO_ID_HERE",
)
response = prime_client.get_portfolio_credit_information(request)
Report incorrect code
Copy
Ask AI
primectl get-credit --help
Report incorrect code
Copy
Ask AI
const portfoliosService = new PortfoliosService(client);
portfoliosService.getPortfolioCredit({
portfolioId: 'PORTFOLIO_ID_HERE'
}).then(async (response) => {
console.log('Portfolio Credit: ', response);
})
Path Parameters
The portfolio ID
Response
200 - application/json
A successful response.
Show child attributes
Show child attributes
The unique ID of the portfolio
Example:
"e8bbed13-fa33-41de-86d5-4335d8f08166"
The currency symbol credit is denoted in
Example:
"USD"
The maximum credit limit
Example:
"100000"
The amount of credit used
Example:
"4000"
The amount of credit available
Example:
"96000"
Whether or not a portfolio is frozen due to balance outstanding or other reason
Example:
true
The reason why the portfolio is frozen
Example:
"Portfolio frozen manually by admin"
Show child attributes
Show child attributes
The currency this loan is due in
Example:
"BTC"
The amount due
Example:
"4000"
The date this settlement is due, expressed in UTC
Example:
"2021-05-31T09:59:59.000Z"
Whether the portfolio has credit enabled
Example:
true
The amount of adjusted credit used
Example:
"5000"
The amount of adjusted portfolio equity
Example:
"2000"
Was this page helpful?
⌘I