Metadata-Version: 2.5
Name: ironflow-sdk
Version: 0.6.1
Summary: Deprecated. Use the Ironflow REST API (docs.ironflow.sh) or the MCP server @ironflowsh/mcp for Hyperliquid data.
Project-URL: Homepage, https://ironflow.sh
Project-URL: Documentation, https://docs.ironflow.sh
Project-URL: Support, https://docs.ironflow.sh
Author-email: Ironflow <hello@ironflow.sh>
License: MIT
License-File: LICENSE
Keywords: deprecated,hyperliquid,ironflow,market-data
Classifier: Development Status :: 7 - Inactive
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27
Requires-Dist: websockets>=12
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Description-Content-Type: text/markdown

# ironflow-sdk (deprecated)

This package is no longer maintained. Its code is the same as 0.6.0 (May 2026); 0.6.1 only replaces this README and the package description.

It needs an API key for every data call, and its WebSocket, order status, trigger, deposit, withdrawal and export methods call endpoints that no longer exist.

## Use instead

- **REST API**, no key needed: `curl "https://api.ironflow.sh/v1/candles?market=BTC-PERP&interval=1h"`, or the same URL with `httpx` or `requests`. Docs: [docs.ironflow.sh](https://docs.ironflow.sh)
- **MCP server** for AI agents: `https://mcp.ironflow.sh/mcp`, or locally `npx -y @ironflowsh/mcp`.
- **Ironbox** to test a Hyperliquid trading bot on a paper account: `curl -X POST https://api.ironflow.sh/v1/ironbox`, then pass the `base_url` from the answer to the official `hyperliquid-python-sdk`.

## Current limits

- No key: 30 requests per minute, 300 per day, 24 hours of history.
- Free key from [ironflow.sh/key](https://ironflow.sh/key): 60 requests per minute, 14 days of history.
- x402 pay per call with USDC on Base, from $0.001, no key: [pay per call](https://docs.ironflow.sh/guides/pay-per-call).
- Every Hyperliquid fill since 25 May 2025: native perps, HIP-3, HIP-4 outcome markets and spot.
- Live feeds are Server-Sent Events (`/v1/liquidations/stream`, `/v1/trades/stream`). There is no WebSocket API.

## License

MIT
