{
    "info": {
        "author": "Shane Fontaine",
        "author_email": "shane6fontaine@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "Intended Audience :: Financial and Insurance Industry",
            "Intended Audience :: Information Technology",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "# ethfinex-python\n\n[![Build Status](https://travis-ci.org/shanefontaine/ethfinex-python.svg?branch=master)](https://travis-ci.org/shanefontaine/ethfinex-python)\n[![Downloads](https://pepy.tech/badge/ethfinex-python)](https://pepy.tech/project/ethfinex-python)\n[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/shanefontaine/ethfinex-python/master/LICENSE)\n\nThe unofficial Python client for the [Ethfinex](https://www.ethfinex.com/api_docs) and [Ethfinex Trustless](https://ethfinex.docs.apiary.io/#) APIs.\n\n##### Provided under MIT License by Shane Fontaine.\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n_I am in no way affiliated with or funded by Ethfinex, Ethfinex Trustless, Ethfinex Inc., Bitfinex, iFinex Inc., Tether, Tether Limited, or any subsidiaries or affiliates of any of the previously mentioned entities._\n\n## Functionality\n- A simple to use Python wrapper for both public and authenticated endpoints.\n- [Easy trading directly against Ethfinex Trustless, Bitfinex and Ethfinex orderbooks](https://blog.ethfinex.com/introducing-ethfinex-trustless-2f7390955fe0/)\n- Simple parsing of data returned from the Ethfinex API\n\n## Under Development\n- Better error handling\n- Tests\n\n## Getting Started\nThis README is documentation on the syntax of the python client presented in this repository. See function docstrings for full syntax details.\nThis API attempts to present a clean interface to Ethfinex, but in order to use it to its full potential, you must familiarize yourself with the official Ethfinex documentation.\n\n- https://www.ethfinex.com/api_docs\n\nYou may manually install the project or use pip:\n\n```python\npip install ethfinex-python\n\n# or\n\npip install git+git://github.com/shanefontaine/ethfinex-python.git\n```\n\n### Public Client\nOnly some endpoints in the API are available to everyone. The public endpoints can be reached using PublicClient\n\n```python\nimport ethfinex\npublic_client = ethfinex.PublicClient()\n```\n\n### PublicClient Methods\n- [get_platform_status](https://docs.bitfinex.com/v2/reference#rest-public-platform-status)\n```python\npublic_client.get_platform_status()\n```\n\n- [get_ticker](https://docs.bitfinex.com/v2/reference#rest-public-ticker)\n```python\n# Get the ticker for a specific pair.\npublic_client.get_ticker('tBTCUSD')\n```\n\n- [get_trades](https://docs.bitfinex.com/v2/reference#rest-public-trades)\n```python\n# Get the trades for a specific pair\npublic_client.get_trades('tBTCUSD')\n# To include a start and end time\npublic_client.get_trades('tBTCUSD', start=1514764800000, end=1514765700000)\n# To reverse the order that data is delivered (old to new)\npublic_client.get_trades('tBTCUSD', start=1514764800000, end=1514765700000, sort=1)\n```\n\n- [get_books](https://docs.bitfinex.com/v2/reference#rest-public-books)\n```python\n# Get the books for a specific pair\npublic_client.get_books('tBTCUSD')\n# To get more or less granular precision\npublic_client.get_books('tBTCUSD', precision='P1')\n```\n\n- [get_stats](https://docs.bitfinex.com/v2/reference#rest-public-stats)\n```python\n# Get the stats for a specific pair\npublic_client.get_stats('tBTCUSD', 'funding.size', 'long', 'hist')\n# To reverse the order that data is delivered (old to new)\npublic_client.get_stats('tBTCUSD', 'funding.size', 'long', 'hist', sort=1)\n```\n\n- [get_candles](https://docs.bitfinex.com/v2/reference#rest-public-candles)\n```python\n# Get the candles for a specific pair\npublic_client.get_candles('tBTCUSD', '1m', 'hist')\n# To include a start and end time\npublic_client.get_candles('tBTCUSD', '1m', 'hist', start=1514764800000, end=1514765700000)\n```\n\n## Testing\nUnit tests are under development using the pytest framework. Contributions are welcome!\n\nTo run the full test suite, in the project directory run:\n\n```\npython -m pytest\n```\n\n## Changelog\n\n_0.1.2_\n- Major README update\n\n_0.1.1_\n- Add CI\n- Add `public_client` tests\n\n_0.1.0_\n- Fully functional public client.\n\n_0.0.1_\n- Original PyPI release.",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/shanefontaine/ethfinex",
        "keywords": "ethfinex,ethfinex-api,orderbook,trade,bitcoin,ethereum,BTC,ETH,client,api,wrapper,exchange,crypto,currency,trading,trading-api,ethfinex-trustless,bitfinex",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ethfinex-python",
        "package_url": "https://pypi.org/project/ethfinex-python/",
        "platform": "",
        "project_url": "https://pypi.org/project/ethfinex-python/",
        "project_urls": {
            "Homepage": "https://github.com/shanefontaine/ethfinex"
        },
        "release_url": "https://pypi.org/project/ethfinex-python/0.1.2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "An unofficial python wrapper for the Ethfinex exchange",
        "version": "0.1.2"
    },
    "last_serial": 4643413,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f31f715638182232fa60a6fe52cf64d9",
                    "sha256": "5943b0de842a794bc8801ad2bc871e5096da7b63f4a3333bce3ab545349c09d8"
                },
                "downloads": -1,
                "filename": "ethfinex_python-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f31f715638182232fa60a6fe52cf64d9",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 3092,
                "upload_time": "2018-12-25T09:55:13",
                "url": "https://files.pythonhosted.org/packages/34/1c/d05f8df55acf6d622abf7c13ba27b53c1baf8089b1463e98e5a9d26fd46d/ethfinex_python-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b7b0e2074df45617720f56021db58d4b",
                    "sha256": "73922e1d792f78f55cdde963db8ebca7e0c4733c0a4d85576707ca963fe32fe6"
                },
                "downloads": -1,
                "filename": "ethfinex-python-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b7b0e2074df45617720f56021db58d4b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 1849,
                "upload_time": "2018-12-25T09:55:15",
                "url": "https://files.pythonhosted.org/packages/31/3d/31929f0ad364f341a05283c9db453a4a73e7f4b12309dc10da67b32b70d9/ethfinex-python-0.0.1.tar.gz"
            }
        ],
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cca4d064123617c02cbf2e1850eed296",
                    "sha256": "07fe580ea75f3333cb0158d7fde7a6be737b4f8ca8d6a8109bcf0dd6a22c1905"
                },
                "downloads": -1,
                "filename": "ethfinex-python-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "cca4d064123617c02cbf2e1850eed296",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4071,
                "upload_time": "2018-12-28T08:39:00",
                "url": "https://files.pythonhosted.org/packages/e4/c0/89a4d9c9978a3a33683da0f0b4450e22ee98e94a80cb65bf8f3c0ff98f3a/ethfinex-python-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "40a5f1f202e551c861db8cb8fe9fd051",
                    "sha256": "e0fc489c54bcfe4753f1a3e8c488f04825f6157dfcb4486f0f43ad2d488c0056"
                },
                "downloads": -1,
                "filename": "ethfinex-python-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "40a5f1f202e551c861db8cb8fe9fd051",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4693,
                "upload_time": "2018-12-29T06:40:18",
                "url": "https://files.pythonhosted.org/packages/70/1b/70c1f31c09bc9d04bf1dd9ebe9e7742047c01d1d3952171edbc11ae10985/ethfinex-python-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "24926bfe37ab46d3c4a6ce53a7dd634a",
                    "sha256": "41a3097bbdaad74b04061b53b01dd7bbe2b05201df1eb69440dbb2a22e184b20"
                },
                "downloads": -1,
                "filename": "ethfinex-python-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "24926bfe37ab46d3c4a6ce53a7dd634a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5641,
                "upload_time": "2018-12-29T07:05:20",
                "url": "https://files.pythonhosted.org/packages/ef/19/8186d960315dfc24c48ac9a20ed91de4f1acc8c8c6a19ad9cdbed6a87cd7/ethfinex-python-0.1.2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "24926bfe37ab46d3c4a6ce53a7dd634a",
                "sha256": "41a3097bbdaad74b04061b53b01dd7bbe2b05201df1eb69440dbb2a22e184b20"
            },
            "downloads": -1,
            "filename": "ethfinex-python-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "24926bfe37ab46d3c4a6ce53a7dd634a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5641,
            "upload_time": "2018-12-29T07:05:20",
            "url": "https://files.pythonhosted.org/packages/ef/19/8186d960315dfc24c48ac9a20ed91de4f1acc8c8c6a19ad9cdbed6a87cd7/ethfinex-python-0.1.2.tar.gz"
        }
    ]
}