currensees


Namecurrensees JSON
Version 1.1.1 PyPI version JSON
download
home_pagehttps://moatsystems.com/currency-api/
SummaryPython library for integrating with the Currency API.
upload_time2023-05-03 03:48:50
maintainer
docs_urlNone
authorMoat Systems Limited
requires_python>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
licenseBSD 3-Clause
keywords currency currency api currensees currensees sdk rate rates exchange rates moat moatsystems moat systems
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            currensees
==========

.. image:: https://badge.fury.io/py/currensees.svg
    :target: https://badge.fury.io/py/currensees
    :alt: Currency API Python Package Version

Python library for integrating with `Currency API`_ functionality.

.. _Currency API: https://moatsystems.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 currensees

Or:

.. code-block:: bash

	$ easy_install currensees


Usage Example
-------------

.. code-block:: python

    from currensees.auth import Auth
    from currensees.currencies import Currencies
    from currensees.historical import Historical
    from currensees.convert import Convert
    from currensees.convert_all import ConvertAll
    from currensees.daily_average import DailyAverage
    from currensees.weekly_average import WeeklyAverage
    from currensees.monthly_average import MonthlyAverage
    from currensees.margins_spreads import MarginsSpreads
    from currensees.performances import Performances
    from currensees.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://moatsystems.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.currensees.com/
.. _contact us: https://moatsystems.com/contact/

License
--------

This project is licensed under the `BSD 3-Clause License`_.  

.. _BSD 3-Clause License: https://moatsystems.com/assets/license/BSD_3_Clause.txt


Copyright
----------

Copyright |copy| 2020 - 2023 `Moat Systems Limited`_. All Rights Reserved.

.. |copy| unicode:: 0xA9 .. copyright sign
.. _Moat Systems Limited: https://moatsystems.com/



            

Raw data

            {
    "_id": null,
    "home_page": "https://moatsystems.com/currency-api/",
    "name": "currensees",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
    "maintainer_email": "",
    "keywords": "currency,currency api,currensees,currensees sdk,rate,rates,exchange rates,moat,moatsystems,moat systems",
    "author": "Moat Systems Limited",
    "author_email": "support@moatsystems.com",
    "download_url": "https://files.pythonhosted.org/packages/5a/b3/937dcd87918aeb990f6e448a757a3f7cc6ad845bf19932c6ffc804440051/currensees-1.1.1.tar.gz",
    "platform": null,
    "description": "currensees\n==========\n\n.. image:: https://badge.fury.io/py/currensees.svg\n    :target: https://badge.fury.io/py/currensees\n    :alt: Currency API Python Package Version\n\nPython library for integrating with `Currency API`_ functionality.\n\n.. _Currency API: https://moatsystems.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 currensees\n\nOr:\n\n.. code-block:: bash\n\n\t$ easy_install currensees\n\n\nUsage Example\n-------------\n\n.. code-block:: python\n\n    from currensees.auth import Auth\n    from currensees.currencies import Currencies\n    from currensees.historical import Historical\n    from currensees.convert import Convert\n    from currensees.convert_all import ConvertAll\n    from currensees.daily_average import DailyAverage\n    from currensees.weekly_average import WeeklyAverage\n    from currensees.monthly_average import MonthlyAverage\n    from currensees.margins_spreads import MarginsSpreads\n    from currensees.performances import Performances\n    from currensees.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://moatsystems.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.currensees.com/\n.. _contact us: https://moatsystems.com/contact/\n\nLicense\n--------\n\nThis project is licensed under the `BSD 3-Clause License`_.  \n\n.. _BSD 3-Clause License: https://moatsystems.com/assets/license/BSD_3_Clause.txt\n\n\nCopyright\n----------\n\nCopyright |copy| 2020 - 2023 `Moat Systems Limited`_. All Rights Reserved.\n\n.. |copy| unicode:: 0xA9 .. copyright sign\n.. _Moat Systems Limited: https://moatsystems.com/\n\n\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause",
    "summary": "Python library for integrating with the Currency API.",
    "version": "1.1.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/moatsystems/currensees_sdk/issues",
        "Changes": "https://github.com/moatsystems/currensees_sdk/blob/main/CHANGELOG.md",
        "Documentation": "https://docs.currensees.com/",
        "Homepage": "https://moatsystems.com/currency-api/",
        "Source Code": "https://github.com/moatsystems/currensees_sdk"
    },
    "split_keywords": [
        "currency",
        "currency api",
        "currensees",
        "currensees sdk",
        "rate",
        "rates",
        "exchange rates",
        "moat",
        "moatsystems",
        "moat systems"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df3df722d1d678fbc1b1ed64f3abd25e6d6baffbca97728065e936ac517e6f59",
                "md5": "1a738ce7289f84d7d1ace44edda71747",
                "sha256": "da30c3df915284217abf99d9d76017eb6ea7926530e72a1454ddc8dfc06c59d1"
            },
            "downloads": -1,
            "filename": "currensees-1.1.1-py3.9.egg",
            "has_sig": false,
            "md5_digest": "1a738ce7289f84d7d1ace44edda71747",
            "packagetype": "bdist_egg",
            "python_version": "1.1.1",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 17550,
            "upload_time": "2023-05-03T03:48:49",
            "upload_time_iso_8601": "2023-05-03T03:48:49.535624Z",
            "url": "https://files.pythonhosted.org/packages/df/3d/f722d1d678fbc1b1ed64f3abd25e6d6baffbca97728065e936ac517e6f59/currensees-1.1.1-py3.9.egg",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47e83f26544a3e4c49f58d653c3ff51fd0953d64ab5b19cb3cd54a1e3be3faaf",
                "md5": "d3a59bffb47848a107bbb5455589ae98",
                "sha256": "5e8a6bc0c073aafe223558d19724c1994663cd2d8bb159ca56d3734c3785a2a7"
            },
            "downloads": -1,
            "filename": "currensees-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d3a59bffb47848a107bbb5455589ae98",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 9394,
            "upload_time": "2023-05-03T03:48:47",
            "upload_time_iso_8601": "2023-05-03T03:48:47.280250Z",
            "url": "https://files.pythonhosted.org/packages/47/e8/3f26544a3e4c49f58d653c3ff51fd0953d64ab5b19cb3cd54a1e3be3faaf/currensees-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5ab3937dcd87918aeb990f6e448a757a3f7cc6ad845bf19932c6ffc804440051",
                "md5": "b5950b4c2348bbdcaa42f5b9d163b49f",
                "sha256": "044c4187e7d97ed4e22462f47bc79e459409e4e6fc0af5f9a92b17e05341de95"
            },
            "downloads": -1,
            "filename": "currensees-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b5950b4c2348bbdcaa42f5b9d163b49f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 6974,
            "upload_time": "2023-05-03T03:48:50",
            "upload_time_iso_8601": "2023-05-03T03:48:50.843871Z",
            "url": "https://files.pythonhosted.org/packages/5a/b3/937dcd87918aeb990f6e448a757a3f7cc6ad845bf19932c6ffc804440051/currensees-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-03 03:48:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "moatsystems",
    "github_project": "currensees_sdk",
    "github_not_found": true,
    "lcname": "currensees"
}
        
Elapsed time: 0.07881s