User Detection API

User Detection API Documentation

Detect User-Agent Information

• GET /

  • Summary: Retrieves and returns information about the user's device, operating system, browser, IP address, and more based on the incoming request headers.

  • Responses:

    • 200 OK: User-agent information detected successfully.
      • Content-Type: application/json
      • Schema:

        {
          "type": "object",
          "properties": {
            "language": {
              "type": "string",
              "description": "Preferred language of the user extracted from the 'Accept-Language' header."
            },
            "os": {
              "type": "string",
              "description": "Operating system of the user's device."
            },
            "ip": {
              "type": "string",
              "description": "IP address of the user."
            },
            "device": {
              "type": "string",
              "description": "Type of device used, such as Desktop, Tablet, Mobile, or Unknown."
            },
            "browser": {
              "type": "string",
              "description": "Browser used by the user."
            },
            "browserVersion": {
              "type": "string",
              "description": "Version of the browser."
            },
            "timeZone": {
              "type": "string",
              "description": "Time zone of the user based on browser settings."
            },
            "referrer": {
              "type": "string",
              "description": "Referrer URL if the request came from another site."
            },
            "cookies": {
              "type": "string",
              "description": "Raw cookie header from the request."
            },
            "geo": {
              "type": "object",
              "description": "Optional geolocation data based on the user's IP address.",
              "properties": {
                "country": {
                  "type": "string",
                  "description": "Country derived from the IP address."
                },
                "region": {
                  "type": "string",
                  "description": "Region derived from the IP address."
                },
                "city": {
                  "type": "string",
                  "description": "City derived from the IP address."
                }
              }
            }
          }
        }

  • Tags:

    • User Detection

• All Other Methods on /

  • Summary: Handles unsupported methods for the root route.
  • Responses:
    • 405 Method Not Allowed: Method not supported on the root route.
  • Tags:
    • User Detection