stx-python 0.6.0__py3-none-any.whl

stx_python-0.6.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,24 @@
+stx/__init__.py,sha256=MAL0HwyAymbYuywOpc5h6xzwWJAqYQTqz6clAYNRqdY,1572
+stx/_async_client.py,sha256=ptM-qY8uofbP_BGfJgHh3oYvxQiGXtApIOUQxR8EZ24,35016
+stx/_base.py,sha256=hVtML3jZVnPLakq9yfgqilwthwoqSyytOy8iMGJ0Uvc,2500
+stx/_client.py,sha256=3xSPt31QgVJwRUEAUOF5x9Y0tNIGUgdomTO6fkABcxE,17990
+stx/_config.py,sha256=FK6psgOM7-fY0zrl3VHFxdpdm1FS6PJ9lVm_zQRQ46E,3801
+stx/_http.py,sha256=zSRbLtobI6v6oR2gzlqXcCDqHV1aa7spfeZQE8LHoiI,4536
+stx/_money.py,sha256=dQYk8cWl7hYje-hhf-3Gtkg6g6piz2HXpuC5IaoG76s,4520
+stx/_operations.py,sha256=8SqtczgIA4iT0FUUoSpOzVd0-QVgPRvtqYgUSoRTw3k,7135
+stx/_paging.py,sha256=f7hkPfwtwdrq_D8kvkEk7RH3O_tuS_CJvM3O4x5WlQ4,1695
+stx/_results.py,sha256=KrQE_jMZFyMNo3CCZ7v_zFOz5t5UPMV8vBi5iibcmKM,813
+stx/_retry.py,sha256=NCOd7mWchlGiDa5YSMJ3VZDX53Mcuh3mOM1a5s64uJ4,2793
+stx/_settings.py,sha256=RgjDSYFBLyV_dEaC1KFEhKAkOyhcv8voUIHZXnb3kzY,7026
+stx/_signing.py,sha256=9q_W9ke-ZPO0zO3PHmtAZFwtkdt5AHgmfcRC_8xxFYw,8368
+stx/_version.py,sha256=ccXu7DcvraXp5p7HfCR-fOyecMRd_e6QevT-JF9PayE,365
+stx/_ws.py,sha256=WCeUkmpXfz6JON-ZOSmaio_gbID2tAAh15iMoOTC9CE,40751
+stx/enums.py,sha256=-Mx-96ZSJRqYPIHm4kBa6kX00o6kMvH2ND9MJEsGq1I,228
+stx/exceptions.py,sha256=UKDurLbZHzl52rxrk_MbpRK4AIyystbcKKqezGrCwtQ,5071
+stx/models.py,sha256=pzMvi_gR0CtVrxBU0jf1wgl5OAjCWV9flYPKH9hvCbM,69455
+stx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stx_python-0.6.0.dist-info/licenses/LICENSE,sha256=BO8tXq5Nk15qHHQSnCUFtwowziyPRQ7FGmQwGMg4Lmk,1060
+stx_python-0.6.0.dist-info/METADATA,sha256=OcjuIMV5OXYNXmvkrzh7ckUne8gfBebUZ1JOH808kUU,5151
+stx_python-0.6.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+stx_python-0.6.0.dist-info/top_level.txt,sha256=AAtWAp9b91wbzJ9LNEybit6Wu3j634-xaYGeE5C18Ow,4
+stx_python-0.6.0.dist-info/RECORD,,

stx_python-0.6.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

stx_python-0.6.0.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+stx