Skip to main content

Trading Bot SDK for StockAPIs - Build custom trading bots with ease

Project description

stockapis-bot

Python SDK for building trading bots with StockAPIs platform.

Features

  • gRPC streaming for real-time signals from Django
  • Binance Futures testnet/live trading
  • Redis pub/sub for event handling
  • Telegram channel signal extraction

Install

pip install stockapis-bot

Environment

# Binance TESTNET
BINANCE__API_KEY=your_testnet_api_key
BINANCE__API_SECRET=your_testnet_api_secret
BINANCE__TESTNET=true

# Django gRPC
GRPC__HOST=localhost
GRPC__PORT=50051
GRPC__API_KEY=dev-key

# Redis
REDIS__HOST=localhost
REDIS__PORT=6379
REDIS__CHANNEL=trading_signals

# Telegram Spy
TELEGRAM__API_ID=123456
TELEGRAM__API_HASH=your_api_hash
TELEGRAM__SESSION=1BQA...          # from `telegram-spy auth`
TELEGRAM__CHANNELS=channel1,channel2

Quick Start

from stockapis_bot import BotClient, ClientConfig, TradingBot, TradingSignal, SignalDecision

class MyBot(TradingBot):

    async def on_signal(self, signal: TradingSignal) -> SignalDecision:
        """Main handler - called for each signal."""
        if signal.confidence < 0.7:
            return SignalDecision.skip("Low confidence")

        # Calculate quantity from USDT amount
        qty = await self.calculate_quantity(signal.symbol, usdt_amount=100, leverage=10)

        if signal.is_buy_signal:
            return SignalDecision.buy(qty, "High confidence buy")
        elif signal.is_sell_signal:
            return SignalDecision.sell(qty, "High confidence sell")

        return SignalDecision.skip("Unknown signal")

    # Lifecycle hooks
    async def on_start(self) -> None:
        print(f"Bot {self.name} started")

    async def on_stop(self, reason: str) -> None:
        print(f"Bot stopped: {reason}")

    async def on_config_update(self, config) -> None:
        print(f"Config updated: active={config.active}")

# Run
bot = MyBot(bot_id="my-bot", name="My Bot")
config = ClientConfig.from_settings(bot_id="my-bot", bot_name="My Bot")
client = BotClient.create(bot, config)
await client.run()

Bot Methods

# Trading
await self.buy(symbol, quantity)
await self.sell(symbol, quantity, reduce_only=True)

# Market data
ticker = await self.get_ticker("BTCUSDT")  # ticker.price
balance = await self.get_balance()          # balance.available_usdt

# Utils
qty = await self.calculate_quantity(symbol, usdt_amount=100, leverage=10)
await self.set_leverage(symbol, leverage=20)

# State
self.is_running    # bool
self.is_active     # bool (running + config.active)
self.config        # BotConfig from Django

CLI

Command Description Args
telegram-spy auth Generate session string -i API_ID -h API_HASH
telegram-spy test Test session validity -i API_ID -h API_HASH -s SESSION
telegram-spy channels List your channels -i API_ID -h API_HASH -s SESSION
telegram-spy run Run spy → Redis reads from env
telegram-spy send Send test signal BOT__TOKEN env

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stockapis_bot-0.2.0.tar.gz (71.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stockapis_bot-0.2.0-py3-none-any.whl (97.3 kB view details)

Uploaded Python 3

File details

Details for the file stockapis_bot-0.2.0.tar.gz.

File metadata

  • Download URL: stockapis_bot-0.2.0.tar.gz
  • Upload date:
  • Size: 71.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for stockapis_bot-0.2.0.tar.gz
Algorithm Hash digest
SHA256 402c0e54454d585991ad829553fd779d91c8d938bdb0cbea5d1186b886b6d540
MD5 8e31f22ce510527861ea65195e40df33
BLAKE2b-256 b67468c1486d1c7d244d26ae8cea8259c4698dbd28f8d7fb2332394108416a1f

See more details on using hashes here.

File details

Details for the file stockapis_bot-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: stockapis_bot-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 97.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for stockapis_bot-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38492860cd04da70adc1eb128c89afa9b2b1dd4ae8d3caf795cf2593579bdada
MD5 37ce48194e12511d75f4b6b00907fed3
BLAKE2b-256 b43c964f5a730e395bd4a2e9d4b73b488f24f40ca7bc5720e2820e0289bb5bef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page