firehsd/README.md

Fire HSD - Public Handshake API

A Python Flask webserver providing a free public API for the Handshake blockchain.

Features

• Query blocks, headers, transactions, coins, and names from a public HSD node
• No authentication required for read-only endpoints
• Fast, simple, and open source (AGPLv3)

Quick Start

1. Install requirements

   python3 -m pip install -r requirements.txt
   

2. Run the dev server

   python3 server.py
   

3. Production (Gunicorn)

   python3 main.py
   

API Endpoints

Some examples:

• /api/v1/status — Check HSD node status
• /api/v1/block/<blockid> — Get block data by block id
• /api/v1/header/<blockid> — Get header data by block id
• /api/v1/tx/<txid> — Get transaction info
• /api/v1/name/<name> — Get name info
• /api/v1/help — List all API endpoints

Configuration

Set environment variables in .env or use example.env:

HSD_HOST=127.0.0.1
HSD_API_KEY=APIKEY

Support & Donations

If you'd like to help keep the service running and growing, consider donating:

• PayPal
• Card (Stripe)
• HNS, BTC, or other

License

GNU AGPLv3

© 2025 Nathan Woodburn