blockchain
clearloop
network
address-book
currencies
API Reference
orders
files
lending
- GETGet Loans
- POSTCreate Loan
- PATCHCalculate Loan LTV Dry Run
- PATCHAccept Loan Term Extension
- PATCHAccept Loan Interest Payment
- PATCHAccept Loan
- PATCHAccept Loan Rebalance
- PATCHAccept Loan Repayment
- PATCHAccept Loan Rerate
- PATCHAccept Loan Top Up
- PATCHApprove Loan
- PATCHCancel Loan Term Extension
- PATCHCancel Loan Interest Payment
- PATCHCancel Loan
- PATCHCancel Loan Rebalance
- PATCHCancel Loan Repayment
- PATCHCancel Loan Rerate
- PATCHCancel Loan Top Up
- PATCHConfirm External Disbursement
- PATCHConfirm External Interest Payment
- PATCHConfirm External Repayment
- PATCHConfirm External Top Up
- PATCHDefault Loan
- PATCHEstimate Loan Leverage Ratio
- PATCHEstimate Loan LTV
- PATCHExtend Loan Term
- GETGet Loan by ID
- PATCHPay Loan Interest
- PATCHRebalance Loan
- PATCHReject Loan
- PATCHRepay Loan
- PATCHRerate Loan
- PATCHSecure Collateral Loan
- PATCHTop Up Loan
reports
Get Portfolios
Retrieve your portfolios (in UI terms - accounts)
curl --request GET \
--url https://api.copper.co/platform/portfolios
{
"portfolios": [
{
"createdAt": "1617235200000",
"createdBy": "<string>",
"extra": {
"baseCurrency": "<string>",
"clearLoopDelegationsBlocked": true,
"clearLoopPortfolioId": "<string>",
"clearLoopUnDelegationsBlocked": true,
"clientAccountId": "<string>",
"customerId": "<string>",
"exchange": "okex",
"externalAccountId": "<string>",
"parentPortfolioId": "<string>",
"quoteCurrency": "<string>",
"showWalletBalance": "real",
"usdWithdrawalLimit": "<string>"
},
"isActive": true,
"organizationId": "1fa95ae7-5f74-4258-a4c6-687b39d7941d",
"portfolioDescription": "My portfolio description",
"portfolioId": "<string>",
"portfolioName": "My portfolio",
"portfolioType": "custody",
"status": "active",
"updatedAt": "1617235200000",
"updatedBy": "<string>"
}
]
}
Query Parameters
Filter by portfolio types. See details
custody
, trading-vault
, trading
, external
, clearloop
Filter by portfolio types not in. See details
custody
, trading-vault
, trading
, external
, clearloop
Filter by portfolio id
Filter by organization id
Filter by is active
Filter only DeFi vaults
Filter by signing enabled signing flow type
Offset for pagination
Limit for pagination
Response
List of portfolios
Portfolio creation date
"1617235200000"
Portfolio creator ID
Portfolio active state
Portfolio id
Portfolio name
"My portfolio"
Portfolio type. See details
custody
, trading-vault
, trading
, external
, clearloop
Portfolio extra data
Base currency for external account that use margin pair
Portfolio Delegations are disabled/blocked
Identifier of a ClearLoop portfolio, if any
Portfolio Undelegations are disabled/blocked
Unique client exchange's account identifier used for ClearLoop
External customer identifier from an exchange
External exchange associated with this portfolio
"okex"
External portfolio exchange account type
Identifier of an external third-party account related to the portfolio
Identifier of a parent portfolio, if any
Quote currency for external account that use margin pair
Type of balance shown for the external account. See details
real
, margin
Withdrawal limit of the portfolio in USD
Organization ID
"1fa95ae7-5f74-4258-a4c6-687b39d7941d"
Portfolio description
"My portfolio description"
Portfolio status
Portfolio update date
"1617235200000"
Portfolio updater ID
curl --request GET \
--url https://api.copper.co/platform/portfolios
{
"portfolios": [
{
"createdAt": "1617235200000",
"createdBy": "<string>",
"extra": {
"baseCurrency": "<string>",
"clearLoopDelegationsBlocked": true,
"clearLoopPortfolioId": "<string>",
"clearLoopUnDelegationsBlocked": true,
"clientAccountId": "<string>",
"customerId": "<string>",
"exchange": "okex",
"externalAccountId": "<string>",
"parentPortfolioId": "<string>",
"quoteCurrency": "<string>",
"showWalletBalance": "real",
"usdWithdrawalLimit": "<string>"
},
"isActive": true,
"organizationId": "1fa95ae7-5f74-4258-a4c6-687b39d7941d",
"portfolioDescription": "My portfolio description",
"portfolioId": "<string>",
"portfolioName": "My portfolio",
"portfolioType": "custody",
"status": "active",
"updatedAt": "1617235200000",
"updatedBy": "<string>"
}
]
}