# freecurrencyapi Python Client #
Freecurrencyapi Python Client is the official Python Wrapper around the freecurrencyapi [API](https://freecurrencyapi.com/).
## Installation
Install from pip:
````sh
pip install freecurrencyapi
````
Install from code:
````sh
pip install git+https://github.com/everapihq/freecurrencyapi-python.git
````
## Usage
All freecurrencyapi API requests are made using the `Client` class. This class must be initialized with your API access key string. [Where is my API access key?](https://app.freecurrencyapi.com/dashboard)
In your Python application, import `freecurrencyapi` and pass authentication information to initialize it:
````python
import freecurrencyapi
client = freecurrencyapi.Client('API_KEY')
````
### Retrieve Status
```python
print(client.status())
```
### Retrieve Currencies
[https://freecurrencyapi.com/docs/currencies](https://freecurrencyapi.com/docs/currencies)
```python
result = client.currencies(currencies=['EUR', 'CAD'])
print(result)
```
### Retrieve Latest Exchange Rates
[https://freecurrencyapi.com/docs/latest](https://freecurrencyapi.com/docs/latest)
```python
result = client.latest()
print(result)
```
### Retrieve Historical Exchange Rates
[https://freecurrencyapi.com/docs/historical](https://freecurrencyapi.com/docs/historical)
```python
result = client.historical('2022-02-02')
print(result)
```
### Contact us
Any feedback? Please feel free to [contact our team](mailto:office@everapi.com).
Raw data
{
"_id": null,
"home_page": "https://github.com/everapihq/freecurrencyapi-python",
"name": "freecurrencyapi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "free currency api,exchange rates,rates api,freecurrencyapi,currency api",
"author": "Everapi",
"author_email": "office@everapi.com",
"download_url": "https://files.pythonhosted.org/packages/8b/f6/a1a9fd0f728c603c7813f96b245fb699e83f0183b4bbcb61955c5be3c354/freecurrencyapi-0.1.0.tar.gz",
"platform": null,
"description": "# freecurrencyapi Python Client #\n\nFreecurrencyapi Python Client is the official Python Wrapper around the freecurrencyapi [API](https://freecurrencyapi.com/).\n\n## Installation\n\nInstall from pip:\n````sh\npip install freecurrencyapi\n````\n\nInstall from code:\n````sh\npip install git+https://github.com/everapihq/freecurrencyapi-python.git\n````\n\n## Usage\n\nAll freecurrencyapi API requests are made using the `Client` class. This class must be initialized with your API access key string. [Where is my API access key?](https://app.freecurrencyapi.com/dashboard)\n\nIn your Python application, import `freecurrencyapi` and pass authentication information to initialize it:\n\n````python\nimport freecurrencyapi\nclient = freecurrencyapi.Client('API_KEY')\n````\n\n### Retrieve Status\n\n```python\n\nprint(client.status())\n\n```\n\n### Retrieve Currencies\n[https://freecurrencyapi.com/docs/currencies](https://freecurrencyapi.com/docs/currencies)\n```python\n\nresult = client.currencies(currencies=['EUR', 'CAD'])\nprint(result)\n\n```\n\n### Retrieve Latest Exchange Rates\n[https://freecurrencyapi.com/docs/latest](https://freecurrencyapi.com/docs/latest)\n\n```python\n\nresult = client.latest()\nprint(result)\n\n```\n\n### Retrieve Historical Exchange Rates\n[https://freecurrencyapi.com/docs/historical](https://freecurrencyapi.com/docs/historical)\n\n```python\n\nresult = client.historical('2022-02-02')\nprint(result)\n\n```\n\n### Contact us\nAny feedback? Please feel free to [contact our team](mailto:office@everapi.com).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Freecurrencyapi Python Client",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/everapihq/freecurrencyapi-python"
},
"split_keywords": [
"free currency api",
"exchange rates",
"rates api",
"freecurrencyapi",
"currency api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8bf6a1a9fd0f728c603c7813f96b245fb699e83f0183b4bbcb61955c5be3c354",
"md5": "fbe5cbaed8274101a0011207ad2391b9",
"sha256": "cd28291cf6ea51cf2c3a84d71af46b64fb6a8fbee26d19a34177a67e8f6ccbe4"
},
"downloads": -1,
"filename": "freecurrencyapi-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "fbe5cbaed8274101a0011207ad2391b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2481,
"upload_time": "2023-05-31T07:18:35",
"upload_time_iso_8601": "2023-05-31T07:18:35.311624Z",
"url": "https://files.pythonhosted.org/packages/8b/f6/a1a9fd0f728c603c7813f96b245fb699e83f0183b4bbcb61955c5be3c354/freecurrencyapi-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 07:18:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "everapihq",
"github_project": "freecurrencyapi-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "freecurrencyapi"
}