tradingsignalbot

The Python client for the TradingSignalBot API.

The API is a preview. It is not live yet, so this package holds only the part you need first: verifying the signature of a webhook delivery, so you know an event came from TradingSignalBot and was not changed or replayed. The full client (render a chart from your own levels, register webhooks, read signals) comes here when the sandbox opens. Get early access to get sandbox keys first.

pip install tradingsignalbot

Standard library only (hmac.compare_digest), Python 3.8+, typed.

Verify a delivery

from flask import Flask, request, abort
from tradingsignalbot import verify_webhook, WebhookVerificationError

app = Flask(__name__)

@app.post("/hooks/signals")
def signals():
    try:
        event = verify_webhook(request.get_data(), request.headers.get("TSB-Signature"), SECRET)
    except WebhookVerificationError as e:
        abort(400, e.code)
    return "", 204

Pass the raw body, exactly as it arrived. Parsed and re-serialised JSON will not match.

The scheme

The scheme, as the API page states it:

The repository's test-vectors.json holds the cases both packages are tested against.

Both packages compare in constant time and check every signature and every secret, so a mismatch takes as long as a match.

API

secret can be a list while you rotate it. WebhookVerificationError.code is one of missing_header, bad_header, no_signature, timestamp, mismatch, bad_json.

Licence

MIT. Source and the JavaScript package: github.com/TradingSignalBot/sdk.

Part of the Forexia network: InterestRateDecision.com · Forexia Academy · TradingSignalBot · PropSim · OpenCharts