GET
/
clearloop
/
settlements
curl --request GET \
  --url https://api.copper.co/platform/clearloop/settlements
{
  "pagination": {
    "limit": "<string>",
    "page": "<string>",
    "pages": "<string>",
    "totalItems": "<string>"
  },
  "settlements": [
    {
      "completedAt": "<string>",
      "createdAt": "<string>",
      "cycleEndTimestamp": "<string>",
      "cycleStartTimestamp": "<string>",
      "deadline": "<string>",
      "exchange": "<string>",
      "exchangeId": "<string>",
      "failureReason": "<string>",
      "settlementDetails": [
        {
          "clientAccountId": "<string>",
          "exchangeSettlementId": "<string>",
          "organizationId": "<string>",
          "portfolioId": "<string>",
          "settlementInstructions": [
            {
              "balance": "<string>",
              "blockchainTransactionId": "<string>",
              "currency": "<string>",
              "orderId": "<string>",
              "orderStatus": "new",
              "settlementAmount": "<string>",
              "settlementAmountUSD": "<string>",
              "settlementInstructionId": "<string>",
              "status": "new"
            }
          ]
        }
      ],
      "settlementId": "<string>",
      "settlementStatus": "new"
    }
  ]
}

P&L is settled for all clients at the same time. If an exchange lacks sufficient collateral to meet all client settlement requirements, a margin call is issued, and client orders remain pending until the exchange tops up its account.

Note that Copper does not act as a calculation agent – P&L is always calculated by the exchange.

There is a dedicated section for settlements cycles in the user interface of every ClearLoop account, as shown below.

ClearLoop Settlements

To obtain information about past settlements, use the Settlements API with the following parameters:

Query Parameters

​
portfolioId
string

Copper portfolio unique identifier for which records can be retrieved

​
clientAccountId
string

Exchange account unique identifier for which records can be retrieved

​
exchangeSettlementId
string

Exchange settlement identifier per client. Every client has a different settlement id

​
createdAfter
string

Unix timestamp in milliseconds to filter settlements created after this time

​
createdBefore
string

Unix timestamp in milliseconds to filter settlements created before this time

​
cycleStartTimestamp
string

Unix timestamp down to the millisecond granularity that can be used to retrieve records for this cycle timestamp

​
cycles
string

Last number of cycles that you want to retrieve for every exchange. For example for 1 cycle, it would mean to bring back the last settlement for every exchange

​
clearLoopSettlementStatuses
enum<string>[]

Comma separated list with statuses to be included. See details

​
clearLoopSettlementStatusesNotIn
enum<string>[]

Comma separated list with statuses not to be included. See details

​
limit
string
default:1000

Limit for pagination

​
sortDirection
string
default:asc

Parameter to sort data in 'asc' ascending or 'desc' descending order according to 'created_at'

​
offset
string

Offset for pagination

Response

200
application/json

OK

The response is of type object.