Webdeeds.org API Overview
Welcome to the Webdeeds.org Public API documentation. This guide will help you understand and use our API to create, manage, and transfer digital tradeables we call "webdeeds" or "deeds".
️⚠️ IMPORTANT ⚠️: Proceed with caution.
Webdeeds.org is in a very experimental stage of development. There is a lot of testing to be done before this system is ready to be used in production environments or systems.
What is Webdeeds.org?
Webdeeds.org provides a simple yet powerful API for creating and transferring digital assets (deeds) with associated metadata. These deeds can represent tickets, certificates, tokens, or any other digital asset you want to track and transfer securely.
Core Capabilities
The Webdeeds API allows you to:
- Mint new deeds with associated metadata and outputs
- Swap deed secrets to transfer ownership or split deeds
- Retrieve registry items that hold metadata and totals for minted deeds
How It Works
The integrity of swaps is maintained by ensuring that the server checks that the hash of the inputs' secrets matches the hash stored in the database. Transferring webdeeds between parties is done "out of band" by simply copying the output.
Quick Example: Concert Tickets
- Mint 100 tickets: Create a batch of tickets for an event
- Split the tickets: Divide the tickets into smaller batches for distribution
- Transfer tickets: Send tickets to buyers by sharing the output string
- Secure ownership: Buyers update the secret to secure their ownership
- Redeem tickets: Present the valid output at the venue
Check out our detailed tutorials to see more examples and learn advanced usage patterns.
Getting Started
To start using the Webdeeds API, explore our API Reference for detailed endpoint documentation and example requests/responses.