# TunnelSats Public Wireguard API

## Docs
- [About our team](https://api.tunnelsats.com/about-our-team-358202m0.md): 
- [📢 Public](https://api.tunnelsats.com/-public-489229f0.md): Public endpoints that don’t require authentication.  
- [🔐 Authenticated](https://api.tunnelsats.com/-authenticated-489230f0.md): Endpoints that require `Authorization: Bearer {{apiKey}}` or NIP-98.  
- Announcements [💫 What is TunnelSats?](https://api.tunnelsats.com/-what-is-tunnelsats-358204m0.md): 
- Announcements [🚀 Introducing the TunnelSats Public API v1](https://api.tunnelsats.com/-introducing-the-tunnelsats-public-api-v1-358203m0.md): 
- Cookbook [🛠️ Automation & Code Examples](https://api.tunnelsats.com/%EF%B8%8F-automation-code-examples-358247m0.md): 
- Cookbook [🐚 Bash One-Liners](https://api.tunnelsats.com/-bash-one-liners-358248m0.md): 
- Cookbook [🛑 Error Codes & Troubleshooting](https://api.tunnelsats.com/-error-codes-troubleshooting-358264m0.md): 
- Cookbook [🎁 Referral Program: Earn Bonus Months](https://api.tunnelsats.com/-referral-program-earn-bonus-months-358265m0.md): 

## API Docs
- 📢 Public [List Servers](https://api.tunnelsats.com/list-servers-4063128e0.md): Returns available VPN servers.
- 📢 Public [Create Subscription](https://api.tunnelsats.com/create-subscription-4063129e0.md): Creates Lightning invoice for new subscription.
- 📢 Public [Check Status / Heal](https://api.tunnelsats.com/check-status-heal-4063130e0.md): Checks payment status. **Triggers 'status healing' if webhook missed.**
- 📢 Public [Claim Subscription](https://api.tunnelsats.com/claim-subscription-4063131e0.md): Provisions WireGuard config. Call after payment confirmed.
- 📢 Public [Renew Subscription](https://api.tunnelsats.com/renew-subscription-4063132e0.md): Creates renewal invoice for existing subscription.
- 📢 Public [Get Subscription Status](https://api.tunnelsats.com/get-subscription-status-4063133e0.md): Returns subscription status by polling VPN servers. No authentication required.
- 🔐 Authenticated [List My Subscriptions](https://api.tunnelsats.com/list-my-subscriptions-4063136e0.md): Returns subscriptions linked to authenticated user.
- 🔐 Authenticated [Sync Subscription](https://api.tunnelsats.com/sync-subscription-4063137e0.md): Triggers real-time sync from VPN server. Returns updated bandwidth/expiry.
- 🔐 Authenticated [Create Referral Code](https://api.tunnelsats.com/create-referral-code-4063138e0.md): Creates a referral code for the authenticated user.
- 🔐 Authenticated [Referral History](https://api.tunnelsats.com/referral-history-4063139e0.md): Retrieves a history of successful referrals (paid/claimed orders) that earned you bonus months.

## Schemas
- [Server](https://api.tunnelsats.com/server-740543d0.md): 
- [InvoiceOrder](https://api.tunnelsats.com/invoiceorder-740544d0.md): 
- [SubscriptionStatus](https://api.tunnelsats.com/subscriptionstatus-740545d0.md): 
- [WireGuardConfig](https://api.tunnelsats.com/wireguardconfig-740546d0.md): 
- [ReferralCode](https://api.tunnelsats.com/referralcode-740547d0.md): 
- [ReferralHistory](https://api.tunnelsats.com/referralhistory-740548d0.md): 
- [NodeLookup](https://api.tunnelsats.com/nodelookup-740549d0.md): 
- [ConnectivityResult](https://api.tunnelsats.com/connectivityresult-740550d0.md):