Skip to main content

Random User Generator is a simple tool for generating random user data. It returns the user's name, email, and more.

Project description

Random User Generator API

Random User Generator is a simple tool for generating random user data. It returns the user's name, email, and more.

Build Status Code Climate Prod Ready

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


Installation

Using pip:

pip install apiverve-randomusergenerator

Using pip3:

pip3 install apiverve-randomusergenerator

Configuration

Before using the randomusergenerator 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_randomusergenerator.apiClient import RandomusergeneratorAPIClient

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

query = { "count": 1 }

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

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

Usage

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

Setup

# Import the client module
from apiverve_randomusergenerator.apiClient import RandomusergeneratorAPIClient

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

Perform Request

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

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

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": [
    {
      "id": "04e47b46-c078-4d51-a7e9-17708ebea53e",
      "name": "Yvette Greenholt",
      "gender": "Female",
      "username": "Julien.Kutch",
      "email": "Jude_Kuhic@yahoo.com",
      "password": "M90Tqd9_5_9tbuE",
      "registered": "2024-12-06T20:36:01.485Z",
      "phone": "832.718.9991 x55356",
      "cell": "(344) 512-8916 x36142",
      "birthdate": "1958-06-28T06:23:25.829Z"
    }
  ],
  "code": 200
}

Error Handling

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

Basic Error Handling

from apiverve_randomusergenerator.apiClient import RandomusergeneratorAPIClient, RandomusergeneratorAPIClientError

api = RandomusergeneratorAPIClient("[YOUR_API_KEY]")

query = { "count": 1 }

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except RandomusergeneratorAPIClientError 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_randomusergenerator.apiClient import RandomusergeneratorAPIClient, RandomusergeneratorAPIClientError

api = RandomusergeneratorAPIClient("[YOUR_API_KEY]")

query = { "count": 1 }

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 RandomusergeneratorAPIClientError 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_randomusergenerator.apiClient import RandomusergeneratorAPIClient, RandomusergeneratorAPIClientError

query = { "count": 1 }

# Using context manager ensures proper cleanup
with RandomusergeneratorAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except RandomusergeneratorAPIClientError 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_randomusergenerator.apiClient import RandomusergeneratorAPIClient

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

query = { "count": 1 }

# 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_randomusergenerator.apiClient import RandomusergeneratorAPIClient

api = RandomusergeneratorAPIClient("[YOUR_API_KEY]")

query = { "count": 1 }

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_randomusergenerator-1.1.14.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

apiverve_randomusergenerator-1.1.14-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for apiverve_randomusergenerator-1.1.14.tar.gz
Algorithm Hash digest
SHA256 92b0599a900420be6e8c44b76aa4f528afd9263799509d1c1130aafa0fcdc5b6
MD5 d132ae5c9efa127d44251dfc4c4f798a
BLAKE2b-256 d4fa56eab4c491b77f6eb16264b17c646ba79f6d10d44e1663a29fb3af052735

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_randomusergenerator-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 25344e90486efe82e8d5495a0b72e42cf403afbfbf2f99b16ba4bc69e333952f
MD5 1579805819dffde7f2d937258786eeca
BLAKE2b-256 1ee7841c68f88d26abf0632d3d1bd47159b5d1f3d6d8bc7537facad47a6f470a

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