AlgoWay JSON Schema Definition

AlgoWay JSON Schema Definition

This document defines required and optional fields used in AlgoWay webhook alerts. The schema ensures consistent interpretation of TradingView and external integrations.

Required Fields (4)

  • platform_name — text identifier defining which trading platform handles the order.
    Example values: metatrader5, dxtrade, matchtrader, binance, bybit, capitalcom, bitget, okx, capitalcom, capitalcom, capitalcom, capitalcom, capitalcom, capitalcom.
    ⚠️ This field is automatically inserted by the server based on webhook configuration. The sender must never define it manually.
  • ticker — trading symbol such as EURUSD, BTCUSDT, or XAUUSD. Defines the market instrument. Always mandatory.
  • order_contracts — numeric value for trade size or volume. Must be convertible to a floating-point number. Typically derived from upstream fields like qty, Q, risk, or volume.
  • order_action — defines order direction.
    Allowed keywords: buy, sell, flat.
    Normalization rules:
    • long → buy
    • short → sell
    • close → flat

Optional Fields

  • stop_loss — numeric distance (points or pips). Usually a small integer < 1000.
  • take_profit — numeric distance (points or pips), same interpretation as stop_loss.
  • sl_price — absolute price level for stop loss (e.g., 1.0845 or any value >1000).
  • tp_price — absolute price level for take profit.
  • price — explicit execution price if present in alert.
  • trailing_pips — numeric trailing-step value (for trailing stop logic). Extracted from fields such as trailstep or TS.
  • comment — free text field for user notes, labels, or EA magic number.

All optional fields are omitted if not provided. Empty strings are converted to null and ignored. Any value that cannot be parsed as a number in numeric fields triggers a validation failure.

Platforms Supporting trailing_pips

  • ✅ Binance Futures — trailing value sent directly to API at order creation.
  • ✅ Bybit Futures — supports native trailing-stop parameter.
  • ✅ Bitget Futures — native trailing stop supported; handler sends trailing_pips with order.
  • ✅ Capital.com — field interpreted and added to order options.
  • ✅ DxTrade — supports dynamic trailing, field parsed and transmitted.
  • ✅ Match-Trader — accepts trailing distance; passed when non-zero.

Platforms Ignoring trailing_pips

  • ❌ cTrader — no webhook-level trailing; handled on broker side.
  • ❌ OKX, MEXC, BitMart — trailing not implemented in current handlers.

Summary: Only crypto and CFD connectors (Binance, Bybit, Bitget, Capital.com, DxTrade, Match-Trader) process trailing_pips. Others either delegate trailing to EA or safely ignore the field.