1. 📢 Public
TunnelSats Public Wireguard API
  • About our team
  • 📢 Public
    • List Available WireGuard Servers & Regions
      GET
    • Create a New WireGuard Subscription (Invoice Generation)
      POST
    • Claim WireGuard Configuration After Payment Settlement
      POST
    • Check subscription status via payment hash
      GET
    • Renew an Existing VPN Subscription (Anonymous)
      POST
    • Get Subscription & Bandwidth Status by WireGuard Public Key
      POST
    • Request Bandwidth Top-Up ($1 for +100GB)
      POST
  • 🔐 Authenticated
    • List Account Subscriptions (Authenticated)
      GET
    • Sync Subscription
      POST
    • Create Referral Code
      POST
    • Referral History
      GET
  • 🔧 Tools
    • Lightning Node Network Address Discovery
      POST
    • Universal Connectivity & Latency Probe
      POST
  • Announcements
    • 💫 What is TunnelSats?
    • 🚀 Introducing the TunnelSats Public API v1
    • How TunnelSats Leverages Public APIs for Confined VPN Management
  • Cookbook
    • 🛑 Error Codes & Troubleshooting
    • 🎁 Referral Program: Earn Bonus Months
    • 🚑 Node Health & Upkeep
    • 🛡️ Security & Authentication
    • 🛠️ Automation & Code Examples
    • ⚡ Bandwidth Top-Up ($1 for +100GB)
    • 🐚 Bash One-Liners
  • Schemas
    • Server
    • InvoiceOrder
    • SubscriptionStatus
    • WireGuardConfig
    • ReferralCode
    • ReferralHistory
    • NodeLookup
    • ConnectivityResult
    • ApiError
    • RenewalOrder
    • BandwidthResetResponse
    • PublicKeyStatusResponse
    • ClaimResult
    • SubscriptionListItem
  1. 📢 Public

Get Subscription & Bandwidth Status by WireGuard Public Key

POST
/api/public/v1/subscription/status
Polls WireGuard servers to return real-time expiry, bandwidth consumption in GB, peer enable status, and hosting server domain for a given WireGuard public key.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Status retrieved successfully
Bodyapplication/json

🟠400Bad Request
🟠404Record Not Found
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://tunnelsats.com/api/public/v1/subscription/status' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data '{
    "wgPublicKey": "pWyZTQx8C4gzzgMVJHiN1ptI46wDtyJSMRa+wxtkXOM="
}'
Response Response Example
200 - Example 1
{
    "expiry": "2026-10-15T12:00:00Z",
    "bandwidth_used_gb": 85.4,
    "status": "enabled",
    "server_domain": "us3.tunnelsats.com",
    "last_synced_at": "2026-08-31T18:00:00Z"
}
Modified at 2026-08-31 19:53:35
Previous
Renew an Existing VPN Subscription (Anonymous)
Next
Request Bandwidth Top-Up ($1 for +100GB)
Built with