๐ฒRevenue Share (RevShare)
This documentation provides details on the API endpoints available for Whirlprivacy.io, focusing on revenue-related operations.
โ ๏ธ You must be logged in to use these requests.
Common Headers
For all requests that require user authentication, you must include the following headers:
Header Name | Value | Description |
---|---|---|
X-API-key |
| API token obtained after authentication. |
GET /rev/eligible
- Check Rev Share Eligibility
/rev/eligible
- Check Rev Share EligibilityDescription: Determines if a user is eligible for revenue sharing.
Parameters:
Parameter | Location | Type | Required | Description |
---|---|---|---|---|
| query |
| Yes | The address of the user to verify |
Response:
Error Handling:
Error Name | Description |
---|---|
Unauthorized | The user is not logged in or token is invalid. |
Example Code:
GET /rev/history
- Get User's Revenue Share History
/rev/history
- Get User's Revenue Share HistoryDescription: Fetches the revenue share history of the logged-in user for a specified ticker.
Parameters:
Parameter | Location | Type | Required | Description |
---|---|---|---|---|
| query |
| Yes | The ticker symbol of the asset to filter the history. |
| query |
| No | The page number for pagination. Defaults to 1 if not provided. |
Response:
Error Handling:
Error Name | Description |
---|---|
Unauthorized | The user is not logged in or token is invalid. |
InvalidTicker | The provided ticker symbol is not supported. |
Example Code:
GET /rev/total
- Get User's Total Revenue Shares by Ticker
/rev/total
- Get User's Total Revenue Shares by TickerDescription: Calculates the total revenue shares for a user by a specific ticker.
Parameters:
Parameter | Location | Type | Required | Description |
---|---|---|---|---|
| query |
| No | The ticker symbol of the asset. Defaults to "ETH" if not provided. |
Response:
Error Handling:
Error Name | Description |
---|---|
Unauthorized | The user is not logged in or token is invalid. |
InvalidTicker | The provided ticker symbol is not supported. |
Example Code:
Last updated