deepalgo-sovereign 0.2.1

Python SDK for the DeepAlgo Sovereign AI Regime API

DeepAlgo Sovereign SDK

Python client for the DeepAlgo Sovereign AI Regime API — institutional-grade regime classification, entry signal quality, and order-flow intelligence across FX, metals, indices, and commodities.

Installation

pip install deepalgo-sovereign

Quick Start

1. Get a free API key

from deepalgo_sovereign import DeepAlgoClient

DeepAlgoClient.enroll("[e-mail]")
# Your API key arrives in your inbox within seconds — no card required.

2. Check a regime

client = DeepAlgoClient(api_key="your_key_here")

regime = client.verify_regime("EUR_USD")
print(regime["is_favorable"])                        # True
print(regime["veto_reason"])                         # None  (or a veto code)
print(regime["metrics"]["regime"])                   # "MEAN_REVERTING"
print(regime["metrics"]["composite_confidence"])     # 0.7843
print(regime["metrics"]["vpin_at_time"])             # 0.31
print(regime["stability_score"])                     # "82.4%"

3. Check entry signal quality

signal = client.get_entry_signal("EUR_USD")
print(signal)
# {
#   "entry_quality": "HIGH",
#   "current_ou_z": 1.42,
#   "ou_z_threshold": 0.75,
#   "recommended_delay_candles": 3,
#   "best_confirmation_signal": "rsi_divergence",
#   "calibrated": True
# }

if signal["entry_quality"] in ("HIGH", "MEDIUM"):
    regime = client.verify_regime("EUR_USD")
    if regime["is_favorable"]:
        # statistically sound entry — proceed
        pass

API Reference

DeepAlgoClient.enroll(email)

Class method. Registers for a free API key — no account creation required. Key is emailed within seconds.

DeepAlgoClient.enroll("[e-mail]")

client.verify_regime(asset, use_tlock=True)

Returns the AI regime verdict for an instrument.

Parameter	Type	Description
asset	str	OANDA instrument name, e.g. "EUR_USD", "XAU_USD"
use_tlock	bool	Enable/disable the third validation layer (default: True)

Response fields:

Field	Type	Description
is_favorable	bool	True if all three locks pass
veto_reason	str | None	Gate that blocked — REGIME_VETO, AI_PROXY_VETO, TRANSFORMER_VETO, ENTROPY_VETO, or None
stability_score	str	Lock 2 neural stability as a percentile, e.g. "82.4%"
divergence	str	Divergence label — "NONE" when regime is clean
metrics.regime	str	HMM state — "MEAN_REVERTING", "TRENDING", "HIGH_VOL"
metrics.composite_confidence	float	Combined confidence after all scalars applied
metrics.entropy	float	Shannon entropy of return distribution (0–1)
metrics.vpin_at_time	float	VPIN at scan time — > 0.80 = predatory flow
metrics.entropy_scalar	float	Confidence multiplier from entropy (1.0 = no reduction)
metrics.vpin_scalar	float	Confidence multiplier from order-flow toxicity
metrics.macro_z_score	float	Z-score vs macro driver spread
metrics.lock3_score	float	Transformer sequence validation score

client.check_lock(instrument, injected_data=None)

Binary EXECUTE / VETO decision. Use this in your order router immediately before placing a trade — reads pre-computed state from Redis so response is sub-millisecond on the server side.

decision = client.check_lock("EUR_USD")
if decision["authorized"]:
    place_order()

Field	Type	Description
authorized	bool	True = EXECUTE, False = BLOCK
decision	str	"EXECUTE" or "BLOCK"
forensics.failed_lock	str	Which lock blocked, or "NONE"
forensics.vpin_toxicity	float	Current VPIN — > 0.75 = toxic
forensics.pip_multiplier	int	Correct pip factor for this instrument
forensics.execution_intelligence.execution_benchmarks.vwap_deviation_bps	float	Distance from VWAP in basis points
forensics.execution_intelligence.capacity_metrics.suggested_max_clip_usd	float	Max recommended trade size

client.get_entry_signal(instrument)

Returns OU-calibrated entry timing quality. Derived from 60-day IC analysis across 76 instruments — identifies whether the current moment is a statistically optimal entry point, not just whether the regime is right.

Field	Type	Description
entry_quality	str	HIGH, MEDIUM, LOW, or NO_DATA
current_ou_z	float	Live OU z-score — deviation from equilibrium in σ
ou_z_threshold	float	Calibrated threshold from IC analysis
recommended_delay_candles	int	Optimal M5 candle wait after signal touch
best_confirmation_signal	str	Highest-IC confirmation signal at optimal lag
calibrated	bool	False if instrument has no calibration data yet

client.validate_sequence(asset, candles)

Runs the full validation stack using 60 M5 candles of OHLCV data.

result = client.validate_sequence("EUR_USD", candles=[...])  # list of 60 OHLCV dicts
# {"is_authorized": True, "verdict": "AUTHORIZED"}

Supported Instruments

The API covers 76+ instruments across four asset classes:

• FX: EUR_USD, GBP_USD, USD_JPY, EUR_JPY, GBP_JPY, AUD_USD, and 30+ major/minor/exotic pairs
• Metals: XAU_USD, XAG_USD, XAU_EUR, XAU_JPY, XAU_AUD
• Indices: SPX500_USD, NAS100_USD, US30_USD, EU50_EUR, DE30_EUR, JP225_USD
• Commodities: NATGAS_USD, SUGAR_USD, WHEAT_USD, SOYBN_USD, CORN_USD

Tier Access

Feature	Free	Professional	Institutional
Instruments	4	15	All 76+
API calls / day	50	Unlimited	Unlimited
verify_regime()	✓	✓	✓
get_entry_signal()	—	✓	✓
OU-calibrated entry timing	—	✓	✓
Institutional order-flow VPIN	—	—	✓
Cross-client Network Intelligence	—	—	✓

Upgrade at gateway.deepalgo.co.uk

Health Check

import requests
r = requests.get("https://api.deepalgo.co.uk/health")
print(r.json())

Support

• Documentation: deepalgo.co.uk
• Email: [e-mail]

---

DeepAlgo Sovereign SDK v0.2.0 — MIT License