Sandshrew

Enterprise-grade Bitcoin Indexer

High-performance, open-source Bitcoin indexer and API. Built for speed, reliability, and scalability.

Scalable

Handles high load

Lightning Fast

Sub-100ms queries

Open Source

MIT Licensed

Easy Setup

Docker ready

Features

Advanced Indexing

Efficient indexing of Bitcoin transactions, UTXOs, ordinals, and inscriptions with optimized storage.

High Performance

Built for speed with Rust and optimized database queries for minimal latency.

Easy Deployment

Simple setup with Docker and comprehensive documentation for quick deployment.

Rich API

Comprehensive REST API with WebSocket support for real-time updates.

Getting Started

Configuration

import { LaserEyesClient, createConfig, MAINNET } from '@omnisat/lasereyes-core'

const config = createConfig({
  network: MAINNET,
  dataSources: {
    sandshrew: {
      apiKey: process.env.SANDSHREW_API_KEY,
      priority: 1  // Set as primary data source
    }
  }
})

Get your API key at sandshrew.io

API Examples

Fetching Data

import { useLaserEyes } from '@omnisat/lasereyes-react'

function BitcoinData() {
  const { client } = useLaserEyes()
  
  async function fetchData() {
    const manager = client.getDataSourceManager()
    
    // Get address balance and UTXOs
    const balance = await manager.getBalance('bc1p...')
    const utxos = await manager.getUtxos('bc1p...')
    
    // Get ordinals and inscriptions
    const inscriptions = await manager.getInscriptions('bc1p...')
    const content = await manager.getInscriptionContent('123...')
    
    // Get BRC-20 and runes data
    const brc20 = await manager.getMetaBalances('bc1p...', 'brc20')
    const runes = await manager.getMetaBalances('bc1p...', 'runes')
  }
}

Advanced Features

Real-time Updates

// Subscribe to real-time updates
const ws = new WebSocket('wss://api.sandshrew.io/v1/ws')

ws.onmessage = (event) => {
  const data = JSON.parse(event.data)
  
  // Handle different event types
  switch (data.type) {
    case 'block':
      console.log('New block:', data.block)
      break
    case 'tx':
      console.log('New transaction:', data.tx)
      break
    case 'inscription':
      console.log('New inscription:', data.inscription)
      break
  }
}

Self-Hosting

Docker Support

Easy deployment with official Docker images and compose files.

Full Control

Run your own instance with complete control over data and settings.

Community Support

Active community and maintainers for support and contributions.

Open Source

Sandshrew is open source under the MIT license. We welcome contributions from the community!

View on GitHub

Maestro

Mempool.space