Copy Page
TunnelSats Public Wireguard API
Announcements
👋 About our team
💫 What is TunnelSats?
🚀 Introducing the TunnelSats Public API v1
🧩 How the TunnelSats StartOS Package Uses the Public API
How TunnelSats Leverages Public APIs for Confined VPN Management
📡 Discovery
List Available WireGuard Servers & Regions
GET
⚡ Purchase
Create a New WireGuard Subscription (Invoice Generation)
POST
Check Invoice Status & Polling by Payment Hash
GET
Claim WireGuard Configuration After Payment Settlement
POST
🔄 Lifecycle
Get Subscription & Bandwidth Status by WireGuard Public Key
POST
Sync Subscription (Real-Time Server Refresh)
POST
Renew an Existing VPN Subscription (Anonymous)
POST
Request Bandwidth Top-Up ($1 for +100GB)
POST
🔑 Account
List Account Subscriptions (Authenticated)
Create Referral Code
Get Referral Code
Referral History
🔧 Tools
Lightning Node Network Address Discovery
Universal Connectivity & Latency Probe
Cookbook
🛠️ Automation & Code Examples
🐚 Bash One-Liners
🚑 Node Health & Upkeep
⚡ Bandwidth Top-Up ($1 for +100GB)
🛡️ Security & Authentication
🎁 Referral Program: Earn Bonus Months
🛑 Error Codes & Troubleshooting
Schemas
Server
InvoiceOrder
SubscriptionStatus
NodeLookup
ConnectivityResult
ApiError
ClaimResult
BandwidthResetResponse
PublicKeyStatusResponse
ReferralCode
ReferralHistory
BandwidthResetPaymentStatus
RenewalOrder
SubscriptionListItem
SyncResult
Sign-up
ConnectivityResult
Copy Page
The result of a ping or connectivity test against a specific Lightning node endpoint.
{
"success"
:
true
,
"reachable"
:
true
,
"latencyMs"
:
35
,
"message"
:
"Connection successful"
}