fixedfloat-client 0.1.0__tar.gz

fixedfloat_client-0.1.0/.gitignore

@@ -0,0 +1,46 @@
+# Dependencies
+node_modules/
+.pnp.*
+.yarn/
+.pnpm-store/
+
+# Build
+dist/
+build/
+*.tsbuildinfo
+*.egg-info/
+.eggs/
+wheels/
+
+# Tests and coverage
+coverage/
+.nyc_output/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+.coverage.*
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+.venv/
+venv/
+env/
+
+# Secrets
+.env
+.env.*
+!.env.example
+AGENTS.md
+
+# GitBook / HonKit
+_book/
+
+# OS and editors
+.DS_Store
+Thumbs.db
+.idea/
+*.swp

fixedfloat_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 TysikGG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fixedfloat_client-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.5
+Name: fixedfloat-client
+Version: 0.1.0
+Summary: Python client for the FixedFloat cryptocurrency exchange API v2
+Project-URL: Repository, https://github.com/TysikGG/api-kit
+Project-URL: Documentation, https://fixedfloat.com/api
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# fixedfloat-client
+
+[![PyPI version](https://img.shields.io/pypi/v/fixedfloat-client.svg)](https://pypi.org/project/fixedfloat-client/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python Version](https://img.shields.io/pypi/pyversions/fixedfloat-client.svg)](https://pypi.org/project/fixedfloat-client/)
+
+Modern, fully typed Python client library for the [FixedFloat](https://fixedfloat.com/api) cryptocurrency exchange REST API v2.
+
+Official API documentation: <https://fixedfloat.com/api>
+
+---
+
+## Features
+
+- ⚡ **Fixed & Float Exchange Rates** — Choose between guaranteed fixed rates (1% fee) and floating market rates (0.5% fee).
+- 🔐 **Automatic Request Signing** — Cryptographic HMAC-SHA256 signature generation (`X-API-KEY` & `X-API-SIGN`) built-in.
+- 🪙 **Multi-Currency Support** — Trade Bitcoin, Ethereum, USDT, Solana, Monero, and dozens of other coins across multiple blockchains.
+- 🐍 **Modern Pythonic Design** — Type annotations, dataclass models (`Order`, `PriceResult`, `Currency`), context manager support (`with FixedFloat(...) as client:`), and custom exceptions.
+- 🚨 **Emergency Handling** — Support for emergency resolution actions (`EXCHANGE` or `REFUND`) on interrupted orders.
+
+---
+
+## Installation
+
+```bash
+pip install fixedfloat-client
+```
+
+Requires Python 3.10 or higher.
+
+---
+
+## Quick Start (Safe Check)
+
+The quick check only inspects supported currencies and price quotes. It does not create orders or spend funds:
+
+```python
+import os
+from fixedfloat import FixedFloat
+
+with FixedFloat(
+    api_key=os.environ.get("FIXEDFLOAT_API_KEY"),
+    api_secret=os.environ.get("FIXEDFLOAT_API_SECRET"),
+) as client:
+    # 1. Fetch available currencies
+    currencies = client.get_currencies()
+    print(f"Available currencies: {len(currencies)}")
+
+    # 2. Query price calculation for 0.1 BTC to ETH
+    price = client.get_price(
+        from_ccy="BTC",
+        to_ccy="ETH",
+        amount=0.1,
+        direction="from",
+        order_type="float",
+    )
+    print(f"0.1 BTC -> {price.to_side.amount} ETH (Rate: {price.to_side.rate})")
+```
+
+---
+
+## Usage Guide
+
+### 1. Creating a Floating Rate Order
+
+Create an exchange order with a floating rate, deposit instructions, and receive destination address:
+
+```python
+from fixedfloat import FixedFloat, FixedFloatError
+
+with FixedFloat(
+    api_key="your_api_key",
+    api_secret="your_api_secret",
+) as client:
+    # Create float order
+    order = client.create_order(
+        from_ccy="BTC",
+        to_ccy="ETH",
+        amount=0.1,
+        direction="from",
+        order_type="float",
+        to_address="0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+        refund_address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",  # optional
+    )
+
+    print(f"Order Created! ID: {order.id}")
+    print(f"Security Token: {order.token}")
+    print(f"Send BTC to: {order.from_side.address}")
+    print(f"Order Status: {order.status}")
+```
+
+### 2. Creating a Fixed Rate Order
+
+Lock in a guaranteed rate for 10 minutes:
+
+```python
+fixed_order = client.create_order(
+    from_ccy="ETH",
+    to_ccy="BTC",
+    amount=2.5,
+    direction="from",
+    order_type="fixed",
+    to_address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
+)
+
+print(f"Fixed Order ID: {fixed_order.id}")
+print(f"Expected Payout: {fixed_order.to_side.amount} BTC")
+print(f"Send ETH to: {fixed_order.from_side.address}")
+```
+
+### 3. Tracking Order Status & QR Codes
+
+Check order execution, transaction confirmations, and fetch QR codes:
+
+```python
+# Query status using order ID and secret token
+current = client.get_order(order.id, order.token)
+print(f"Status: {current.status}")
+
+if current.from_side.tx:
+    print(f"Deposit confirmations: {current.from_side.tx.confirmations}")
+
+# Fetch QR code for deposit address
+qr = client.get_qr(order.id, order.token)
+print(f"Deposit QR code: {qr.src}")
+
+# Attach email address for status notifications
+client.set_email(order.id, order.token, "user@example.com")
+```
+
+### 4. Setting Emergency Action Choice
+
+If an order requires user decision (e.g. rate shifted or deposit was delayed):
+
+```python
+# Choose to execute exchange at current market rate or refund
+client.set_emergency(
+    id=order.id,
+    token=order.token,
+    choice="REFUND",
+    address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
+)
+print("Emergency action submitted.")
+```
+
+---
+
+## API Reference
+
+### `FixedFloat` Class
+
+#### Constructor
+
+```python
+FixedFloat(
+    api_key: Optional[str] = None,
+    api_secret: Optional[str] = None,
+    base_url: str = "https://ff.io/api/v2",
+    timeout: float = 15.0,
+)
+```
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `api_key` | `str` | `None` | Your FixedFloat API key. |
+| `api_secret` | `str` | `None` | Your FixedFloat API secret for HMAC signatures. |
+| `base_url` | `str` | `"https://ff.io/api/v2"` | FixedFloat API v2 base URL. |
+| `timeout` | `float` | `15.0` | HTTP request timeout in seconds. |
+
+#### Methods
+
+- **`get_currencies() -> list[Currency]`** — Retrieves all supported cryptocurrencies and networks.
+- **`get_price(from_ccy, to_ccy, amount, direction="from", order_type="float", ...) -> PriceResult`** — Price estimates, rates, limits.
+- **`create_order(from_ccy, to_ccy, amount, to_address, direction="from", order_type="float", ...) -> Order`** — Creates a new order.
+- **`get_order(id: str, token: str) -> Order`** — Retrieves order status and transaction info.
+- **`set_emergency(id, token, choice, address=None, extra_id=None) -> Any`** — Sets emergency choice (`EXCHANGE` or `REFUND`).
+- **`set_email(id, token, email) -> Any`** — Sets email address for order notifications.
+- **`get_qr(id, token) -> QrResult`** — Retrieves deposit address QR code.
+
+---
+
+## Error Handling
+
+When the FixedFloat API returns an error or non-zero status code, a `FixedFloatError` is raised:
+
+```python
+from fixedfloat import FixedFloat, FixedFloatError
+
+try:
+    with FixedFloat() as client:
+        client.get_order("INVALID_ID", "INVALID_TOKEN")
+except FixedFloatError as exc:
+    print(f"FixedFloat Error: {exc.message} (Code: {exc.code})")
+```
+
+Common error codes:
+- `101` — Invalid currency pair or amount out of limits.
+- `102` — Missing required parameter.
+- `103` — Invalid destination wallet address.
+- `401` — Unauthorized: invalid API key or signature.
+
+---
+
+## License
+
+MIT

fixedfloat_client-0.1.0/README.md

@@ -0,0 +1,206 @@
+# fixedfloat-client
+
+[![PyPI version](https://img.shields.io/pypi/v/fixedfloat-client.svg)](https://pypi.org/project/fixedfloat-client/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![Python Version](https://img.shields.io/pypi/pyversions/fixedfloat-client.svg)](https://pypi.org/project/fixedfloat-client/)
+
+Modern, fully typed Python client library for the [FixedFloat](https://fixedfloat.com/api) cryptocurrency exchange REST API v2.
+
+Official API documentation: <https://fixedfloat.com/api>
+
+---
+
+## Features
+
+- ⚡ **Fixed & Float Exchange Rates** — Choose between guaranteed fixed rates (1% fee) and floating market rates (0.5% fee).
+- 🔐 **Automatic Request Signing** — Cryptographic HMAC-SHA256 signature generation (`X-API-KEY` & `X-API-SIGN`) built-in.
+- 🪙 **Multi-Currency Support** — Trade Bitcoin, Ethereum, USDT, Solana, Monero, and dozens of other coins across multiple blockchains.
+- 🐍 **Modern Pythonic Design** — Type annotations, dataclass models (`Order`, `PriceResult`, `Currency`), context manager support (`with FixedFloat(...) as client:`), and custom exceptions.
+- 🚨 **Emergency Handling** — Support for emergency resolution actions (`EXCHANGE` or `REFUND`) on interrupted orders.
+
+---
+
+## Installation
+
+```bash
+pip install fixedfloat-client
+```
+
+Requires Python 3.10 or higher.
+
+---
+
+## Quick Start (Safe Check)
+
+The quick check only inspects supported currencies and price quotes. It does not create orders or spend funds:
+
+```python
+import os
+from fixedfloat import FixedFloat
+
+with FixedFloat(
+    api_key=os.environ.get("FIXEDFLOAT_API_KEY"),
+    api_secret=os.environ.get("FIXEDFLOAT_API_SECRET"),
+) as client:
+    # 1. Fetch available currencies
+    currencies = client.get_currencies()
+    print(f"Available currencies: {len(currencies)}")
+
+    # 2. Query price calculation for 0.1 BTC to ETH
+    price = client.get_price(
+        from_ccy="BTC",
+        to_ccy="ETH",
+        amount=0.1,
+        direction="from",
+        order_type="float",
+    )
+    print(f"0.1 BTC -> {price.to_side.amount} ETH (Rate: {price.to_side.rate})")
+```
+
+---
+
+## Usage Guide
+
+### 1. Creating a Floating Rate Order
+
+Create an exchange order with a floating rate, deposit instructions, and receive destination address:
+
+```python
+from fixedfloat import FixedFloat, FixedFloatError
+
+with FixedFloat(
+    api_key="your_api_key",
+    api_secret="your_api_secret",
+) as client:
+    # Create float order
+    order = client.create_order(
+        from_ccy="BTC",
+        to_ccy="ETH",
+        amount=0.1,
+        direction="from",
+        order_type="float",
+        to_address="0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
+        refund_address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",  # optional
+    )
+
+    print(f"Order Created! ID: {order.id}")
+    print(f"Security Token: {order.token}")
+    print(f"Send BTC to: {order.from_side.address}")
+    print(f"Order Status: {order.status}")
+```
+
+### 2. Creating a Fixed Rate Order
+
+Lock in a guaranteed rate for 10 minutes:
+
+```python
+fixed_order = client.create_order(
+    from_ccy="ETH",
+    to_ccy="BTC",
+    amount=2.5,
+    direction="from",
+    order_type="fixed",
+    to_address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
+)
+
+print(f"Fixed Order ID: {fixed_order.id}")
+print(f"Expected Payout: {fixed_order.to_side.amount} BTC")
+print(f"Send ETH to: {fixed_order.from_side.address}")
+```
+
+### 3. Tracking Order Status & QR Codes
+
+Check order execution, transaction confirmations, and fetch QR codes:
+
+```python
+# Query status using order ID and secret token
+current = client.get_order(order.id, order.token)
+print(f"Status: {current.status}")
+
+if current.from_side.tx:
+    print(f"Deposit confirmations: {current.from_side.tx.confirmations}")
+
+# Fetch QR code for deposit address
+qr = client.get_qr(order.id, order.token)
+print(f"Deposit QR code: {qr.src}")
+
+# Attach email address for status notifications
+client.set_email(order.id, order.token, "user@example.com")
+```
+
+### 4. Setting Emergency Action Choice
+
+If an order requires user decision (e.g. rate shifted or deposit was delayed):
+
+```python
+# Choose to execute exchange at current market rate or refund
+client.set_emergency(
+    id=order.id,
+    token=order.token,
+    choice="REFUND",
+    address="bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
+)
+print("Emergency action submitted.")
+```
+
+---
+
+## API Reference
+
+### `FixedFloat` Class
+
+#### Constructor
+
+```python
+FixedFloat(
+    api_key: Optional[str] = None,
+    api_secret: Optional[str] = None,
+    base_url: str = "https://ff.io/api/v2",
+    timeout: float = 15.0,
+)
+```
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `api_key` | `str` | `None` | Your FixedFloat API key. |
+| `api_secret` | `str` | `None` | Your FixedFloat API secret for HMAC signatures. |
+| `base_url` | `str` | `"https://ff.io/api/v2"` | FixedFloat API v2 base URL. |
+| `timeout` | `float` | `15.0` | HTTP request timeout in seconds. |
+
+#### Methods
+
+- **`get_currencies() -> list[Currency]`** — Retrieves all supported cryptocurrencies and networks.
+- **`get_price(from_ccy, to_ccy, amount, direction="from", order_type="float", ...) -> PriceResult`** — Price estimates, rates, limits.
+- **`create_order(from_ccy, to_ccy, amount, to_address, direction="from", order_type="float", ...) -> Order`** — Creates a new order.
+- **`get_order(id: str, token: str) -> Order`** — Retrieves order status and transaction info.
+- **`set_emergency(id, token, choice, address=None, extra_id=None) -> Any`** — Sets emergency choice (`EXCHANGE` or `REFUND`).
+- **`set_email(id, token, email) -> Any`** — Sets email address for order notifications.
+- **`get_qr(id, token) -> QrResult`** — Retrieves deposit address QR code.
+
+---
+
+## Error Handling
+
+When the FixedFloat API returns an error or non-zero status code, a `FixedFloatError` is raised:
+
+```python
+from fixedfloat import FixedFloat, FixedFloatError
+
+try:
+    with FixedFloat() as client:
+        client.get_order("INVALID_ID", "INVALID_TOKEN")
+except FixedFloatError as exc:
+    print(f"FixedFloat Error: {exc.message} (Code: {exc.code})")
+```
+
+Common error codes:
+- `101` — Invalid currency pair or amount out of limits.
+- `102` — Missing required parameter.
+- `103` — Invalid destination wallet address.
+- `401` — Unauthorized: invalid API key or signature.
+
+---
+
+## License
+
+MIT

fixedfloat_client-0.1.0/examples/check.py

@@ -0,0 +1,35 @@
+"""Example checking FixedFloat currencies and price without spending balance."""
+
+import os
+
+from fixedfloat import FixedFloat
+
+
+def main() -> None:
+    api_key = os.getenv("FIXEDFLOAT_API_KEY")
+    api_secret = os.getenv("FIXEDFLOAT_API_SECRET")
+
+    with FixedFloat(api_key=api_key, api_secret=api_secret) as client:
+        print("Fetching currencies from FixedFloat...")
+        currencies = client.get_currencies()
+        print(f"Success! Found {len(currencies)} currencies.")
+
+        btc = next((c for c in currencies if c.code == "BTC"), None)
+        eth = next((c for c in currencies if c.code == "ETH"), None)
+        if btc and eth:
+            print(f"BTC: {btc.name} (network: {btc.network})")
+            print(f"ETH: {eth.name} (network: {eth.network})")
+
+        print("\nChecking exchange rate for BTC to ETH...")
+        price = client.get_price(
+            from_ccy="BTC",
+            to_ccy="ETH",
+            amount=0.1,
+            direction="from",
+            order_type="float",
+        )
+        print(f"0.1 BTC -> {price.to_side.amount} ETH (Rate: {price.to_side.rate})")
+
+
+if __name__ == "__main__":
+    main()

fixedfloat_client-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "fixedfloat-client"
+version = "0.1.0"
+description = "Python client for the FixedFloat cryptocurrency exchange API v2"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = [
+  "httpx>=0.27",
+]
+
+[project.urls]
+Repository = "https://github.com/TysikGG/api-kit"
+Documentation = "https://fixedfloat.com/api"
+
+[dependency-groups]
+dev = [
+  "pytest>=8",
+  "pytest-httpx>=0.30",
+  "ruff>=0.8",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/fixedfloat"]
+
+[tool.pytest.ini_options]
+markers = [
+  "live: calls the real FixedFloat API",
+]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+src = ["src", "tests", "examples"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]

fixedfloat_client-0.1.0/src/fixedfloat/__init__.py

@@ -0,0 +1,34 @@
+"""FixedFloat API v2 client library."""
+
+from .client import DEFAULT_REFCODE, FixedFloat
+from .errors import FixedFloatError
+from .types import (
+    Currency,
+    EmergencyChoice,
+    ExchangeDirection,
+    Order,
+    OrderSide,
+    OrderTime,
+    OrderTx,
+    OrderType,
+    PriceResult,
+    PriceSide,
+    QrResult,
+)
+
+__all__ = [
+    "DEFAULT_REFCODE",
+    "Currency",
+    "EmergencyChoice",
+    "ExchangeDirection",
+    "FixedFloat",
+    "FixedFloatError",
+    "Order",
+    "OrderSide",
+    "OrderTime",
+    "OrderTx",
+    "OrderType",
+    "PriceResult",
+    "PriceSide",
+    "QrResult",
+]