User Agent API Documentation

Your Browser

The API detected your browser as: Unknown Bot on Unknown

Introduction

The User Agent API provides two main services:

  1. Retrieve user agent data collected through our tracking system
  2. Generate customized user agent strings for testing purposes

Both services require a valid API key for authentication.

Authentication

All API requests require an API key, which should be included as a query parameter:

https://example.com/api/get_useragent.php?key=YOUR_API_KEY

For demo purposes, you can use the following API key: demo_key_123

Note: The demo key has strict rate limits. For production use, please obtain a proper API key.

User Agent String Generation

GET /api/get_useragent.php

Generate a customized user agent string for testing purposes.

Parameters
Parameter Type Description Required
key string Your API key for authentication Yes
type string Device type: "desktop", "android", or "ios" Yes
os_type string Operating system type (e.g., "windows", "macos", "linux", "android", "ios") Yes
os_version string OS version (e.g., "10", "latest", "random") Yes
browser_name string Browser name (e.g., "chrome", "firefox", "safari") Yes
browser_version string Browser version (e.g., "100", "latest", "random") Yes
device string Device model (e.g., "Samsung Galaxy S21", "iPhone 13", "random") Yes
Example Request
https://example.com/api/get_useragent.php?key=demo_key_123&type=android&os_type=android&os_version=12&browser_name=chrome&browser_version=latest&device=random
Example Response
{ "success": true, "status": 200, "user_agent": "Mozilla/5.0 (Linux; Android 12; SM-G990B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.6099.43 Mobile Safari/537.36", "device": { "brand": "Samsung", "model": "SM-G990B", "marketing_name": "Galaxy S21 FE" }, "browser": { "name": "Chrome", "version": "120.0.6099.43" }, "os": { "name": "Android", "version": "12" } }

Random User Agent Generation (Simplified)

New! This is a simplified endpoint that generates random user agents with just one parameter.
GET /api/random_useragent.php

Generate a fully random user agent string by just specifying the device type. All other parameters (OS version, browser, device model) are automatically randomized with latest versions.

Parameters
Parameter Type Description Required
key string Your API key for authentication Yes
type string Device type: "desktop", "android", or "iphone" Yes
Behavior by Type
  • desktop: Random Windows/Mac OS + Random Chrome/Firefox with latest version
  • android: Random Android 10-15 + Random Chrome/Firefox with latest version + Random device from popular brands
  • iphone: Random iOS 13+ version + Random Safari/Chrome/Firefox with latest version + Random iPhone model
Example Requests
https://example.com/api/random_useragent.php?key=demo_key_123&type=desktop
https://example.com/api/random_useragent.php?key=demo_key_123&type=android
https://example.com/api/random_useragent.php?key=demo_key_123&type=iphone
Example Response (Android)
{ "success": true, "status": 200, "user_agent": "Mozilla/5.0 (Linux; Android 14; SM-G990B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.6846.0 Mobile Safari/537.36", "device": { "type": "Mobile", "brand": "Samsung", "model": "SM-G990B", "marketing_name": "Galaxy S21 FE" }, "os": { "name": "Android", "version": "14" }, "browser": { "name": "Chrome", "version": "133.0.6846.0" }, "api_usage": { "note": "Using demo API key. Register for a free account to get higher limits and usage tracking." } }
Example Response (iPhone)
{ "success": true, "status": 200, "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/21C66 Safari/604.1", "device": { "type": "Mobile", "brand": "Apple", "model": "iPhone15,2", "marketing_name": "iPhone 14 Pro" }, "os": { "name": "iOS", "version": "17.2.1", "build": "21C66" }, "browser": { "name": "Safari", "version": "17.0" } }
Example Response (Desktop)
{ "success": true, "status": 200, "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.6846.0 Safari/537.36", "device": { "type": "Desktop", "brand": "Windows PC", "model": "Win64; x64" }, "os": { "name": "Windows", "version": "10.0" }, "browser": { "name": "Chrome", "version": "133.0.6846.0" } }

Error Responses

The API returns error responses with appropriate HTTP status codes when something goes wrong:

Status Code Description Example
400 Bad Request - Missing or invalid parameters
{ "success": false, "status": 400, "error": "Missing parameters: type, os_type" }
401 Unauthorized - Missing or invalid API key
{ "success": false, "status": 401, "error": "Invalid API key." }
429 Too Many Requests - Rate limit exceeded
{ "success": false, "error": "Rate limit exceeded (100 requests/minute)" }

Rate Limits

The API enforces rate limits to prevent abuse:

Rate limit information is included in the response metadata.

View Database Demo View Dashboard