blockchain
clearloop
network
address-book
currencies
API Reference
orders
files
lending
- GETGet Loans
- POSTCreate Loan
- PATCHCalculate Loan LTV Dry Run
- PATCHAccept Loan Term Extension
- PATCHAccept Loan Interest Payment
- PATCHAccept Loan
- PATCHAccept Loan Rebalance
- PATCHAccept Loan Repayment
- PATCHAccept Loan Rerate
- PATCHAccept Loan Top Up
- PATCHApprove Loan
- PATCHCancel Loan Default
- PATCHCancel Loan Term Extension
- PATCHCancel Loan Interest Payment
- PATCHCancel Loan
- PATCHCancel Loan Rebalance
- PATCHCancel Loan Repayment
- PATCHCancel Loan Rerate
- PATCHCancel Loan Top Up
- PATCHConfirm External Disbursement
- PATCHConfirm External Interest Payment
- PATCHConfirm External Repayment
- PATCHConfirm External Top Up
- PATCHDefault Loan
- PATCHEstimate Loan Leverage Ratio
- PATCHEstimate Loan LTV
- PATCHExtend Loan Term
- GETGet Loan by ID
- PATCHPay Loan Interest
- PATCHRebalance Loan
- PATCHReject Loan
- PATCHRepay Loan
- PATCHRerate Loan
- PATCHSecure Collateral Loan
- PATCHTop Up Loan
reports
Dry Run Order
curl --request POST \
--url https://api.copper.co/platform/dry-run-orders \
--header 'Content-Type: application/json' \
--data '{
"amount": "<string>",
"baseCurrency": "<string>",
"deliveryType": "free-of-payment",
"feeLevel": "low",
"includeFeeInWithdraw": true,
"limitType": "otc",
"mainCurrency": "<string>",
"memo": "<string>",
"orderType": "sell",
"payload": "<string>",
"payloads": [
"<string>"
],
"portfolioId": "<string>",
"priceLimit": "<string>",
"quoteAmount": "<string>",
"quoteCurrency": "<string>",
"quoteMainCurrency": "<string>",
"requestedNetworkFees": {
"feePerByte": "<string>",
"gasLimit": "<string>",
"gasPriceGwei": "<string>",
"maxFeePerGas": "<string>",
"maxPriorityFeePerGas": "<string>"
},
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>"
}'{
"amount": "<string>",
"baseCurrency": "<string>",
"extra": {
"availableCoSigners": [
"<string>"
],
"availableSnapshot": "<string>",
"balanceSnapshot": "<string>",
"blockchainTransactionType": "send",
"clearLoop": true,
"clearLoopExtra": {
"clearLoopExternalNetted": true,
"clearLoopSettlementId": "<string>"
},
"clientAccountId": "<string>",
"coSigners": [
"<string>"
],
"coSignersNumber": "<string>",
"confirmations": "<string>",
"counterpartyPortfolioId": "<string>",
"deliveryType": "free-of-payment",
"depositOrderId": "<string>",
"depositTargetId": "<string>",
"description": "<string>",
"estimatedFees": {
"estimatedTime": "<string>",
"fee": "<string>",
"feeCurrency": "<string>",
"feePerByte": {},
"gasLimit": {},
"gasPriceGwei": "<string>",
"reportingCurrencyRate": "<string>",
"transactionBytes": "<string>"
},
"externalBroadcast": true,
"feeLevel": "low",
"fromAddresses": [
"<string>"
],
"fromCounterpartyId": "<string>",
"fromCryptoAddress": {
"_embedded": {
"currencyConfigurations": [
{
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"currencyConfigurationId": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
},
"acceptTokens": true,
"address": "<string>",
"addressTags": [
null
],
"addressType": "externally-owned-account",
"category": "smart-contract",
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"mainCurrency": "<string>",
"memo": "<string>",
"name": "<string>",
"organizationId": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
},
"fromCryptoAddressId": "<string>",
"fromPortfolioId": "<string>",
"includeFeeInWithdraw": true,
"invoiceId": "<string>",
"marketPrice": "<string>",
"memo": "<string>",
"nextTransferTo": [
{
"cryptoAddressId": "<string>",
"portfolioId": "<string>",
"targetType": "external"
}
],
"originalDepositAmount": "<string>",
"partSigned": {},
"payload": "<string>",
"payloads": [
"<string>"
],
"reportingCurrencyRate": "<string>",
"reportingQuoteCurrencyRate": "<string>",
"signed": {},
"spenderAddress": "<string>",
"terminatedReportingCurrencyRate": "<string>",
"toAddress": "<string>",
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>",
"totalQuoteAmount": "<string>",
"transactionId": "<string>",
"transactionRequest": {},
"transferAmount": "<string>",
"transferChainId": "<string>",
"transferDepositTargetId": "<string>",
"transferFees": "<string>",
"transferFeesCurrency": "<string>",
"transferTransactionId": "<string>",
"withdrawFee": "<string>",
"withdrawOrderId": "<string>"
},
"mainCurrency": "<string>",
"orderType": "sell",
"portfolioId": "<string>",
"warning": {
"code": "<string>",
"message": "<string>"
}
}Body
sell, buy, deposit, withdraw, multi-withdraw, wallet-message, retrieved-deposit, earn-reward, earn-shared-reward, claim-shared-reward, cross-chain-deposit, cross-chain-withdraw free-of-payment, payment-vs-payment low, medium, high otc, rfq Response
sell, buy, deposit, withdraw, multi-withdraw, wallet-message, retrieved-deposit, earn-reward, earn-shared-reward, claim-shared-reward, cross-chain-deposit, cross-chain-withdraw The ids of user who can approve an order. If not set, anybody with Approver permission can approve
Snapshot of a wallet available balance at the moment of order termination
Snapshot of a wallet balance at the moment of order termination
Blockchain transaction type. See details
send, multi-withdraw, account-set, allowance, smart-call, multi-smart-call, activate, stake-delegation, stake-nomination, stake-undelegation, complete-withdrawal, stake-complete-deposit, take-reward, pool-creation, edit-pool, governance-vote, unjail, importance-transfer, transfer-stake, rebond-stake, chill, cross-chain-send Indicates whether the order is a part of a ClearLoop
Additional order information related to ClearLoop specific orders
Unique client exchange's account identifier used for ClearLoop
The ids of user who has approved an order
The number of required approves for an order
Number of confirmations for a blockchain transaction
Settlement order type only applicable for settle orders. See details
free-of-payment, payment-vs-payment The id of a deposit order where a withdraw was made to
Determines if the deposit came from a send, reward claim, or stake undelegation transaction
The id of a deposit target where an order was made to
The description of the order
The estimated fees for an order
The amount of the fee
The currency in which the fee is denominated
The estimated time in milliseconds for the transaction to be confirmed
The fee per byte of the transaction
The gas limit for the transaction
The gas price in Gwei
The fee amount in the reporting currency
The number of bytes in the transaction
Withdraw is requested to be processed by external system. In that case we don't broadcast it to blockchain
The fee level for the withdrawal. See details
low, medium, high List of addresses from which the deposit was made. This is an array because, on some blockchains like Bitcoin (BTC), the sending address can include multiple input UTXO addresses
The id of a counterparty where an order was made from
The object of a crypto address where an order was made from. Will be removed in the future. Use fromCryptoAddressId instead
Address
Address type. See details
externally-owned-account, internal-account, smart-contract, payable-smart-contract Created at timestamp
Created by user id
Crypto address id
Currency of an address
Indicates, if an address is whitelisted
Name of an address
Additional information for this crypto address
Crypto address currency configuration
Created at timestamp
Created by user id
Crypto address id
Currency of an address
Currency configuration id
Indicates, if an address is whitelisted
Extra information for an address
Last used at
Portfolio ids, if address set for particular portfolios
Last updated Updated at timestamp
Updated by user id
Indicates an address can be used for tokens on the same blockchain network
Address tags
Address category. See details
smart-contract, payable-smart-contract, mining, unknown, self-hosted, vasp Extra information for an address
Last used at
Main currency of an address
Address memo (destination tag for XRP)
Organization id
Portfolio ids, if address set for particular portfolios
Last updated Updated at timestamp
Updated by user id
The id of a crypto address where an order was made from
The id of a portfolio where an order was made from
Indicates whether the fee should be included in the withdrawal amount or added on top of it
The id of an invoice where an order was made to
Withdraw memo (destination tag for XRP)
The remain list of next transfer targets
external, portfolio Amount of the original deposit transaction
Partly-signed data
Serialized list of unsigned transactions. For Ethereum only type 0 (legacy) transactions are supported
The snapshot of a base currency rate at the moment of order creation
The snapshot of a quote currency rate at the moment of order creation
Fully-signed data
For ETH Approve transaction store spender address
The snapshot of a base currency rate at the moment of order termination
The address where the funds should be transferred
The id of a counterparty where an order was made to
The id of a crypto address where an order was made to
The id of an invoice where an order was made to
The id of an lending invoice where an order was made to
The id of a portfolio where an order was made to
The amount of a quote currency in an order
The blockchain transaction id on an order
Data which needs to be passed to Copper Unlimited to sign the transaction
Amount transferred from proxy to destination
The id to identify orders, created as a part of the same order chain
The deposit target ID of the proxy address for the transfer
Network fees required for transferring from proxy to destination
Currency of fees paid for transferring from proxy to destination
The hash of the transaction transferring funds from proxy to destination
The amount of fees for the order
The id of a withdraw order where a deposit was made from
curl --request POST \
--url https://api.copper.co/platform/dry-run-orders \
--header 'Content-Type: application/json' \
--data '{
"amount": "<string>",
"baseCurrency": "<string>",
"deliveryType": "free-of-payment",
"feeLevel": "low",
"includeFeeInWithdraw": true,
"limitType": "otc",
"mainCurrency": "<string>",
"memo": "<string>",
"orderType": "sell",
"payload": "<string>",
"payloads": [
"<string>"
],
"portfolioId": "<string>",
"priceLimit": "<string>",
"quoteAmount": "<string>",
"quoteCurrency": "<string>",
"quoteMainCurrency": "<string>",
"requestedNetworkFees": {
"feePerByte": "<string>",
"gasLimit": "<string>",
"gasPriceGwei": "<string>",
"maxFeePerGas": "<string>",
"maxPriorityFeePerGas": "<string>"
},
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>"
}'{
"amount": "<string>",
"baseCurrency": "<string>",
"extra": {
"availableCoSigners": [
"<string>"
],
"availableSnapshot": "<string>",
"balanceSnapshot": "<string>",
"blockchainTransactionType": "send",
"clearLoop": true,
"clearLoopExtra": {
"clearLoopExternalNetted": true,
"clearLoopSettlementId": "<string>"
},
"clientAccountId": "<string>",
"coSigners": [
"<string>"
],
"coSignersNumber": "<string>",
"confirmations": "<string>",
"counterpartyPortfolioId": "<string>",
"deliveryType": "free-of-payment",
"depositOrderId": "<string>",
"depositTargetId": "<string>",
"description": "<string>",
"estimatedFees": {
"estimatedTime": "<string>",
"fee": "<string>",
"feeCurrency": "<string>",
"feePerByte": {},
"gasLimit": {},
"gasPriceGwei": "<string>",
"reportingCurrencyRate": "<string>",
"transactionBytes": "<string>"
},
"externalBroadcast": true,
"feeLevel": "low",
"fromAddresses": [
"<string>"
],
"fromCounterpartyId": "<string>",
"fromCryptoAddress": {
"_embedded": {
"currencyConfigurations": [
{
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"currencyConfigurationId": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
}
]
},
"acceptTokens": true,
"address": "<string>",
"addressTags": [
null
],
"addressType": "externally-owned-account",
"category": "smart-contract",
"createdAt": "<string>",
"createdBy": "<string>",
"cryptoAddressId": "<string>",
"currency": "<string>",
"extra": {},
"isWhitelist": true,
"lastUsedAt": "<string>",
"mainCurrency": "<string>",
"memo": "<string>",
"name": "<string>",
"organizationId": "<string>",
"portfolioIds": [
"<string>"
],
"updatedAt": "<string>",
"updatedBy": "<string>"
},
"fromCryptoAddressId": "<string>",
"fromPortfolioId": "<string>",
"includeFeeInWithdraw": true,
"invoiceId": "<string>",
"marketPrice": "<string>",
"memo": "<string>",
"nextTransferTo": [
{
"cryptoAddressId": "<string>",
"portfolioId": "<string>",
"targetType": "external"
}
],
"originalDepositAmount": "<string>",
"partSigned": {},
"payload": "<string>",
"payloads": [
"<string>"
],
"reportingCurrencyRate": "<string>",
"reportingQuoteCurrencyRate": "<string>",
"signed": {},
"spenderAddress": "<string>",
"terminatedReportingCurrencyRate": "<string>",
"toAddress": "<string>",
"toCounterpartyId": "<string>",
"toCryptoAddressId": "<string>",
"toInvoiceId": "<string>",
"toLendingInvoiceId": "<string>",
"toPortfolioId": "<string>",
"totalQuoteAmount": "<string>",
"transactionId": "<string>",
"transactionRequest": {},
"transferAmount": "<string>",
"transferChainId": "<string>",
"transferDepositTargetId": "<string>",
"transferFees": "<string>",
"transferFeesCurrency": "<string>",
"transferTransactionId": "<string>",
"withdrawFee": "<string>",
"withdrawOrderId": "<string>"
},
"mainCurrency": "<string>",
"orderType": "sell",
"portfolioId": "<string>",
"warning": {
"code": "<string>",
"message": "<string>"
}
}