Skip to main content

Unit Converter is a simple tool for converting units. It returns the converted value.

Project description

Unit Converter API

Unit Converter is a simple tool for converting units. It returns the converted value.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Unit Converter API


Installation

Using pip:

pip install apiverve-unitconverter

Using pip3:

pip3 install apiverve-unitconverter

Configuration

Before using the unitconverter 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_unitconverter.apiClient import UnitconverterAPIClient

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

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

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

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

Usage

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

Setup

# Import the client module
from apiverve_unitconverter.apiClient import UnitconverterAPIClient

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

Perform Request

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

Define Query
query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "result": {
      "result": 45.36,
      "from": "100 lb",
      "to": "kg"
    },
    "unitDefinitions": {
      "from": {
        "abbr": "lb",
        "measure": "mass",
        "system": "imperial",
        "singular": "Pound",
        "plural": "Pounds"
      },
      "to": {
        "abbr": "kg",
        "measure": "mass",
        "system": "metric",
        "singular": "Kilogram",
        "plural": "Kilograms"
      }
    }
  }
}

Error Handling

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

Basic Error Handling

from apiverve_unitconverter.apiClient import UnitconverterAPIClient, UnitconverterAPIClientError

api = UnitconverterAPIClient("[YOUR_API_KEY]")

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

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

api = UnitconverterAPIClient("[YOUR_API_KEY]")

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

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 UnitconverterAPIClientError 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_unitconverter.apiClient import UnitconverterAPIClient, UnitconverterAPIClientError

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

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

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

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

# 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_unitconverter.apiClient import UnitconverterAPIClient

api = UnitconverterAPIClient("[YOUR_API_KEY]")

query = {
    "value": 100,
    "from": "lb",
    "to": "kg"
}

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_unitconverter-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_unitconverter-1.1.14-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_unitconverter-1.1.14.tar.gz
Algorithm Hash digest
SHA256 4e1ff1e887ddd7e845dd5eb353f0779e778a43c8e76a532623dfaf109a94709c
MD5 0f9529141c7b688ceebd99eea3a63182
BLAKE2b-256 533faffafbd7fc048fd1c7738b60a3caf75232dd06d720322a45fd3e6b9d9901

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_unitconverter-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6fb1ce8ecb789f966130eba45126d71368954455ce175720479091ce86205df8
MD5 4221bb5e13ac6441fcc6a1b5a1af4322
BLAKE2b-256 079a0e45f8f5025586f41d441a5745bc12af664ab8c692f01fde88330781697e

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