Copper Developer Portal

Developer Guides

API Reference

Product Guides

Changelog

Bilateral Lending

Deprecated API

Copper Platform

Retrieve Portfolio by ID

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

Identifier of an external third-party account related to the portfolio

Quote currency for external account that use margin pair

Type of balance shown for the external account. [See details](/enums/BalanceType)

Introduction

When you perform request without specifying any additional filters like portfolioId or currency, the method returns all wallets which has non-zero balances only

Fetch balances

Fetch transfers

Fetch orders

Fetch updated transfer or orders

Move funds between portfolios

Withdraw to an Address Book address

Move funds between exchange subaccounts

Move funds between exchanges

Chain of withdrawals

Approve order

Sign order

Cancel order

Delegate (lock) funds

Undelegate (unlock) funds

Fetch delegated balances

How to launch

Create a withdrawal order

Start signing

Sign transaction

Get Copper Unlimited Transaction

Enabling SSL/TLS

Example of the service

What are Fees Vaults

Create a smart-call order

Create a multi-smart-call order

Get staking reward orders

Create staking order

Get active stakes

Get pending stakes

Get outstanding stakes

How to set up

Validate signature

Webhook events

Getting Started

Authentication

Rate limits

Errors

Create API Key

Try it out

Single Sign-On

Multi-factor authentication

Passkeys

Permissions

Validate Address

Get ClearLoop Actions

Get ClearLoop Action by ID

Get ClearLoop Balances

Get ClearLoop Exchanges

Get ClearLoop Exchange by ID

Get ClearLoop Settlements

Get ClearLoop Settlement by ID

Get Counterparties

Retrieve information about crypto addresses in an organization's address book

Get Crypto Addresses

Create a new crypto address in an organization's address book

Create Crypto Address

Retrieve information about a crypto address in an organization's address book

Get Crypto Address by ID

Deactivate a crypto address in an organization's address book

Deactivate Crypto Address

Get Currencies

Get Currency

Retrieve information about all deposit targets in an organization

Get Deposit Targets

Create Deposit Target

Activate Deposit Target Currency

Dry Run Order

Get Orders

Create Order

Bulk orders creation. If the execution of an order fails, it will not affect the execution of other orders. Failed orders will be returned in the response. The bulk size should be less than 50 orders.

Create Multiple Orders

Accept Order

Cancel Order

Approve (co-sign) Order

Get Order by ID

Start Signing

Download Files

Get Organizations

Retrieve information about all activities in the organization

Get Activities

Retrieve information about organization members

Get Organization Members

Retrieve your portfolios (in UI terms - accounts)

Get Portfolios

Create Portfolio

Archive Portfolio

Create Orders NET Report

Create Stake Orders Report

Create Stake Rewards Report

Create Position Statement Report

Create Balance Report

Get Active Stakes

Get Outstanding Stakes

Get Pending Stakes

Get Wallets

Create Wallet

Get Wallet by ID

Get Loans

Initiate loan creation. This action can only be carried out by the lender.

Create Loan

Accept a loan. This action can only be carried out by the borrower.

Accept Loan

Accept the loan rebalance request. Only a lender can carry out this action.

Accept Loan Rebalance

Accept the full or partial loan repayment request. Only requests that were initiated by the counterparty can be accepted.

Accept Loan Repayment

Accept the loan interest rerate request. Only the borrower can carry out this action.

Accept Loan Rerate

Accept the loan top up request. Only a borrower can carry out this action.

Accept Loan Top Up

Approve a loan. This action can only be carried out by the lender if a loan is in awaiting-approval state.

Approve Loan

Cancel a loan that is awaiting acceptance. This action can be carried out by the lender or the borrower.

Cancel Loan

Cancel the loan rebalance request that is awaiting acceptance. This action can be carried out by the lender or the borrower.

Cancel Loan Rebalance

Cancel the full or partial loan repayment. This action can be carried out by the borrower or the lender.

Cancel Loan Repayment

Cancel the loan interest rerate request that is awaiting acceptance. This action can be carried out by the lender or the borrower.

Cancel Loan Rerate

Cancel the loan top up request that is awaiting acceptance. This action can be carried out by the lender or the borrower.

Cancel Loan Top Up

Confirm the external disbursement of an off-platform managed loan. Only the lender can carry out this action.

Confirm External Disbursement

Confirm the external repayment of an off-platform managed loan. Only the lender can carry out this action.

Confirm External Repayment

Confirm the external top up of an off-platform managed loan. Only the lender can carry out this action.

Confirm External Top Up

Default a loan that is in a defaultable state. This action can only be carried out by the lender.

Default Loan

Obtain an estimated loan LTV after taking into account requested loan amount and/or collateral amount adjustments.

Estimate Loan LTV

Obtain an estimated loan leverage ratio after taking into account requested loan amount and/or collateral amount adjustments.

Estimate Loan Leverage Ratio

Cancel the loan term extensino request. This action can be carried out by the borrower or the lender.

Cancel Loan Term Extension

Get Loan by ID

Create a loan rebalance request. This action can only be carried out by the borrower and must be accepted by the lender.

Rebalance Loan

Reject a loan. This action can only be carried out by the lender if a loan is in awaiting-approval state.

Reject Loan

Request the partial or full repayment of a loan. This request can be initiated by either the borrower or the lender. The resulting request needs to be accepted by the counterparty.

Repay Loan

Request a new loan interest rerate. The new interest rate must be stated in BPS. This action can only be carried out by the lender.

Rerate Loan

Secure collateral for a loan. This action can only be carried out by the borrower and should be invoked for both initial and subsequent collateral top ups.

Secure Collateral Loan

Request a loan top up. This action can only be carried out by the lender and must be accepted by the borrower.

Top Up Loan

<Warning>The `GET /accounts` API endpoint is deprecated and should not be used for new integrations. It will be removed in future releases.</Warning> To fetch portfolios, use the [`GET /portfolios`](/api-reference/portfolios/get-portfolios) endpoint instead.<br/> To retrieve wallets, use the [`GET /wallets`](/api-reference/wallets/get-wallets) endpoint.

API Documentation

blockchain

clearloop

network

address-book

currencies

deposit-targets

orders

files

organizations

portfolios

reports

stake

wallets

Retrieve Portfolio by ID

Path Parameters

Response