Skip to main content

Acronym Expander is an AI-powered tool for expanding acronyms to their full meanings. It uses a dictionary of common acronyms and AI for unknown ones, with optional context for better accuracy.

Project description

Acronym Expander API

Acronym Expander is an AI-powered tool for expanding acronyms to their full meanings. It uses a dictionary of common acronyms and AI for unknown ones, with optional context for better accuracy.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Acronym Expander API


Installation

Using pip:

pip install apiverve-acronymexpander

Using pip3:

pip3 install apiverve-acronymexpander

Configuration

Before using the acronymexpander 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_acronymexpander.apiClient import AcronymexpanderAPIClient

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

query = {
    "acronym": "API",
    "context": "General"
}

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

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

Usage

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

Setup

# Import the client module
from apiverve_acronymexpander.apiClient import AcronymexpanderAPIClient

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

Perform Request

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

Define Query
query = {
    "acronym": "API",
    "context": "General"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "acronym": "API",
    "expansions": [
      {
        "expansion": "Application Programming Interface",
        "description": "A set of protocols for building software",
        "category": "technology"
      }
    ],
    "most_common": {
      "expansion": "Application Programming Interface",
      "description": "A set of protocols for building software",
      "category": "technology"
    },
    "source": "dictionary",
    "context_provided": "software"
  }
}

Error Handling

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

Basic Error Handling

from apiverve_acronymexpander.apiClient import AcronymexpanderAPIClient, AcronymexpanderAPIClientError

api = AcronymexpanderAPIClient("[YOUR_API_KEY]")

query = {
    "acronym": "API",
    "context": "General"
}

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

api = AcronymexpanderAPIClient("[YOUR_API_KEY]")

query = {
    "acronym": "API",
    "context": "General"
}

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 AcronymexpanderAPIClientError 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_acronymexpander.apiClient import AcronymexpanderAPIClient, AcronymexpanderAPIClientError

query = {
    "acronym": "API",
    "context": "General"
}

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

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

query = {
    "acronym": "API",
    "context": "General"
}

# 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_acronymexpander.apiClient import AcronymexpanderAPIClient

api = AcronymexpanderAPIClient("[YOUR_API_KEY]")

query = {
    "acronym": "API",
    "context": "General"
}

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_acronymexpander-1.2.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

apiverve_acronymexpander-1.2.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_acronymexpander-1.2.0.tar.gz.

File metadata

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

File hashes

Hashes for apiverve_acronymexpander-1.2.0.tar.gz
Algorithm Hash digest
SHA256 1021d51f087df8d59592cc3906c988308e4b24eb81cfd812bf4b0494efbca5a1
MD5 b357e19b864da0b860d87271645dacad
BLAKE2b-256 83f1f8ffbc6f8fd655b1aca3f0eadf3c10d3cb88efffc13ed21d660b129c944d

See more details on using hashes here.

File details

Details for the file apiverve_acronymexpander-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_acronymexpander-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f7afc7fc51657b8454fca84f5fa35c0198d93e571672c0cabb772b0196d0d23
MD5 4216fd3cf4b086ef599979598934b30f
BLAKE2b-256 b79d5c12eebc1bc93800f5de1a0ec48d43f973b4f21a79da8fabf53f3b66fb91

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