MM Flow
FlowScripts

Perfected FlowScript

CoinDome: Order Book Delta

CoinDome: Order Book Delta V2 is indexed as 052_coindome_order_book_delta.flowscript. The exact FlowScript is viewable here; chart observe and trading automation use the current mmflow chart/recipe signal proxy until FlowScript v2 transpilation is available.

This exact FlowScript uses the v2 source dialect. It is viewable and connected to the chart/automation proxy, but direct editor execution needs the FlowScript v2 transpiler.

Dialect

flowscript-v2

Compatibility

flowscript-v2-needs-transpile

Position

offchart

Axis

true

Size

18.7 KB

Lines

404

Native Signal Candidates

6 source-level chart marker triggers extracted from guarded FlowScript v2 blocks.

6/6 guarded

Bull Regime

line 344:9

Trigger

(showShapes) && (crossUp)

Value

smoothedComposite

Deps

crossUp:var, showShapes:input

Bear Regime

line 354:9

Trigger

(showShapes) && (crossDn)

Value

smoothedComposite

Deps

crossDn:var, showShapes:input

Extreme Bid

line 364:9

Trigger

(showShapes) && (extremeUp)

Value

smoothedComposite

Deps

extremeUp:var, showShapes:input

Extreme Ask

line 374:9

Trigger

(showShapes) && (extremeDn)

Value

smoothedComposite

Deps

extremeDn:var, showShapes:input

Z+ Extreme

line 384:9

Trigger

(showShapes) && (zExtremeUp)

Value

zScore

Deps

showShapes:input, zExtremeUp:var

Z− Extreme

line 394:9

Trigger

(showShapes) && (zExtremeDn)

Value

zScore

Deps

showShapes:input, zExtremeDn:var

052_coindome_order_book_delta.flowscript

source path: kscripts/perfected/052_coindome_order_book_delta.flowscript · sha256:3933fcc9cbd753546f7a3d93e4ba7b14d9a010804ccd1b4549b6792e336cca07

hash verified
//@version=2
// ============================================================================
// CoinDome: Order Book Delta V2 — Production-Quality Bid-Ask Imbalance Indicator
// Author: CoinDomeDE (@CoinDomeDE)  |  Perfected by: kScript_Perfection_Engineer
// Tags: ADVANCED, #Orderbook, #delta, #orderbookdelta, #coindome, #OBI, #OFI
//
// Multi-level order book delta (bid-ask imbalance) with z-score normalization,
// depth-decaying composite, regime detection, and session-level tracking.
//
// FORMULA FOUNDATION:
// 1. Order Book Delta: Δ = BidVol − AskVol  (absolute volume difference)
// 2. Normalized Delta: ΔN = (BidVol − AskVol) / (BidVol + AskVol)  ∈ [−1, +1]
//    per Order Book Filtration and Directional Signal Extraction (2025).
// 3. Z-Score Normalization: z = (ΔN − μ_ΔN) / σ_ΔN  per Zhao & Palomar (2018)
//    mean-reversion trigger framework. Enables cross-asset comparability.
// 4. Depth-Weighted Composite Delta: Σ w_i × ΔN_i / Σ w_i  where w_i = decay^(i−1)
//    per Xu, Gould & Howison (2019), multi-level OFI with decaying weights.
// 5. Regime Segmentation: Sell-heavy (−1, −1/3), Neutral (−1/3, +1/3),
//    Buy-heavy (+1/3, +1) per Cartea, Donnelly & Jaimungal (2018).
// 6. Queue Imbalance Logic: Logistic regression between queue imbalance and
//    next-tick direction, per Gould & Bonart (2016).
//
// RESEARCH BASIS:
//  • Cont, Kukanov & Stoikov (2014), "The Price Impact of Order Book Events",
//    J. Financial Econometrics 12(1), 47–88. OFI = Σ(E_bid^i − E_ask^i);
//    linear price-impact model; slope ∝ 1/depth. The script's bid-ask delta
//    is a resting-liquidity analog of OFI.
//  • Xu, Gould & Howison (2019), "Multi-Level Order-Flow Imbalance in a Limit
//    Order Book", arXiv:1907.06230. Multi-level OFI with decaying weights.
//    Deeper book levels improve short-horizon prediction.
//  • Gould & Bonart (2016), "Queue Imbalance as a One-Tick-Ahead Price Predictor
//    in a Limit Order Book", Market Microstructure & Liquidity 2(1), 1650006.
//    Queue imbalance predicts next mid-price direction; logistic regression
//    shows significant classification improvement for liquid stocks.
//  • Cartea, Donnelly & Jaimungal (2018), "Enhancing Trading Strategies with
//    Order Book Signals", Appl. Math. Finance 25(1), 1–35. Three-regime
//    segmentation: Sell-heavy (−1,−1/3), Neutral (−1/3,1/3), Buy-heavy (1/3,1).
//    Positive price moves preceded by buy-heavy books.
//  • Order Book Filtration and Directional Signal Extraction (2025, arXiv:2507.22712).
//    OBI as bounded regime indicator; |OBI| → 1 flags directional extremes.
//  • Zhao & Palomar (2018), "Mean-Reverting Portfolio With Budget Constraint".
//    z-score normalization framework: z̄_t = (z_t − μ_z) / σ_z.
// ============================================================================

define(
    title="CoinDome: Order Book Delta V2",
    position="offchart",
    axis=true
)

// ------------------------------------------------------------------------------
// User Inputs — grouped and constrained per production spec
// ------------------------------------------------------------------------------

// --- Depth Configuration ---
var depth1 = input(name="depth1", type="number", defaultValue=1.0, label="Depth Band 1 (%)", constraints={min: 0.1, max: 50.0, step: 0.1}, group="Depth")
var depth2 = input(name="depth2", type="number", defaultValue=2.5, label="Depth Band 2 (%)", constraints={min: 0.1, max: 50.0, step: 0.1}, group="Depth")
var depth3 = input(name="depth3", type="number", defaultValue=5.0, label="Depth Band 3 (%)", constraints={min: 0.1, max: 50.0, step: 0.1}, group="Depth")
var depth4 = input(name="depth4", type="number", defaultValue=10.0, label="Depth Band 4 (%)", constraints={min: 0.1, max: 50.0, step: 0.1}, group="Depth")

var useDepthWeighting = input(name="useDepthWeighting", type="boolean", defaultValue=true, label="Use Depth-Decaying Weights", group="Depth")
var weightDecay = input(name="weightDecay", type="number", defaultValue=0.75, label="Weight Decay Factor", constraints={min: 0.0, max: 1.0, step: 0.05}, group="Depth")

// --- Smoothing ---
var smoothLen = input(name="smoothLen", type="number", defaultValue=5, label="EMA Smoothing Length", constraints={min: 1, max: 50, step: 1}, group="Smoothing")
var smoothComposite = input(name="smoothComposite", type="boolean", defaultValue=true, label="Smooth Composite Delta", group="Smoothing")

// --- Z-Score ---
var useZScore = input(name="useZScore", type="boolean", defaultValue=true, label="Enable Z-Score Normalization", group="Z-Score")
var zScoreWindow = input(name="zScoreWindow", type="number", defaultValue=50, label="Z-Score Lookback Window", constraints={min: 10, max: 200, step: 5}, group="Z-Score")

// --- Thresholds & Regime ---
var bullThresh = input(name="bullThresh", type="number", defaultValue=33.0, label="Bullish Regime Threshold (%)", constraints={min: 10.0, max: 90.0, step: 1.0}, group="Thresholds")
var bearThresh = input(name="bearThresh", type="number", defaultValue=-33.0, label="Bearish Regime Threshold (%)", constraints={min: -90.0, max: -10.0, step: 1.0}, group="Thresholds")
var extremeThresh = input(name="extremeThresh", type="number", defaultValue=66.0, label="Extreme Imbalance Threshold (%)", constraints={min: 50.0, max: 95.0, step: 1.0}, group="Thresholds")

// --- Display ---
var showGuides = input(name="showGuides", type="boolean", defaultValue=true, label="Show Guide Lines", group="Display")
var showRawBars = input(name="showRawBars", type="boolean", defaultValue=true, label="Show Raw Delta Bars", group="Display")
var showShapes = input(name="showShapes", type="boolean", defaultValue=true, label="Show Regime Shapes", group="Display")
var showComposite = input(name="showComposite", type="boolean", defaultValue=true, label="Show Composite Line", group="Display")
var showZScore = input(name="showZScore", type="boolean", defaultValue=true, label="Show Z-Score Line", group="Display")
var showIndividual = input(name="showIndividual", type="boolean", defaultValue=false, label="Show Individual Depth Lines", group="Display")

// --- Colors ---
var bidColor = input(name="bidColor", type="color", defaultValue="#26a69a", label="Bid-Dominant Color", group="Colors")
var askColor = input(name="askColor", type="color", defaultValue="#ef5350", label="Ask-Dominant Color", group="Colors")
var neutralColor = input(name="neutralColor", type="color", defaultValue="#9e9e9e", label="Neutral Color", group="Colors")
var extremeBidColor = input(name="extremeBidColor", type="color", defaultValue="#00e676", label="Extreme Bid Color", group="Colors")
var extremeAskColor = input(name="extremeAskColor", type="color", defaultValue="#ff1744", label="Extreme Ask Color", group="Colors")
var zScoreColor = input(name="zScoreColor", type="color", defaultValue="#ffca28", label="Z-Score Color", group="Colors")

// ------------------------------------------------------------------------------
// Data Sources
// ------------------------------------------------------------------------------
timeseries priceBars = ohlcv(symbol=currentSymbol, exchange=currentExchange)
timeseries px = priceBars.close
timeseries book = source("orderbook", currentSymbol, currentExchange)

// NaN guard — prevent execution before data is loaded (Cont et al. 2014 data-integrity best practice)
if (isnan(px[0])) {
    return
}

// ------------------------------------------------------------------------------
// Order Book Aggregation — Actual L2 depth data
// ------------------------------------------------------------------------------
// CRITICAL BUG FIX: The original script used a synthetic bid/ask proxy based on
// price position within the bar (upW/downW × volume). This is a heuristic that
// confuses trade-flow direction with resting liquidity. The perfected version
// uses actual orderbook depth (sumBids/sumAsks) per the kScript API.
//
// Research basis: Cont, Kukanov & Stoikov (2014) showed that resting depth at
// multiple levels carries independent predictive information. Synthetic proxies
// cannot replicate this structure.

var bids1 = sumBids(book, depth1)
var asks1 = sumAsks(book, depth1)
var bids2 = sumBids(book, depth2)
var asks2 = sumAsks(book, depth2)
var bids3 = sumBids(book, depth3)
var asks3 = sumAsks(book, depth3)
var bids4 = sumBids(book, depth4)
var asks4 = sumAsks(book, depth4)

// Book availability check — prevents NaN/undefined propagation (Gould & Bonart 2016 robustness)
var bookAvailable = bids1 > 0 && asks1 > 0 && bids2 > 0 && asks2 > 0 && bids3 > 0 && asks3 > 0 && bids4 > 0 && asks4 > 0

// ------------------------------------------------------------------------------
// Delta Computation with Zero-Division Guards
// ------------------------------------------------------------------------------
// Delta = BidVol − AskVol (absolute volume difference)
// Normalized Delta = (BidVol − AskVol) / (BidVol + AskVol) ∈ [−1, +1]
// per Order Book Filtration (2025) and Korean Derivatives Association (2015).

var denom1 = bids1 + asks1
var denom2 = bids2 + asks2
var denom3 = bids3 + asks3
var denom4 = bids4 + asks4

var delta1 = bookAvailable ? bids1 - asks1 : 0.0
var delta2 = bookAvailable ? bids2 - asks2 : 0.0
var delta3 = bookAvailable ? bids3 - asks3 : 0.0
var delta4 = bookAvailable ? bids4 - asks4 : 0.0

var deltaN1 = bookAvailable && denom1 > 0 ? (bids1 - asks1) / denom1 * 100.0 : 0.0
var deltaN2 = bookAvailable && denom2 > 0 ? (bids2 - asks2) / denom2 * 100.0 : 0.0
var deltaN3 = bookAvailable && denom3 > 0 ? (bids3 - asks3) / denom3 * 100.0 : 0.0
var deltaN4 = bookAvailable && denom4 > 0 ? (bids4 - asks4) / denom4 * 100.0 : 0.0

// ------------------------------------------------------------------------------
// Depth-Weighted Composite Delta (Xu, Gould & Howison 2019)
// ------------------------------------------------------------------------------
// Multi-level OFI with geometrically decaying weights.
// w_i = decay^(i−1) for i = 1,2,3,4.
// Composite = Σ w_i × ΔN_i / Σ w_i.
// This significantly improves short-horizon prediction vs. top-of-book alone.

var w1 = 1.0
var w2 = useDepthWeighting ? weightDecay : 1.0
var w3 = useDepthWeighting ? weightDecay * weightDecay : 1.0
var w4 = useDepthWeighting ? weightDecay * weightDecay * weightDecay : 1.0

var wSum = w1 + w2 + w3 + w4
var compositeDelta = wSum > 0 ? (w1 * delta1 + w2 * delta2 + w3 * delta3 + w4 * delta4) / wSum : 0.0
var compositeDeltaN = wSum > 0 ? (w1 * deltaN1 + w2 * deltaN2 + w3 * deltaN3 + w4 * deltaN4) / wSum : 0.0

// ------------------------------------------------------------------------------
// Smoothing (EMA per Cont et al. 2014 noise-reduction)
// ------------------------------------------------------------------------------
var smoothed1 = ema(deltaN1, smoothLen)
var smoothed2 = ema(deltaN2, smoothLen)
var smoothed3 = ema(deltaN3, smoothLen)
var smoothed4 = ema(deltaN4, smoothLen)
var smoothedComposite = smoothComposite ? ema(compositeDeltaN, smoothLen) : compositeDeltaN
var smoothedAbsComposite = smoothComposite ? ema(math.abs(compositeDeltaN), smoothLen) : math.abs(compositeDeltaN)

// ------------------------------------------------------------------------------
// Z-Score Normalization (Zhao & Palomar 2018)
// ------------------------------------------------------------------------------
// z = (current − mean) / stddev over rolling window.
// Enables cross-asset comparability and mean-reversion signal detection.

var deltaMean = sma(smoothedComposite, zScoreWindow)
var deltaStd = stdev(smoothedComposite, zScoreWindow)
var zScore = useZScore && deltaStd > 0 ? (smoothedComposite - deltaMean) / deltaStd : 0.0

// ------------------------------------------------------------------------------
// Regime Detection (Cartea, Donnelly & Jaimungal 2018 three-segment model)
// ------------------------------------------------------------------------------
// Segmented into three regimes:
//   Sell-heavy: ΔN ≤ bearThresh
//   Neutral:    bearThresh < ΔN < bullThresh
//   Buy-heavy:  ΔN ≥ bullThresh
// These segments predict future price moves: positive changes preceded by
// buy-heavy books; negative changes by sell-heavy books.

var regime = 0      // 0 = neutral, 1 = bull, -1 = bear
var extremeRegime = 0  // 0 = normal, 1 = extreme bull, -1 = extreme bear

if (smoothedComposite >= bullThresh) {
    regime = 1
} else if (smoothedComposite <= bearThresh) {
    regime = -1
}

if (smoothedComposite >= extremeThresh) {
    extremeRegime = 1
} else if (smoothedComposite <= -extremeThresh) {
    extremeRegime = -1
}

// ------------------------------------------------------------------------------
// Static State Tracking (Session-level persistence)
// ------------------------------------------------------------------------------
// Stateful computation for anchoring, session tracking, and counters.
// Tracks regime transitions, session extremes, and extreme-event counts.

static lastRegime = 0
static regimeChangeCount = 0
static sessionHighDelta = -999999.0
static sessionLowDelta = 999999.0
static extremeBidCount = 0
static extremeAskCount = 0
static lastBarIndex = 0

var currentBarIndex = bar_index[0]

if (!isnan(currentBarIndex) && currentBarIndex != lastBarIndex) {
    // New bar — update session tracking
    lastBarIndex = currentBarIndex

    if (compositeDeltaN > sessionHighDelta) {
        sessionHighDelta = compositeDeltaN
    }
    if (compositeDeltaN < sessionLowDelta) {
        sessionLowDelta = compositeDeltaN
    }

    if (lastRegime != regime) {
        lastRegime = regime
        regimeChangeCount = regimeChangeCount + 1
    }

    if (extremeRegime == 1) {
        extremeBidCount = extremeBidCount + 1
    } else if (extremeRegime == -1) {
        extremeAskCount = extremeAskCount + 1
    }
}

// ------------------------------------------------------------------------------
// Plots — Multiple Visualization Types (Line, Bar, Shape, Fill, HLine)
// ------------------------------------------------------------------------------

// Horizontal guide lines — zero line and configurable threshold zones
hline(value=0, color="#ffffff30", width=1)

if (showGuides) {
    hline(value=bullThresh, color=opacity(bidColor, 30), width=1)
    hline(value=bearThresh, color=opacity(askColor, 30), width=1)
    hline(value=extremeThresh, color=opacity(extremeBidColor, 20), width=1)
    hline(value=-extremeThresh, color=opacity(extremeAskColor, 20), width=1)
}

// Raw normalized composite delta as color-coded histogram bars
if (showRawBars) {
    plotBar(
        value=smoothedComposite,
        colors=[bidColor, askColor, neutralColor],
        colorIndex=regime == 1 ? 0 : (regime == -1 ? 1 : 2),
        width=1,
        label=["Composite Delta"],
        desc=["Depth-weighted composite normalized delta (positive=bid, negative=ask). Regime-coded."]
    )
}

// Smoothed composite line with regime-coded fill area
if (showComposite) {
    plotLine(
        value=smoothedComposite,
        width=2,
        colors=[bidColor, askColor, neutralColor],
        colorIndex=regime == 1 ? 0 : (regime == -1 ? 1 : 2),
        label=["Composite Delta"],
        desc=["Depth-weighted composite normalized delta (EMA-smoothed). Regime: bull/bear/neutral."],
        fill=true
    )
}

// Z-Score line (cross-asset comparable mean-reversion signal)
if (showZScore && useZScore) {
    plotLine(
        value=zScore,
        width=1,
        colors=[zScoreColor],
        label=["Z-Score"],
        desc=["Rolling z-score of composite delta. |z| > 2 flags statistically extreme imbalance."]
    )
}

// Individual depth lines (optional, for granular analysis)
if (showIndividual) {
    plotLine(
        value=smoothed1,
        width=1,
        colors=[opacity(bidColor, 50)],
        label=["Delta 1%"],
        desc=["Normalized delta at 1% depth (shallow book, top-of-book)"]
    )
    plotLine(
        value=smoothed2,
        width=1,
        colors=[opacity(bidColor, 40)],
        label=["Delta 2.5%"],
        desc=["Normalized delta at 2.5% depth (near-term liquidity)"]
    )
    plotLine(
        value=smoothed3,
        width=1,
        colors=[opacity(askColor, 40)],
        label=["Delta 5%"],
        desc=["Normalized delta at 5% depth (medium-term absorption)"]
    )
    plotLine(
        value=smoothed4,
        width=1,
        colors=[opacity(askColor, 50)],
        label=["Delta 10%"],
        desc=["Normalized delta at 10% depth (deep book, structural level)"]
    )
}

// Regime transition shapes — directional signal extraction (Cartea et al. 2018)
if (showShapes) {
    var crossUp = smoothedComposite >= bullThresh && !isnan(smoothedComposite[1]) && smoothedComposite[1] < bullThresh
    var crossDn = smoothedComposite <= bearThresh && !isnan(smoothedComposite[1]) && smoothedComposite[1] > bearThresh
    var extremeUp = smoothedComposite >= extremeThresh && !isnan(smoothedComposite[1]) && smoothedComposite[1] < extremeThresh
    var extremeDn = smoothedComposite <= -extremeThresh && !isnan(smoothedComposite[1]) && smoothedComposite[1] > -extremeThresh
    var zExtremeUp = useZScore && zScore >= 2.0 && !isnan(zScore[1]) && zScore[1] < 2.0
    var zExtremeDn = useZScore && zScore <= -2.0 && !isnan(zScore[1]) && zScore[1] > -2.0

    if (crossUp) {
        plotShape(
            value=smoothedComposite,
            shape="triangleup",
            color=extremeBidColor,
            width=3,
            label=["Bull Regime"],
            desc=["Composite delta crossed into bullish regime (buy-heavy)"]
        )
    }
    if (crossDn) {
        plotShape(
            value=smoothedComposite,
            shape="triangledown",
            color=extremeAskColor,
            width=3,
            label=["Bear Regime"],
            desc=["Composite delta crossed into bearish regime (sell-heavy)"]
        )
    }
    if (extremeUp) {
        plotShape(
            value=smoothedComposite,
            shape="diamond",
            color=extremeBidColor,
            width=4,
            label=["Extreme Bid"],
            desc=["Extreme bid pressure detected — deep book buy-heavy imbalance"]
        )
    }
    if (extremeDn) {
        plotShape(
            value=smoothedComposite,
            shape="diamond",
            color=extremeAskColor,
            width=4,
            label=["Extreme Ask"],
            desc=["Extreme ask pressure detected — deep book sell-heavy imbalance"]
        )
    }
    if (zExtremeUp) {
        plotShape(
            value=zScore,
            shape="flag",
            color=extremeBidColor,
            width=3,
            label=["Z+ Extreme"],
            desc=["Z-score extreme: statistically unusual buy-heavy imbalance (z ≥ 2)"]
        )
    }
    if (zExtremeDn) {
        plotShape(
            value=zScore,
            shape="flag",
            color=extremeAskColor,
            width=3,
            label=["Z− Extreme"],
            desc=["Z-score extreme: statistically unusual sell-heavy imbalance (z ≤ −2)"]
        )
    }
}