trading-cli 0.3.0__tar.gz

trading_cli-0.3.0/EXCHANGES.md

@@ -0,0 +1,398 @@
+# FastBooks Exchange API Reference
+
+Detailed per-exchange documentation for the FastBooks CLI. Each exchange has specific requirements, supported features, and configuration notes.
+
+---
+
+## Binance
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot, Perpetual Futures (USDT-M, COIN-M)
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+- **Testnet:** Available (`--testnet` flag)
+
+### Setup
+```bash
+fastbooks wallet add binance --api-key YOUR_KEY --api-secret YOUR_SECRET
+fastbooks wallet add binance --api-key YOUR_KEY --api-secret YOUR_SECRET --testnet  # testnet
+fastbooks wallet test binance
+```
+
+### Supported Operations
+| Operation | Spot | Perpetual |
+|-----------|------|-----------|
+| Place order (market/limit/stop) | Yes | Yes |
+| Cancel order | Yes | Yes |
+| List orders | Yes | Yes |
+| Get balance | Yes | Yes |
+| Get positions | N/A | Yes |
+| Set leverage | N/A | Yes |
+
+### Symbol Format
+- Spot: `BTC/USDT`, `ETH/USDT`, `SOL/USDT`
+- Perpetual: `BTC/USDT`, `ETH/USDT` (same, auto-detected)
+
+### Notes
+- Rate limits: 1200 requests/minute (order weight varies)
+- Minimum order sizes vary by symbol
+- Leverage range: 1x-125x depending on symbol
+
+---
+
+## Bybit
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot, USDT Perpetual, Inverse Perpetual
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+
+### Setup
+```bash
+fastbooks wallet add bybit --api-key YOUR_KEY --api-secret YOUR_SECRET
+```
+
+### Supported Operations
+| Operation | Spot | Perpetual |
+|-----------|------|-----------|
+| Place order | Yes | Yes |
+| Cancel order | Yes | Yes |
+| List orders | Yes | Yes |
+| Get balance | Yes | Yes |
+| Get positions | N/A | Yes |
+| Set leverage | N/A | Yes |
+
+### Symbol Format
+- Spot: `BTC/USDT`, `ETH/USDT`
+- Perpetual: `BTC/USDT`, `ETH/USDT`
+
+### Notes
+- Unified Trading Account (UTA) supported
+- Leverage range: 1x-100x
+
+---
+
+## OKX
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot, Perpetual Swap, Futures, Options
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+- **Passphrase:** Required (set during API key creation on OKX)
+
+### Setup
+```bash
+fastbooks wallet add okx --api-key YOUR_KEY --api-secret YOUR_SECRET --passphrase YOUR_PASSPHRASE
+```
+
+### Symbol Format
+- Spot: `BTC/USDT`, `ETH/USDT`
+- Swap: `BTC/USDT`, `ETH/USDT`
+
+### Notes
+- Passphrase is **mandatory** — OKX rejects requests without it
+- Supports unified margin mode
+
+---
+
+## Kraken
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot, Perpetual (via Kraken Pro)
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+
+### Setup
+```bash
+fastbooks wallet add kraken --api-key YOUR_KEY --api-secret YOUR_SECRET
+```
+
+### Notes
+- Kraken uses non-standard symbol formats internally (XBT instead of BTC)
+- The CLI normalizes symbols automatically
+
+---
+
+## Coinbase
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot only
+
+### Authentication
+- **API Key:** Required (Advanced Trade API)
+- **API Secret:** Required
+
+### Setup
+```bash
+fastbooks wallet add coinbase --api-key YOUR_KEY --api-secret YOUR_SECRET
+```
+
+### Notes
+- Only spot trading supported
+- Uses Advanced Trade API (not legacy Pro API)
+- No perpetual/futures support
+
+---
+
+## KuCoin
+
+**Type:** Centralized Exchange (CEX)
+**Markets:** Spot only
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+- **Passphrase:** Required
+
+### Setup
+```bash
+fastbooks wallet add kucoin --api-key YOUR_KEY --api-secret YOUR_SECRET --passphrase YOUR_PASSPHRASE
+```
+
+### Notes
+- Passphrase **mandatory** (like OKX)
+- Spot trading only through CLI currently
+
+---
+
+## Hyperliquid
+
+**Type:** On-chain Perpetual DEX (Arbitrum)
+**Markets:** Perpetual only
+
+### Authentication
+- **Private Key:** EVM private key, 64 hex characters (with or without `0x` prefix)
+- No API key/secret needed — transactions are signed with wallet
+
+### Setup
+```bash
+fastbooks wallet add hyperliquid --api-key 0xYOUR_64_CHAR_HEX_PRIVATE_KEY
+# The --api-key flag is used for the private key
+```
+
+### Supported Operations
+| Operation | Status |
+|-----------|--------|
+| Place order (market/limit) | Yes |
+| Cancel order | Limited |
+| Get balance | Limited |
+| Get positions | Limited |
+| Set leverage | Yes |
+
+### Symbol Format
+- Perpetual: `ETH/USDC`, `BTC/USDC`, `SOL/USDC`
+- Uses USDC as quote currency (not USDT)
+
+### Notes
+- **On-chain execution** — all orders are settled on Arbitrum
+- Order prices formatted to 5 significant figures
+- Wallet address derived from private key
+- Supports `Ioc` (immediate-or-cancel for market) and `Gtc` (good-till-cancel for limit)
+- No API rate limits (blockchain throughput limits apply)
+
+---
+
+## Interactive Brokers (IBKR)
+
+**Type:** Traditional Broker
+**Markets:** Stocks, Options, Forex, Futures, Bonds
+
+### Authentication
+- **Gateway:** IB Gateway must be running (ports 4001 paper / 4002 live)
+- **Credentials:** Encrypted with AES-256-GCM via `IBKR_ENCRYPTION_KEY`
+
+### Setup
+```bash
+# 1. Start IB Gateway (via Docker or native)
+# 2. Set encryption key
+export IBKR_ENCRYPTION_KEY=your_base64_encoded_key
+
+# 3. Configure via API (credentials stored encrypted)
+```
+
+### Supported Operations
+| Operation | Status |
+|-----------|--------|
+| Place order (market/limit) | Yes |
+| Cancel order | Limited |
+| Get order | Yes |
+| List orders | Yes |
+| Order history | Yes |
+| Get balance | Yes |
+| Get positions | Yes |
+
+### Symbol Format
+- Stocks: `AAPL`, `MSFT`, `GOOGL`
+- Options: Exchange-specific contract IDs
+- Forex: `EUR/USD`, `GBP/USD`
+
+### Notes
+- Paper trading on port 4001, live on port 4002
+- Requires running IB Gateway or TWS
+- Market hours constraints apply
+- 2FA may be required (handled via IBeam)
+
+---
+
+## Alpaca
+
+**Type:** Traditional Broker (Commission-Free)
+**Markets:** US Stocks, Crypto
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+- **Paper mode:** Use `--sandbox` flag
+
+### Setup
+```bash
+# Paper trading (recommended for testing)
+fastbooks wallet add alpaca --api-key YOUR_KEY --api-secret YOUR_SECRET --sandbox
+
+# Live trading
+fastbooks wallet add alpaca --api-key YOUR_KEY --api-secret YOUR_SECRET
+```
+
+### Supported Operations
+| Operation | Status |
+|-----------|--------|
+| Place order | Yes |
+| Cancel order | Yes |
+| Get order | Yes |
+| List orders | Yes |
+| Get balance | Yes |
+| Get positions | Yes (via balance) |
+
+### Symbol Format
+- Stocks: `AAPL`, `MSFT`, `TSLA`
+- Crypto: `BTC/USD`, `ETH/USD`
+
+### Notes
+- Commission-free stock trading
+- Paper and live API endpoints are different
+- Extended hours trading supported
+- Fractional shares supported
+
+---
+
+## Deribit
+
+**Type:** Centralized Exchange (Derivatives)
+**Markets:** Options, Perpetual
+
+### Authentication
+- **API Key:** Required
+- **API Secret:** Required
+- **Testnet:** Available
+
+### Setup
+```bash
+fastbooks wallet add deribit --api-key YOUR_KEY --api-secret YOUR_SECRET
+fastbooks wallet add deribit --api-key YOUR_KEY --api-secret YOUR_SECRET --testnet
+```
+
+### Current Support
+- Options chain data (`fastbooks markets options BTC`)
+- Options orderbook data
+- Read-only (execution coming soon)
+
+---
+
+## Jupiter (Solana DEX)
+
+**Type:** DEX Aggregator on Solana
+**Markets:** 5000+ Solana tokens
+
+### Authentication
+- Solana wallet required for swaps (read-only data is public)
+
+### Current Support
+- Ticker data via `fastbooks markets tickers --category dex`
+- Token pricing and liquidity data
+- 5000+ tokens with live prices
+
+### Notes
+- Best price routing across Solana DEXs
+- On-chain swap execution planned (requires wallet integration)
+- Uses Jupiter V6 API
+
+---
+
+## Uniswap (Ethereum DEX)
+
+**Type:** Decentralized Exchange (Ethereum)
+**Markets:** 1000+ ERC-20 tokens
+
+### Authentication
+- EVM wallet required for swaps (read-only data is public)
+
+### Current Support
+- Ticker data via `fastbooks markets tickers --category dex`
+- Pool and liquidity data
+
+### Notes
+- Uniswap V3 concentrated liquidity
+- Gas fees apply for on-chain execution
+- Multi-chain support planned (Polygon, Arbitrum, Base)
+
+---
+
+## Polymarket
+
+**Type:** Prediction Market
+**Markets:** Binary prediction events
+
+### Authentication
+- Read-only (no auth needed for market data)
+
+### Current Support
+- Market search and orderbook data
+- YES/NO token pricing
+
+### Usage
+```bash
+fastbooks markets orderbook polymarket "presidential election"
+```
+
+---
+
+## Limitless
+
+**Type:** Prediction Market
+**Markets:** Binary prediction events
+
+### Authentication
+- Read-only
+
+### Usage
+```bash
+fastbooks markets orderbook limitless "some-market-slug"
+```
+
+---
+
+## DEX Aggregation (Additional)
+
+The following DEXs provide ticker data through the aggregated tickers endpoint:
+
+| DEX | Chain | Approx Tokens |
+|-----|-------|---------------|
+| Raydium | Solana | 2000+ |
+| Orca | Solana | 1500+ |
+| SushiSwap | Multi-chain | 2000+ |
+| Curve | Multi-chain | 600+ |
+| GeckoTerminal | Multi-chain | 800+ |
+
+Access via:
+```bash
+fastbooks markets tickers --category dex
+fastbooks --json markets tickers --category dex --limit 100
+```

trading_cli-0.3.0/LICENSE

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

trading_cli-0.3.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include SKILL.md
+include EXCHANGES.md
+include LICENSE
+recursive-include examples *.sh
+recursive-include tests *.py *.md
+global-exclude __pycache__/*
+global-exclude *.py[cod]