โจ๏ธTide APIs
Get project space leaderboard
This API lets users view a leaderboard that tracks participants' progress in a certain project space. The leaderboard provides information on the number of tasks completed, rewards claimed, and experience points earned by each participant.
Please note that no authentication is required since leaderboard data is public.
Get leaderboard
GET
https://api-prod.tideprotocol.xyz/public/project/${projectId}/leaderboard
Get leadboard data of a given Tide project.
Query Parameters
Name | Type | Description |
---|---|---|
nextPage | Integer | Number of the requested page. Default = |
by | ADDRESS | Required field to filter by address |
search | address | Searched value ( |
pageSize | Integer | Number of entries for each page. Default = |
onlyListedCampaigns | Boolean | Filter by campaigns only listed on Tide frontend |
lastDays | Integer | Get participants' progress only up to |
currentPeriod | String | Get participants' progress of the current period. Accepted values: |
cids | String | Filter by campaigns ID (cids). cids are separated by comma (e.g. cids= |
Get Tide NFT user data for a specific campaign
This API lets users get information related to one NFT minted in one specific Tide campaign.
Using this endpoint Tide gives you access to information related to the specific campaign and metadata related to the NFT minted by one specific user.
Please note that no authentication is required since the data shown is public.
Get tide NFT user data
GET
https://api-prod.tideprotocol.xyz/public/nft/${userAddress}/${contractAddress}/${chainId}
Display user NFT metadata as well as other info such as leaderboard position, XPs, etc.
Path Parameters
Name | Type | Description |
---|---|---|
userAddress | String | Wallet address of the user for which data will be retrieved. |
contractAddress | String | Contract address for the campaigns that is tracked. |
chainId | String | ChainId in which the campaign contract has been deployed. |
Get Specific Tide campaign
This API lets users get information about a specific campaign
Get specific tide campaign
GET
https://api-prod.tideprotocol.xyz/public/campaign/${campaignId}
Path Parameters
Name | Type | Description |
---|---|---|
campaignId | String | Campaign identifier (ID) |
Get Tide campaigns for a specific chain
This API lets users get all the campaigns information for a specific chain.
Get tide campaign for a specific chain
GET
https://api-prod.tideprotocol.xyz/public/campaign/chain/${chainId}
Display all campaigns for a chain with all the campaign info
Path Parameters
Name | Type | Description |
---|---|---|
chainId | String | ChainId in which the campaign contract has been deployed. |
Get Campaign info
This API let users get some basic information about a single campaign like participants and campaign's timings.
Get campaign info
GET
https://api-prod.tideprotocol.xyz/public/campaign/info/${campaignId}
Get campaign basic info, to fetch fast data about users campaign
Path Parameters
Name | Type | Description |
---|---|---|
campaignId | String | Campaign identifier (ID) |
Get User claimable Campaigns
This API let users get information about a specific wallet address claimable campaigns.
Get user claimable campaigns
GET
https://api-prod.tideprotocol.xyz/public/claimable-campaigns/${userAddress}
Get user claimable Campaigns with number of missing Tasks
Path Parameters
Name | Type | Description |
---|---|---|
userAddress | Address | User Address |
Get User XP for a specific Campaign
This API let users get information about a user's address XPs for a specific campaign.
Get user XP for a specific campaign
GET
https://api-prod.tideprotocol.xyz/public/campaign/user-xp/${userAddress}/${campaignId}
Get user XPs for a specific campaign
Path Parameters
Name | Type | Description |
---|---|---|
userAddress | Address | User Address |
campaignId | String | Campaign identifier (ID) |
Get User XP for a specific project Space
This API let users get information about a user's address XPs for a specific project space.
Get user XP for a specific project space
GET
https://api-prod.tideprotocol.xyz/public/project/user-xp/${userAddress}/${projectId}
Get total user XPs for a specific project space
Path Parameters
Name | Type | Description |
---|---|---|
userAddress | Address | User Address |
projectId | String | Project identifier (ID) |
Last updated