fxdatapi
==========
.. image:: https://badge.fury.io/py/fxdatapi.svg
:target: https://badge.fury.io/py/fxdatapi
:alt: Currency API Python Package Version
Python library for integrating with `Currency API`_ functionality.
.. _Currency API: https://horisystems.com/currency-api/
Requirements
-------------
Python 2.7 and later.
Setup
------
You can install this package by using the pip tool and installing:
.. code-block:: bash
$ pip install fxdatapi
Or:
.. code-block:: bash
$ easy_install fxdatapi
Usage Example
-------------
.. code-block:: python
from fxdatapi.auth import Auth
from fxdatapi.currencies import Currencies
from fxdatapi.historical import Historical
from fxdatapi.convert import Convert
from fxdatapi.convert_all import ConvertAll
from fxdatapi.daily_average import DailyAverage
from fxdatapi.weekly_average import WeeklyAverage
from fxdatapi.monthly_average import MonthlyAverage
from fxdatapi.margins_spreads import MarginsSpreads
from fxdatapi.performances import Performances
from fxdatapi.signals import Signals
# Authenticate and log in
auth = Auth()
username = "your_username"
password = "your_password"
result = auth.login(username, password)
print("Login successful:", result)
currencies = Currencies(auth.headers)
result = currencies.get_currencies(username, "19", "04", "2023")
print("Currencies:", result)
uuid = "currency_uuid"
result = currencies.get_currency(uuid, username, "19", "04", "2023")
print("Currency:", result)
historical = Historical(auth.headers)
result = historical.get_historical(username, "2023_04_19", "19", "04", "2023")
print("Historical data:", result)
uuid = "historical_uuid"
result = historical.get_historical_currency(uuid, username, "2023_04_19", "19", "04", "2023")
print("Historical currency:", result)
convert = Convert(auth.headers)
result = convert.convert_currency(username, "2023_04_19", "GBP", "EUR", "500")
print("Converted amount:", result)
convert_all = ConvertAll(auth.headers)
result = convert_all.convert_all_currencies(username, "GBP", 120, "2023_04_19")
print("Converted amounts:", result)
daily_average = DailyAverage(auth.headers)
result = daily_average.get_daily_average("2023_04_19")
print("Daily average:", result)
weekly_average = WeeklyAverage(auth.headers)
result = weekly_average.get_weekly_average("2023_04_03", "2023_04_07")
print("Weekly average:", result)
monthly_average = MonthlyAverage(auth.headers)
result = monthly_average.get_monthly_average("2023", "04")
print("Monthly average:", result)
margins_spreads = MarginsSpreads(auth.headers)
result = margins_spreads.get_margins_spreads(username, "19", "04", "2023")
print("Margins and spreads:", result)
uuid = "margins_spreads_uuid"
result = margins_spreads.get_margins_spreads_currency(uuid, username, "19", "04", "2023")
print("Margins and spreads for currency:", result)
performances = Performances(auth.headers)
result = performances.get_performances(username)
print("Performances:", result)
uuid = "performance_uuid"
result = performances.get_performance(uuid, username)
print("Performance:", result)
signals = Signals(auth.headers)
result = signals.get_signals(username)
print("Signals:", result)
uuid = "signal_uuid"
result = signals.get_signal(uuid, username)
print("Signal:", result)
Setting up Currency API Account
-------------------------------
Subscribe here for a `user account`_.
.. _user account: https://horisystems.com/currency-api/
Using the Currency API
----------------------
You can read the `API documentation`_ to understand what's possible with the Currency API. If you need further assistance, don't hesitate to `contact us`_.
.. _API documentation: https://docs.fxdatapi.com/
.. _contact us: https://horisystems.com/contact/
License
--------
This project is licensed under the `BSD 3-Clause License`_.
.. _BSD 3-Clause License: https://horisystems.com/assets/license/BSD_3_Clause.txt
Copyright
----------
Copyright |copy| 2020 - 2023 `Hori Systems Limited`_. All Rights Reserved.
.. |copy| unicode:: 0xA9 .. copyright sign
.. _Hori Systems Limited: https://horisystems.com/
Raw data
{
"_id": null,
"home_page": "https://horisystems.com/currency-api/",
"name": "fxdatapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "currency,currency api,fxdatapi,fxdatapi sdk,rate,rates,exchange rates,hori,horisystems,hori systems",
"author": "Hori Systems Limited",
"author_email": "support@horisystems.com",
"download_url": "https://files.pythonhosted.org/packages/9b/53/07e79d4e1f7745fbfcd01994e4629945a8cb8ebf526c3c31e1141950566c/fxdatapi-1.1.4.tar.gz",
"platform": null,
"description": "fxdatapi\n==========\n\n.. image:: https://badge.fury.io/py/fxdatapi.svg\n :target: https://badge.fury.io/py/fxdatapi\n :alt: Currency API Python Package Version\n\nPython library for integrating with `Currency API`_ functionality.\n\n.. _Currency API: https://horisystems.com/currency-api/\n\n\nRequirements\n-------------\n\nPython 2.7 and later.\n\n\nSetup\n------\n\nYou can install this package by using the pip tool and installing:\n\n.. code-block:: bash\n\n\t$ pip install fxdatapi\n\nOr:\n\n.. code-block:: bash\n\n\t$ easy_install fxdatapi\n\n\nUsage Example\n-------------\n\n.. code-block:: python\n\n from fxdatapi.auth import Auth\n from fxdatapi.currencies import Currencies\n from fxdatapi.historical import Historical\n from fxdatapi.convert import Convert\n from fxdatapi.convert_all import ConvertAll\n from fxdatapi.daily_average import DailyAverage\n from fxdatapi.weekly_average import WeeklyAverage\n from fxdatapi.monthly_average import MonthlyAverage\n from fxdatapi.margins_spreads import MarginsSpreads\n from fxdatapi.performances import Performances\n from fxdatapi.signals import Signals\n\n # Authenticate and log in\n auth = Auth()\n username = \"your_username\"\n password = \"your_password\"\n\n result = auth.login(username, password)\n print(\"Login successful:\", result)\n\n currencies = Currencies(auth.headers)\n result = currencies.get_currencies(username, \"19\", \"04\", \"2023\")\n print(\"Currencies:\", result)\n\n uuid = \"currency_uuid\"\n result = currencies.get_currency(uuid, username, \"19\", \"04\", \"2023\")\n print(\"Currency:\", result)\n\n historical = Historical(auth.headers)\n result = historical.get_historical(username, \"2023_04_19\", \"19\", \"04\", \"2023\")\n print(\"Historical data:\", result)\n\n uuid = \"historical_uuid\"\n result = historical.get_historical_currency(uuid, username, \"2023_04_19\", \"19\", \"04\", \"2023\")\n print(\"Historical currency:\", result)\n\n convert = Convert(auth.headers)\n result = convert.convert_currency(username, \"2023_04_19\", \"GBP\", \"EUR\", \"500\")\n print(\"Converted amount:\", result)\n\n convert_all = ConvertAll(auth.headers)\n result = convert_all.convert_all_currencies(username, \"GBP\", 120, \"2023_04_19\")\n print(\"Converted amounts:\", result)\n\n daily_average = DailyAverage(auth.headers)\n result = daily_average.get_daily_average(\"2023_04_19\")\n print(\"Daily average:\", result)\n\n weekly_average = WeeklyAverage(auth.headers)\n result = weekly_average.get_weekly_average(\"2023_04_03\", \"2023_04_07\")\n print(\"Weekly average:\", result)\n\n monthly_average = MonthlyAverage(auth.headers)\n result = monthly_average.get_monthly_average(\"2023\", \"04\")\n print(\"Monthly average:\", result)\n\n margins_spreads = MarginsSpreads(auth.headers)\n result = margins_spreads.get_margins_spreads(username, \"19\", \"04\", \"2023\")\n print(\"Margins and spreads:\", result)\n\n uuid = \"margins_spreads_uuid\"\n result = margins_spreads.get_margins_spreads_currency(uuid, username, \"19\", \"04\", \"2023\")\n print(\"Margins and spreads for currency:\", result)\n\n performances = Performances(auth.headers)\n result = performances.get_performances(username)\n print(\"Performances:\", result)\n\n uuid = \"performance_uuid\"\n result = performances.get_performance(uuid, username)\n print(\"Performance:\", result)\n\n signals = Signals(auth.headers)\n result = signals.get_signals(username)\n print(\"Signals:\", result)\n\n uuid = \"signal_uuid\"\n result = signals.get_signal(uuid, username)\n print(\"Signal:\", result)\n\nSetting up Currency API Account\n-------------------------------\n\nSubscribe here for a `user account`_.\n\n.. _user account: https://horisystems.com/currency-api/\n\n\nUsing the Currency API\n----------------------\n\nYou can read the `API documentation`_ to understand what's possible with the Currency API. If you need further assistance, don't hesitate to `contact us`_.\n\n.. _API documentation: https://docs.fxdatapi.com/\n.. _contact us: https://horisystems.com/contact/\n\nLicense\n--------\n\nThis project is licensed under the `BSD 3-Clause License`_. \n\n.. _BSD 3-Clause License: https://horisystems.com/assets/license/BSD_3_Clause.txt\n\n\nCopyright\n----------\n\nCopyright |copy| 2020 - 2023 `Hori Systems Limited`_. All Rights Reserved.\n\n.. |copy| unicode:: 0xA9 .. copyright sign\n.. _Hori Systems Limited: https://horisystems.com/\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Python library for integrating with the Currency API.",
"version": "1.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/horisystems/fxdatapi_sdk/issues",
"Changes": "https://github.com/horisystems/fxdatapi_sdk/blob/main/CHANGELOG.md",
"Documentation": "https://docs.fxdatapi.com/",
"Homepage": "https://horisystems.com/currency-api/",
"Source Code": "https://github.com/horisystems/fxdatapi_sdk"
},
"split_keywords": [
"currency",
"currency api",
"fxdatapi",
"fxdatapi sdk",
"rate",
"rates",
"exchange rates",
"hori",
"horisystems",
"hori systems"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "67f02612d1387db7c03e81489cd7a48c8591365c8bf9d73fdebab008126917d8",
"md5": "ca2d21390d9a9dfab69fbbb3709e1e54",
"sha256": "c033b24e38c1fd66640971f1af736177401f6a482133a785ef492fc14b354962"
},
"downloads": -1,
"filename": "fxdatapi-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca2d21390d9a9dfab69fbbb3709e1e54",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 9316,
"upload_time": "2023-10-28T20:32:41",
"upload_time_iso_8601": "2023-10-28T20:32:41.402141Z",
"url": "https://files.pythonhosted.org/packages/67/f0/2612d1387db7c03e81489cd7a48c8591365c8bf9d73fdebab008126917d8/fxdatapi-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b5307e79d4e1f7745fbfcd01994e4629945a8cb8ebf526c3c31e1141950566c",
"md5": "32338d53c00832d58e550221ea8157bb",
"sha256": "50487b5fb57741fcabe05572ac6e1493e7d0a62a4ea6960a6a9e4833695cc92a"
},
"downloads": -1,
"filename": "fxdatapi-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "32338d53c00832d58e550221ea8157bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 7730,
"upload_time": "2023-10-28T20:32:42",
"upload_time_iso_8601": "2023-10-28T20:32:42.868771Z",
"url": "https://files.pythonhosted.org/packages/9b/53/07e79d4e1f7745fbfcd01994e4629945a8cb8ebf526c3c31e1141950566c/fxdatapi-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-28 20:32:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "horisystems",
"github_project": "fxdatapi_sdk",
"github_not_found": true,
"lcname": "fxdatapi"
}
JSON
