API Introduction

Learn how to interact with your Droplit instances programmatically.

Introduction

Welcome to the Droplit API documentation. Here you'll find the information you need to integrate your applications with your Droplit instances.

All API endpoints are relative to your Droplit service URL (typically http://localhost:8080 for local development, or your deployed service URL).

Getting Started

To use the API, you'll need to:

  1. Understand the Authentication mechanism.
  2. Familiarize yourself with the available endpoints:
    • Tap Faucet - For dispensing satoshis (if configured).
    • Push Data - For sending arbitrary data to your Droplit.
    • Mint Inscriptions - For creating ordinal inscriptions and BSV21 tokens.

Navigate through the sections to learn more about each aspect of the API.