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.1.0.tar.gz (4.0 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.1.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for algoproven-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6cf7f744c8148f41b92a851ad7532d696b3ef0c35bec35fd4e1192edbc65f66c
MD5 ea6098938ad8d3e3190253f948d7c2cb
BLAKE2b-256 a41842783cf1d69ffba7272492705ed7a66a46365f60080278b2514c3d3a68a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: algoproven-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 374ce0a85ef63ce09cc6c964581418d39d2c560786fe9b6a9223845e82d4ee87
MD5 2381600dc7c1431a26b674dad6f1cab0
BLAKE2b-256 6ab30ad2562af70f2a74790e091672ddffb12c48232290880f30dd82f84808f2

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