API Documentation

NAT Type Detection

Get your NAT type and related information through our API endpoint.

GET /api/nat

Response

{
  "success": true,
  "data": {
    "natType": "Full Cone NAT",
    "publicIp": "123.45.67.89",
    "consoleMapping": {
      "xbox": "Type 1 (Open)",
      "playstation": "Type 1 (Open)",
      "nintendo": "Type 1 (Open)"
    }
  }
}

Example Usage

curl https://whatsmynat.com/api/nat

Error Response

In case of an error, the API will return:

{
  "success": false,
  "error": "Failed to detect NAT type"
}