MM Flow
FlowScripts

Perfected FlowScript

SCF Bid-Ask Compare

SCF Bid-Ask Compare [Perfected] is indexed as 087_scf_bid_ask_compare.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

17.4 KB

Lines

387

Native Signal Candidates

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

5/5 guarded

Bull Regime

line 337:9

Trigger

(showShapes) && (crossUp)

Value

smoothedComposite

Deps

crossUp:var, showShapes:input

Bear Regime

line 347:9

Trigger

(showShapes) && (crossDn)

Value

smoothedComposite

Deps

crossDn:var, showShapes:input

Extreme Bid

line 357:9

Trigger

(showShapes) && (extremeUp)

Value

smoothedComposite

Deps

extremeUp:var, showShapes:input

Extreme Ask

line 367:9

Trigger

(showShapes) && (extremeDn)

Value

smoothedComposite

Deps

extremeDn:var, showShapes:input

Depth Aligned

line 377:9

Trigger

(showShapes) && (alignStart)

Value

smoothedComposite

Deps

alignStart:var, showShapes:input

087_scf_bid_ask_compare.flowscript

source path: kscripts/perfected/087_scf_bid_ask_compare.flowscript · sha256:5fe21adf3ef570e900ba75b2ec42eae85f7a3d72d9d9c39793c87f5278bd4075

hash verified
//@version=2
// Source: kiyotaka.ai/hub/kscript (original) — Perfected by kScript_Perfection_Engineer

// ============================================================================
// SCF Bid-Ask Compare — Multi-Depth Orderbook Comparison [Perfected]
// Author: SoulzBTC (@SoulzBTC) — Perfected by kScript_Perfection_Engineer
// Tags: FLOW, #orderbook, #liquidity, #microstructure, #OBI, #bidask, #multi-depth
//
// Compares bid and ask volume at multiple orderbook depths (1%, 2.5%, 5%, 10%)
// using depth-weighted composite OBI, bid/ask ratios, regime detection, and
// color-coded alignment signals. Reveals buying/selling pressure imbalances
// and directional conviction across shallow and deep book layers.
//
// FORMULA FOUNDATION:
// 1. Order Book Imbalance (OBI): OBI = (BidVol − AskVol) / (BidVol + AskVol) ∈ [−1, +1]
//    per Cont, Kukanov & Stoikov (2014) and Order Book Filtration (2025).
// 2. Depth-Weighted Composite OBI: Σ w_i × OBI_i / Σ w_i where w_i = decay^(i−1)
//    per Xu, Gould & Howison (2019); multi-level OFI improves prediction.
// 3. Regime Segmentation: Sell-heavy (−1, −1/3), Neutral (−1/3, +1/3),
//    Buy-heavy (+1/3, +1) per Cartea, Donnelly & Jaimungal (2018).
// 4. Bid/Ask Ratio: bids/asks at 1% depth as short-horizon diagnostic
//    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 linearly predicts price changes.
//  • Xu, Gould & Howison (2019), "Multi-Level Order-Flow Imbalance in a Limit
//    Order Book", arXiv:1907.06230. Multi-level OFI with decaying weights.
//  • Gould & Bonart (2016), "Queue Imbalance as a One-Tick-Ahead Price
//    Predictor", Market Microstructure & Liquidity 2(1), 1650006.
//  • Cartea, Donnelly & Jaimungal (2018), "Enhancing Trading Strategies with
//    Order Book Signals", Appl. Math. Finance 25(1), 1–35. Three-regime model.
//  • Order Book Filtration (2025), arXiv:2507.22712. OBI close to ±1 flags
//    directional extremes and predicts short-term returns.
// ============================================================================

define(
    title="SCF Bid-Ask Compare [Perfected]",
    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 OBI", group="Smoothing")

// --- 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")
var alignThresh = input(name="alignThresh", type="number", defaultValue=0.3, label="Alignment Strength Threshold", constraints={min: 0.1, max: 1.0, step: 0.05}, 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 Composite OBI Histogram", 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 showIndividual = input(name="showIndividual", type="boolean", defaultValue=true, label="Show Individual Depth Lines", group="Display")
var showBidAskRatio = input(name="showBidAskRatio", type="boolean", defaultValue=true, label="Show Bid/Ask Ratio (1% depth)", group="Display")
var showAlignment = input(name="showAlignment", type="boolean", defaultValue=true, label="Show Alignment Strength", group="Display")
var lineWidth = input(name="lineWidth", type="number", defaultValue=2, label="Line Width", constraints={min: 1, max: 4, step: 1}, group="Display")
var shapeSize = input(name="shapeSize", type="number", defaultValue=2, label="Shape Size", constraints={min: 1, max: 4, step: 1}, 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 alignColor = input(name="alignColor", type="color", defaultValue="#ffeb3b", label="Alignment 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
if (isnan(px[0])) {
    return
}

// ---------------------------------------------------------------------------
// Order Book Aggregation
// ---------------------------------------------------------------------------
// CRITICAL: Do NOT wrap depth percentages in math.floor() or math.max().
// The kScript API accepts depth as a float percentage (e.g., 1.0 = 1%,
// 2.5 = 2.5%). Research basis: Cont et al. (2014) showed price impact slope
// is inversely proportional to depth; multi-depth bands operationalize this.

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
var bookAvailable = bids1 > 0 && asks1 > 0 && bids2 > 0 && asks2 > 0 && bids3 > 0 && asks3 > 0 && bids4 > 0 && asks4 > 0

// ---------------------------------------------------------------------------
// OBI Computation with Zero-Division Guards
// ---------------------------------------------------------------------------
// OBI = (Bid − Ask) / (Bid + Ask) ∈ [−1, +1]
// Formula from Cont et al. (2014) and Order Book Filtration (2025).

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

var obi1 = bookAvailable && denom1 > 0 ? (bids1 - asks1) / denom1 * 100.0 : 0.0
var obi2 = bookAvailable && denom2 > 0 ? (bids2 - asks2) / denom2 * 100.0 : 0.0
var obi3 = bookAvailable && denom3 > 0 ? (bids3 - asks3) / denom3 * 100.0 : 0.0
var obi4 = bookAvailable && denom4 > 0 ? (bids4 - asks4) / denom4 * 100.0 : 0.0

// Bid/Ask ratio for 1% depth (Gould & Bonart 2016 diagnostic)
var ratio1 = bookAvailable && asks1 > 0 ? bids1 / asks1 : 1.0

// ---------------------------------------------------------------------------
// Depth-Weighted Composite OBI (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 × OBI_i / Σ w_i.

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 compositeOBI = wSum > 0 ? (w1 * obi1 + w2 * obi2 + w3 * obi3 + w4 * obi4) / wSum : 0.0

// ---------------------------------------------------------------------------
// Smoothing (EMA per Cont et al. 2014 noise-reduction)
// ---------------------------------------------------------------------------
var smoothed1 = ema(obi1, smoothLen)
var smoothed2 = ema(obi2, smoothLen)
var smoothed3 = ema(obi3, smoothLen)
var smoothed4 = ema(obi4, smoothLen)
var smoothedComposite = smoothComposite ? ema(compositeOBI, smoothLen) : compositeOBI

// ---------------------------------------------------------------------------
// Regime Detection (Cartea, Donnelly & Jaimungal 2018 three-segment model)
// ---------------------------------------------------------------------------
// Segmented into three regimes:
//   Sell-heavy: OBI ≤ bearThresh
//   Neutral:    bearThresh < OBI < bullThresh
//   Buy-heavy:  OBI ≥ bullThresh

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
}

// ---------------------------------------------------------------------------
// Alignment Detection — Shallow vs Deep Confluence
// ---------------------------------------------------------------------------
// Both depths move in same direction with same sign and sufficient magnitude
var aligned = (smoothed1 > 0 && smoothed4 > 0) || (smoothed1 < 0 && smoothed4 < 0)
var diverge = !aligned
var alignStrength = aligned ? (math.abs(smoothed1) + math.abs(smoothed4)) / 2.0 : 0.0
var strongAlign = aligned && alignStrength > alignThresh * 100.0

// ---------------------------------------------------------------------------
// Static State Tracking (Session-level persistence)
// ---------------------------------------------------------------------------
static lastRegime = 0
static regimeChangeCount = 0
static sessionHighOBI = -999999.0
static sessionLowOBI = 999999.0
static extremeBidCount = 0
static extremeAskCount = 0
static strongAlignCount = 0
static lastBarIndex = 0

var currentBarIndex = bar_index[0]

if (!isnan(currentBarIndex) && currentBarIndex != lastBarIndex) {
    lastBarIndex = currentBarIndex

    if (compositeOBI > sessionHighOBI) {
        sessionHighOBI = compositeOBI
    }
    if (compositeOBI < sessionLowOBI) {
        sessionLowOBI = compositeOBI
    }

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

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

    if (strongAlign) {
        strongAlignCount = strongAlignCount + 1
    }
}

// ---------------------------------------------------------------------------
// Cross Detection (shape triggers)
// ---------------------------------------------------------------------------
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 alignStart = strongAlign && !isnan(smoothedComposite[1]) && !((smoothed1[1] > 0 && smoothed4[1] > 0) || (smoothed1[1] < 0 && smoothed4[1] < 0))

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

// Horizontal guide lines
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 composite OBI as histogram bars (bid/ask pressure visualization)
if (showRawBars) {
    plotBar(
        value=compositeOBI,
        colors=[bidColor, askColor],
        width=1,
        label=["Composite OBI Raw"],
        desc=["Depth-weighted composite OBI histogram (positive=bid, negative=ask)"]
    )
}

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

// Individual depth lines (granular analysis)
if (showIndividual) {
    plotLine(
        value=smoothed1,
        width=1,
        colors=[opacity(bidColor, 60)],
        label=["OBI 1%"],
        desc=["Order Book Imbalance at 1% depth (shallow book, top-of-book)"]
    )
    plotLine(
        value=smoothed2,
        width=1,
        colors=[opacity(bidColor, 45)],
        label=["OBI 2.5%"],
        desc=["Order Book Imbalance at 2.5% depth (near-term liquidity)"]
    )
    plotLine(
        value=smoothed3,
        width=1,
        colors=[opacity(askColor, 45)],
        label=["OBI 5%"],
        desc=["Order Book Imbalance at 5% depth (medium-term absorption)"]
    )
    plotLine(
        value=smoothed4,
        width=1,
        colors=[opacity(askColor, 60)],
        label=["OBI 10%"],
        desc=["Order Book Imbalance at 10% depth (deep book, structural level)"]
    )
}

// Bid/Ask ratio line (1% depth diagnostic, Gould & Bonart 2016)
if (showBidAskRatio) {
    var ratioPct = (ratio1 - 1.0) * 100.0
    plotLine(
        value=ratioPct,
        width=1,
        colors=[bidColor, askColor, neutralColor],
        colorIndex=ratioPct > 5.0 ? 0 : (ratioPct < -5.0 ? 1 : 2),
        label=["Bid/Ask Ratio 1%"],
        desc=["Bid/Ask ratio at 1% depth, centered at 0 (positive = bid heavy)"]
    )
}

// Alignment strength (shallow-deep confluence)
if (showAlignment) {
    var alignSigned = alignStrength * (smoothed1 > 0 ? 1 : -1)
    plotLine(
        value=alignSigned,
        width=1,
        colors=[alignColor],
        label=["Alignment Strength"],
        desc=["Shallow (1%) and deep (10%) depth confluence strength and direction"]
    )
}

// Regime transition shapes — directional signal extraction
if (showShapes) {
    if (crossUp) {
        plotShape(
            value=smoothedComposite,
            shape="triangleup",
            colorIndex=extremeBidColor,
            width=shapeSize + 1,
            label=["Bull Regime"],
            desc=["Composite OBI crossed into bullish regime (buy-heavy)"]
        )
    }
    if (crossDn) {
        plotShape(
            value=smoothedComposite,
            shape="triangledown",
            colorIndex=extremeAskColor,
            width=shapeSize + 1,
            label=["Bear Regime"],
            desc=["Composite OBI crossed into bearish regime (sell-heavy)"]
        )
    }
    if (extremeUp) {
        plotShape(
            value=smoothedComposite,
            shape="diamond",
            colorIndex=extremeBidColor,
            width=shapeSize + 2,
            label=["Extreme Bid"],
            desc=["Extreme bid pressure detected — deep book buy-heavy imbalance"]
        )
    }
    if (extremeDn) {
        plotShape(
            value=smoothedComposite,
            shape="diamond",
            colorIndex=extremeAskColor,
            width=shapeSize + 2,
            label=["Extreme Ask"],
            desc=["Extreme ask pressure detected — deep book sell-heavy imbalance"]
        )
    }
    if (alignStart) {
        plotShape(
            value=smoothedComposite,
            shape="circle",
            colorIndex=alignColor,
            width=shapeSize,
            label=["Depth Aligned"],
            desc=["Shallow and deep book aligned in same direction — strong directional signal"]
        )
    }
}