Skip to main content

The prop-firm rule runtime for futures bots — ask before every trade: can this break my prop account?

Project description

algoproven

The prop-firm rule runtime for futures bots. Execution tools send trades — AlgoProven decides whether the next trade is allowed under your exact prop-firm rules. Ask before every order: can this break my prop account?

Pure Python stdlib, no dependencies.

Install

pip install algoproven        # (publishing to PyPI soon)
# from source: cd sdk && pip install -e .

Use

from algoproven import RuleGate

gate = RuleGate()  # -> https://app.algoproven.com

v = gate.check(firm="topstep_50k", symbol="ES", qty=2, stop_ticks=12, room=1000)
print(v["decision"], "-", v["reason"])
# ALLOW - Risk $300 is within $1,000 of room - $700 left after.

# one-liner go/no-go inside your bot's order path:
if not gate.allowed(firm="topstep_50k", symbol="ES", qty=5, stop_ticks=40, room=1000):
    return  # REDUCE or BLOCK — skip the trade

gate.firms()   # -> available presets

Verdicts

decision meaning
ALLOW risk fits the room — take it
REDUCE too big — max_safe_qty tells you the largest safe size
BLOCK no safe size — tighten the stop or skip

Each verdict returns {decision, reason, max_safe_qty, proposed_risk, room, distance_to_breach}.

Inputs

  • firm — preset key (topstep_50k, apex_50k, ffn_50k; see gate.firms())
  • symbolES / MES / NQ / MNQ / MGC / MCL / M6E
  • qty, stop_ticks — the proposed trade; OR pass open_risk (the $ you'd lose if stopped)
  • room — $ left before breach today (daily-loss room or live distance-to-breach). Defaults to the firm's binding line.

Notes

v1 is stateless — it computes on the values you pass, holds no credentials, places no orders. Live account-state binding (real-time distance-to-breach, PayoutLock, multi-account) ships with the AlgoProven cockpit. Rules change weekly; confirm against your firm's official page.

Not affiliated with any prop firm. Not financial advice.

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

algoproven-0.2.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

algoproven-0.2.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for algoproven-0.2.0.tar.gz
Algorithm Hash digest
SHA256 45fd76f075fb4639f8a6b16165be2f2365c74f3b6929fcf40864aa78ad19a776
MD5 43f014c12959e8f1248bf0e79662b0b5
BLAKE2b-256 053fd78bca10a9106ec8d2c5c3fa7dd1fbe0b2e0cddc0dd1b33f32d8fbc25387

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for algoproven-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 802502793b5d43af568c7ebd42031662fc17739b99bcd3957a29a72d377c9acf
MD5 ab573edc2c85e87e7acb06163f2c43b1
BLAKE2b-256 2b82fbb92bb24b17dbe654a01e3fec6e114991937dc6d3d047ac7e179756acab

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