DOCSEARCHbyAlgolia
Submit Docs

Cardano Token Registry

repository·master·Indexed 43 days ago

https://github.com/cardano-foundation/cardano-token-registry

A CIP-26 compliant off-chain metadata registry for the Cardano mainnet. It provides a standardized way to map on-chain asset identifiers to human-readable metadata via a RESTful API supporting both CIP-68 (on-chain) and CIP-26 (off-chain) metadata for Mainnet and Preprod environments.

Tokens
2.7K
Snippets
1
Records
16
Agent score
54%

What's inside Cardano Token Registry

  1. API Security, Privacy, and Liability

    master

    Security and Auditing

    The Foundation may monitor API usage to ensure quality and compliance. The Foundation reserves the right to audit your application, systems, and records to verify compliance with these terms.

    Privacy

    The Foundation's general Privacy Policy applies: https://cardanofoundation.org/en/privacy. For privacy-related inquiries, contact gdpr@cardanofoundation.org.

    Disclaimer of Liability

    • "As Is" Basis: The API is provided "as is" and "as available" without any warranties or guarantees.
    • Risk: Use of the API is at your own risk. The Foundation is not liable for damages resulting from false information, third-party IP infringement, API non-availability, external network failures, or malware/DDoS attacks resulting from API use.

  2. Understand changes to the API Terms of Use

    master
    The Cardano Foundation may revise these Terms at any time without prior notice. Continued use of the Cardano Registry after any modifications are made constitutes the User's acceptance of the updated Terms. In the event of a conflict between the current version of these Terms and any previous versions, the current version in effect prevails.

  3. Disclaimer and liability limitations

    master

    The Cardano Registry is provided "as is" and "as available" for general information purposes only. Users interact with the registry at their own risk.

    Key Disclaimers

    • No Warranties: The Foundation does not guarantee that the registry or its information is complete, true, accurate, or up-to-date. The approval process is a technical measure and does not constitute verification or endorsement of the data.
    • No Financial Advice: Information in the registry does not constitute solicitation, offer, recommendation, or advice regarding digital assets or financial instruments.
    • Availability: The Foundation may interrupt or change features at any time without notice and is not liable for disruptions caused by external factors (ISP failure, network failure, etc.).

    Liability Exclusions

    To the extent permitted by law, the Foundation excludes all liability for:

    • Loss or damage (direct or indirect) arising from the use of or reliance upon the registry.
    • False information or infringement of third-party rights.
    • Damage resulting from viruses, malware, or DDoS attacks.
    • Information deleted by the Foundation at its discretion.

  4. API License and Restrictions

    master

    The Foundation grants a limited, non-exclusive, non-transferable, non-sublicensable, non-assignable, worldwide, and revocable license to use the API and its documentation solely for the purpose of developing, testing, and supporting your application integration.

    Key Restrictions:

    • Rate Limiting: The Foundation enforces limits on the number of API requests or the number of End Users you may serve. You must not attempt to circumvent these limits.
    • Content Filtering: The Foundation may restrict, limit, or filter information accessible through the API at its sole discretion to ensure compliance with laws or regulations.
    • Updates: The Foundation may update or change the API at any time without notice. You are responsible for any modifications required in your application to maintain functionality.

  5. Understand the Cardano Registry API usage terms

    master

    The Cardano Registry API provides read-only access to fetch information from the Cardano Registry. Use of the API is free of charge and is permitted for both personal and commercial purposes, subject to the following core requirements:

    • Compliance: You must comply with these API Terms, the general Cardano Registry Terms of Use, and all applicable laws (including privacy and data export laws).
    • Access Method: You must only access the API using the methods described in its official documentation.
    • Prohibited Actions: You may not attempt to circumvent technical security measures, test the vulnerability of the API/networks, or engage in excessive or abusive usage that exceeds set limits.
    • Third-Party Apps: If you build an application for End Users that uses this API, you must maintain your own service agreement and privacy policy that includes the Cardano Registry’s Terms of Use by reference.
    • Attribution: All copyright, patent, trademark, and attribution notices found in the registry data must be retained in your application.

  6. Rules for publishing information to the Cardano Registry

    master

    When submitting information to be published in the Cardano Registry, users must adhere to the following requirements:

    Data Accuracy and Maintenance

    • You must warrant that all submitted information is true and accurate.
    • You are solely responsible for keeping your submitted information up to date.

    Prohibited Content

    • Inappropriate Content: Do not submit misleading, impersonating, illegal, offensive, defamatory, racist, sexist, unethical, explicit, or harmful content (including harmful code).
    • Infringement: Do not submit information that infringes on private/personal data or intellectual property rights (copyrights, trademarks, patents).
    • Financial Services: Do not submit information that could be construed as the provision or promotion of financial instruments, investment products, or financial advice (e.g., including financial data, expected returns, or forward-looking statements).

    Approval and Rights

    • Publication is subject to approval at the sole discretion of the Foundation. The Foundation may reject, correct, or delete information at any time without notice.
    • By submitting, you grant the Foundation the necessary rights to use the information and acknowledge that all submitted data will be publicly accessible and usable by third parties.

  7. Follow submission well-formedness rules for metadata

    master

    To ensure your Pull Request is accepted, adhere to these rules:

    1. Single Commit: Submissions must consist of a single commit directly off the master branch.
    2. Single File: Each PR must add or modify exactly one file in the mappings/ folder. Split multiple mappings into separate PRs.
    3. Naming Convention: The filename must match the encoded subject key of the entry, in all lowercase.
    4. Size Limit: The maximum file size for a single metadata entry is 370 KB.

  8. Permitted use of the Cardano Registry

    master

    The Cardano Registry and its information can be used for personal or commercial purposes provided that:

    • Use complies with these Terms and all applicable laws.
    • These Terms are included by reference in your use.
    • You do not use the Foundation's trade names, trademarks, or proprietary content without permission.
    • If using third-party protected names/content found in the registry, you have obtained prior permission from the owner.
    • All copyright, patent, trademark, and attribution notices from the registry information are retained.

    Note: Access via API is governed by a separate "API Terms of Use" which applies in addition to these general terms.

  9. Terminate use of the Cardano Registry API

    master
    Users can terminate their agreement with the Cardano Foundation by simply discontinuing all use of the API. Upon termination, all rights and licenses granted under the Terms of Use cease immediately, and the User is required to promptly destroy all copies of documentation and proprietary information received under the agreement.

  10. Register or update token metadata via GitHub

    master

    Metadata registration is handled through GitHub Pull Requests against the master branch of the cardano-token-registry repository. Every submission is subject to automated well-formedness checks and human vetting.

    • New registration: Add a single JSON file to the mappings/ folder.
    • Updating an entry: Modify the existing JSON file in the mappings/ folder.

    For detailed instructions on generating fields and signing entries, refer to the Registry Wiki or use the offchain-metadata-tools.

  11. Query token metadata via the RESTful API

    master

    The Cardano Token Metadata Server provides a RESTful API to query both CIP-68 (on-chain) and CIP-26 (off-chain) metadata. You can look up a specific subject using a GET request to the /metadata/{subject} endpoint.

    Note that the API is available for both Mainnet and Preprod environments. The Preprod instance uses the same API v2 endpoints, allowing you to reuse requests by simply changing the base URL.

    GET https://tokens.cardano.org/metadata/{subject}