Skip to main content

Betting trading framework

Project description

flūmine

Build Status Coverage Status PyPI version Downloads

flumine is an open-source, event-based trading framework for sports betting, designed to simplify the development and execution of betting strategies on betting venues. flumine provides efficient handling of data streams, risk management, and execution capabilities.

docs

join betcode slack group (2.5k+ members!)

overview

  • Event-based Execution: Real-time execution of trading strategies based on incoming market events
  • Custom Strategy Implementation: Easily define and implement trading strategies
  • Risk Management: Integrated risk management tools to monitor and limit exposure
  • Modular Design: Easily extendable and customizable components
  • Simulation: Simulate strategies/execution using historical data
  • Paper Trading: Test strategies in a simulated environment before going live
  • Data: Support for market, order and custom streaming data
  • Venues: Multi venue / concurrent venue support

venues

  • Betfair
  • Betconnect (account/execution functionality)
  • Betdaq (account/execution functionality)
  • Smarkets (future)
  • Matchbook (future)
  • Polymarket (future)
  • Kalshi (future)

Backtesting Analysis

Tested on Python 3.9, 3.10, 3.11, 3.12, 3.13 and 3.14.

installation

$ pip install flumine

flumine requires Python 3.9+

setup

Get started...

from flumine import Flumine, BaseStrategy
from betfairlightweight.filters import streaming_market_filter

# Define your strategy here
class ExampleStrategy(BaseStrategy):
    def check_market_book(self, market, market_book) -> bool:
        # process_market_book only executed if this returns True
        return True

    def process_market_book(self, market, market_book):
        # Your strategy logic
        pass

# Initialize the framework
framework = Flumine()

# Add your strategy to the framework
framework.add_strategy(
    ExampleStrategy(
        market_filter=streaming_market_filter(
            event_type_ids=["7"],
            country_codes=["GB"],
            market_types=["WIN"],
        )
    )
)

# Start the trading framework
framework.run()

Example strategy with logic and order execution:

from flumine import BaseStrategy
from flumine.order.trade import Trade
from flumine.order.order import LimitOrder, OrderStatus
from flumine.markets.market import Market
from betfairlightweight.filters import streaming_market_filter
from betfairlightweight.resources import MarketBook


class ExampleStrategy(BaseStrategy):
    def start(self, flumine) -> None:
        print("starting strategy 'ExampleStrategy'")

    def check_market_book(self, market: Market, market_book: MarketBook) -> bool:
        # process_market_book only executed if this returns True
        if market_book.status != "CLOSED":
            return True

    def process_market_book(self, market: Market, market_book: MarketBook) -> None:
        # process marketBook object
        for runner in market_book.runners:
            if runner.status == "ACTIVE" and runner.last_price_traded < 1.5:
                trade = Trade(
                    market_id=market_book.market_id,
                    selection_id=runner.selection_id,
                    handicap=runner.handicap,
                    strategy=self
                )
                order = trade.create_order(
                    side="LAY",
                    order_type=LimitOrder(price=1.01, size=2.00)
                )
                market.place_order(order)

    def process_orders(self, market: Market, orders: list) -> None:
        for order in orders:
            if order.status == OrderStatus.EXECUTABLE:
                if order.size_remaining == 2.00:
                    market.cancel_order(order, 0.02)  # reduce size to 1.98
                if order.order_type.persistence_type == "LAPSE":
                    market.update_order(order, "PERSIST")
                if order.size_remaining > 0:
                    market.replace_order(order, 1.02)  # move


# Initialize the framework
framework = Flumine()

# Add your strategy to the framework
framework.add_strategy(
    ExampleStrategy(
        market_filter=streaming_market_filter(
            event_type_ids=["7"],
            country_codes=["GB"],
            market_types=["WIN"],
        )
    )
)

# Start the trading framework
framework.run()

features

  • Streaming
  • Multiple strategies
  • Multiple clients
  • Order execution
  • Paper trading
  • Simulation
  • Event simulation (multi market)
  • Middleware and background workers to enable Scores / RaceCard / InPlayService

dependencies

flumine relies on these libraries:

  • betfairlightweight - Betfair API support
  • betdaq-retail - BETDAQ API support
  • betconnect - BetConnect API support
  • tenacity - Used for connection retrying (streaming)
  • python-json-logger - JSON logging
  • requests - HTTP support
  • smart-open - Efficient streaming of very large files from/to storages such as S3, including (de)compression

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

flumine-2.13.7.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

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

flumine-2.13.7-py3-none-any.whl (88.1 kB view details)

Uploaded Python 3

File details

Details for the file flumine-2.13.7.tar.gz.

File metadata

  • Download URL: flumine-2.13.7.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for flumine-2.13.7.tar.gz
Algorithm Hash digest
SHA256 3564708fc5007c7ed94961a5cde9280d84253a3e28ae16e91808ca17b6a7eebc
MD5 ad39e3a562108cb9b89f31cc4d6561a1
BLAKE2b-256 398c48bde97f28f63def40a5973bff201c8eb9980e9984683ad0ad085dab146e

See more details on using hashes here.

File details

Details for the file flumine-2.13.7-py3-none-any.whl.

File metadata

  • Download URL: flumine-2.13.7-py3-none-any.whl
  • Upload date:
  • Size: 88.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for flumine-2.13.7-py3-none-any.whl
Algorithm Hash digest
SHA256 05f19de456add9dcc7328e8456e92670ce766bf4a09857574d3b0119c2201bcf
MD5 beb6f441912063264ed5a4db03576721
BLAKE2b-256 9277e0783bd54021f846d6bc83b04949bd13d68773a14fbf20a2c62cb7c15ed6

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