# # CryptoFusePy
CryptoFusePy is a Python library for interacting with the [CryptoFuse API](https://www.cryptofuse.net/api_docs). It enables developers to easily integrate CryptoFuse's cryptocurrency swapping functionality into their Python applications.
# ## Installation
Alternatively, if the package is available on PyPI, you can install it using `pip`:
```sh
git clone https://github.com/your_username_here/cryptofusepy.git
cd cryptofusepy
pip install .
```
## Usage
You can use the `CryptoFuseClient` class from the `cryptofusepy` package to interact with the CryptoFuse API.
Here's a quick example on how you can instantiate the client and fetch the available cryptocurrencies:
```python
from cryptofusepy import CryptoFuseClient
# Instantiate the client
client = CryptoFuseClient()
# Fetch available cryptos
available_cryptos = client.fetch_available_cryptos()
print(available_cryptos)
```
For a more detailed example that shows how to use all the endpoints, please see the [example.py](example.py) file in this repository.
## Available Methods
Here is a list of available methods in the `CryptoFuseClient` class:
- `fetch_available_cryptos(): Fetches the available cryptocurrencies.`
- `fetch_exchange_rate(from_crypto, to_crypto): Fetches the exchange rate between two cryptocurrencies.`
- `generate_address(from_crypto, to_crypto, user_address, referral=None): Generates an address for swapping.`
- `register_referral(to_crypto, user_address, referral): Registers a referral.`
- `get_address_by_uuid(uuid): Retrieves address information by UUID.`
- `get_latest_transaction(uuid, latest_known_transaction_id=None, latest_known_transaction_status=None): Retrieves the latest transaction for the provided UUID.`
- `get_crypto_swap_status(): Retrieves the Crypto Swap status.`
## Contributing
Contributions are welcome! Please feel free to submit a pull request or create an issue if you find a bug or have a feature request.
Raw data
{
"_id": null,
"home_page": "",
"name": "cryptofusepy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "cryptofuse cryptocurrency cryptoswap swap crypto",
"author": "Silenttttttt",
"author_email": "cryptofuse.net@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b9/15/9a75eaf1a3dda8f4c7441767f42debaf5123b4583a1aa8f85c93502b07da/cryptofusepy-0.1.1.tar.gz",
"platform": null,
"description": "# # CryptoFusePy\n\nCryptoFusePy is a Python library for interacting with the [CryptoFuse API](https://www.cryptofuse.net/api_docs). It enables developers to easily integrate CryptoFuse's cryptocurrency swapping functionality into their Python applications.\n\n\n# ## Installation\n\nAlternatively, if the package is available on PyPI, you can install it using `pip`:\n\n\n```sh\ngit clone https://github.com/your_username_here/cryptofusepy.git\ncd cryptofusepy\npip install .\n```\n## Usage\n\nYou can use the `CryptoFuseClient` class from the `cryptofusepy` package to interact with the CryptoFuse API.\n\nHere's a quick example on how you can instantiate the client and fetch the available cryptocurrencies:\n\n```python\nfrom cryptofusepy import CryptoFuseClient\n\n# Instantiate the client\nclient = CryptoFuseClient()\n\n# Fetch available cryptos\navailable_cryptos = client.fetch_available_cryptos()\nprint(available_cryptos)\n```\n\nFor a more detailed example that shows how to use all the endpoints, please see the [example.py](example.py) file in this repository.\n\n## Available Methods\n\nHere is a list of available methods in the `CryptoFuseClient` class:\n\n- `fetch_available_cryptos(): Fetches the available cryptocurrencies.`\n- `fetch_exchange_rate(from_crypto, to_crypto): Fetches the exchange rate between two cryptocurrencies.`\n- `generate_address(from_crypto, to_crypto, user_address, referral=None): Generates an address for swapping.`\n- `register_referral(to_crypto, user_address, referral): Registers a referral.`\n- `get_address_by_uuid(uuid): Retrieves address information by UUID.`\n- `get_latest_transaction(uuid, latest_known_transaction_id=None, latest_known_transaction_status=None): Retrieves the latest transaction for the provided UUID.`\n- `get_crypto_swap_status(): Retrieves the Crypto Swap status.`\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a pull request or create an issue if you find a bug or have a feature request.\n",
"bugtrack_url": null,
"license": "",
"summary": "Python library for interacting with the CryptoFuse API",
"version": "0.1.1",
"project_urls": {
"Source Code": "https://github.com/Os-brod/CryptoFusepy"
},
"split_keywords": [
"cryptofuse",
"cryptocurrency",
"cryptoswap",
"swap",
"crypto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99f18f73b21b320423b4f0144ef48781b7774ea601a631b5804627ce390187a1",
"md5": "d257ee28765e97de3bc28377025b8679",
"sha256": "d89323c6bdc53cecd6443732738396768d0a271211bce1e7f59d2972ed03545f"
},
"downloads": -1,
"filename": "cryptofusepy-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d257ee28765e97de3bc28377025b8679",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3124,
"upload_time": "2023-06-20T00:54:10",
"upload_time_iso_8601": "2023-06-20T00:54:10.611649Z",
"url": "https://files.pythonhosted.org/packages/99/f1/8f73b21b320423b4f0144ef48781b7774ea601a631b5804627ce390187a1/cryptofusepy-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9159a75eaf1a3dda8f4c7441767f42debaf5123b4583a1aa8f85c93502b07da",
"md5": "ce0c563558e7414b367d37a3b138327b",
"sha256": "d5febd79d99c452bea16e5ee768b760dec76d15313c3dba5a9b53d32b03a56b1"
},
"downloads": -1,
"filename": "cryptofusepy-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ce0c563558e7414b367d37a3b138327b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2665,
"upload_time": "2023-06-20T00:54:12",
"upload_time_iso_8601": "2023-06-20T00:54:12.816866Z",
"url": "https://files.pythonhosted.org/packages/b9/15/9a75eaf1a3dda8f4c7441767f42debaf5123b4583a1aa8f85c93502b07da/cryptofusepy-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 00:54:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Os-brod",
"github_project": "CryptoFusepy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cryptofusepy"
}
JSON
