curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loansimport requests
url = "https://api.copper.co/platform/organizations/{organizationId}/loans"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/organizations/{organizationId}/loans', 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/organizations/{organizationId}/loans",
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/organizations/{organizationId}/loans"
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/organizations/{organizationId}/loans")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/organizations/{organizationId}/loans")
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{
"loans": [
{
"amount": "<string>",
"borrowerCounterpartyId": "<string>",
"borrowerOrganizationId": "<string>",
"createdBy": "<string>",
"currency": "<string>",
"externalId": "<string>",
"lenderCounterpartyId": "<string>",
"lenderOrganizationId": "<string>",
"loanId": "<string>",
"loanType": "agency-lending-parent-loan",
"mainCurrency": "<string>",
"status": "awaiting-approval",
"borrowerPortfolioId": "<string>",
"createdAt": "<string>",
"debtRatio": "<string>",
"debtRatioUpdatedAt": "<string>",
"defaultReason": "<string>",
"embedded": {
"childLoans": "<array>",
"collaterals": [
{
"amount": "<string>",
"collateralId": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
],
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
],
"loanAllocations": [
{
"allocationType": "disburse",
"amount": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"confirmedAt": "<string>",
"confirmedBy": "<string>",
"effectiveDate": "<string>"
},
"loanAllocationId": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"status": "new",
"counterpartyOrderId": "<string>",
"createdBy": "<string>",
"externalFailureDescription": "<string>",
"fromPortfolioId": "<string>",
"orderId": "<string>",
"requestorCounterpartyId": "<string>",
"terminatedAt": "<string>",
"toPortfolioId": "<string>",
"updatedAt": "<string>"
}
],
"loanInterest": {
"accruedInterest": "<string>",
"createdAt": "<string>",
"interestCurrency": "<string>",
"loanId": "<string>",
"loanInterestId": "<string>",
"lastPaymentAt": "<string>",
"realisedInterest": "<string>",
"unrealisedInterest": "<string>",
"updatedAt": "<string>"
},
"loanModifications": [
{
"createdAt": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"currentInterestRate": "<string>",
"currentMaturityDate": "<string>",
"newInterestRate": "<string>",
"newMaturityDate": "<string>"
},
"loanId": "<string>",
"loanModificationId": "<string>",
"modificationType": "rerate",
"status": "awaiting-acceptance",
"createdBy": "<string>",
"requestorCounterpartyId": "<string>",
"updatedAt": "<string>"
}
],
"marginCall": {}
},
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"approvedAt": "<string>",
"approvedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"defaultThreshold": "<string>",
"defaultedAt": "<string>",
"defaultedBy": "<string>",
"disbursedAt": "<string>",
"externalDisbursal": true,
"externalInterestPayment": true,
"initialLtv": "<string>",
"initiallyRequiredCollateralUsd": "<string>",
"lenderFeeShare": "<string>",
"lenderFeeSharePercentage": "<string>",
"marginCallExpiryPeriod": "<string>",
"marginCallThreshold": "<string>",
"rebalanceThreshold": "<string>",
"rejectedAt": "<string>",
"rejectedBy": "<string>",
"repaidAt": "<string>",
"repaidBy": "<string>",
"requiredCollaterals": [
{
"amount": "<string>",
"currency": "<string>",
"mainCurrency": "<string>",
"amountInUsd": "<string>"
}
]
},
"interestRate": "<string>",
"lenderPortfolioId": "<string>",
"maturityDate": "<string>",
"originalLoanAmount": "<string>",
"originalLoanValue": "<string>",
"startDate": "<string>",
"terminatedAt": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Get Loans
Retrieve loans
curl --request GET \
--url https://api.copper.co/platform/organizations/{organizationId}/loansimport requests
url = "https://api.copper.co/platform/organizations/{organizationId}/loans"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.copper.co/platform/organizations/{organizationId}/loans', 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/organizations/{organizationId}/loans",
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/organizations/{organizationId}/loans"
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/organizations/{organizationId}/loans")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.copper.co/platform/organizations/{organizationId}/loans")
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{
"loans": [
{
"amount": "<string>",
"borrowerCounterpartyId": "<string>",
"borrowerOrganizationId": "<string>",
"createdBy": "<string>",
"currency": "<string>",
"externalId": "<string>",
"lenderCounterpartyId": "<string>",
"lenderOrganizationId": "<string>",
"loanId": "<string>",
"loanType": "agency-lending-parent-loan",
"mainCurrency": "<string>",
"status": "awaiting-approval",
"borrowerPortfolioId": "<string>",
"createdAt": "<string>",
"debtRatio": "<string>",
"debtRatioUpdatedAt": "<string>",
"defaultReason": "<string>",
"embedded": {
"childLoans": "<array>",
"collaterals": [
{
"amount": "<string>",
"collateralId": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"portfolioId": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
],
"counterparties": [
{
"counterpartyId": "<string>",
"counterpartyName": "<string>",
"counterpartyType": "standard",
"networkTag": "<string>",
"backgroundImageId": "<string>",
"counterpartyDescription": "<string>",
"extra": {
"exchangeId": "<string>"
},
"imageId": "<string>",
"priority": "<string>",
"tags": [
"featured"
]
}
],
"loanAllocations": [
{
"allocationType": "disburse",
"amount": "<string>",
"createdAt": "<string>",
"currency": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"confirmedAt": "<string>",
"confirmedBy": "<string>",
"effectiveDate": "<string>"
},
"loanAllocationId": "<string>",
"loanId": "<string>",
"mainCurrency": "<string>",
"status": "new",
"counterpartyOrderId": "<string>",
"createdBy": "<string>",
"externalFailureDescription": "<string>",
"fromPortfolioId": "<string>",
"orderId": "<string>",
"requestorCounterpartyId": "<string>",
"terminatedAt": "<string>",
"toPortfolioId": "<string>",
"updatedAt": "<string>"
}
],
"loanInterest": {
"accruedInterest": "<string>",
"createdAt": "<string>",
"interestCurrency": "<string>",
"loanId": "<string>",
"loanInterestId": "<string>",
"lastPaymentAt": "<string>",
"realisedInterest": "<string>",
"unrealisedInterest": "<string>",
"updatedAt": "<string>"
},
"loanModifications": [
{
"createdAt": "<string>",
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"currentInterestRate": "<string>",
"currentMaturityDate": "<string>",
"newInterestRate": "<string>",
"newMaturityDate": "<string>"
},
"loanId": "<string>",
"loanModificationId": "<string>",
"modificationType": "rerate",
"status": "awaiting-acceptance",
"createdBy": "<string>",
"requestorCounterpartyId": "<string>",
"updatedAt": "<string>"
}
],
"marginCall": {}
},
"extra": {
"acceptedAt": "<string>",
"acceptedBy": "<string>",
"approvedAt": "<string>",
"approvedBy": "<string>",
"cancelledAt": "<string>",
"cancelledBy": "<string>",
"defaultThreshold": "<string>",
"defaultedAt": "<string>",
"defaultedBy": "<string>",
"disbursedAt": "<string>",
"externalDisbursal": true,
"externalInterestPayment": true,
"initialLtv": "<string>",
"initiallyRequiredCollateralUsd": "<string>",
"lenderFeeShare": "<string>",
"lenderFeeSharePercentage": "<string>",
"marginCallExpiryPeriod": "<string>",
"marginCallThreshold": "<string>",
"rebalanceThreshold": "<string>",
"rejectedAt": "<string>",
"rejectedBy": "<string>",
"repaidAt": "<string>",
"repaidBy": "<string>",
"requiredCollaterals": [
{
"amount": "<string>",
"currency": "<string>",
"mainCurrency": "<string>",
"amountInUsd": "<string>"
}
]
},
"interestRate": "<string>",
"lenderPortfolioId": "<string>",
"maturityDate": "<string>",
"originalLoanAmount": "<string>",
"originalLoanValue": "<string>",
"startDate": "<string>",
"terminatedAt": "<string>",
"unrealisedAmount": "<string>",
"updatedAt": "<string>"
}
]
}{
"error": "bad-request",
"message": "<string>"
}{
"error": "forbidden",
"message": "<string>"
}{
"error": "conflict",
"message": "<string>"
}Path Parameters
Query Parameters
The account to filter by
The list of loan ids to filter by
The loan side to filter by. See details
lend, borrow The loan type to filter by. See details
agency-lending-parent-loan, agency-inventory, agency-lending-collateralised-child-loan, agency-title-transfer-collateralised-loan, agency-lending-uncollateralised-child-loan, agency-uncollateralised-loan, agency-lending-first-lien-child-loan, agency-clearloop-loan, agency-lending-pledge-collateralised-child-loan, agency-pledge-collateralised-loan, bilateral-lending-title-transfer-collateralised-loan, bilateral-title-transfer-collateralised-loan, bilateral-lending-pledge-collateralised-loan, bilateral-pledge-collateralised-loan, bilateral-lending-uncollateralised-loan, bilateral-uncollateralised-loan agency-lending-parent-loan, agency-inventory, agency-lending-collateralised-child-loan, agency-title-transfer-collateralised-loan, agency-lending-uncollateralised-child-loan, agency-uncollateralised-loan, agency-lending-first-lien-child-loan, agency-clearloop-loan, agency-lending-pledge-collateralised-child-loan, agency-pledge-collateralised-loan, bilateral-lending-title-transfer-collateralised-loan, bilateral-title-transfer-collateralised-loan, bilateral-lending-pledge-collateralised-loan, bilateral-pledge-collateralised-loan, bilateral-lending-uncollateralised-loan, bilateral-uncollateralised-loan The loan status to filter by. See details
awaiting-approval, awaiting-acceptance, awaiting-collateral, awaiting-interest-payment, disbursing, active, repaying, defaulting, partially-defaulting, early-termination-in-progress, early-termination-completed, defaulted, default-resolved, cancelled, rejected, errored, repaid, repaying-interest, interest-repaid, securing-collateral, collateral-secured, releasing-collateral, collateral-released, closed Flag to filter out open loans
Flag indicating if collaterals should be included in embedded
Flag indicating if counterparties should be included in embedded
Flag indicating if child loans should be included in embedded - Only applicable for agency lending parent loans
Flag indicating if allocations should be included in embedded
Flag indicating if loan interest should be included in embedded - Only applicable for bilateral loans
The number of loans to include in the response
The number of loans to skip in the response
The field to sort by. Currently supported: updatedAt
The direction to sort by - must be used in conjunction with sortBy. See details
ASC, DESC Response
OK
The list of loans
Show child attributes
Show child attributes
Was this page helpful?