├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── coinpayments ├── __init__.py └── api.py ├── setup.py └── tests ├── __init__.py └── test_api.py /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | dist/ 3 | *.egg-info/ 4 | *.egg 5 | *.py[cod] 6 | __pycache__/ 7 | *.so 8 | *~ 9 | .python-version -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | python: 4 | - "3.4" 5 | - "3.5" 6 | - "3.6" 7 | 8 | install: pip install requests 9 | 10 | script: python -m unittest tests/test_api.py 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CoinPayments API Client 2 | [![Build Status](https://travis-ci.org/OnGridSystems/coinpayments-py.svg?branch=master)](https://travis-ci.org/OnGridSystems/coinpayments-py) 3 | [![PyPI version](https://badge.fury.io/py/coinpayments-py.svg)](https://badge.fury.io/py/coinpayments-py) 4 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 5 | ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/coinpayments-py.svg) 6 | [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) 7 | 8 | Use this library to easily interact with [CoinPayments](https://www.coinpayments.net) crypto/coin payment gateway API directly from your Python 3 application. 9 | 10 | ## Documentation 11 | 12 | * [API Documentation](https://www.coinpayments.net/merchant-tools-api) on official website. 13 | 14 | ## Installation 15 | 16 | Use pip to install coinpayments-py: 17 | 18 | ``` 19 | pip install coinpayments-py 20 | ``` 21 | 22 | ## Basic Usage 23 | 24 | Initialize api object 25 | 26 | ``` 27 | >>> from coinpayments import CoinPaymentsAPI 28 | 29 | >>> api = CoinPaymentsAPI(public_key='your_api_public_key', 30 | private_key='your_api_private_key') 31 | ``` 32 | 33 | Call any CoinPayments API method as `api` object method with corresponding arguments 34 | ``` 35 | >>> api.rates() 36 | {'error': 'ok', 'result': 'LTCT': {'balance': 839700000, 'balancef': '8.39700000', 'status': 'available', 'coin_status': 'online'}}} 37 | 38 | >>> api.get_callback_address(currency='BTC', ipn_url='http://example.com') 39 | {'error': 'ok', 'result': {'address': '36v6r1XuaWPtrTuhF8iq8AfBzPS8D4eios'}} 40 | ``` 41 | 42 | Also, you can check IPN HMAC signature using `check_signature` method 43 | ``` 44 | >>> from coinpayments import CoinPaymentsAPI 45 | >>> api = CoinPaymentsAPI(public_key=None, 46 | private_key='your_ipn_secret_key') 47 | >>> api.check_signature('ipn_message', 'ipn signautre') 48 | False 49 | ``` 50 | 51 | ## Contributing 52 | 53 | Contributions are welcome. You can learn how from this free series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). 54 | -------------------------------------------------------------------------------- /coinpayments/__init__.py: -------------------------------------------------------------------------------- 1 | from .api import CoinPaymentsAPI 2 | -------------------------------------------------------------------------------- /coinpayments/api.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import hmac 3 | import hashlib 4 | from collections import OrderedDict 5 | from urllib.parse import urlencode 6 | 7 | 8 | class CoinPaymentsAPI: 9 | api_url = 'https://www.coinpayments.net/api.php' 10 | api_version = 1 11 | 12 | def __init__(self, public_key, private_key): 13 | self.public_key = public_key 14 | self.private_key = private_key 15 | 16 | def _build_params(self, command, **kwargs): 17 | base_params = [('version', self.api_version), 18 | ('key', self.public_key), 19 | ('cmd', command), 20 | ('format', 'json')] 21 | 22 | return urlencode(OrderedDict(base_params + sorted(kwargs.items()))) 23 | 24 | def _build_signature(self, params): 25 | if not isinstance(params, bytes): 26 | params = bytearray(params, 'utf-8') 27 | 28 | byte_private_key = bytearray(self.private_key, 'utf-8') 29 | 30 | return hmac.new(byte_private_key, params, hashlib.sha512).hexdigest() 31 | 32 | def check_signature(self, data, signature): 33 | actual_signature = self._build_signature(data) 34 | 35 | return actual_signature == signature 36 | 37 | def send_api_request(self, command, **kwargs): 38 | params = self._build_params(command, **kwargs) 39 | signature = self._build_signature(params) 40 | headers = {'HMAC': signature, 41 | 'Content-Type': 'application/x-www-form-urlencoded'} 42 | 43 | return requests.post(self.api_url, 44 | data=params, 45 | headers=headers).json() 46 | 47 | def get_basic_info(self): 48 | command = 'get_basic_info' 49 | 50 | return self.send_api_request(command) 51 | 52 | def rates(self, **kwargs): 53 | command = 'rates' 54 | 55 | return self.send_api_request(command, **kwargs) 56 | 57 | def balances(self, **kwargs): 58 | command = 'balances' 59 | 60 | return self.send_api_request(command, **kwargs) 61 | 62 | def get_deposit_address(self, **kwargs): 63 | command = 'get_deposit_address' 64 | 65 | return self.send_api_request(command, **kwargs) 66 | 67 | def create_transaction(self, **kwargs): 68 | command = 'create_transaction' 69 | 70 | return self.send_api_request(command, **kwargs) 71 | 72 | def get_callback_address(self, **kwargs): 73 | command = 'get_callback_address' 74 | 75 | return self.send_api_request(command, **kwargs) 76 | 77 | def get_tx_info_multi(self, **kwargs): 78 | command = 'get_tx_info_multi' 79 | 80 | return self.send_api_request(command, **kwargs) 81 | 82 | def get_tx_info(self, **kwargs): 83 | command = 'get_tx_info' 84 | 85 | return self.send_api_request(command, **kwargs) 86 | 87 | def get_tx_ids(self, **kwargs): 88 | command = 'get_tx_ids' 89 | 90 | return self.send_api_request(command, **kwargs) 91 | 92 | def create_transfer(self, **kwargs): 93 | command = 'create_transfer' 94 | 95 | return self.send_api_request(command, **kwargs) 96 | 97 | def create_withdrawal(self, **kwargs): 98 | command = 'create_withdrawal' 99 | 100 | return self.send_api_request(command, **kwargs) 101 | 102 | def create_mass_withdrawal(self, **kwargs): 103 | command = 'create_mass_withdrawal' 104 | 105 | return self.send_api_request(command, **kwargs) 106 | 107 | def convert(self, **kwargs): 108 | command = 'convert' 109 | 110 | return self.send_api_request(command, **kwargs) 111 | 112 | def get_withdrawal_history(self, **kwargs): 113 | command = 'get_withdrawal_history' 114 | 115 | return self.send_api_request(command, **kwargs) 116 | 117 | def get_withdrawal_info(self, **kwargs): 118 | command = 'get_withdrawal_info' 119 | 120 | return self.send_api_request(command, **kwargs) 121 | 122 | def get_conversion_info(self, **kwargs): 123 | command = 'get_conversion_info' 124 | 125 | return self.send_api_request(command, **kwargs) 126 | 127 | def create_withdrawal(self, **kwargs): 128 | command = 'create_withdrawal' 129 | 130 | return self.send_api_request(command, **kwargs) 131 | 132 | def create_mass_withdrawal(self, **kwargs): 133 | command = 'create_mass_withdrawal' 134 | 135 | return self.send_api_request(command, **kwargs) 136 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | from codecs import open 3 | from os import path 4 | 5 | here = path.abspath(path.dirname(__file__)) 6 | 7 | with open(path.join(here, 'README.md'), encoding='utf-8') as f: 8 | long_description = f.read() 9 | 10 | setup( 11 | name='coinpayments-py', 12 | version='0.1.0', 13 | description='CoinPayments API Client for Python', 14 | long_description=long_description, 15 | long_description_content_type='text/markdown', 16 | url='https://github.com/OnGridSystems/coinpayments-py', 17 | author='Roman Nesytov', 18 | author_email='r.nesytov@ongrid.pro', 19 | 20 | classifiers=[ 21 | 'Development Status :: 5 - Stable', 22 | 'Intended Audience :: Developers', 23 | 'License :: OSI Approved :: Apache Software License', 24 | 25 | 'Programming Language :: Python :: 3.4', 26 | 'Programming Language :: Python :: 3.5', 27 | 'Programming Language :: Python :: 3.6', 28 | ], 29 | 30 | keywords='coinpayments currencies crypto', 31 | 32 | packages=find_packages(exclude=['tests']), 33 | 34 | install_requires=['requests'], 35 | 36 | python_requires='>=3.4', 37 | 38 | project_urls={ 39 | 'Bug Reports': 'https://github.com/OnGridSystems/coinpayments-py/issues', 40 | 'Source': 'https://github.com/OnGridSystems/coinpayments-py', 41 | }, 42 | ) 43 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/OnGridSystems/coinpayments-py/33d3b49a2d9dc984eadda8db5bd7ddfa533d08d1/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_api.py: -------------------------------------------------------------------------------- 1 | import requests 2 | from unittest import TestCase 3 | from unittest.mock import patch, Mock 4 | from coinpayments import CoinPaymentsAPI 5 | 6 | 7 | class TestAPI(TestCase): 8 | test_pub_key = 'a2308cc5846557e67b377623dbd2ce939a5fd997ab8302e2295ae65ba1d757e7' 9 | test_priv_key = '508055A03f88Cd1217f6B724878Ff238d43E961d89E5cCb5be7182F3713613c6' 10 | 11 | def setUp(self): 12 | self.api = CoinPaymentsAPI(public_key=self.test_pub_key, 13 | private_key=self.test_priv_key) 14 | 15 | def test_send_request(self): 16 | response_mock = Mock() 17 | 18 | with patch.object(requests, 'post', return_value=response_mock) as mocked_requests: 19 | self.api.get_deposit_address(currency='BTC') 20 | 21 | mocked_requests.assert_called_once_with( 22 | 'https://www.coinpayments.net/api.php', 23 | data='version=1&key=a2308cc5846557e67b377623dbd2ce939a5fd997ab8302e2295ae65ba1d757e7&cmd=get_deposit_address&format=json¤cy=BTC', 24 | headers={ 25 | 'HMAC': '32c6cdc253046073c369eed253a15bc8ff78c17d62b28c124eb5dfac148b02740e8849887657439369c24fad8a611f58f35d92a9a433804c7b16c7ed38314f6d', 26 | 'Content-Type': 'application/x-www-form-urlencoded' 27 | }) 28 | 29 | assert response_mock.json.call_count == 1 30 | 31 | def test_check_signature(self): 32 | data = 'version=1&key=a2308cc5846557e67b377623dbd2ce939a5fd997ab8302e2295ae65ba1d757e7&cmd=rates&format=json' 33 | signature = '09f27bea915ba042a50e1f54bc5988ad07cf4c6d5b375e660ca1109f8d451fd28cc96e8779c9d633e181e400cf7af61a61fbc0d326ac1e5a6ea77e7c5caa9fd9' 34 | 35 | self.assertTrue(self.api.check_signature(data, signature)) 36 | --------------------------------------------------------------------------------