Get ClearLoop Settlement by ID
curl --request GET \
--url https://api.copper.co/platform/clearloop/settlements/{settlementId}import requests
url = "https://api.copper.co/platform/clearloop/settlements/{settlementId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/clearloop/settlements/{settlementId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.copper.co/platform/clearloop/settlements/{settlementId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.copper.co/platform/clearloop/settlements/{settlementId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.copper.co/platform/clearloop/settlements/{settlementId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/clearloop/settlements/{settlementId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"cycleStartTimestamp": "<string>",
"exchange": "<string>",
"exchangeId": "<string>",
"settlementId": "<string>",
"settlementStatus": "new",
"settlementSubStatus": "started",
"completedAt": "<string>",
"createdAt": "<string>",
"custodian": "<string>",
"cycleEndTimestamp": "<string>",
"deadline": "<string>",
"failureReason": "<string>",
"settlementDetails": [
{
"clientAccountId": "<string>",
"exchangeSettlementId": "<string>",
"portfolioId": "<string>",
"settlementInstructions": [
{
"currency": "<string>",
"settlementAmount": "<string>",
"balance": "<string>",
"orderId": "<string>",
"orderStatus": "new",
"settlementAmountUSD": "<string>",
"settlementInstructionId": "<string>",
"status": "new"
}
],
"exclusionDetails": {
"exclusionReason": "<string>",
"exclusionSettlementId": "<string>"
},
"organizationId": "<string>",
"pnlAttributionEndTimestamp": "<string>",
"pnlAttributionStartTimestamp": "<string>",
"status": "new"
}
],
"triggerOrigin": "<string>"
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}clearloop
Get ClearLoop Settlement by ID
GET
/
clearloop
/
settlements
/
{settlementId}
Get ClearLoop Settlement by ID
curl --request GET \
--url https://api.copper.co/platform/clearloop/settlements/{settlementId}import requests
url = "https://api.copper.co/platform/clearloop/settlements/{settlementId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/clearloop/settlements/{settlementId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.copper.co/platform/clearloop/settlements/{settlementId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.copper.co/platform/clearloop/settlements/{settlementId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.copper.co/platform/clearloop/settlements/{settlementId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/clearloop/settlements/{settlementId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"cycleStartTimestamp": "<string>",
"exchange": "<string>",
"exchangeId": "<string>",
"settlementId": "<string>",
"settlementStatus": "new",
"settlementSubStatus": "started",
"completedAt": "<string>",
"createdAt": "<string>",
"custodian": "<string>",
"cycleEndTimestamp": "<string>",
"deadline": "<string>",
"failureReason": "<string>",
"settlementDetails": [
{
"clientAccountId": "<string>",
"exchangeSettlementId": "<string>",
"portfolioId": "<string>",
"settlementInstructions": [
{
"currency": "<string>",
"settlementAmount": "<string>",
"balance": "<string>",
"orderId": "<string>",
"orderStatus": "new",
"settlementAmountUSD": "<string>",
"settlementInstructionId": "<string>",
"status": "new"
}
],
"exclusionDetails": {
"exclusionReason": "<string>",
"exclusionSettlementId": "<string>"
},
"organizationId": "<string>",
"pnlAttributionEndTimestamp": "<string>",
"pnlAttributionStartTimestamp": "<string>",
"status": "new"
}
],
"triggerOrigin": "<string>"
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Response
OK
Status describing the settlement. See details
Available options:
new, pending-exchange-confirmation, in-progress, post-pnl-fetch, completed, failed, skipped, cancelled, partially-completed, ignored, pre-pnl-fetch, trading-account-order-execution-completed, on-chain-orders-in-progress, pre-termination, under-review, pending-settlements-check, excluded Sub-status providing additional context to the status of the settlement. See details
Available options:
started, in-progress, completed, failed, exchange-api-failure, waiting-exchange-calculation, insufficient-collateral, negative-balances, client-loss-greater-than-delegated, pending-previous-settlement, copper-order-flow-failed, pending-order-processing, pending-order-creation, pending-delegations, pending-exchange-notification, paused, waiting-funds, settlement-not-complete-within-cycle-time, manual-resolving, partially-completed, all-portfolios-excluded Was this page helpful?