ETethereal
Referral

Returns summary of your referral activity

Changed on
get/v1/referral/summary

Request

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"
}

Changes

  • 63e8937ff6f7Revision changes
    • info

      added the non-success response with the status

  • dc14c1586dfaRevision changes
    • breaking

      the X-Ethereal-Intent request header's property undefined was restricted to a list of enum values

    • breaking

      the header request parameter X-Ethereal-Intent was restricted to a list of enum values

    • breaking

      for the header request parameter X-Ethereal-Intent, the type changed from string to number

    • breaking

      for the header request parameter X-Ethereal-Sender, the format changed from no format to hex

    • breaking

      for the header request parameter X-Ethereal-Signature, the format changed from no format to hex

    • info

      added the new enum value 0.00 to the header request parameter X-Ethereal-Intent

    • info

      added the new enum value 1.00 to the header request parameter X-Ethereal-Intent

    • info

      added the new enum value 2.00 to the header request parameter X-Ethereal-Intent

    • info

      added the new enum value 3.00 to the header request parameter X-Ethereal-Intent

    • info

      the response's property default value Bad Request was removed for the status

    • info

      the response's property default value Forbidden was removed for the status

    • info

      the response's property default value Not Found was removed for the status

    • info

      the response's property default value Too Many Requests was removed for the status

    • info

      the response's property default value Unauthorized was removed for the status

    • info

      the response's property default value Unprocessable Entity was removed for the status

    • info

      the response's property default value 400 was removed for the status

    • info

      the response's property default value 401 was removed for the status

    • info

      the response's property default value 403 was removed for the status

    • info

      the response's property default value 404 was removed for the status

    • info

      the response's property default value 422 was removed for the status

    • info

      the response's property default value 429 was removed for the status

    • info

      response property message list-of-types was narrowed by removing types array from media type application/json of response 400