Skip to main content
POST
/
reports
/
orders
/
net
Create Orders NET Report
curl --request POST \
  --url https://api.copper.co/platform/reports/orders/net \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportType": "transfers",
  "terminatedAtFrom": "<string>",
  "terminatedAtTo": "<string>",
  "orderTypes": [
    "sell"
  ],
  "portfolioIds": [
    "<string>"
  ],
  "portfolioTypes": [
    "custody"
  ]
}
'
{}

Body

application/json
​
reportType
enum<string>
required

Group of orders to be included in the report. See details

Available options:
transfers,
orders,
transactions,
trading
​
terminatedAtFrom
string
required

Timestamp in milliseconds of when orders were terminated from

​
terminatedAtTo
string
required

Timestamp in milliseconds of when orders were terminated to

​
orderTypes
enum<string>[]

List of order types for the report. See details

Available options:
sell,
buy,
deposit,
withdraw,
multi-withdraw,
wallet-message,
retrieved-deposit,
earn-reward,
earn-shared-reward,
claim-shared-reward,
cross-chain-deposit,
cross-chain-withdraw
Example:

"buy,sell"

​
portfolioIds
string[]

List of portfolio ids for the report

Example:

"portfolioId1,portfolioId2"

​
portfolioTypes
enum<string>[]

List of portfolio types for the report. See details

Available options:
custody,
trading-vault,
trading,
external,
clearloop
Example:

"custody,external"

Response

OK

The response is of type object.