market-client (Python)
High-level async Python client for the new Market bridge server (server/). The client hides HTTP and WebSocket details, logs in via /login, and exposes ergonomic helpers for common operations (symbols, book, orders, candles) plus simple streaming hooks for market data and per-user unicast events.
Key features:
- Performs
/loginand reuses the session cookie automatically for subsequent REST calls. - Async helpers for
/symbols,/book/{sym},/order.place,/order.cancel,/orders,/order.history,/portfolio, and/candles. - Optional MD (
/ws/md) and unicast (/ws/unicast) WebSocket listeners with simple hook registration. - Lightweight in-memory ring buffer that records unicast events; configurable capacity plus helper methods to inspect or clear the buffer.
Install
This package depends on httpx and websockets.
Editable install for local development:
python3 -m venv .venv
. .venv/bin/activate
pip install -e ./market-client
Or install the runtime requirements directly:
pip install httpx>=0.24 websockets>=10
Quickstart
import asyncio
from market_client import MarketClient
async def main():
client = MarketClient("http://localhost:8000")
await client.login() # obtains gw_uid cookie + user/session ids
symbols = await client.get_symbols()
print("symbols:", [s["sym"] for s in symbols[:3]])
if symbols:
sym = symbols[0]["sym"]
book = await client.get_book(sym, depth=10)
print(sym, "book bids:", book.get("bids", [])[:2])
# Optional streaming hooks
async def on_unicast(evt):
print("unicast:", evt.get("event"))
await client.connect_unicast(on_event=on_unicast)
# Clean up when done
await client.aclose()
asyncio.run(main())
See examples/simple.py for a minimal sample and examples/order_flow.py for a more involved orchestrator that drives several agents concurrently.
API highlights
await MarketClient.connect(base_url, connect_md=False, connect_unicast=False, ...)- Convenience classmethod that instantiates the client, calls
login(), and optionally attaches MD/unicast listeners.
- Convenience classmethod that instantiates the client, calls
await login()->LoginInfo- Performs
POST /loginand storesuser/sessionids for later use (i.e.,/ws/unicast?user=...).
- Performs
- High-level REST helpers (all async):
get_symbols(force_refresh=False)-> list of symbol dictsget_book(sym, depth=20, side="both")-> book snapshot payloadplace_order(...),cancel_order(...),list_orders(),order_history(...)get_portfolio(),get_candles(...)
- Streaming:
connect_md(symbols=None, on_event=None)/disconnect_md()connect_unicast(on_event=None)/disconnect_unicast()set_md_hook(handler)andset_event_hook(handler)register global callbacks invoked for each MD/unicast event before the per-stream handler.
send(op, payload)/api_request(...)- Compatibility helpers that translate well-known ops (e.g.,
symbols.list,book.get,order.place,candles.get,admin.*) into the appropriate REST call. Responses are wrapped in a legacy envelope ({"type":"response","payload":...}) so existing scripts that expect the older format keep working.
- Compatibility helpers that translate well-known ops (e.g.,
- Transactions ring buffer (unicast events only):
configure_transactions(capacity=1000)get_transactions(limit=None)clear_transactions()
Transactions ring buffer example
from market_client import MarketClient
client = MarketClient("http://localhost:8000")
await client.login()
client.configure_transactions(capacity=5000)
def on_unicast(evt):
print("evt:", evt.get("event"))
await client.connect_unicast(on_event=on_unicast)
# Later...
recent = client.get_transactions(limit=100)
client.clear_transactions()
await client.aclose()
Server assumptions
Matches the FastAPI bridge server in server/ with routes:
POST /loginGET /symbolsGET /book/{sym}POST /order.placePOST /order.cancelGET /ordersGET /order.historyGET /portfolioGET /candlesPOST /admin/*(requiresas_role="admin"insend())- WebSockets:
/ws/md?symbols=...,/ws/unicast?user=...
Metadata
Release files for alodenhftmarketclient 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| alodenhftmarketclient-0.1.4.tar.gz | 6.7 kB | Without provenance | Details for alodenhftmarketclient-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alodenhftmarketclient-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for alodenhftmarketclient-0.1.4-py3-none-any.whl |
Total release size: 14.3 kB
Release files / alodenhftmarketclient-0.1.4.tar.gz
| Download URL | alodenhftmarketclient-0.1.4.tar.gz |
|---|---|
| Size | 6.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e65e2cf5c35da8d83c034d81b37954de6f34326fd6943db8452ed16d9f014ae
|
|
BLAKE2b-256 checksum How to use checksums |
29537cb88da1395adb343370ca220be7cc13f5ef8a932bc7cbfdae0b175106bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.9 Darwin/25.0.0
|
Release files / alodenhftmarketclient-0.1.4-py3-none-any.whl
| Download URL | alodenhftmarketclient-0.1.4-py3-none-any.whl |
|---|---|
| Size | 7.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1e93702c164286ff4bd6e69e8924452dc0b3f5f7a5066423bba26d23ba487ee6
|
|
BLAKE2b-256 checksum How to use checksums |
facbf28c2b009b41ad3fd1fc12354770e3ca6f44f41bc24700600f8b7eb12f03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.12.9 Darwin/25.0.0
|
Security for alodenhftmarketclient 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.