whitebird-api 0.1.1__tar.gz

whitebird_api-0.1.1/.gitignore

@@ -0,0 +1,31 @@
+# Tooling caches
+.cache/
+node_modules/
+dist/
+target/
+site/
+coverage/
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.egg-info/
+.coverage
+htmlcov/
+
+# Local secrets
+.env
+.env.*
+!.env.example
+
+# Editors
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+docs/reference/generated/
+scripts/docs/node_modules/
+site/

whitebird_api-0.1.1/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+## [0.1.1](https://github.com/joolertan/whitebird-api/compare/python-v0.1.0...python-v0.1.1) (2026-11-08)
+
+
+### Features
+
+* generate account, KYC and notification resources ([24c57c0](https://github.com/joolertan/whitebird-api/commit/24c57c058342df5e2146fcbd42949606af78292d))
+* generate exchange, balance and merchant resources ([b63943c](https://github.com/joolertan/whitebird-api/commit/b63943c55c9875660b9f9e85f83fcf7712d52553))
+* generate ICO resources ([690d30a](https://github.com/joolertan/whitebird-api/commit/690d30a8f1b409714a74309b1b1fa461ddf256db))
+* generate market data and trading resources ([641bc73](https://github.com/joolertan/whitebird-api/commit/641bc731f29e10593d1fbf4dc812832bc63af540))
+* generate payment provider resources ([babefc3](https://github.com/joolertan/whitebird-api/commit/babefc38d112af3dd4d658ef2ef44b09744c3a38))
+* **python:** accept coroutine code providers in AsyncWhitebird ([b761b4a](https://github.com/joolertan/whitebird-api/commit/b761b4a9dff0b4417ce60bb097014c247502ed36))
+* **python:** add sync and async clients with auth, retries, pagination and SSE ([832e23e](https://github.com/joolertan/whitebird-api/commit/832e23ec957cb365efabf4c695f0720f106ee241))
+* **python:** captcha solver, operation MFA and examples ([fbc9b83](https://github.com/joolertan/whitebird-api/commit/fbc9b835c71da1754721a8934c1183f5c57aff79))
+* **python:** generate brokerage resources ([175ec45](https://github.com/joolertan/whitebird-api/commit/175ec458e2fc3c7839dce050b8e932c8778bcfd2))
+
+
+### Bug Fixes
+
+* check two-factor status before every password login ([b180779](https://github.com/joolertan/whitebird-api/commit/b1807797a0652b961e8a1ffb4033d3087f64fead))
+* **python:** accept union response types in the engine ([50cbba7](https://github.com/joolertan/whitebird-api/commit/50cbba728aa589d16a370cee24aae83752b6c60c))
+* **python:** sign in, refresh and retry like the web app ([5b1e4de](https://github.com/joolertan/whitebird-api/commit/5b1e4de419ec075f3e78d367c6249b9f81308233))
+* **python:** use Decimal for brokerage amounts ([9e750d5](https://github.com/joolertan/whitebird-api/commit/9e750d5dcc377f04c8cdeba20928931dadfb30c4))
+
+
+### Documentation
+
+* add READMEs, contributing guide and security policy ([1d42f36](https://github.com/joolertan/whitebird-api/commit/1d42f366470d26b7986b04a6a504ee0e26704722))
+* describe what the SDKs do instead of how the spec is built ([5260784](https://github.com/joolertan/whitebird-api/commit/526078462e652d3d15e90d5ac48dfcf6d3285807))
+* **spec:** describe ICO operation types in English ([ce94835](https://github.com/joolertan/whitebird-api/commit/ce94835377e65b2c3e51ad04eaf9091f33ca33bb))

whitebird_api-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joolertan
+
+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.

whitebird_api-0.1.1/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.5
+Name: whitebird-api
+Version: 0.1.1
+Summary: Unofficial Whitebird API client
+Project-URL: Homepage, https://github.com/joolertan/whitebird-api
+Project-URL: Repository, https://github.com/joolertan/whitebird-api
+Project-URL: Documentation, https://whitebird-api.readthedocs.io
+Project-URL: Issues, https://github.com/joolertan/whitebird-api/issues
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,client,crypto,cryptocurrency,exchange,sdk,trading,whitebird
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.12
+Provides-Extra: otp
+Requires-Dist: pyotp>=2.9; extra == 'otp'
+Description-Content-Type: text/markdown
+
+# whitebird-api
+
+[![PyPI](https://img.shields.io/pypi/v/whitebird-api?label=PyPI)](https://pypi.org/project/whitebird-api/)
+[![Python](https://img.shields.io/pypi/pyversions/whitebird-api)](https://pypi.org/project/whitebird-api/)
+[![Docs](https://img.shields.io/readthedocs/whitebird-api)](https://whitebird-api.readthedocs.io)
+
+Unofficial Python client for the [Whitebird](https://whitebird.io) crypto exchange API, sync and
+async, fully typed.
+
+Covers market data, exchange and spot trading, deposits and withdrawals, payment cards,
+brokerage, ICO tokens, KYC, notifications and account settings.
+
+```sh
+pip install whitebird-api
+pip install "whitebird-api[otp]"   # TOTP codes for accounts with two-factor authentication
+```
+
+```python
+import os
+
+from whitebird import Whitebird
+from whitebird.otp import TOTP
+
+client = Whitebird(
+    os.environ["WHITEBIRD_USERNAME"],
+    os.environ["WHITEBIRD_PASSWORD"],
+    otp=TOTP(os.environ["WHITEBIRD_TOTP_SECRET"]),
+)
+
+book = client.market.orderbook(symbol="BTCUSDT", limit=5)
+
+# Paginated methods are iterable; pages are fetched as the loop goes.
+for order in client.exchange.orders.history(size=50):
+    print(order.number, order.status)
+
+# Real-time notifications, reconnecting on their own.
+with client.notifications.stream() as events:
+    for event in events:
+        print(event.data.type, event.data.payload)
+```
+
+`AsyncWhitebird` offers the same methods as coroutines, with `async for` over listings and
+streams.
+
+- **Sessions:** the client signs in on the first call that needs it, refreshes the token a minute
+  before it expires and keeps it in a token store (`FileTokenStore` survives restarts);
+  `client.user.logout()` ends the session.
+- **Two-factor codes:** `otp=` takes `TOTP(secret)`, a function returning the current code (one
+  that asks the user keeps the secret out of the program; coroutine functions with
+  `AsyncWhitebird`) or a fixed code. It is asked for a code only when Whitebird wants one.
+- **Captcha:** accounts without two-factor authentication sign in through a slider captcha; pass
+  `captcha=` a function that returns the slider position.
+- **Withdrawals:** when Whitebird refuses an operation for MFA and `otp` is configured, the client
+  obtains the operation MFA token and sends the operation again;
+  `client.confirm_operation("WITHDRAWAL", code)` does it explicitly.
+- **Errors and retries:** `APIError` subclasses carry `status_code`, `error_code`, `sub_status`,
+  `message` and `fields`; network failures raise `TransportError`. Reads are retried after
+  network errors, timeouts and HTTP 429/502/503/504, other requests only when Whitebird surely
+  did not process them (HTTP 429, connection failures).
+- **Escape hatch:** `client.request(service, method, path, ...)` calls endpoints the SDK does not
+  cover yet.
+
+Documentation: <https://whitebird-api.readthedocs.io> ·
+Examples: [`examples/python`](https://github.com/joolertan/whitebird-api/tree/main/examples/python)
+
+This project is not affiliated with Whitebird.

whitebird_api-0.1.1/README.md

@@ -0,0 +1,66 @@
+# whitebird-api
+
+[![PyPI](https://img.shields.io/pypi/v/whitebird-api?label=PyPI)](https://pypi.org/project/whitebird-api/)
+[![Python](https://img.shields.io/pypi/pyversions/whitebird-api)](https://pypi.org/project/whitebird-api/)
+[![Docs](https://img.shields.io/readthedocs/whitebird-api)](https://whitebird-api.readthedocs.io)
+
+Unofficial Python client for the [Whitebird](https://whitebird.io) crypto exchange API, sync and
+async, fully typed.
+
+Covers market data, exchange and spot trading, deposits and withdrawals, payment cards,
+brokerage, ICO tokens, KYC, notifications and account settings.
+
+```sh
+pip install whitebird-api
+pip install "whitebird-api[otp]"   # TOTP codes for accounts with two-factor authentication
+```
+
+```python
+import os
+
+from whitebird import Whitebird
+from whitebird.otp import TOTP
+
+client = Whitebird(
+    os.environ["WHITEBIRD_USERNAME"],
+    os.environ["WHITEBIRD_PASSWORD"],
+    otp=TOTP(os.environ["WHITEBIRD_TOTP_SECRET"]),
+)
+
+book = client.market.orderbook(symbol="BTCUSDT", limit=5)
+
+# Paginated methods are iterable; pages are fetched as the loop goes.
+for order in client.exchange.orders.history(size=50):
+    print(order.number, order.status)
+
+# Real-time notifications, reconnecting on their own.
+with client.notifications.stream() as events:
+    for event in events:
+        print(event.data.type, event.data.payload)
+```
+
+`AsyncWhitebird` offers the same methods as coroutines, with `async for` over listings and
+streams.
+
+- **Sessions:** the client signs in on the first call that needs it, refreshes the token a minute
+  before it expires and keeps it in a token store (`FileTokenStore` survives restarts);
+  `client.user.logout()` ends the session.
+- **Two-factor codes:** `otp=` takes `TOTP(secret)`, a function returning the current code (one
+  that asks the user keeps the secret out of the program; coroutine functions with
+  `AsyncWhitebird`) or a fixed code. It is asked for a code only when Whitebird wants one.
+- **Captcha:** accounts without two-factor authentication sign in through a slider captcha; pass
+  `captcha=` a function that returns the slider position.
+- **Withdrawals:** when Whitebird refuses an operation for MFA and `otp` is configured, the client
+  obtains the operation MFA token and sends the operation again;
+  `client.confirm_operation("WITHDRAWAL", code)` does it explicitly.
+- **Errors and retries:** `APIError` subclasses carry `status_code`, `error_code`, `sub_status`,
+  `message` and `fields`; network failures raise `TransportError`. Reads are retried after
+  network errors, timeouts and HTTP 429/502/503/504, other requests only when Whitebird surely
+  did not process them (HTTP 429, connection failures).
+- **Escape hatch:** `client.request(service, method, path, ...)` calls endpoints the SDK does not
+  cover yet.
+
+Documentation: <https://whitebird-api.readthedocs.io> ·
+Examples: [`examples/python`](https://github.com/joolertan/whitebird-api/tree/main/examples/python)
+
+This project is not affiliated with Whitebird.

whitebird_api-0.1.1/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+name = "whitebird-api"
+dynamic = ["version"]
+description = "Unofficial Whitebird API client"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+keywords = ["whitebird", "crypto", "cryptocurrency", "exchange", "trading", "api", "client", "sdk"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = ["httpx>=0.27", "pydantic>=2.11", "typing-extensions>=4.12"]
+
+[project.optional-dependencies]
+otp = ["pyotp>=2.9"]
+
+[project.urls]
+Homepage = "https://github.com/joolertan/whitebird-api"
+Repository = "https://github.com/joolertan/whitebird-api"
+Documentation = "https://whitebird-api.readthedocs.io"
+Issues = "https://github.com/joolertan/whitebird-api/issues"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13",
+    "pyotp>=2.9",
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "respx>=0.21",
+    "ruff==0.17.4",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/whitebird/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/whitebird"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "RUF", "D", "N", "PT", "PL", "C4", "PIE", "RET"]
+ignore = ["D105", "D107", "PLR0911", "PLR0913", "PLR2004"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["whitebird"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D", "PLC0415"]
+# API values quoted in docstrings can be Cyrillic.
+"src/whitebird/_generated/**" = ["RUF002"]
+
+[tool.mypy]
+strict = true
+files = ["src", "tests", "../examples/python"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+filterwarnings = ["error"]

whitebird_api-0.1.1/src/whitebird/__init__.py

@@ -0,0 +1,78 @@
+"""Unofficial client of the Whitebird crypto exchange API.
+
+Examples:
+    ```python
+    from whitebird import Whitebird
+
+    with Whitebird("me@example.com", "password") as client:
+        print(client.brokerage.subaccounts.me())
+    ```
+"""
+
+from ._client import AsyncWhitebird, Whitebird
+from ._exceptions import (
+    APIError,
+    AuthenticationError,
+    BadRequestError,
+    CaptchaRequiredError,
+    ConflictError,
+    MFARequiredError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    ServerError,
+    TransportError,
+    VerificationRequiredError,
+    WhitebirdError,
+)
+from ._generated.services import Environment
+from ._version import __version__
+from .pagination import AsyncPager, Page, SyncPager
+from .streaming import AsyncEventStream, EventStream, ServerSentEvent
+from .tokens import FileTokenStore, MemoryTokenStore, Tokens, TokenStore
+from .types import (
+    AsyncCaptchaSolver,
+    AsyncCodeProvider,
+    Captcha,
+    CaptchaSolver,
+    CodeProvider,
+    FileContent,
+    RequestOptions,
+)
+
+__all__ = [
+    "APIError",
+    "AsyncCaptchaSolver",
+    "AsyncCodeProvider",
+    "AsyncEventStream",
+    "AsyncPager",
+    "AsyncWhitebird",
+    "AuthenticationError",
+    "BadRequestError",
+    "Captcha",
+    "CaptchaRequiredError",
+    "CaptchaSolver",
+    "CodeProvider",
+    "ConflictError",
+    "Environment",
+    "EventStream",
+    "FileContent",
+    "FileTokenStore",
+    "MFARequiredError",
+    "MemoryTokenStore",
+    "NotFoundError",
+    "Page",
+    "PermissionDeniedError",
+    "RateLimitError",
+    "RequestOptions",
+    "ServerError",
+    "ServerSentEvent",
+    "SyncPager",
+    "TokenStore",
+    "Tokens",
+    "TransportError",
+    "VerificationRequiredError",
+    "Whitebird",
+    "WhitebirdError",
+    "__version__",
+]