<p align="center">
<img src="https://i.imgur.com/5VacA1K.png" width="150"/>
<h1 align="center">FixedFloat API - Python</h1>
<p align="center">
<br>FixedFloat API - Python (unofficial)
<br><a href="https://fixedfloat.com/?ref=a7u3rzvc">Get API Key</a> | <a href="https://fixedfloat.com/api">Docs</a> | <a href="https://fixedfloat.com/">Website</a> | <a href="https://fixedfloat.com/faq">FAQ</a>
</p>
</p>
## Installation
Manual
```bash
git clone https://github.com/GuilhermeFischer/fixedfloat_api.git
pip install -r requirements.txt
```
Pip
```bash
pip install fixedfloat-api
```
## Usage
```python
from fixedfloat_api import FixedFloat
fixedfloat_api = FixedFloat("API_KEY", "SECRET_KEY")
```
## Methods
* [.getCurrencies()](#getcurrencies)
* [.getPrice(fromCurrency, toCurrency, fromQty, toQty, type)](#getpricefromcurrency-tocurrency-fromqty-toqty-type)
* [.getOrder(id, token)](#getorderid-token)
* [.setEmergency(id, token, choice, address)](#setemergencyid-token-choice-address)
* [.createOrder(fromCurrency, toCurrency, toAddress, fromQty, toQty, type, extra)](#createorderfromcurrency-tocurrency-toaddress-fromqty-toqty-type-extra)
### .getCurrencies()
Getting a list of all currencies that are available. [Official docs](https://fixedfloat.com/api#method_getCurrencies)
```python
response = fixedfloat_api.getCurrencies()
```
### .getPrice(fromCurrency, toCurrency, fromQty, toQty, type)
Information about a currency pair with a set amount of funds. [Official docs](https://fixedfloat.com/api#method_getPrice)
```python
// Fixed
response = fixedfloat_api.getPrice("USDCBSC", "BTC", 25.00, type="fixed")
// Float
response = fixedfloat_api.getPrice("USDCBSC", "BTC", 25.00)
```
### .getOrder(id, token)
Receiving information about the order. [Official docs](https://fixedfloat.com/api#method_getOrder)
```python
response = fixedfloat_api.getOrder("ID", "TOKEN")
```
### .setEmergency(id, token, choice, address)
Emergency action choice. [Official docs](https://fixedfloat.com/api#method_setEmergency)
```python
// Exchange
response = fixedfloat_api.setEmergency("ID", "TOKEN", "EXCHANGE")
// Refund
response = fixedfloat_api.setEmergency("ID", "TOKEN", "REFUND", "ADDRESS")
```
### .createOrder(fromCurrency, toCurrency, toAddress, fromQty, toQty, type, extra)
Creating exchange order. [Official docs](https://fixedfloat.com/api#method_createOrder)
```python
// Fixed
response = fixedfloat_api.createOrder("USDCBSC", "BTC", "ADDRESS", 25.00, type="fixed")
// Float
response = fixedfloat_api.createOrder("USDCBSC", "BTC", "ADDRESS", 25.00)
```
## License
fixedfloat_api is Licensed under the [MIT License](https://github.com/GuilhermeFischer/fixedfloat_api/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/GuilhermeFischer/fixedfloat_api",
"name": "fixedfloat-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "api,crypto,exchange,fixedfloat,bitcoin,ethereum",
"author": "Guilherme A. Fischer",
"author_email": "<gfx.fischer@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0e/09/9a69d1a506dca02c6c474249cf0cfcc834ed991478b9ef8593b0b8848b7d/fixedfloat_api-1.0.3.tar.gz",
"platform": null,
"description": "\r\n<p align=\"center\">\r\n\r\n <img src=\"https://i.imgur.com/5VacA1K.png\" width=\"150\"/>\r\n\r\n <h1 align=\"center\">FixedFloat API - Python</h1>\r\n\r\n <p align=\"center\">\r\n\r\n <br>FixedFloat API - Python (unofficial)\r\n\r\n <br><a href=\"https://fixedfloat.com/?ref=a7u3rzvc\">Get API Key</a> | <a href=\"https://fixedfloat.com/api\">Docs</a> | <a href=\"https://fixedfloat.com/\">Website</a> | <a href=\"https://fixedfloat.com/faq\">FAQ</a>\r\n\r\n </p>\r\n\r\n</p>\r\n\r\n\r\n\r\n## Installation\r\n\r\nManual\r\n\r\n```bash\r\n\r\ngit clone https://github.com/GuilhermeFischer/fixedfloat_api.git\r\n\r\npip install -r requirements.txt\r\n\r\n```\r\n\r\nPip\r\n\r\n```bash\r\n\r\npip install fixedfloat-api\r\n\r\n```\r\n\r\n\r\n\r\n## Usage\r\n\r\n```python\r\n\r\nfrom fixedfloat_api import FixedFloat\r\n\r\nfixedfloat_api = FixedFloat(\"API_KEY\", \"SECRET_KEY\")\r\n\r\n\r\n\r\n```\r\n\r\n\r\n\r\n## Methods\r\n\r\n\r\n\r\n* [.getCurrencies()](#getcurrencies)\r\n\r\n* [.getPrice(fromCurrency, toCurrency, fromQty, toQty, type)](#getpricefromcurrency-tocurrency-fromqty-toqty-type)\r\n\r\n* [.getOrder(id, token)](#getorderid-token)\r\n\r\n* [.setEmergency(id, token, choice, address)](#setemergencyid-token-choice-address)\r\n\r\n* [.createOrder(fromCurrency, toCurrency, toAddress, fromQty, toQty, type, extra)](#createorderfromcurrency-tocurrency-toaddress-fromqty-toqty-type-extra)\r\n\r\n\r\n\r\n### .getCurrencies()\r\n\r\n\r\n\r\nGetting a list of all currencies that are available. [Official docs](https://fixedfloat.com/api#method_getCurrencies)\r\n\r\n\r\n\r\n```python\r\n\r\nresponse = fixedfloat_api.getCurrencies()\r\n\r\n```\r\n\r\n\r\n\r\n### .getPrice(fromCurrency, toCurrency, fromQty, toQty, type)\r\n\r\n\r\n\r\nInformation about a currency pair with a set amount of funds. [Official docs](https://fixedfloat.com/api#method_getPrice)\r\n\r\n\r\n\r\n```python\r\n\r\n// Fixed\r\n\r\nresponse = fixedfloat_api.getPrice(\"USDCBSC\", \"BTC\", 25.00, type=\"fixed\")\r\n\r\n\r\n\r\n// Float\r\n\r\nresponse = fixedfloat_api.getPrice(\"USDCBSC\", \"BTC\", 25.00)\r\n\r\n```\r\n\r\n\r\n\r\n### .getOrder(id, token)\r\n\r\n\r\n\r\nReceiving information about the order. [Official docs](https://fixedfloat.com/api#method_getOrder)\r\n\r\n```python\r\n\r\nresponse = fixedfloat_api.getOrder(\"ID\", \"TOKEN\")\r\n\r\n```\r\n\r\n\r\n\r\n### .setEmergency(id, token, choice, address)\r\n\r\n\r\n\r\nEmergency action choice. [Official docs](https://fixedfloat.com/api#method_setEmergency)\r\n\r\n\r\n\r\n```python\r\n\r\n// Exchange\r\n\r\nresponse = fixedfloat_api.setEmergency(\"ID\", \"TOKEN\", \"EXCHANGE\")\r\n\r\n\r\n\r\n// Refund\r\n\r\nresponse = fixedfloat_api.setEmergency(\"ID\", \"TOKEN\", \"REFUND\", \"ADDRESS\")\r\n\r\n```\r\n\r\n\r\n\r\n### .createOrder(fromCurrency, toCurrency, toAddress, fromQty, toQty, type, extra)\r\n\r\n\r\n\r\nCreating exchange order. [Official docs](https://fixedfloat.com/api#method_createOrder)\r\n\r\n\r\n\r\n```python\r\n\r\n// Fixed\r\n\r\nresponse = fixedfloat_api.createOrder(\"USDCBSC\", \"BTC\", \"ADDRESS\", 25.00, type=\"fixed\")\r\n\r\n\r\n\r\n// Float\r\n\r\nresponse = fixedfloat_api.createOrder(\"USDCBSC\", \"BTC\", \"ADDRESS\", 25.00)\r\n\r\n```\r\n\r\n\r\n\r\n## License\r\n\r\nfixedfloat_api is Licensed under the [MIT License](https://github.com/GuilhermeFischer/fixedfloat_api/blob/main/LICENSE)\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "FixedFloat API",
"version": "1.0.3",
"split_keywords": [
"api",
"crypto",
"exchange",
"fixedfloat",
"bitcoin",
"ethereum"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "7a41b5abc949967966021d769b8d026c",
"sha256": "a168b127cc0a65e2cc35cdbe44eff7d878afc5afb5459c700e3dbf9003a917c3"
},
"downloads": -1,
"filename": "fixedfloat_api-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a41b5abc949967966021d769b8d026c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4379,
"upload_time": "2022-12-08T22:09:50",
"upload_time_iso_8601": "2022-12-08T22:09:50.150584Z",
"url": "https://files.pythonhosted.org/packages/b3/ee/8ddfa55e7e4f450fcf943269ebde79c0202f4407d7f85112c2823bc4ac76/fixedfloat_api-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "d1cc770e2fa6bc04d508869a1d414ec2",
"sha256": "2fa022d53f2a8350f8b73d6c6a5d15b6b2e87ccf452418682bbe24cfaac84998"
},
"downloads": -1,
"filename": "fixedfloat_api-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d1cc770e2fa6bc04d508869a1d414ec2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4208,
"upload_time": "2022-12-08T22:09:52",
"upload_time_iso_8601": "2022-12-08T22:09:52.500058Z",
"url": "https://files.pythonhosted.org/packages/0e/09/9a69d1a506dca02c6c474249cf0cfcc834ed991478b9ef8593b0b8848b7d/fixedfloat_api-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-08 22:09:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "GuilhermeFischer",
"github_project": "fixedfloat_api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "fixedfloat-api"
}
JSON
