# metalpriceapi
metalpriceapi is the official Python wrapper for MetalpriceAPI.com. This allows you to quickly integrate our metal price API and foreign exchange rate API into your application. Check https://metalpriceapi.com documentation for more information.
## Installation
Install the latest release with:
pip install metalpriceapi
## Usage
```python
from metalpriceapi.client import Client
api_key = 'SET_YOUR_API_KEY_HERE'
client = Client(api_key)
```
---
## Documentation
#### fetchSymbols()
```python
client.fetchSymbols()
```
[Link](https://metalpriceapi.com/documentation#api_symbol)
---
#### fetchLive(base, currencies)
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.
```python
client.fetchLive(base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
```
[Link](https://metalpriceapi.com/documentation#api_realtime)
---
#### fetchHistorical(date, base, currencies)
- `date` <[string]> Required. Pass in a string with format `YYYY-MM-DD`
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.
```python
client.fetchHistorical(date='2024-02-05', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
```
[Link](https://metalpriceapi.com/documentation#api_historical)
---
#### fetchOHLC(base, currency, date, unit, dateType)
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `currency` <[string]> Required. Specify currency you would like to get OHLC for.
- `date` <[string]> Required. Specify date to get OHLC for specific date using format `YYYY-MM-DD`.
- `unit` <[string]> Optional. Pass in a unit, defaults to troy_oz.
- `date_type` <[string]> Optional. Pass in a date type, overrides date parameter if passed in.
```python
client.fetchOHLC(base='USD', currency='XAU', date='2024-02-05', unit='troy_oz', date_type=None)
```
[Link](https://metalpriceapi.com/documentation#api_ohlc)
---
#### convert(from_currency, to_currency, amount, date)
- `from_currency` <[string]> Optional. Pass in a base currency, defaults to USD.
- `to_currency` <[string]> Required. Specify currency you would like to convert to.
- `amount` <[number]> Required. The amount to convert.
- `date` <[string]> Optional. Specify date to use historical midpoint value for conversion with format `YYYY-MM-DD`. Otherwise, it will use live exchange rate date if value not passed in.
```python
client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2024-02-05')
```
[Link](https://metalpriceapi.com/documentation#api_convert)
---
#### timeframe(start_date, end_date, base, currencies)
- `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.
- `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.
```python
client.timeframe(start_date='2024-02-05', end_date='2024-02-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
```
[Link](https://metalpriceapi.com/documentation#api_timeframe)
---
#### change(start_date, end_date, base, currencies)
- `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.
- `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.
```python
client.change(start_date='2024-02-05', end_date='2024-02-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
```
[Link](https://metalpriceapi.com/documentation#api_change)
---
#### carat(base, date)
- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
- `date` <[string]> Optional. Specify date to get Carat for specific date using format `YYYY-MM-DD`. If not specified, uses live rates.
```python
client.carat(base='USD', date='2024-02-05')
```
[Link](https://metalpriceapi.com/documentation#api_carat)
---
#### usage()
```python
client.usage()
```
[Link](https://metalpriceapi.com/documentation#api_usage)
---
**[Official documentation](https://metalpriceapi.com/documentation)**
---
## FAQ
- How do I get an API Key?
Free API Keys are available [here](https://metalpriceapi.com).
- I want more information
Checkout our FAQs [here](https://metalpriceapi.com/faq).
## Support
For support, get in touch using [this form](https://metalpriceapi.com/contact).
[List]: https://www.w3schools.com/python/python_datatypes.asp 'List'
[number]: https://www.w3schools.com/python/python_datatypes.asp 'Number'
[string]: https://www.w3schools.com/python/python_datatypes.asp 'String'
Raw data
{
"_id": null,
"home_page": "https://github.com/metalpriceapi/metalpriceapi-python",
"name": "metalpriceapi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "currency, metal price, exchangerate, rates",
"author": "MetalpriceAPI",
"author_email": "contact@metalpriceapi.com",
"download_url": "https://files.pythonhosted.org/packages/74/c3/92c563f13dba4d3dc6fb92f80e22d9c1e6a905c853663cd475146dc7e6af/metalpriceapi-1.1.2.tar.gz",
"platform": null,
"description": "# metalpriceapi\n\nmetalpriceapi is the official Python wrapper for MetalpriceAPI.com. This allows you to quickly integrate our metal price API and foreign exchange rate API into your application. Check https://metalpriceapi.com documentation for more information.\n\n## Installation\n\nInstall the latest release with:\n\n\n pip install metalpriceapi\n\n## Usage\n\n```python\nfrom metalpriceapi.client import Client\n\napi_key = 'SET_YOUR_API_KEY_HERE'\nclient = Client(api_key)\n```\n---\n## Documentation\n\n#### fetchSymbols()\n```python\nclient.fetchSymbols()\n```\n\n[Link](https://metalpriceapi.com/documentation#api_symbol)\n\n---\n#### fetchLive(base, currencies)\n\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.\n\n```python\nclient.fetchLive(base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])\n```\n\n[Link](https://metalpriceapi.com/documentation#api_realtime)\n\n---\n#### fetchHistorical(date, base, currencies)\n\n- `date` <[string]> Required. Pass in a string with format `YYYY-MM-DD`\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.\n\n```python\nclient.fetchHistorical(date='2024-02-05', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])\n```\n\n[Link](https://metalpriceapi.com/documentation#api_historical)\n\n---\n#### fetchOHLC(base, currency, date, unit, dateType)\n\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `currency` <[string]> Required. Specify currency you would like to get OHLC for.\n- `date` <[string]> Required. Specify date to get OHLC for specific date using format `YYYY-MM-DD`.\n- `unit` <[string]> Optional. Pass in a unit, defaults to troy_oz.\n- `date_type` <[string]> Optional. Pass in a date type, overrides date parameter if passed in.\n\n```python\nclient.fetchOHLC(base='USD', currency='XAU', date='2024-02-05', unit='troy_oz', date_type=None)\n```\n\n[Link](https://metalpriceapi.com/documentation#api_ohlc)\n\n---\n#### convert(from_currency, to_currency, amount, date)\n\n- `from_currency` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `to_currency` <[string]> Required. Specify currency you would like to convert to.\n- `amount` <[number]> Required. The amount to convert.\n- `date` <[string]> Optional. Specify date to use historical midpoint value for conversion with format `YYYY-MM-DD`. Otherwise, it will use live exchange rate date if value not passed in.\n\n```python\nclient.convert(from_currency='USD', to_currency='EUR', amount=100, date='2024-02-05')\n```\n\n[Link](https://metalpriceapi.com/documentation#api_convert)\n\n---\n#### timeframe(start_date, end_date, base, currencies)\n\n- `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.\n- `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.\n\n```python\nclient.timeframe(start_date='2024-02-05', end_date='2024-02-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])\n```\n\n[Link](https://metalpriceapi.com/documentation#api_timeframe)\n\n---\n#### change(start_date, end_date, base, currencies)\n\n- `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.\n- `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `currencies` <[List]<[string]>> Optional. Pass in an list of currencies to return values for.\n\n```python\nclient.change(start_date='2024-02-05', end_date='2024-02-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])\n```\n\n[Link](https://metalpriceapi.com/documentation#api_change)\n\n---\n#### carat(base, date)\n\n- `base` <[string]> Optional. Pass in a base currency, defaults to USD.\n- `date` <[string]> Optional. Specify date to get Carat for specific date using format `YYYY-MM-DD`. If not specified, uses live rates.\n\n```python\nclient.carat(base='USD', date='2024-02-05')\n```\n\n[Link](https://metalpriceapi.com/documentation#api_carat)\n\n---\n#### usage()\n\n```python\nclient.usage()\n```\n\n[Link](https://metalpriceapi.com/documentation#api_usage)\n\n---\n**[Official documentation](https://metalpriceapi.com/documentation)**\n\n---\n## FAQ\n\n- How do I get an API Key?\n\n Free API Keys are available [here](https://metalpriceapi.com).\n\n- I want more information\n\n Checkout our FAQs [here](https://metalpriceapi.com/faq).\n\n\n## Support\n\nFor support, get in touch using [this form](https://metalpriceapi.com/contact).\n\n\n[List]: https://www.w3schools.com/python/python_datatypes.asp 'List'\n[number]: https://www.w3schools.com/python/python_datatypes.asp 'Number'\n[string]: https://www.w3schools.com/python/python_datatypes.asp 'String'\n",
"bugtrack_url": null,
"license": null,
"summary": "Official Python wrapper for metalpriceapi.com",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/metalpriceapi/metalpriceapi-python"
},
"split_keywords": [
"currency",
" metal price",
" exchangerate",
" rates"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dbd39b2f7e35d3e1c4eda839ed658f354ae203ba67fd63162081d0db09875393",
"md5": "4933931ca4cf47af4616220ef2ac9c09",
"sha256": "d78af00ce5f78d768cc7948d05628a1e3f1d66e8212e00ef0fe069eea79c3748"
},
"downloads": -1,
"filename": "metalpriceapi-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4933931ca4cf47af4616220ef2ac9c09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3262,
"upload_time": "2025-02-03T23:26:28",
"upload_time_iso_8601": "2025-02-03T23:26:28.272064Z",
"url": "https://files.pythonhosted.org/packages/db/d3/9b2f7e35d3e1c4eda839ed658f354ae203ba67fd63162081d0db09875393/metalpriceapi-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "74c392c563f13dba4d3dc6fb92f80e22d9c1e6a905c853663cd475146dc7e6af",
"md5": "44105c9a990744d53138cbc5ee29b702",
"sha256": "ae14d4399349e336f1c70dcc654efb862fd7c83add961bc5cac36f624827a5e6"
},
"downloads": -1,
"filename": "metalpriceapi-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "44105c9a990744d53138cbc5ee29b702",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3052,
"upload_time": "2025-02-03T23:26:30",
"upload_time_iso_8601": "2025-02-03T23:26:30.429742Z",
"url": "https://files.pythonhosted.org/packages/74/c3/92c563f13dba4d3dc6fb92f80e22d9c1e6a905c853663cd475146dc7e6af/metalpriceapi-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-03 23:26:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "metalpriceapi",
"github_project": "metalpriceapi-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.31.0"
]
]
}
],
"lcname": "metalpriceapi"
}
JSON
