Provable API Documentation
Overview
The Provable API provides access to the Aleo blockchain through RESTful endpoints.
Developers can query block-level information, transactions, programs, transitions, and more, as well as broadcast transactions. These endpoints are foundational for building applications and services in the Aleo ecosystem.
Rate Limiting
Rate limiting is enforced across all endpoints:
- 5 requests per second
- 100,000 requests per day
Abuse may result in blacklisting. For higher limits, contact explorer@provable.com.
Quick Links
🚀 Get Started with API v2
Base URL: https://api.provable.com/v2/{network}
📖 Browse by Category
SnarkOS Core Endpoints
- Blocks - Block data, state roots, and history
- Transactions - Transaction queries and broadcasting
- Committee - Validator and delegation info
- Programs - Smart contract queries
- Solutions - Prover solution broadcasting
Public API
- Blocks - Block data, state roots, and history
- Transactions - Transaction queries and broadcasting
- Programs - Smart contract queries
- Metrics - Block, transaction, and program analytics
- Supply - Total and circulating supply
- DeFi - DeFi metrics and token data
- Staking - Delegation and staking data
- Proving - Prover statistics and rewards
- Address - Address-specific data
Delegated Proving
- Submit Delegated Proof - Submit proofs for delegated execution
Record Scanning
- Register Scanner - Register a new scanner
- Get Owned Records - Retrieve owned records
- Get Scanner Status - Check scanner status
Auth
- Register for Auth - Register for authentication
- Issue JWT - Issue a signed JWT
API v2 Reference
SnarkOS
Core blockchain endpoints that mirror SnarkOS client node functionality.
Blocks
- Get latest block
- Get latest block height
- Get latest block hash
- Get block by height or hash
- Get block hash by transaction ID
- Get transactions by block height
- Get blocks in range
- Get latest state root
- Get state root by height
- Get block height by state root
- Get state path by commitment
- Get state paths by commitments
- Get height by hash
- Get block history
Committee
Programs
- Get program by ID
- Get transition ID by input/output ID
- Get program mappings
- Get latest edition of program
- Get program by edition
- Get program mapping value
- Get program deployment transaction
- Get program deployment by edition
Solutions
Transactions
- Transaction by transaction ID
- Transaction by transition ID
- Confirmed transaction
- Unconfirmed transaction
- Broadcast transaction
Public API
Enhanced endpoints for explorer and analytics functionality.
Blocks
- Latest Block
- Latest Block Hash
- Latest Block Height
- Block by Height
- Block by Hash
- Find Block Hash by TX ID
- Latest State Root
- State Root by Height
- Find Block Height by State Root
- Find State Path by Commitment
- State Paths by Commitments
- Find Height by Hash
- Block History
Transactions
- Transactions by Address
- Latest Transactions Summary
- Transaction by TX ID
- Find TX ID by Transition ID
- Confirmed Transaction
- Unconfirmed Transaction
- Transactions by Block Height
- Transactions by Block Hash
- Transitions by Address
- Broadcast Transaction
Programs
- Program by ID
- Latest Calls by Program ID
- Latest Edition of Program
- Program by Edition
- Program Mapping Value
- Program Mappings
- Find Transition ID
- Program Deployment TX
- Program Deployment TX by Edition
Metrics
- Latest Blocks Summary
- Transaction Metrics Daily
- Program Metrics
- Puzzle Rewards Monthly
- APY Monthly
- APY for Current Validators
- Program Metrics by Range
- Validator Participation
- Puzzle Rewards Daily
- Total Prover Metrics
- APY Last 24 Hours
Supply
- Total Supply
- Total Supply - Microcredits
- Circulating Supply - Microcredits
- Circulating Supply - Credits
DeFi
Staking
Proving
Address
Delegated Proving
Record Scanning
- Register scanner
- Get owned records
- Get record tags
- Get record serial numbers
- Get scanner status
- Get encrypted records
Auth
API v1 Reference
Blocks
- Get latest block
- Get blocks in range
- Get latest block height
- Get latest block hash
- Get block by height or hash
- Get block hash by transaction ID
- Get latest state root
- Get state root by height
- Get block height by state root
- Get state path by commitment
- Get height by hash
- Get block history
Committee
Programs
- Get program by ID
- Get latest edition of program
- Get program by edition
- Get program mappings
- Get program mapping value
- Get transition ID by input/output ID
- Get program deployment transaction
- Get program deployment by edition