Integration Guides

import requests
import time

API_URL = "https://api.depthsignal.io"
API_KEY = "your-api-key-here"  # Replace with your key
HEADERS = {"X-API-Key": API_KEY}
SYMBOL = "BTCUSDT"

def get_context_read(symbol):
    """Fetch composite reads and summarize market context."""
    url = API_URL + "/v1/orderbook/composite/" + symbol
    resp = requests.get(url, headers=HEADERS, timeout=10)
    resp.raise_for_status()
    data = resp.json()

    composites = data.get("composites", {})
    direction = composites.get("directional_pressure", 0)
    whale = composites.get("whale_conviction", 0)
    liquidity_risk = composites.get("liquidity_risk", 0)

    if liquidity_risk > 0.7:
        return {"context": "elevated liquidity stress", "reason": "Liquidity conditions are thinner than normal and deserve extra review"}
    if direction > 0.3 and whale > 0.2:
        return {"context": "buy-side pressure skew", "reason": "Directional pressure and larger-size activity are aligned to the same side"}
    if direction < -0.3 and whale < -0.2:
        return {"context": "sell-side pressure skew", "reason": "Directional pressure and larger-size activity are aligned to the same side"}
    return {"context": "mixed context", "reason": "Pressure is mixed and no clean summary stands out"}

# Main loop
while True:
    try:
        read = get_context_read(SYMBOL)
        print("[" + SYMBOL + "] " + read["context"] + ": " + read["reason"])
        # Route the context into your dashboard or review workflow here
    except Exception as e:
        print("Error: " + str(e))
    time.sleep(30)

const API_URL = "https://api.depthsignal.io";
const API_KEY = "your-api-key-here";
const SYMBOLS = ["BTCUSDT", "ETHUSDT", "SOLUSDT", "BNBUSDT", "XRPUSDT"];

async function fetchFeatures(symbol) {
  const url = API_URL + "/v1/orderbook/features/" + symbol;
  const res = await fetch(url, {
    headers: { "X-API-Key": API_KEY }
  });
  if (!res.ok) throw new Error(symbol + ": " + res.status);
  return res.json();
}

async function poll() {
  const results = await Promise.allSettled(
    SYMBOLS.map(s => fetchFeatures(s))
  );
  console.clear();
  console.log("Symbol      | Spread   | SMS    | OFI      | Age(s)");
  console.log("------------|----------|--------|----------|-------");
  results.forEach(function(r, i) {
    if (r.status === "fulfilled") {
      // features is keyed per-exchange; pick binance (or first available)
      var feats = r.value.features || {};
      var d = feats.binance || Object.values(feats)[0] || {};
      var fresh = r.value.data_freshness || {};
      var fr = fresh.binance || Object.values(fresh)[0] || {};
      var age = (fr.age_seconds != null) ? fr.age_seconds : "?";
      console.log(
        SYMBOLS[i].padEnd(12) + "| " +
        (d.bid_ask_spread || 0).toFixed(5).padStart(8) + "| " +
        (d.smart_money_score || 0).toFixed(3).padStart(6) + "| " +
        (d.order_flow_imbalance || 0).toFixed(3).padStart(8) + "| " +
        String(age).padStart(5)
      );
    }
  });
}

// Poll every 10 seconds
setInterval(poll, 10000);
poll();