TunnelSats Public Wireguard API
    TunnelSats Public Wireguard API
    • About our team
    • πŸ“’ Public
      • List Servers
        GET
      • Create Subscription
        POST
      • Check Status / Heal
        GET
      • Claim Subscription
        POST
      • Renew Subscription
        POST
      • Get Subscription Status
        POST
    • πŸ” Authenticated
      • List My Subscriptions
        GET
      • Sync Subscription
        POST
      • Create Referral Code
        POST
      • Referral History
        GET
    • Announcements
      • πŸ’« What is TunnelSats?
      • πŸš€ Introducing the TunnelSats Public API v1
    • Cookbook
      • πŸ› οΈ Automation & Code Examples
      • 🐚 Bash One-Liners
      • πŸ›‘ Error Codes & Troubleshooting
      • 🎁 Referral Program: Earn Bonus Months
    • Schemas
      • Server
      • InvoiceOrder
      • SubscriptionStatus
      • WireGuardConfig
      • ReferralCode
      • ReferralHistory
      • NodeLookup
      • ConnectivityResult

    πŸ“’ Public

    postman_ts_banner.jpeg

    TunnelSats API#

    Programmatic access to TunnelSats VPN subscriptions.

    ⚑ Quick Start#

    1.
    List Servers: GET /servers - See available locations.
    2.
    Create Subscription: POST /create - Get a Lightning invoice.
    3.
    Pay: Pay the invoice with any Lightning wallet.
    4.
    Claim: POST /claim - Receive your WireGuard config.

    πŸ’° Pricing#

    DurationPriceDiscount
    1 month$3.00-
    3 months$8.555%
    6 months$16.2010%
    12 months$28.8020%
    Prices converted to Sats at current BTC/USD rate.

    πŸ†” Server IDs#

    IDLocation
    us-eastAshburn, USA
    us-westHillsboro, USA
    eu-deNuremberg, DE
    asia-sgSingapore
    sa-brSao Paulo, BR

    🎁 Referral Program#

    Include referralCode in /create for bonus months:
    3mo plan β†’ +1 month free
    6mo plan β†’ +2 months free
    12mo plan β†’ +3 months free

    πŸ” Authentication#

    Most endpoints are public - no auth needed to buy!
    For account endpoints (List My Subs, Sync):
    MethodHeaderHow to Get
    API Key (recommended)Authorization: {{vault:bearer-token}}Dashboard β†’ Settings β†’ API Keys
    NIP-98 (advanced)Authorization: NostrRequires Nostr signing (e.g. Alby extension)

    ❓ FAQ#

    Q: Do I need an API Key to buy a subscription?
    A: No! The purchase flow is completely public. Keys are only for managing your account.
    Q: Where do I get an API Key?
    A: Log in at tunnelsats.com β†’ Dashboard β†’ Settings β†’ Generate API Key.
    Q: What's the difference between API Key and NIP-98?
    A: API Keys are simple Bearer tokens. NIP-98 uses Nostr-signed events - useful for Nostr-native apps but requires cryptographic signing.
    Q: Can I use my own WireGuard keys?
    A: Yes! Pass wgPublicKey in /claim to bring your own keys. Otherwise we generate them for you.

    ⏱️ Rate Limits#

    Reads: 60/min
    Creates: 10/min
    Claims: 10/min

    πŸ–₯️ Base URL#

    https://tunnelsats.com
    Public endpoints that don’t require authentication.
    Use these to discover available servers and basic status info.
    Start here to get yourΒ first 200 OK.
    Modified atΒ 2026-02-10 22:20:31
    Previous
    About our team
    Next
    List Servers
    Built with