Skip to main content
GET
/
v1
/
referral
/
referral_history
Get referral history
curl --request GET \
  --url https://api.orderly.org/v1/referral/referral_history \
  --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": [
      {
        "account_id": "0x114f583aea808c5812e16109b6c087660285a26f0a31dcc0f9b54f1a6a0fefbd",
        "user_address": "0xa8ec6970fec8842dd229eef170f624c3d77dab45",
        "referral_code": "C4",
        "volume": 1229.12,
        "referral_rebate": 2.22,
        "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

start date range that you wish to query, in the format ‘YYYY-MM-DD’

​
end_date
string

end date range that you wish to query, in the format ‘YYYY-MM-DD’

​
page
integer

the page you wish to query start from 1

​
size
integer

the page size you wish to query (max: 500)

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