{ "info": { "author": "Ahmed Belal", "author_email": "contact@gatecoin.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# Gatecoin Python REST API client\n\nThis is a simple Gatecoin python REST API client library that abstracts away the REST for the end user.\n\n## Installation\n\nThe library can be collected from PyPI like so:\n\n`$ pip install gatecoin_api`\n\n## Usage\n\nThe package exposes the `GatecoinAPI` client class which has methods from the Gatecoin REST API. Public methods may be directly used, for trading methods API credentials need to be set:\n\n```python\napi = GatecoinAPI('private_key', 'public_key')\n```\n\nor\n\n```python\napi = GatecoinAPI()\napi.set_credentials('private_key', 'public_key')\n```\n\n\nAfter that trading APIs may be used. Example usage of the Public API:\n\n```python\napi = GatecoinAPI()\nres = api.get_currency_pairs()\nprint(res.response_status.message) # 'OK'\nprint(res.currency_pairs[0].trading_code) # 'BTCEUR'\nprint(res.currency_pairs[0].base_currency) # 'BTC'\nprint(res.currency_pairs[0].price_decimal_places) # 1\n```\n\n## Implemented methods\n- Trading\n - set_credentials\n - get_balances\n - get_balance\n - get_open_orders\n - get_open_order\n - create_order\n - cancel_order\n - cancel_all_orders\n - get_trade_history\n- Public\n - get_currency_pairs\n - get_market_depth\n - get_order_book\n - get_recent_transactions\n\n## Development\n\nTo develop or test using this package without installing from PyPI, you can clone the repository and set up the environment in a virtual envirnonment at the root of the working copy:\n\n`$ virtualenv venv --python=python3`\n\nActivate the virtual environment:\n\n`$ source venv/bin/activate`\n\nInstall development dependencies:\n\n`$ pip install -r requirements.txt`\n\nRun the interactive python shell and you can use the package as the example given below:\n\n```python\n$ python\n>>> from gatecoin_api import GatecoinAPI as GA\n>>> api = GA()\n>>> res = api.get_currency_pairs()\n>>> res.response_status.message\n'OK'\n>>> res.currency_pairs[0].trading_code\n'BTCEUR'\n>>> res.currency_pairs[0].base_currency\n'BTC'\n>>> res.currency_pairs[0].quote_currency\n'EUR'\n>>> res.currency_pairs[0].display_name\n'BTC / EUR'\n>>> res.currency_pairs[0].name\n'BTC / EUR'\n>>> res.currency_pairs[0].price_decimal_places\n1\n```\n\n## Tests\n\nTo setup correctly for tests, set valid development API keys and API base URL in your shell environment:\n\n```sh\nexport GTC_TESTS_PRIVATE_KEY=\nexport GTC_TESTS_PUBLIC_KEY=\nexport GTC_API_BASE_URL=\n```\n\nFor Windows command line, please use the `set` command:\n\n```bat\nset GTC_TESTS_PRIVATE_KEY=\nset GTC_TESTS_PUBLIC_KEY=\nset GTC_API_BASE_URL=\n```\n\n To run tests please execute:\n\n`$ python setup.py test`\n\nIf development keys are not set, trading scope tests will fail.\n\n", "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/gatecoin/api-gatecoin-python", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "gatecoin-api", "package_url": "https://pypi.org/project/gatecoin-api/", "platform": "", "project_url": "https://pypi.org/project/gatecoin-api/", "project_urls": { "Homepage": "https://github.com/gatecoin/api-gatecoin-python" }, "release_url": "https://pypi.org/project/gatecoin-api/1.0.0/", "requires_dist": [ "requests", "marshmallow", "pytz" ], "requires_python": "", "summary": "A simple GateCoin REST API client", "version": "1.0.0" }, "last_serial": 4489388, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "fb7e622a08edad37cdac1ffd4b8766e9", "sha256": "dc7d27f9dca7bba79e64f60f35af3c08b777c161388c5dd61ad284ff6c2a760f" }, "downloads": -1, "filename": "gatecoin_api-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "fb7e622a08edad37cdac1ffd4b8766e9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9163, "upload_time": "2018-09-27T10:59:44", "url": "https://files.pythonhosted.org/packages/e9/72/2071bb1cf4c3e439fb6ecfb43877dfb699ae6559454b76b35b22693294e7/gatecoin_api-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "509c218c4b064c3952d1191c69032fd2", "sha256": "20e3a1e706dac84d44f4a42d16d265c2a9d70714300ab748ba89c048ddf33b9f" }, "downloads": -1, "filename": "gatecoin_api-0.0.1.tar.gz", "has_sig": false, "md5_digest": "509c218c4b064c3952d1191c69032fd2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8843, "upload_time": "2018-09-27T10:59:45", "url": "https://files.pythonhosted.org/packages/df/ce/a56e554c02ed34cc8be3b31c20fba42f9f5af5a3f5f30ac56d2bc3d85a20/gatecoin_api-0.0.1.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "abe7f2711ef4d4dd134459539885b053", "sha256": "627877a695f1833a02bd4dd35c65514c651330e6edbf4e940055207945adb9ca" }, "downloads": -1, "filename": "gatecoin_api-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "abe7f2711ef4d4dd134459539885b053", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9150, "upload_time": "2018-11-15T11:51:54", "url": "https://files.pythonhosted.org/packages/26/69/ee638fc77137d44c765a70286ffa4c1725667337b4f9c1b4f6f45e9d5a04/gatecoin_api-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36f5fd229814c5a892ac7ee40d5dd642", "sha256": "2427ab88267920f5f4c98ae45175fc728bd6f8d39c469f2cccaa12b8a56de27c" }, "downloads": -1, "filename": "gatecoin_api-1.0.0.tar.gz", "has_sig": false, "md5_digest": "36f5fd229814c5a892ac7ee40d5dd642", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8812, "upload_time": "2018-11-15T11:51:56", "url": "https://files.pythonhosted.org/packages/16/31/3c82d1f021c825aa6e1186a09eeaaa202f505615930719696d2567bf6f00/gatecoin_api-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "abe7f2711ef4d4dd134459539885b053", "sha256": "627877a695f1833a02bd4dd35c65514c651330e6edbf4e940055207945adb9ca" }, "downloads": -1, "filename": "gatecoin_api-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "abe7f2711ef4d4dd134459539885b053", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9150, "upload_time": "2018-11-15T11:51:54", "url": "https://files.pythonhosted.org/packages/26/69/ee638fc77137d44c765a70286ffa4c1725667337b4f9c1b4f6f45e9d5a04/gatecoin_api-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36f5fd229814c5a892ac7ee40d5dd642", "sha256": "2427ab88267920f5f4c98ae45175fc728bd6f8d39c469f2cccaa12b8a56de27c" }, "downloads": -1, "filename": "gatecoin_api-1.0.0.tar.gz", "has_sig": false, "md5_digest": "36f5fd229814c5a892ac7ee40d5dd642", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8812, "upload_time": "2018-11-15T11:51:56", "url": "https://files.pythonhosted.org/packages/16/31/3c82d1f021c825aa6e1186a09eeaaa202f505615930719696d2567bf6f00/gatecoin_api-1.0.0.tar.gz" } ] }