VPNDetection Documentation

Answers what the presented key is, what plan is behind it, and what has been spent against that plan's allowance in the current window.

Authorization

apikey<token>

?apikey=<key>. Convenient in a browser; prefer a header elsewhere.

In: query

Response Body

`application/json`

curl -X GET "https://api.vpndetection.io/api/v1/account/me"

{
  "org_id": "85bb51e4-2eb6-4a31-8e4d-02ba8b98fe61",
  "apikey": {
    "id": "0ab424cc-7619-4dad-b027-afacdc2cedb0",
    "expires": null,
    "allowed_cidrs": []
  },
  "plan": {
    "key": "max",
    "tier": "max"
  },
  "usage": {
    "requests": 580,
    "quota": 5000000,
    "hard_limit": null,
    "window_start": "2026-09-04T07:00:00Z",
    "window_end": "2026-10-04T07:00:00Z"
  }
}

{
  "error": "an API key is required"
}

{
  "error": "source address not allowed for this API key"
}

{
  "error": "usage is temporarily unavailable"
}

Your key, plan and usage

Authorization

Response Body

200application/json

401application/json

403application/json

503application/json

A key on a paid plan, uncapped

A key on the free plan. There is no subscription, so the window is the calendar month, and the allowance is a hard stop rather than a billable overage.

Example missing

Example invalid

Example revoked

Example expired

`application/json`

`application/json`

`application/json`

`application/json`