Skip to main content

Number to Words is a simple tool for converting numbers to words. It returns the number in words.

Project description

Number to Words API

Number to Words is a simple tool for converting numbers to words. It returns the number in words.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Number to Words API


Installation

Using pip:

pip install apiverve-numbertowords

Using pip3:

pip3 install apiverve-numbertowords

Configuration

Before using the numbertowords 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_numbertowords.apiClient import NumbertowordsAPIClient

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

query = { "number": 975.07 }

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

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

Usage

The Number to Words API documentation is found here: https://docs.apiverve.com/ref/numbertowords. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_numbertowords.apiClient import NumbertowordsAPIClient

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

Perform Request

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

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

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "number": 975.07,
    "words": "nine hundred seventy-five point zero seven",
    "ordinal": "nine hundred seventy-fifth point zero seven",
    "numberOfDigits_numeric": 3,
    "numberOfDigits_words": "three",
    "eachNumber": [
      "nine",
      "seven",
      "five"
    ],
    "afterDecimal": {
      "number": "07",
      "words": [
        "zero",
        "seven"
      ],
      "numberOfDigits_numeric": 2,
      "numberOfDigits_words": "two"
    },
    "locale": "en-US"
  }
}

Error Handling

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

Basic Error Handling

from apiverve_numbertowords.apiClient import NumbertowordsAPIClient, NumbertowordsAPIClientError

api = NumbertowordsAPIClient("[YOUR_API_KEY]")

query = { "number": 975.07 }

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

api = NumbertowordsAPIClient("[YOUR_API_KEY]")

query = { "number": 975.07 }

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 NumbertowordsAPIClientError 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_numbertowords.apiClient import NumbertowordsAPIClient, NumbertowordsAPIClientError

query = { "number": 975.07 }

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

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

query = { "number": 975.07 }

# 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_numbertowords.apiClient import NumbertowordsAPIClient

api = NumbertowordsAPIClient("[YOUR_API_KEY]")

query = { "number": 975.07 }

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

Uploaded Source

Built Distribution

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

apiverve_numbertowords-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_numbertowords-1.1.14.tar.gz
Algorithm Hash digest
SHA256 11e4ea86b7b4212642287c724f92b485af458f51b2e7cb04fb2bcced9d88e0f3
MD5 1145ced2d97c66cba7b0963434fed3ff
BLAKE2b-256 20e68957ba00691e7f816fdbbeebc87bb1ba97082cecf940d2a8f908c40633e6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_numbertowords-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 92d8113ba5752ad437a1f24d8b0ca5ca3b235ba09a8b579e776dd7525cb99d9a
MD5 36a50ddf65b8d10094247719c940b67f
BLAKE2b-256 185168fe618b5a638458c47b00c0de1d1e48582c96b153600f96568bd0ac31a0

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