API Reference
The Surflux API provides indexed, queryable access to Sui blockchain data. Instead of running your own indexer or parsing raw RPC responses, you get structured, high-performance APIs that return the exact data you need.
Why Use Indexed APIs?
Speed: Queries return in milliseconds. No need to scan blocks, decode Move objects, or aggregate data yourself.
Reliability: Surflux handles all the complexity of maintaining sync with the blockchain. Your queries work even during network upgrades or chain reorganizations.
Developer Experience: Clean REST endpoints with predictable responses. No complex RPC calls or cryptic error messages.
Cost: Avoid the operational overhead of running and maintaining your own indexing infrastructure.
Available APIs
NFT Indexing API
Query NFT ownership, collection metadata, holder distribution, and Kiosk data. Covers all NFT types on Sui including standard NFTs, Kiosk-held assets, and custom implementations.
Key endpoints:
- Address NFTs — Get all NFTs owned by an address
- NFT by Object ID — Retrieve a single NFT by its object ID
- Collection Snapshot — Query NFTs within a collection
- Collection Holders — Analyze holder distribution
- Kiosks NFTs — Access NFTs stored in Sui Kiosks
Use cases: NFT marketplaces, wallet interfaces, portfolio trackers, analytics dashboards, discovery tools.
DeepBook Indexing API
Access DeepBook trading data including pool metadata, order book depth, historical trades, and OHLCV candlestick data. Built for trading interfaces, market analysis, and automated strategies.
Key endpoints:
- Get Pools — List all trading pools with metadata
- Order Book Depth — Current bids and asks
- Recent Trades — Historical trade executions
- OHLCV — Candlestick data for charting
Use cases: Trading dashboards, charting tools, market making bots, analytics platforms, portfolio trackers.
View DeepBook API Documentation →
Authentication
All API requests require an API key passed as a query parameter:
curl "https://api.surflux.dev/nfts/address/0x...?api-key=YOUR_API_KEY"
Don't have an API key? Create your account to get started.
Base URL
All REST API endpoints use:
Mainnet:
https://api.surflux.dev/
Testnet:
https://testnet-api.surflux.dev/
For real-time streaming via Server-Sent Events, see Flux Streams.
Rate Limits
API keys have usage limits based on your plan. Check your dashboard for current limits and usage.
Support
- View getting started guide
- Join our Discord community for support
- Report issues on GitHub