# ForexRateAPI
forexrateapi is the official Python API wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.
## Installation
Install the latest release with:
pip install forexrateapi
## Usage
```python
from forexrateapi.client import Client
api_key = 'SET_YOUR_API_KEY_HERE'
client = Client(api_key)
```
---
## Documentation
#### fetchSymbols()
```python
client.fetchSymbols()
```
[Link](https://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])
```
[Link](https://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])
```
[Link](https://forexrateapi.com/documentation#api_historical)
---
#### 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://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])
```
[Link](https://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])
```
[Link](https://forexrateapi.com/documentation#api_change)
---
**[Official documentation](https://forexrateapi.com/documentation)**
---
## FAQ
- How do I get an API Key?
Free API Keys are available [here](https://forexrateapi.com).
- I want more information
Checkout our FAQs [here](https://forexrateapi.com/faq).
## Support
For support, get in touch using [this form](https://forexrateapi.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/forexrateapi/forexrateapi-python",
"name": "forexrateapi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "currency,foreign exchange rate,currency conversion,exchangerate,rates",
"author": "ForexRateAPI",
"author_email": "contact@forexrateapi.com",
"download_url": "https://files.pythonhosted.org/packages/d5/0c/c5206f63caea54c30c2b8df147675c9775ec7ea3e5e1cda68a60fe82a273/forexrateapi-1.0.4.tar.gz",
"platform": null,
"description": "# ForexRateAPI\n\nforexrateapi is the official Python API wrapper for ForexRateAPI.com. This allows you to quickly integrate our foreign exchange rate API and currency conversion API into your application. Check https://forexrateapi.com documentation for more information.\n\n## Installation\n\nInstall the latest release with:\n\n\n pip install forexrateapi\n\n## Usage\n\n```python\nfrom forexrateapi.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://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])\n```\n\n[Link](https://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])\n```\n\n[Link](https://forexrateapi.com/documentation#api_historical)\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://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])\n```\n\n[Link](https://forexrateapi.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=['AUD', 'CAD', 'GBP', 'JPY'])\n```\n\n[Link](https://forexrateapi.com/documentation#api_change)\n\n---\n**[Official documentation](https://forexrateapi.com/documentation)**\n\n\n---\n## FAQ\n\n- How do I get an API Key?\n\n Free API Keys are available [here](https://forexrateapi.com).\n\n- I want more information\n\n Checkout our FAQs [here](https://forexrateapi.com/faq).\n\n\n## Support\n\nFor support, get in touch using [this form](https://forexrateapi.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": "",
"summary": "Official Python wrapper for forexrateapi.com",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/forexrateapi/forexrateapi-python"
},
"split_keywords": [
"currency",
"foreign exchange rate",
"currency conversion",
"exchangerate",
"rates"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce7729f5c9da3e199a85de42aa576af072850d779c234286cdc65e70d826eae3",
"md5": "85bc1cc0ac457c070486e694245687a9",
"sha256": "3c334112d34a067dc92903d96b7a0f8eec5d9a274e1160c77b2051384179ac38"
},
"downloads": -1,
"filename": "forexrateapi-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85bc1cc0ac457c070486e694245687a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3768,
"upload_time": "2024-02-22T02:46:25",
"upload_time_iso_8601": "2024-02-22T02:46:25.857692Z",
"url": "https://files.pythonhosted.org/packages/ce/77/29f5c9da3e199a85de42aa576af072850d779c234286cdc65e70d826eae3/forexrateapi-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d50cc5206f63caea54c30c2b8df147675c9775ec7ea3e5e1cda68a60fe82a273",
"md5": "c00491442edd27776cfff661083874b1",
"sha256": "8046271a46266362206389219bbe7a3679020267a94a683122c89b6c458636e5"
},
"downloads": -1,
"filename": "forexrateapi-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "c00491442edd27776cfff661083874b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3425,
"upload_time": "2024-02-22T02:46:28",
"upload_time_iso_8601": "2024-02-22T02:46:28.812609Z",
"url": "https://files.pythonhosted.org/packages/d5/0c/c5206f63caea54c30c2b8df147675c9775ec7ea3e5e1cda68a60fe82a273/forexrateapi-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 02:46:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "forexrateapi",
"github_project": "forexrateapi-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "forexrateapi"
}
JSON
