Skip to main content

User Agent Generator is a simple tool for generating user agent strings. It returns a random user agent string.

Project description

User Agent Generator API

User Agent Generator is a simple tool for generating user agent strings. It returns a random user agent string.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the User Agent Generator API


Installation

Using pip:

pip install apiverve-useragentgenerator

Using pip3:

pip3 install apiverve-useragentgenerator

Configuration

Before using the useragentgenerator API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient

# Initialize the client with your APIVerve API key
api = UseragentgeneratorAPIClient("[YOUR_API_KEY]")

query = { "device": "desktop" }

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The User Agent Generator API documentation is found here: https://docs.apiverve.com/ref/useragentgenerator. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient

# Initialize the client with your APIVerve API key
api = UseragentgeneratorAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = { "device": "desktop" }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12) AppleWebKit/604.1.28 (KHTML, like Gecko) Version/16.0.0 Safari/604.1.28",
    "browser": {
      "name": "Safari",
      "version": "16.0.0",
      "major": "16"
    },
    "engine": {
      "name": "WebKit",
      "version": "604.1.28"
    },
    "os": {
      "name": "Mac OS",
      "version": "10.12"
    },
    "device": {
      "vendor": "Apple",
      "model": "Macintosh"
    },
    "cpu": {}
  }
}

Error Handling

The API client provides comprehensive error handling through the UseragentgeneratorAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient, UseragentgeneratorAPIClientError

api = UseragentgeneratorAPIClient("[YOUR_API_KEY]")

query = { "device": "desktop" }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except UseragentgeneratorAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient, UseragentgeneratorAPIClientError

api = UseragentgeneratorAPIClient("[YOUR_API_KEY]")

query = { "device": "desktop" }

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except UseragentgeneratorAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient, UseragentgeneratorAPIClientError

query = { "device": "desktop" }

# Using context manager ensures proper cleanup
with UseragentgeneratorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except UseragentgeneratorAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient

# Enable debug mode
api = UseragentgeneratorAPIClient("[YOUR_API_KEY]", debug=True)

query = { "device": "desktop" }

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_useragentgenerator.apiClient import UseragentgeneratorAPIClient

api = UseragentgeneratorAPIClient("[YOUR_API_KEY]")

query = { "device": "desktop" }

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_useragentgenerator-1.1.14.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_useragentgenerator-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_useragentgenerator-1.1.14.tar.gz.

File metadata

File hashes

Hashes for apiverve_useragentgenerator-1.1.14.tar.gz
Algorithm Hash digest
SHA256 1c07a5526bbe70183413ad86eb005252420ea03278899181432af1d4d27f172b
MD5 5d4f7853f162887ba6c1d068f770867b
BLAKE2b-256 688ae24635840b979a4164787642f9b59dac05516ac1cfdb4979511e6ca74772

See more details on using hashes here.

File details

Details for the file apiverve_useragentgenerator-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_useragentgenerator-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 3fe387e672e21e555339370c88adaf74cc807ae4e1a617b4083f094fa8d7d230
MD5 f9894815abef9779a1c1e0c33c700dde
BLAKE2b-256 49395620096485e4213c228b67a033524ae2e0da4d39a53b41bcc98f23921159

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page