Get Subscription & Bandwidth Status by WireGuard Public Key

POST

https://tunnelsats.com/api/public/v1/subscription/status

Polls WireGuard servers to return real-time expiry, bandwidth consumption and quota, bandwidth-reset allowance, peer status, hosting server domain and forwarded port. No authentication required. Rate limit: 30 requests/min per IP.

404 vs 503: 404 means every VPN server answered and none holds the key: the key is unknown (import or buy a subscription). 503 (ERR_SERVICE_UNAVAILABLE, with Retry-After) means the key was not found on the servers that answered but at least one server could not be checked: retry later and do not treat the key as unknown. When an active server cannot be checked, a copy of the key on a legacy server is not reported either (the active server may hold the current one), so that case is a 503 as well.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Subscription status and bandwidth data

Bodyapplication/json

🟠404

🔴503

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 Example

200 - Success

{
    "expiry": "2026-10-15T12:00:00Z",
    "bandwidth_used_gb": 45.67,
    "bandwidth_limit_gb": 100,
    "bandwidth_resets_this_month": 0,
    "max_resets_per_month": 2,
    "status": "enabled",
    "server_domain": "de2.tunnelsats.com",
    "vpn_port": 24556,
    "last_synced_at": "2026-09-01T12:00:00Z"
}

Modified at 2026-10-10 22:07:24

Claim WireGuard Configuration After Payment Settlement

Sync Subscription (Real-Time Server Refresh)