RWA.io Token Unlocks Guide

This guide outlines how to submit and retrieve token distribution data through the RWA.io API. Our API enables access to tokenomics information including allocation breakdowns, vesting schedules, and supply metrics.

1. Basic Details

Purpose: Capture core identification and reference details about the token.

Fields:

  • Networks (Required): Networks on which the token is deployed
  • Top holder list URL: Link to list of top token holders
  • Distribution Schedule URL: Link to an externally hosted distribution schedule (e.g., Notion, Google Sheet etc.)

2. Coin/Token Supply Information

Purpose: Define the creation and upper supply limits of the token.

Fields:

  • Token Generation Date (TGE) (Required): Date when the token was generated
  • Max Supply Amount (Required): Maximum number of tokens that will ever be created (if fixed)

3. Total Supply

Purpose: Capture details regarding the total token supply and its historical distribution.

Fields:

  • Total Supply Amount (Required): Total number of tokens in existence
  • Total Supply API: If available, a link orendpoint providing real-time supply figures

4. Circulating Supply

Purpose: Detail how many tokens are currently in active circulation.

Fields:

  • Circulating Supply Amount (Required): Number of tokens currently in circulation
  • Circulating Supply API: API URL where circulating supply can be verified
  • Vested/Locked Wallets: List of wallets where tokens are vested/locked

5. Token Unlock Schedule

Purpose: Provide data on how and when tokens are unlocked over time.

Users can upload a CSV file detailing the unlock schedule. The data will be displayed as a time series on the unlocks section of the project page.

Options:

  • Download CSV: Download template file for data upload
  • Upload CSV: Submit the template file with your data filled in

6. Initial Token Allocation

Purpose: Breakdown of how tokens are initially distributed across stakeholders.

Fields for each allocation:

  • Allocation Name (Required): e.g., Team, Investors, Ecosystem
  • Percentage of Allocation (%) (Required): Portion of total supply allocated
  • Token Generation Event Percentage (TGE %): Portion distributed at TGE
  • Cliff Period (Months) (Required): Months before tokens begin to unlock
  • Vesting Period (Months) (Required): Period over which tokens vest post-cliff
  • Release Schedule (Frequency) (Required): Description of release schedule (e.g. 15% TGE unlock, 2 monthscliff, 8 months linear unlocks)

7. Submitter Information

Purpose: Identify the individual submitting the data.

Fields:

  • Role (Required): Submitter's role within the project (e.g., Founder, Developer)

8. Additional Information

Purpose: Any other relevant information not captured above.

Fields:

  • Notes: Any additional information for the RWA.io team

Important

  • All data submitted should be verifiable via on-chain data or reputable off-chain sources
  • If a field does not apply, enter "N/A" or leave it blank where appropriate
  • CSV uploads must match the required schema outlined in the downloadable template

RWA mascot otto ready to help

Need help?

Contact Us