Sign in
latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Referral

Returns summary of your referral activity

get/v1/referral/summary

Query parameters

subaccountstring hex
Example:0x7072696d61727900000000000000000000000000000000000000000000000000

Bytes32 encoded subaccount name (0x prefix, zero padded, set when using linked signer)

Headers

X-Ethereal-Authstring required

Must be: EIP712Auth

X-Ethereal-Senderstring hex required

Address that signed this message

X-Ethereal-Signaturestring hex required

Hex-encoded EIP-712 signature authorizing this request

X-Ethereal-Intent0 | 1 | 2 | 3 required

Intent of the message (action to be taken)

X-Ethereal-SignedAtstring required

Message signedAt current timestamp (seconds since Unix Epoch)

Response

codestring

The referee's referral code to be shared and claimed by others (undefined if not activated)

codeUsageRemaininginteger required

Number of remaining times the referral code can be claimed

createdAtinteger required

Timestamp of when this referral was activated (ms since Unix Epoch)

idstring uuid required

Id representing the referral

refereestring hex required

Address of the referee (non-checksummed)

refereeTotalPointsstring decimal required

Total points (excl. referral points) earned by the referee since referee claimed the code (precision: 9)

referrerstring hex

Address of the referrer (non-checksummed; undefined if not set)

Example response

{
  "code": "XYZ123456789",
  "codeUsageRemaining": 5,
  "createdAt": 1712019600000,
  "id": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
  "referee": "0x4c9EDD5852cd905f086C759E8383e09bff1E68B3",
  "refereeTotalPoints": "1234567.890000000",
  "referrer": "0x41e038d9c9aF27369EcBCe72A69a96695A1fD0D3"
}