{ "info": { "author": "CodingRonin", "author_email": "CodingRonin@zumcoin.org", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU Affero General Public License v3", "Programming Language :: Python :: 3" ], "description": "

\n\n# ZUM Services Python API Interface\n\nThis wrapper allows you to easily interact with the [ZUM Services](https://zum.services) 1.0.1 API to quickly develop applications that interact with the [ZumCoin](https://zumcoin.org) Network.\n\n\n# Table of Contents\n\n1. [Installation](#installation)\n2. [Intialization](#intialization)\n3. [Documentation](#documentation)\n 1. [Methods](#methods)\n\n# Installation\n\n```bash\npip install zumservices-api-py\n```\n\n# Intialization\n\n```python\nimport os\nfrom ZUMservices import ZS\n\nos.environ[\"ZUM_SERVICES_TOKEN\"] = \"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoieW8iLCJhcHBJZCI6MjAsInVzZXJJZCI6MiwicGVybWlzc2lvbnMiOlsiYWRkcmVzczpuZXciLCJhZGRyZXNzOnZpZXciLCJhZGRyZXNzOmFsbCIsImFkZHJlc3M6c2NhbiIsImFkZHJlc3M6ZGVsZXRlIiwidHJhbnNmZXI6bmV3IiwidHJhbnNmZXI6dmlldyJdLCJpYXQiOjE1Mzk5OTQ4OTgsImV4cCI6MTU3MTU1MjQ5OCwiYXVkIjoiZ2FuZy5jb20iLCJpc3MiOiJUUlRMIFNlcnZpY2VzIiwianRpIjoiMjIifQ.KkKyg18aqZfLGMGTnUDhYQmVSUoocrr4CCdLBm2K7V87s2T-3hTtM2MChJB2UdbDLWnf58GiMa_t8xp9ZjZjIg\"\n\nos.environ[\"ZUM_SERVICES_TIMEOUT\"] = 2000\n\n```\n\nGenerate a token with the ZUM Services [Dashboard](https://zum.services) and store it as the variable ``ZUM_SERVICES_TOKEN`` in your os environment along with ``ZUM_SERVICES_TIMEOUT`` if you wish the change the default timeout of 2000.\n\n\n\n# Documentation\n\nAPI documentation is available at https://zum.services/documentation\n\n\n## Methods\n\n### createAddress()\nCreate a new ZUM addresses\n\n```python\nZS.createAddress()\n```\n\n\n### getAddress(address)\nGet address details by address\n```python\nZS.getAddress(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\")\n```\n\n\n### deleteAddress(address)\nDelete a selected ZUM address\n\n```python\nZS.deleteAdddress(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\")\n```\n\n\n### getAddresses()\nView all addresses.\n\n```python\nZS.getAddresses()\n```\n\n\n### scanAddress(address, blockIndex)\nScan an address for transactions between a 100 block range starting from the specified blockIndex.\n\n```python\nZS.scanAddress(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\", 899093)\n```\n\n\n### getAddressKeys(address)\nGet the public and secret spend key of an address.\n\n```python\nZS.getAddressKeys(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\")\n```\n\n\n### integrateAddress(address, paymentId)\nCreate an integrated address with an address and payment ID.\n\n```python\nZS.integrateAddress(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\", \"7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804\")\n```\n\n\n### getIntegratedAddresses(address)\nGet all integrated addresses by address.\n\n```python\nZS.getIntegratedAddresses(\"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\")\n```\n\n\n### getFee(amount)\nCalculate the ZUM Services fee for an amount specified in ZUM with two decimal points.\n\n```python\nZS.getFee(1.23)\n```\n\n\n### createTransfer(sender, receiver, amount, fee, paymentId, extra)\nSend a ZUM transaction with an address with the amount specified two decimal points.\n\n```python\nZS.createTransfer(\n \"Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC\",\n \"Zum1yhbRwHsXj19c1hZgFzgxVcWDywsJcDKURDud83MqMNKoDTvKEDf6k7BoHnfCiPbj4kY2arEmQTwiVmhoELPv3UKhjYjCMcm\",\n 1234.56,\n 1.23,\n \"7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804\",\n \"3938f915a11582f62d93f82f710df9203a029f929fd2f915f2701d947f920f99\"\n)\n```\n#### You can leave the last two fields (paymentId and extra) blank.\n\n\n### getTransfer(address)\nGet a transaction details specified by transaction hash.\n\n```python\nZS.getTransfer(\"EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ\")\n```\n\n\n### getWallet()\nGet wallet container info and health check.\n\n```python\nZS.getWallet()\n```\n\n\n### getStatus()\nGet the current status of the ZUM Services infrastructure.\n\n```python\nZS.getStatus()\n```\n\n\n\n# License\n\n```\nCopyright (c) 2019 ZumCoin Development Team\n\nPlease see the included LICENSE file for more information.\n```\n\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/zum-services/zumservices-api-py", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "zumservices-api-py", "package_url": "https://pypi.org/project/zumservices-api-py/", "platform": "", "project_url": "https://pypi.org/project/zumservices-api-py/", "project_urls": { "Homepage": "https://github.com/zum-services/zumservices-api-py" }, "release_url": "https://pypi.org/project/zumservices-api-py/1.0.1/", "requires_dist": null, "requires_python": "", "summary": "Python wrapper to interact with the ZUM Services API.", "version": "1.0.1" }, "last_serial": 5891955, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "6aa992f9a878d95e1d58289dcf3b94ba", "sha256": "fb8dfa9c8cb6d43375205371c8100e8ca365c5d48248dedc6341a7859c3c3f98" }, "downloads": -1, "filename": "zumservices_api_py-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6aa992f9a878d95e1d58289dcf3b94ba", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17250, "upload_time": "2019-09-26T18:04:13", "url": "https://files.pythonhosted.org/packages/2c/2b/7cbc870bf6544037ea989aee53935b08a2119fae6770a37eda627cdb8842/zumservices_api_py-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a47cb6568788a48f4c04bf832412148a", "sha256": "c822b9d2976e978d9ac6fa6588b1e3358b884777f4b4e365feaca1eba1ec5a5d" }, "downloads": -1, "filename": "zumservices-api-py-1.0.1.tar.gz", "has_sig": false, "md5_digest": "a47cb6568788a48f4c04bf832412148a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4158, "upload_time": "2019-09-26T18:04:16", "url": "https://files.pythonhosted.org/packages/b6/4f/ea16e1292312109eb19ce329baccd265ddf6d782afd29c153f39ffbae438/zumservices-api-py-1.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "6aa992f9a878d95e1d58289dcf3b94ba", "sha256": "fb8dfa9c8cb6d43375205371c8100e8ca365c5d48248dedc6341a7859c3c3f98" }, "downloads": -1, "filename": "zumservices_api_py-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "6aa992f9a878d95e1d58289dcf3b94ba", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17250, "upload_time": "2019-09-26T18:04:13", "url": "https://files.pythonhosted.org/packages/2c/2b/7cbc870bf6544037ea989aee53935b08a2119fae6770a37eda627cdb8842/zumservices_api_py-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a47cb6568788a48f4c04bf832412148a", "sha256": "c822b9d2976e978d9ac6fa6588b1e3358b884777f4b4e365feaca1eba1ec5a5d" }, "downloads": -1, "filename": "zumservices-api-py-1.0.1.tar.gz", "has_sig": false, "md5_digest": "a47cb6568788a48f4c04bf832412148a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4158, "upload_time": "2019-09-26T18:04:16", "url": "https://files.pythonhosted.org/packages/b6/4f/ea16e1292312109eb19ce329baccd265ddf6d782afd29c153f39ffbae438/zumservices-api-py-1.0.1.tar.gz" } ] }