Skip to main content

Gold Price is a simple tool for getting the current price of gold. It returns the current price of gold in any currency and in various units.

Project description

Gold Price API

Gold Price is a simple tool for getting the current price of gold. It returns the current price of gold in any currency and in various units.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Gold Price API


Installation

Using pip:

pip install apiverve-goldprice

Using pip3:

pip3 install apiverve-goldprice

Configuration

Before using the goldprice 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_goldprice.apiClient import GoldpriceAPIClient

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

query = { "currency": "USD" }

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

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

Usage

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

Setup

# Import the client module
from apiverve_goldprice.apiClient import GoldpriceAPIClient

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

Perform Request

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

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

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "currency": "USD",
    "gram": 103.71,
    "kilogram": 103705.56,
    "ounce": 2940,
    "lastUpdated": 1740074702
  }
}

Error Handling

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

Basic Error Handling

from apiverve_goldprice.apiClient import GoldpriceAPIClient, GoldpriceAPIClientError

api = GoldpriceAPIClient("[YOUR_API_KEY]")

query = { "currency": "USD" }

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

api = GoldpriceAPIClient("[YOUR_API_KEY]")

query = { "currency": "USD" }

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 GoldpriceAPIClientError 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_goldprice.apiClient import GoldpriceAPIClient, GoldpriceAPIClientError

query = { "currency": "USD" }

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

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

query = { "currency": "USD" }

# 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_goldprice.apiClient import GoldpriceAPIClient

api = GoldpriceAPIClient("[YOUR_API_KEY]")

query = { "currency": "USD" }

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

Uploaded Source

Built Distribution

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

apiverve_goldprice-1.1.14-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apiverve_goldprice-1.1.14.tar.gz
Algorithm Hash digest
SHA256 e3c098bd35ddff186749a1873b827433de88a70d37165903d0fa2823c5eb2e29
MD5 768096ad2bdcf48f14d938452dee3335
BLAKE2b-256 2b7983c9b9f8e0316e76253a4c19e52fc34f0953b9b954bb3778053aa3cb140e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for apiverve_goldprice-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 a6e9aca05d16b7031039d31a46a6337b4817291cbfe3b54dc93f98920bd51289
MD5 8dfaa7b32552e6a6b507a2465a2649e8
BLAKE2b-256 d751c61eaf0b2ee771c6c99a0d267952906b21c8542cfdc8366359e56141e9d1

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