Documentation

Everything you need to integrate with MintFlow API

Quick Start
Get up and running in 5 minutes
API Reference
Complete API documentation
Examples
Sample code and integrations

Getting Started

Welcome to the MintFlow API documentation. This guide will help you purchase subscription NFTs and authenticate your API requests using bitcoin-auth.

Authentication

All API requests require authentication using bitcoin-auth (BRC-77). Here's a quick example:

JavaScript Example
bitcoin-auth
import { getAuthToken } from 'bitcoin-auth';

const token = getAuthToken({
  privateKeyWif: 'your-private-key',
  requestPath: '/api/market/data',
  scheme: 'brc77'
});

const response = await fetch('https://api.1sat.market/market/data', {
  headers: {
    'X-Auth-Token': token
  }
});

Purchasing a Subscription

Subscriptions are NFTs that you purchase with MNEE stablecoin. Once minted, the NFT grants you access to the API based on your tier.

  1. Choose your tier (Starter, Pro, or Enterprise)
  2. Connect your wallet or provide a designated address
  3. Pay with MNEE stablecoin
  4. Receive your subscription NFT
  5. Start making authenticated API requests

Rate Limits

Rate limits are enforced based on your subscription tier:

Starter

60 calls/minute

50,000 calls/month

Pro

120 calls/minute

200,000 calls/month

Enterprise

Custom limits

Unlimited calls

Need Help?

For support, please visit our GitHub issues or contact us directly based on your tier.