Python SDK for the DeepAlgo Sovereign AI Regime API
Project description
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("you@email.com")
# 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,
# "regime_label": "MEAN_REVERTING",
# "lock1_pass": True,
# "lock2_pass": True,
# "lock3_pass": True,
# "veto_reason": None
# }
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("you@email.com")
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 active locks pass |
regime_label |
str | MEAN_REVERTING, TRENDING, or NEUTRAL |
lock1_pass |
bool | Regime Classification gate |
lock2_pass |
bool | Structural Noise Filter gate |
lock3_pass |
bool | Sequence Validation gate (only if use_tlock=True) |
veto_reason |
str | None | Reason for veto if is_favorable is False |
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: support@deepalgo.co.uk
DeepAlgo Sovereign SDK v0.2.0 — MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file deepalgo_sovereign-0.2.0.tar.gz.
File metadata
- Download URL: deepalgo_sovereign-0.2.0.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28dbf7992dceb3b5df6b8a4be6723dc41a82965c7ef933f8c27946a716f7037a
|
|
| MD5 |
642132f6ef53acc47316ae68121aa50e
|
|
| BLAKE2b-256 |
792b983b6b1ac635c350c2977cc4081b3c6c30cbfd8166aae53512792611a6a5
|
File details
Details for the file deepalgo_sovereign-0.2.0-py3-none-any.whl.
File metadata
- Download URL: deepalgo_sovereign-0.2.0-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa3e1bdcfe212c44dfc3ac07b1fd96ba9d3ff25d82fb982bf06fcac2f0ab8356
|
|
| MD5 |
33e42ec598f8f8edf7ab47449d092e6f
|
|
| BLAKE2b-256 |
838308ca62bab5c8e29c5124470c7067d3e01261fa87c211ac07e206d0a327ac
|