clearloop

Get ClearLoop Settlements

get/clearloop/settlements

Request

Query parameters

portfolioIdstring

Unique Copper account identifier for which records can be retrieved

clientAccountIdstring

Exchange account unique identifier for which records can be retrieved

exchangeSettlementIdstring

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

createdAfterstring

Unix timestamp in milliseconds to filter settlements created after this time

createdBeforestring

Unix timestamp in milliseconds to filter settlements created before this time

cycleStartTimestampstring

Unix timestamp (in milliseconds) of the date and time when the settlement cycle has started

cyclesstring

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

clearLoopSettlementStatusesClearLoopSettlementStatus[]

Comma separated list with statuses to be included. See details

clearLoopSettlementStatusesNotInClearLoopSettlementStatus[]

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

limitstring

Maximum number of records to return (pagination limit)

sortDirectionstring

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

offsetstring

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

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.