API documentation

NOTIFY — market watcher bot

NOTIFY is the second service bot: it never trades. It scans the market — one pair or the whole exchange — and sends a notification whenever a pair matches your volume/price filters. It is the API counterpart of the terminal’s “Monitoring” block: the same settings — minimum daily volume (volume.minVal), price change in % (price.percentChange), quote-asset filter (quote), minimum price (price.minVal) and the exchange. Typical uses: catching volume spikes before the crowd, feeding candidates to your own strategy, or just keeping a finger on the market’s pulse without staring at screeners.

Prerequisites: the bot lifecycle. Required fields: type, exchange and timeFrame (ms, minimum 300000) — everything else narrows the scan.

📌 Shape alert: symbol here is a string and optional — omit it and the bot scans all pairs on the exchange that pass the filters. timeFrame is in milliseconds, required per the spec, minimum 300000 (5 minutes) (shapes table).

Verified config — a volume-spike scanner

Watch every USDT pair on Binance Spot; notify when 24h volume is above 5 M USDT and grew by 50%+, while the price is above 0.01 and moved 10%+:

{
  "type": "NOTIFY",
  "settings": {
    "type": "NOTIFY",
    "name": "Volume Spike Scanner",
    "exchange": "binance-spot",
    "quote": "USDT",
    "timeFrame": 900000,
    "volume": { "minVal": 5000000, "percentChange": 50 },
    "price":  { "minVal": 0.01,   "percentChange": 10 }
  }
}

Field reference

Field Type Meaning
exchange string Exchange whose market to scan (data feed)
symbol string Single pair to watch; omit to scan all pairs matching the filters
quote string Scan only pairs quoted in this asset (e.g. "USDT")
volume object {minVal, percentChange} — minimum 24h volume in the quote asset and minimum volume change % (negative allows decreasing volume)
price object {minVal, percentChange} — minimum absolute price and minimum price change %
onetime boolean true — notify once and stop · false — keep monitoring
timeFrame integer (milliseconds) Candle timeframe for the analysis; required, minimum 300000 (5 minutes)
timeout array Lifetime/inactivity rules (shared)
filters object The shared composite filters (incl. blacklist) are available too
name string Display name

All threshold values here are plain JSON numbers — this is scanner configuration, not money (the conventions exception).

Pitfalls

  • No symbol = whole-market scan. Powerful, and noisy if your thresholds are low — start strict, then loosen.
  • volume.percentChange accepts negatives: -30 means «volume may have fallen by up to 30%» — useful for dry-up scans.
  • NOTIFY carries no deposit/orders/stop — it cannot act on what it finds. Pair it with your own logic: a NOTIFY hit → your code creates a bot or an order.
  • timeFrame here is milliseconds and required: minimum 300000 (5 minutes); 900000 = 15 minutes.

Verified against API spec v2.0.0 · 2026-07-12

Cookie Preferences

Manage your cookie preferences below. Necessary cookies are always active as they are essential for the website to function properly.

Strictly Necessary

Essential for the website to function. These cookies cannot be disabled.

Analytics

Help us understand how visitors interact with our website by collecting and reporting information anonymously.

Marketing

Used to track visitors across websites to display relevant advertisements.

Preferences

Allow the website to remember choices you make, such as language or region.