Skip to main content
GET
/
clearloop
/
settlements
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>",
      "custodian": "<string>",
      "cycleEndTimestamp": "<string>",
      "cycleStartTimestamp": "<string>",
      "deadline": "<string>",
      "exchange": "<string>",
      "exchangeId": "<string>",
      "failureReason": "<string>",
      "settlementDetails": [
        {
          "clientAccountId": "<string>",
          "exchangeSettlementId": "<string>",
          "organizationId": "<string>",
          "pnlAttributionEndTimestamp": "<string>",
          "pnlAttributionStartTimestamp": "<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

Unique Copper account identifier for which records can be retrieved

​
clientAccountId
string

Exchange account unique identifier for which records can be retrieved

​
exchangeSettlementId
string

Unique exchange settlement identifier per instruction, defined by client account and settlement currency. Guaranteed to be unique within each exchange.

​
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 (in milliseconds) of the date and time when the settlement cycle has started

​
cycles
string

The number of most recent cycles that you want to retrieve for every exchange. For example, specifying 1 will return the last settlement for every queried 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

Maximum number of records to return (pagination limit)

​
sortDirection
string
default:asc

The sorting order of settlement records, which are sorted by their createdAt field: asc (ascending) or desc (descending)

​
offset
string

Number of records to skip before starting to return results (pagination offset)

Response

OK

​
settlements
object[]
required
​
pagination
object