stx-python 0.6.0__tar.gz

stx_python-0.6.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 0.6.0 (2026-10-02)
+
+First release on PyPI. Install it with `pip install stx-python`; while 0.6.0 is a release candidate, use `pip install --pre stx-python`.
+
+- `STX` and `AsyncSTX`: a blocking client and an asyncio client for the STX API, with a method for every route (markets, events, orders, fills, positions, balance, per-market account stats and portfolio history). `STX` works inside a program or notebook that already runs an event loop.
+- API-key authentication: every request and the WebSocket handshake are signed with your API key (Ed25519). There is no login call and no session to refresh. Keys come from arguments, `STX_*` environment variables or a profile in `~/.stx/credentials`, and `signer=` accepts a callable for keys held in an HSM or KMS.
+- Built-in environments: select an exchange by name with `region` and `env` (`region="us", env="demo"`; `region="ontario", env="production"`), or point at any host with `host=`.
+- `STXWebSocket`: the documented WebSocket channels on one signed connection: `orderbook`, `ticker`, `trades`, `markets`, `market_stats`, `market_updates`, and your own `orders`, `fills`, `positions`, `settlements`, `balances`, `account` and `user_info`. It handles heartbeats, snapshots, filters, cancel-on-disconnect pings and automatic reconnect with rejoin, and calls `on_reconnect` so you can refresh state.
+- Pagination: list methods return a `Page` with a `cursor`, and each has an `iter_*` twin that walks every page for you.
+- Typed responses: every response is a pydantic model. Money and quantities are strings exactly as the API sends them, never floats.
+- Typed errors (`STXException` and one subclass per failure) and a configurable retry policy. An order is never sent twice after an uncertain failure.
+- Python 3.9 to 3.13. MIT license.
+
+### Changes from the 0.5 alphas
+
+The 0.5 alphas were published to TestPyPI only and used a different API. Code written against them needs to be updated:
+
+- Sign in with an API key instead of an email and password. `login()`, two-factor authentication, token refresh, registration and payments are gone.
+- Methods take plain keyword arguments and return typed models, in place of `params={"input": ...}` and `Selection`/`PRESETS`.
+- `STXWebSocket` joins the documented channels by name, built from your client with `client.websocket()`.
+- Exceptions are named after the failure (`STXAuthenticationException`, `STXRejectedException`, `STXRateLimitException` and so on).
+- `env` accepts `"demo"` and `"production"`. Other deployments are reached with `host=`.
+
+Guides and the API reference: https://docs.stxapp.io/sdks/python/

stx_python-0.6.0/LICENSE

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

stx_python-0.6.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: stx-python
+Version: 0.6.0
+Summary: Official Python SDK for the STX exchange
+Author-email: STX <support@stxapp.io>
+License-Expression: MIT
+Project-URL: Homepage, https://docs.stxapp.io/sdks/python/
+Project-URL: Documentation, https://docs.stxapp.io/sdks/python/
+Project-URL: Changelog, https://docs.stxapp.io/changelog/
+Project-URL: Support, https://docs.stxapp.io/support/
+Keywords: stx,exchange,trading,prediction-market,sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.25
+Requires-Dist: websockets>=12.0
+Requires-Dist: pydantic<3,>=2.0
+Requires-Dist: cryptography>=41.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: python-dotenv>=1.0; extra == "dev"
+Requires-Dist: ruff==0.16.9; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Requires-Dist: pre-commit>=3.5; extra == "dev"
+Requires-Dist: griffe==2.3.0; python_version >= "3.10" and extra == "dev"
+Dynamic: license-file
+
+# stx-python
+
+The official Python SDK for the [STX](https://stxapp.io) exchange.
+
+```bash
+pip install stx-python
+```
+
+Python 3.9 or newer.
+
+## Quickstart
+
+You need an API key for the STX exchange you are building against. [Environments](https://docs.stxapp.io/environments/) lists the exchanges and where to get a key, and [Authentication](https://docs.stxapp.io/sdks/python/authentication/) shows how to give it to the SDK.
+
+```python
+from stx import STX
+
+# Reads your API key and exchange from STX_* environment variables or ~/.stx/credentials.
+with STX() as client:
+    # status "open": markets that have opened for trading (not scheduled, closed or settled).
+    # trading=True: only markets accepting orders right now (an open market can be paused).
+    # limit: markets per page. Looping over page gives this page; client.iter_markets() walks every page.
+    page = client.markets(status="open", trading=True, limit=5)
+
+    for market in page:
+        # bids are what buyers will pay, offers what sellers will accept, best price first.
+        # Prices are dollars per contract, as strings; a winning contract pays market.max_price.
+        bid = market.bids[0].price if market.bids else "-"  # "-" when nobody is bidding
+        offer = market.offers[0].price if market.offers else "-"
+        print(f"{market.event_title}: {market.title}  bid {bid}  offer {offer}")
+```
+
+Sample output:
+
+```text
+New York Yankees at San Diego Padres: Padres First Run  bid -  offer -
+New York Yankees at San Diego Padres: Yankees First Run  bid 0.4200  offer -
+Norfolk State Spartans at Old Dominion Monarchs: Old Dominion Score Last  bid -  offer -
+Norfolk State Spartans at Old Dominion Monarchs: Norfolk St Score Last  bid -  offer -
+Tampa Bay Rays at Philadelphia Phillies: MLB TB @ PHI  bid -  offer -
+```
+
+A bid of `0.4200` on a market whose winning contract pays `1.0000` means a buyer will pay 42 cents for a contract that pays $1 if the Yankees score first.
+
+<details>
+<summary>One market from the response (selected fields)</summary>
+
+```json
+{
+  "market_id": "ddb216af-e752-422c-8688-52f95630b219",
+  "symbol": "STXMLB-26SEP042140NYYSD-ESLAWAYFIRSTRUNNA",
+  "event_title": "New York Yankees at San Diego Padres",
+  "title": "Yankees First Run",
+  "question": "Will New York Yankees score the first run of the game?",
+  "status": "open",
+  "trading": true,
+  "event_start": "2026-09-05T01:40:00.000000Z",
+  "max_price": "1.0000",
+  "last_traded_price": null,
+  "bids": [
+    { "price": "0.4200", "quantity": "5.00" },
+    { "price": "0.2400", "quantity": "4.00" },
+    { "price": "0.2300", "quantity": "2.00" }
+  ],
+  "offers": []
+}
+```
+
+Every market is a `stx.models.Market`; `market.model_dump()` gives you the dict. Every field is described in the [API reference](https://docs.stxapp.io/api/rest/).
+
+</details>
+
+For asyncio, `AsyncSTX` has the same methods to `await`, and `client.websocket()` streams the order book, trades and your own orders, fills and balance.
+
+## Documentation
+
+- [Python SDK guide](https://docs.stxapp.io/sdks/python/)
+- [API reference](https://docs.stxapp.io/api/rest/)
+- [Release notes](https://docs.stxapp.io/changelog/)
+- [Support](https://docs.stxapp.io/support/)
+
+MIT license. Use of the STX API and exchange is subject to the STX terms of use and privacy policy: United States ([terms of use](https://config.stxapp.io/us/terms_of_use.pdf), [privacy policy](https://config.stxapp.io/us/privacy_policy.pdf)), Ontario ([terms of use](https://config.stxapp.ca/on/terms-of-use.pdf), [privacy policy](https://config.stxapp.ca/on/privacy-policy.pdf)).

stx_python-0.6.0/README.md

@@ -0,0 +1,82 @@
+# stx-python
+
+The official Python SDK for the [STX](https://stxapp.io) exchange.
+
+```bash
+pip install stx-python
+```
+
+Python 3.9 or newer.
+
+## Quickstart
+
+You need an API key for the STX exchange you are building against. [Environments](https://docs.stxapp.io/environments/) lists the exchanges and where to get a key, and [Authentication](https://docs.stxapp.io/sdks/python/authentication/) shows how to give it to the SDK.
+
+```python
+from stx import STX
+
+# Reads your API key and exchange from STX_* environment variables or ~/.stx/credentials.
+with STX() as client:
+    # status "open": markets that have opened for trading (not scheduled, closed or settled).
+    # trading=True: only markets accepting orders right now (an open market can be paused).
+    # limit: markets per page. Looping over page gives this page; client.iter_markets() walks every page.
+    page = client.markets(status="open", trading=True, limit=5)
+
+    for market in page:
+        # bids are what buyers will pay, offers what sellers will accept, best price first.
+        # Prices are dollars per contract, as strings; a winning contract pays market.max_price.
+        bid = market.bids[0].price if market.bids else "-"  # "-" when nobody is bidding
+        offer = market.offers[0].price if market.offers else "-"
+        print(f"{market.event_title}: {market.title}  bid {bid}  offer {offer}")
+```
+
+Sample output:
+
+```text
+New York Yankees at San Diego Padres: Padres First Run  bid -  offer -
+New York Yankees at San Diego Padres: Yankees First Run  bid 0.4200  offer -
+Norfolk State Spartans at Old Dominion Monarchs: Old Dominion Score Last  bid -  offer -
+Norfolk State Spartans at Old Dominion Monarchs: Norfolk St Score Last  bid -  offer -
+Tampa Bay Rays at Philadelphia Phillies: MLB TB @ PHI  bid -  offer -
+```
+
+A bid of `0.4200` on a market whose winning contract pays `1.0000` means a buyer will pay 42 cents for a contract that pays $1 if the Yankees score first.
+
+<details>
+<summary>One market from the response (selected fields)</summary>
+
+```json
+{
+  "market_id": "ddb216af-e752-422c-8688-52f95630b219",
+  "symbol": "STXMLB-26SEP042140NYYSD-ESLAWAYFIRSTRUNNA",
+  "event_title": "New York Yankees at San Diego Padres",
+  "title": "Yankees First Run",
+  "question": "Will New York Yankees score the first run of the game?",
+  "status": "open",
+  "trading": true,
+  "event_start": "2026-09-05T01:40:00.000000Z",
+  "max_price": "1.0000",
+  "last_traded_price": null,
+  "bids": [
+    { "price": "0.4200", "quantity": "5.00" },
+    { "price": "0.2400", "quantity": "4.00" },
+    { "price": "0.2300", "quantity": "2.00" }
+  ],
+  "offers": []
+}
+```
+
+Every market is a `stx.models.Market`; `market.model_dump()` gives you the dict. Every field is described in the [API reference](https://docs.stxapp.io/api/rest/).
+
+</details>
+
+For asyncio, `AsyncSTX` has the same methods to `await`, and `client.websocket()` streams the order book, trades and your own orders, fills and balance.
+
+## Documentation
+
+- [Python SDK guide](https://docs.stxapp.io/sdks/python/)
+- [API reference](https://docs.stxapp.io/api/rest/)
+- [Release notes](https://docs.stxapp.io/changelog/)
+- [Support](https://docs.stxapp.io/support/)
+
+MIT license. Use of the STX API and exchange is subject to the STX terms of use and privacy policy: United States ([terms of use](https://config.stxapp.io/us/terms_of_use.pdf), [privacy policy](https://config.stxapp.io/us/privacy_policy.pdf)), Ontario ([terms of use](https://config.stxapp.ca/on/terms-of-use.pdf), [privacy policy](https://config.stxapp.ca/on/privacy-policy.pdf)).

stx_python-0.6.0/pyproject.toml

@@ -0,0 +1,116 @@
+[build-system]
+# setuptools-scm derives the package version from git tags at build
+# time, so we don't have to keep a static `version = "..."` here in
+# sync with the tag we're about to push. One commit can carry multiple
+# tags (`v0.5.0a1`, `v0.5.0rc1`, `v0.5.0`): same source, different
+# wheel labels, without bump commits between each.
+# setuptools>=77 is the first release that understands the SPDX
+# `license = "MIT"` string form (PEP 639) used below.
+requires = ["setuptools>=77.0", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stx-python"
+# `version` is dynamic: read from git via setuptools-scm. See
+# [tool.setuptools_scm] below.
+dynamic = ["version"]
+description = "Official Python SDK for the STX exchange"
+authors = [{ name = "STX", email = "support@stxapp.io" }]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+keywords = ["stx", "exchange", "trading", "prediction-market", "sdk"]
+dependencies = [
+    # REST transport for AsyncSTX and the STX sync wrapper.
+    "httpx>=0.25,<1",
+    # Phoenix channels (STXWebSocket).
+    "websockets>=12.0",
+    # Response models (stx.models).
+    "pydantic>=2.0,<3",
+    # Ed25519 request signing.
+    "cryptography>=41.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Office/Business :: Financial",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://docs.stxapp.io/sdks/python/"
+Documentation = "https://docs.stxapp.io/sdks/python/"
+Changelog = "https://docs.stxapp.io/changelog/"
+Support = "https://docs.stxapp.io/support/"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7",
+    "pytest-asyncio>=0.23",
+    "python-dotenv>=1.0",
+    "ruff==0.16.9",
+    "build>=1.0",
+    "twine>=5.0",
+    "pre-commit>=3.5",
+    # tools/gen_reference.py (the API reference pages); pinned for stable output.
+    "griffe==2.3.0; python_version >= '3.10'",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["stx*"]
+
+[tool.setuptools.package-data]
+stx = ["py.typed"]
+
+[tool.pytest.ini_options]
+python_files = ["test_*.py"]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+markers = [
+    "live: talks to a real STX exchange (tests/e2e)",
+    "prod_readonly: GET-only checks against production (tests/prod)",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+extend-exclude = ["venv", "dist", "build"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "RUF"]
+ignore = [
+    "E501",   # long lines are left to the formatter
+    "UP006",  # typing.List etc. stay readable on 3.9
+    "UP007",  # Optional[...] instead of X | None, for 3.9
+    "UP035",
+    "UP045",
+    "RUF012",
+    "RUF022",
+    "B008",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"stx/models.py" = ["RUF001", "RUF002", "RUF003"]
+
+[tool.ruff.format]
+exclude = ["stx/models.py", "stx/_operations.py"]
+
+[tool.setuptools_scm]
+# When the working tree has a tag at HEAD, that tag is the version.
+# `tag_regex` strips the leading `v` so `v0.5.0a1` becomes `0.5.0a1`
+# in the wheel filename + metadata.
+tag_regex = "^v(?P<version>\\d.*)$"
+# Source-only checkouts without git context (rare; usually only matters
+# if someone downloads a tarball minus .git) get a clearly fake version
+# instead of crashing the build. Real wheels published from CI always
+# build from a tagged commit, so users never see this.
+fallback_version = "0.0.0+nogit"

stx_python-0.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stx_python-0.6.0/stx/__init__.py

@@ -0,0 +1,61 @@
+"""The official Python SDK for the STX exchange.
+
+``AsyncSTX`` and ``STX`` (blocking) make requests; ``STXWebSocket``
+streams the documented channels. Money and quantities are strings exactly
+as the API sends them.
+"""
+
+from stx import models
+from stx._async_client import AsyncSTX
+from stx._client import STX
+from stx._paging import Page
+from stx._results import BatchOrderResult
+from stx._retry import NO_RETRY, RetryPolicy
+from stx._signing import ApiKeyCredentials
+from stx._version import __version__
+from stx._ws import Channel, ChannelMessage, ReconnectPolicy, STXWebSocket
+from stx.enums import Environment, Region
+from stx.exceptions import (
+    STXAPIException,
+    STXAuthenticationException,
+    STXChannelException,
+    STXConfigException,
+    STXException,
+    STXForbiddenException,
+    STXNotFoundException,
+    STXRateLimitException,
+    STXRejectedException,
+    STXServerException,
+    STXTransportException,
+    STXValidationException,
+)
+
+__all__ = [
+    "STX",
+    "AsyncSTX",
+    "STXWebSocket",
+    "Channel",
+    "ChannelMessage",
+    "ReconnectPolicy",
+    "ApiKeyCredentials",
+    "Page",
+    "BatchOrderResult",
+    "RetryPolicy",
+    "NO_RETRY",
+    "models",
+    "Region",
+    "Environment",
+    "STXException",
+    "STXConfigException",
+    "STXAPIException",
+    "STXValidationException",
+    "STXAuthenticationException",
+    "STXForbiddenException",
+    "STXNotFoundException",
+    "STXRejectedException",
+    "STXRateLimitException",
+    "STXServerException",
+    "STXTransportException",
+    "STXChannelException",
+    "__version__",
+]