Quant Integration Portal
Developer Hub & REST API Specification
Programmatically query mathematical liquidation clusters, Cumulative Volume Delta (CVD) models, High Timeframe levels, and trajectory forecasting patterns to power your automated algorithmic bots and trading strategies.
🛠️ API Request Standards
All API queries are served over SSL. There are two things a token changes, and they are separate: any account— including a free one — unlocks the quant payload (ict, htf, prediction, cvd_markers), while a Pro API Access plan removes the 24-hour delay and raises the rate limit to 300 req/min. Without any token you still get candles and the magnet band, on the delay.
Base Production URL: https://ampeld.com/api
Request Headers:
Authorization: Bearer sl_api_your_token_here
Query Parameter Fallback:
?api_token=sl_api_your_token_here⚡ GET /v1/liquidity
Fetch real-time computed liquidation pools, ICT gaps, daily/weekly key support resistance points, and trajectory path forecasts.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| symbol | string | YES | Ticker symbol to analyze (e.g. BTCUSD, EURUSD, AAPL, SOLUSD). |
| interval | integer | NO | Timeframe mapping: 5 (5m), 15 (15m), 30 (30m), 60 (1h, default), 240 (4h), 1440 (Daily). |
| only_candles | boolean | NO | Return only lightweight candle data with active upper/lower liquidity boundary prices (disables ICT metrics). |
Response Status Reference
200 OK
Request succeeded, returns rich data structure.
200 +
locked — no token, no quant payloadCalls without a recognised token still return 200, but only candles and the magnet band. The
ict, htf, prediction and cvd_markers keys are omitted and a locked object names what is missing. There is deliberately no 401, so check for lockedrather than a status code.An expired key degrades silently
A lapsed Pro key does not error either — it falls back to the 24-hour-delayed tier. Automated clients must read
is_delayed and is_premium on every response, or keep trading on day-old candles without noticing.429 Rate Limited
Exceeded plan allowance (300 req/min for active Pro keys; 60 req/min on the free tier).
📊 Data Schema & Glossary
The API delivers a rich payload structure that feeds directly into quantitative engines. Here is the mathematical explanation of each returned model field:
data[].magnet_up / magnet_down
Active upper and lower stop-loss cluster boundaries, derived from volume profiling and retail disposition dynamics. They describe where the model places concentration, not where price will go. Each element of
data[] also carries time, open/high/low/close, volume, delta, vol_flag, whale, whale_value and vwap with its upper and lower bands.ict.fvgs[]
Fair Value Gaps — price inefficiencies in the candle sequence. Each entry:
type (bullish/bearish), top, bottom, time, mitigated, mitigated_time.ict.obs[]
Order blocks. Each entry:
type (support/resistance), price, time, mitigated, mitigated_time, swept_by_spread, and liquidations[]— the forced-exit ladder as { price, level }, where level 0 is the tightest band.htf.daily / htf.weekly
High-timeframe context. Each is an object, not an array, holding
fvgs[] and obs[] in exactly the same shape as their intraday counterparts above.prediction.historical / .future / .historical_paths
Momentum projection built from volume profile and FVG attraction weighting.
historical and future are { time, value } series; historical_pathsholds past projections for backtesting, each point carrying its origin_timeso you can replay what the model said at the time. This is a geometric projection, not a forecast — see our measured accuracy.cvd_markers[]
Cumulative Volume Delta divergences:
{ time, type }, where type is bullish_div or bearish_div. Per-candle delta itself is on data[].delta.spread / spread_pct · is_delayed / is_premium
The modeled stop-hunt buffer applied around each level, absolute and as a percent of price. The tier flags tell you which data you actually received —
is_delayed is true whenever the response is on the free 24-hour delay, with delay_hours alongside it.▼
▼
🌐Interactive Sandbox ConsoleChoose parameters above, then click the glowing button below to dispatch a mock REST client query and inspect the output schema!
🔑 Free API Demo restricts timeframes and adds delay.
🔒
Rate-Limiting Details: Active Pro API keys allow 300 requests/minute; the free tier is limited to 60 requests/minute. For higher-throughput enterprise access, contact support@ampeld.com.