37 lines
2.1 KiB
Markdown
37 lines
2.1 KiB
Markdown
# API Reference
|
|
|
|
This section provides comprehensive API documentation for interacting with the Zenith network and developing applications on top of the Zenith ecosystem.
|
|
|
|
## Available APIs
|
|
|
|
### Zenith Desk API
|
|
The [Zenith Desk API](zenith-desk-api.md) provides developers with tools and libraries for building Urbit applications that integrate with the Zenith blockchain. This API enables seamless interaction between Urbit ships and Zenith's consensus layer.
|
|
|
|
### zenithd API
|
|
The [zenithd API](zenithd.md) provides REST endpoints for querying blockchain state, account information, and module-specific data. Includes comprehensive HTTP/RPC query examples for all Zenith modules.
|
|
|
|
### Janus API
|
|
The [Janus API](janus.md) provides HTTP endpoints for transaction bundling and scry binding submission. Galaxy endpoints accept bundles from stars, while star endpoints accept transactions and scry bindings from planets.
|
|
|
|
### Watchers API
|
|
The Watchers provide GraphQL and REST interfaces for querying indexed blockchain data:
|
|
|
|
- **[Azimuth Watcher](azimuth-watcher.md)**: Query Urbit point ownership, sponsorship, and identity data
|
|
- **[Lockdrop Watcher](lockdrop-watcher.md)**: Query lockdrop deposits and commitments
|
|
- **[Zenith Watcher](zenith-watcher.md)**: Query Zenith blockchain data including accounts, transactions, validators, and scry bindings
|
|
|
|
## Getting Started
|
|
|
|
Choose the appropriate API based on your use case:
|
|
|
|
- **Building Urbit Applications**: Start with the [Zenith Desk API](zenith-desk-api.md)
|
|
- **Querying Blockchain State**: Use the [zenithd API](zenithd.md) for HTTP/REST queries
|
|
- **Indexed Urbit Identity Data**: Use the [Azimuth Watcher](azimuth-watcher.md) for GraphQL queries
|
|
- **Lockdrop Information**: Use the [Lockdrop Watcher](lockdrop-watcher.md) for GraphQL queries
|
|
- **Zenith Blockchain Data**: Use the [Zenith Watcher](zenith-watcher.md) for GraphQL and REST queries
|
|
- **Transaction Bundling**: Use the [Janus API](janus.md) for galaxy and star operations
|
|
|
|
## API Documentation Status
|
|
|
|
API documentation is actively being developed. Check individual pages for the latest specifications, examples, and integration guides.
|