btc-assets-api
A comprehensive API service that retrieves BTC/RGB++ information and assets, processes transactions, and manages automated RGB++ asset workflows through scheduled operations.
This is a service that retrieves BTC/RGB++ information/assets and processes transactions with these assets. It serves as the critical infrastructure component that bridges Bitcoin and CKB networks for RGB++ operations.
Core Functionality
The btc-assets-api provides essential services for RGB++ ecosystem including blockchain data retrieval, transaction processing, and automated workflow management, ensuring seamless integration between Bitcoin and CKB networks.
Core Services
Access to Bitcoin chain data including blocks, headers, transactions, addresses, and RGB++ assets. This functionality is provided by the SPV service.
Available Data
- • Bitcoin blocks and headers
- • Transaction records
- • Address information
- • RGB++ asset data
- • Network statistics
Comprehensive transaction processing capabilities for both Bitcoin and RGB++ asset transactions, ensuring proper validation and execution.
Processing Features
- • Transaction validation
- • Cross-chain coordination
- • Asset transfer processing
- • Error handling & recovery
- • Status tracking
Automated processing of RGB++ asset workflows through scheduled cron jobs, ensuring reliable and timely execution of operations.
Automation Features
- • Scheduled job execution
- • Queue management
- • Workflow orchestration
- • Retry mechanisms
- • Performance monitoring
The btc-assets-api requires an access token for authentication to ensure secure access to Bitcoin and RGB++ asset data and operations.
Testnet Access
Testnet users can generate a token directly via the /token/generate API endpoint. The public testnet endpoint is available for development and testing purposes.
POST /token/generate
Mainnet Access
Mainnet access is restricted to whitelisted users. Please contact us to request an access token for production use.
⚠️ Whitelisted access required
The btc-assets-api provides dedicated endpoints for different network environments, ensuring proper isolation between development and production systems.
Testnet Environments
Bitcoin Testnet
https://api.testnet.rgbpp.io
Bitcoin Signet
https://api.signet.rgbpp.io
Production Environment
Mainnet Access
For production applications, access instructions are available in the btc-assets-api repository.
Get started with btc-assets-api integration by following these essential steps for both development and production environments.
Integration Steps
Choose Environment
Select testnet for development or request mainnet access for production
Obtain Access Token
Generate testnet token via API or request mainnet whitelist access
Configure SDK
Set up RGB++ SDK with appropriate API endpoints and authentication
Start Building
Begin implementing RGB++ asset operations in your application
Application Development
DeFi applications and protocols
NFT marketplaces and platforms
Asset management tools
Cross-chain bridges
Infrastructure Services
Exchange integrations
Wallet service backends
Analytics and monitoring
Enterprise solutions
Repository & Documentation
Support & Community
Continue Learning
Now that you understand btc-assets-api, explore practical implementation examples and start building with RGB++.