Referral

Returns referral code usage details

get/v1/referral/code/{code}

Request

Base URL
https://api.ethereal.trade
Auth
none declared
TypeScript
https://skmtc.dev/ethereal/apis/ethereal-exchange-api/docs/v1/referral/code/:code/get.ts
A function with typed inputs. Its response is checked against the schema.

codestring required

Example:XYZ123456789

Referral code (3-12 alphanumeric uppercase characters)

codestring required

The referral code

remainingUsageinteger required

Number of remaining times the code can be claimed

{
  "code": "XYZ123456789",
  "remainingUsage": 5
}

Aug 25, 202663e8937ff6f7 Revision changes
- info
  added the non-success response with the status
Jun 7, 2026dc14c1586dfa Revision changes
- 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