Skip to main content

Random Word is a simple tool for getting random words. It returns a random word.

Project description

Random Word API

Random Word is a simple tool for getting random words. It returns a random word.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Random Word API


Installation

Using pip:

pip install apiverve-randomword

Using pip3:

pip3 install apiverve-randomword

Configuration

Before using the randomwords 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_randomword.apiClient import RandomwordsAPIClient

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

# This API does not require a Query

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

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

Usage

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

Setup

# Import the client module
from apiverve_randomword.apiClient import RandomwordsAPIClient

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

Perform Request

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

Define Query
# This API does not require a Query
Simple Request
# Make a request to the API
result = api.execute()

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "word": "intercessionate",
    "definitions": [
      "To entreat. [Obs.]"
    ]
  }
}

Error Handling

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

Basic Error Handling

from apiverve_randomword.apiClient import RandomwordsAPIClient, RandomwordsAPIClientError

api = RandomwordsAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()
    print("Success!")
    print(result)
except RandomwordsAPIClientError 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_randomword.apiClient import RandomwordsAPIClient, RandomwordsAPIClientError

api = RandomwordsAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()

    # 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 RandomwordsAPIClientError 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_randomword.apiClient import RandomwordsAPIClient, RandomwordsAPIClientError

# This API does not require a Query

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

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

# This API does not require a Query

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

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_randomword.apiClient import RandomwordsAPIClient

api = RandomwordsAPIClient("[YOUR_API_KEY]")

# This API does not require a Query

try:
    result = api.execute()
    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_randomword-1.1.14.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

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

apiverve_randomword-1.1.14-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apiverve_randomword-1.1.14.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_randomword-1.1.14.tar.gz
Algorithm Hash digest
SHA256 3931f358c75feb3b466fa58ceee4daac62f754f0fa0945846b6971ec0ae13a8c
MD5 399eac2b8a2894eed115e674f5e565cf
BLAKE2b-256 bc67ca1808306fd6707ab13287bb151d12e5c5a2d2fb9409d703326fee187513

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_randomword-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6c8ed4581507c3f1bef59328b2bce705ee68745d8e0ba67e9afb75d409ac17a4
MD5 af4e6d6db96e3a432727205719ad65a9
BLAKE2b-256 5b4d0b7de8c0205f78199a71dfa2243512868e46de87b28d87a3771b748e048b

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