exolix-client 0.1.0__tar.gz

exolix_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

exolix_client-0.1.0/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 api-kit contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

exolix_client-0.1.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.5
+Name: exolix-client
+Version: 0.1.0
+Summary: Python client for the Exolix cryptocurrency exchange API (v2)
+Project-URL: Repository, https://github.com/TysikGG/api-kit
+Project-URL: Documentation, https://exolix.com/developers
+License-Expression: ISC
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# exolix-client
+
+[![PyPI version](https://img.shields.io/pypi/v/exolix-client.svg)](https://pypi.org/project/exolix-client/)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
+[![Python Version](https://img.shields.io/pypi/pyversions/exolix-client.svg)](https://pypi.org/project/exolix-client/)
+
+Modern, fully typed Python client library for the [Exolix](https://exolix.com) instant cryptocurrency exchange API (v2).
+
+Official API documentation: <https://exolix.com/developers>
+
+The PyPI package is `exolix-client`. Import it as `exolix`.
+
+---
+
+## Features
+
+- ⚡ **Fixed & Floating Rates** — Quote a swap by deposit `amount` or by desired `withdrawal_amount`, at a floating or fixed rate.
+- 🪙 **Currencies & Networks** — List coins, networks for one coin, and the full network catalog.
+- 🐍 **Modern Pythonic Design** — Type annotations, context manager support (`with Exolix(...) as client:`), and a custom exception.
+- 🔄 **Transactions** — Create a swap, fetch it by id, and list affiliate transaction history.
+
+---
+
+## Installation
+
+```bash
+pip install exolix-client
+```
+
+Requires Python 3.10 or higher.
+
+---
+
+## Authentication
+
+Partner attribution is the affiliate API key. The default affiliate share is 0.3%. The client sends the key in one header and does not add a referral parameter:
+
+```python
+from exolix import EXOLIX_API_KEY_HEADER
+
+print(EXOLIX_API_KEY_HEADER)  # "Authorization"
+```
+
+Pass the key to the constructor. The client does not read `EXOLIX_API_KEY` from the environment. Public reads work without a key. Transaction history requires a key that Exolix has enabled for that route.
+
+---
+
+## Quick Start (Safe Check)
+
+The quick check only queries currencies and a rate. It does not create a transaction:
+
+```python
+import os
+from exolix import Exolix
+
+with Exolix(api_key=os.environ["EXOLIX_API_KEY"]) as client:
+    currencies = client.get_currencies(page=1, size=5, with_networks=True)
+    print(f"Available currencies: {currencies['count']}")
+
+    quote = client.get_rate(
+        "BTC",
+        "ETH",
+        "float",
+        network_from="BTC",
+        network_to="ETH",
+        amount="0.1",
+    )
+    print(f"0.1 BTC -> {quote['toAmount']} ETH (rate {quote['rate']})")
+```
+
+---
+
+## Usage Guide
+
+### 1. Creating a Floating Rate Swap
+
+```python
+from exolix import Exolix, ExolixError
+
+with Exolix(api_key="your_api_key") as client:
+    quote = client.get_rate(
+        "ETH",
+        "USDT",
+        "float",
+        network_from="ETH",
+        network_to="ETH",
+        amount="0.5",
+    )
+    print(f"Min {quote['minAmount']}, you receive {quote['toAmount']} USDT")
+
+    tx = client.create_transaction(
+        "ETH",
+        "USDT",
+        "ETH",
+        "ETH",
+        "0x0E29D1E501f90649Ad5982E900c455006e4522FC",
+        amount=0.5,
+        rate_type="float",
+    )
+    print(f"Send ETH to {tx['depositAddress']} ({tx['id']})")
+```
+
+`create_transaction` opens a real swap. Quote with `get_rate` first.
+
+### 2. Fixed Rate by Withdrawal Amount
+
+```python
+quote = client.get_rate(
+    "ETH",
+    "USDT",
+    "fixed",
+    network_from="ETH",
+    network_to="ETH",
+    withdrawal_amount="50",
+)
+print(f"Send {quote['fromAmount']} ETH to receive {quote['toAmount']} USDT")
+```
+
+### 3. Tracking Status and History
+
+```python
+tx = client.get_transaction("ab93061434dd0s")
+print(tx["status"])  # wait, confirmation, confirmed, exchanging, sending, success, ...
+
+history = client.get_transactions(page=1, size=25, order="desc")
+print(history["count"])
+```
+
+History is authenticated. Exolix enables it per API key.
+
+---
+
+## API Reference
+
+### `Exolix` Class
+
+#### Constructor
+
+```python
+Exolix(
+    api_key: str | None = None,
+    base_url: str | None = None,
+    timeout: float = 30.0,
+    user_agent: str | None = None,
+)
+```
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `api_key` | `str` | unset | Affiliate API key. Sent as `Authorization`. |
+| `base_url` | `str` | `"https://exolix.com/api/v2"` | API base URL. |
+| `timeout` | `float` | `30.0` | Request timeout in seconds. |
+| `user_agent` | `str` | `"exolix-client/0.1.0"` | User-Agent header. |
+
+#### Methods
+
+- **`get_currencies(...)`** — `GET /currencies`
+- **`get_currency_networks(code)`** — `GET /currencies/{code}/networks`
+- **`get_networks(...)`** — `GET /currencies/networks`
+- **`get_rate(...)`** — `GET /rate` (`rate_type` `float` or `fixed`, `amount` or `withdrawal_amount`)
+- **`create_transaction(...)`** — `POST /transactions`
+- **`get_transaction(transaction_id)`** — `GET /transactions/{id}`
+- **`get_transactions(...)`** — `GET /transactions` (authenticated history)
+
+---
+
+## Error Handling
+
+```python
+from exolix import Exolix, ExolixError
+
+try:
+    with Exolix(api_key="invalid_key") as client:
+        client.get_transactions()
+except ExolixError as error:
+    print(f"{error.code}: {error.message} (HTTP {error.status_code})")
+```
+
+---
+
+## Live Tests
+
+Unit tests mock HTTP and always run. The live suite calls the real API and runs only when `EXOLIX_API_KEY` is set. It is read-only: currencies, networks, a floating rate, a fixed rate, and transaction history. It never creates a transaction.
+
+```bash
+uv run pytest -m "not live"
+EXOLIX_API_KEY=your_key uv run pytest -m live
+```
+
+---
+
+## License
+
+ISC

exolix_client-0.1.0/README.md

@@ -0,0 +1,194 @@
+# exolix-client
+
+[![PyPI version](https://img.shields.io/pypi/v/exolix-client.svg)](https://pypi.org/project/exolix-client/)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](LICENSE)
+[![Python Version](https://img.shields.io/pypi/pyversions/exolix-client.svg)](https://pypi.org/project/exolix-client/)
+
+Modern, fully typed Python client library for the [Exolix](https://exolix.com) instant cryptocurrency exchange API (v2).
+
+Official API documentation: <https://exolix.com/developers>
+
+The PyPI package is `exolix-client`. Import it as `exolix`.
+
+---
+
+## Features
+
+- ⚡ **Fixed & Floating Rates** — Quote a swap by deposit `amount` or by desired `withdrawal_amount`, at a floating or fixed rate.
+- 🪙 **Currencies & Networks** — List coins, networks for one coin, and the full network catalog.
+- 🐍 **Modern Pythonic Design** — Type annotations, context manager support (`with Exolix(...) as client:`), and a custom exception.
+- 🔄 **Transactions** — Create a swap, fetch it by id, and list affiliate transaction history.
+
+---
+
+## Installation
+
+```bash
+pip install exolix-client
+```
+
+Requires Python 3.10 or higher.
+
+---
+
+## Authentication
+
+Partner attribution is the affiliate API key. The default affiliate share is 0.3%. The client sends the key in one header and does not add a referral parameter:
+
+```python
+from exolix import EXOLIX_API_KEY_HEADER
+
+print(EXOLIX_API_KEY_HEADER)  # "Authorization"
+```
+
+Pass the key to the constructor. The client does not read `EXOLIX_API_KEY` from the environment. Public reads work without a key. Transaction history requires a key that Exolix has enabled for that route.
+
+---
+
+## Quick Start (Safe Check)
+
+The quick check only queries currencies and a rate. It does not create a transaction:
+
+```python
+import os
+from exolix import Exolix
+
+with Exolix(api_key=os.environ["EXOLIX_API_KEY"]) as client:
+    currencies = client.get_currencies(page=1, size=5, with_networks=True)
+    print(f"Available currencies: {currencies['count']}")
+
+    quote = client.get_rate(
+        "BTC",
+        "ETH",
+        "float",
+        network_from="BTC",
+        network_to="ETH",
+        amount="0.1",
+    )
+    print(f"0.1 BTC -> {quote['toAmount']} ETH (rate {quote['rate']})")
+```
+
+---
+
+## Usage Guide
+
+### 1. Creating a Floating Rate Swap
+
+```python
+from exolix import Exolix, ExolixError
+
+with Exolix(api_key="your_api_key") as client:
+    quote = client.get_rate(
+        "ETH",
+        "USDT",
+        "float",
+        network_from="ETH",
+        network_to="ETH",
+        amount="0.5",
+    )
+    print(f"Min {quote['minAmount']}, you receive {quote['toAmount']} USDT")
+
+    tx = client.create_transaction(
+        "ETH",
+        "USDT",
+        "ETH",
+        "ETH",
+        "0x0E29D1E501f90649Ad5982E900c455006e4522FC",
+        amount=0.5,
+        rate_type="float",
+    )
+    print(f"Send ETH to {tx['depositAddress']} ({tx['id']})")
+```
+
+`create_transaction` opens a real swap. Quote with `get_rate` first.
+
+### 2. Fixed Rate by Withdrawal Amount
+
+```python
+quote = client.get_rate(
+    "ETH",
+    "USDT",
+    "fixed",
+    network_from="ETH",
+    network_to="ETH",
+    withdrawal_amount="50",
+)
+print(f"Send {quote['fromAmount']} ETH to receive {quote['toAmount']} USDT")
+```
+
+### 3. Tracking Status and History
+
+```python
+tx = client.get_transaction("ab93061434dd0s")
+print(tx["status"])  # wait, confirmation, confirmed, exchanging, sending, success, ...
+
+history = client.get_transactions(page=1, size=25, order="desc")
+print(history["count"])
+```
+
+History is authenticated. Exolix enables it per API key.
+
+---
+
+## API Reference
+
+### `Exolix` Class
+
+#### Constructor
+
+```python
+Exolix(
+    api_key: str | None = None,
+    base_url: str | None = None,
+    timeout: float = 30.0,
+    user_agent: str | None = None,
+)
+```
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `api_key` | `str` | unset | Affiliate API key. Sent as `Authorization`. |
+| `base_url` | `str` | `"https://exolix.com/api/v2"` | API base URL. |
+| `timeout` | `float` | `30.0` | Request timeout in seconds. |
+| `user_agent` | `str` | `"exolix-client/0.1.0"` | User-Agent header. |
+
+#### Methods
+
+- **`get_currencies(...)`** — `GET /currencies`
+- **`get_currency_networks(code)`** — `GET /currencies/{code}/networks`
+- **`get_networks(...)`** — `GET /currencies/networks`
+- **`get_rate(...)`** — `GET /rate` (`rate_type` `float` or `fixed`, `amount` or `withdrawal_amount`)
+- **`create_transaction(...)`** — `POST /transactions`
+- **`get_transaction(transaction_id)`** — `GET /transactions/{id}`
+- **`get_transactions(...)`** — `GET /transactions` (authenticated history)
+
+---
+
+## Error Handling
+
+```python
+from exolix import Exolix, ExolixError
+
+try:
+    with Exolix(api_key="invalid_key") as client:
+        client.get_transactions()
+except ExolixError as error:
+    print(f"{error.code}: {error.message} (HTTP {error.status_code})")
+```
+
+---
+
+## Live Tests
+
+Unit tests mock HTTP and always run. The live suite calls the real API and runs only when `EXOLIX_API_KEY` is set. It is read-only: currencies, networks, a floating rate, a fixed rate, and transaction history. It never creates a transaction.
+
+```bash
+uv run pytest -m "not live"
+EXOLIX_API_KEY=your_key uv run pytest -m live
+```
+
+---
+
+## License
+
+ISC

exolix_client-0.1.0/examples/quickstart.py

@@ -0,0 +1,34 @@
+import os
+import sys
+
+from exolix import Exolix
+
+
+def main() -> None:
+    api_key = os.environ.get("EXOLIX_API_KEY")
+    if not api_key:
+        print("Please set EXOLIX_API_KEY environment variable.", file=sys.stderr)
+        sys.exit(1)
+
+    with Exolix(api_key=api_key) as client:
+        currencies = client.get_currencies(page=1, size=5, with_networks=True)
+        print(f"Currencies available: {currencies['count']}")
+        sample = [f"{c['name']} ({c['code']})" for c in currencies["data"][:5]]
+        print("Sample:", ", ".join(sample))
+
+        networks = client.get_currency_networks("ETH")
+        print("\nETH networks:", ", ".join(network["network"] for network in networks))
+
+        quote = client.get_rate(
+            "BTC",
+            "ETH",
+            "float",
+            network_from="BTC",
+            network_to="ETH",
+            amount="0.1",
+        )
+        print(f"\nEstimated ETH for 0.1 BTC: {quote['toAmount']} (rate {quote['rate']})")
+
+
+if __name__ == "__main__":
+    main()

exolix_client-0.1.0/pyproject.toml

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

exolix_client-0.1.0/src/exolix/__init__.py

@@ -0,0 +1,28 @@
+"""Exolix cryptocurrency exchange API (v2) client."""
+
+from .client import EXOLIX_API_KEY_HEADER, Exolix
+from .errors import ExolixError
+from .types import (
+    Currency,
+    Network,
+    PaginatedCurrencies,
+    PaginatedNetworks,
+    PaginatedTransactions,
+    Rate,
+    RateType,
+    Transaction,
+)
+
+__all__ = [
+    "EXOLIX_API_KEY_HEADER",
+    "Currency",
+    "Exolix",
+    "ExolixError",
+    "Network",
+    "PaginatedCurrencies",
+    "PaginatedNetworks",
+    "PaginatedTransactions",
+    "Rate",
+    "RateType",
+    "Transaction",
+]