Skip to main content
GET
/
v1
/
referral
/
rebate_summary
Get referral rebate summary
curl --request GET \
  --url https://api.orderly.org/v1/referral/rebate_summary \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "data": {
    "rows": [
      {
        "traded_referral": 11,
        "referral_rebate": 2.22,
        "volume": 123.456,
        "date": "2023-11-14"
      }
    ],
    "meta": {
      "records_per_page": 25,
      "current_page": 1,
      "total": 50
    }
  },
  "timestamp": 1702989203989
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

​
start_date
string

max date selection range is 3 months

​
end_date
string

max date selection range is 3 months

​
page
integer

start from 1

​
size
integer

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989