FVG API
Response and request schema references are described in API schemas.
GET /stats/fvg
Section titled “GET /stats/fvg”Fvg Raw
Parameters
Section titled “Parameters”| Name | In | Required | Type / constraints | Description |
|---|---|---|---|---|
symbol |
query | Yes | {"type": "string"} |
|
timeframe |
query | No | {"type": "string", "default": "15m"} |
Candle TF: ‘1m’,‘5m’,‘10m’,‘15m’,‘30m’,‘1H’,‘1D’,‘1W’ or custom ‘17m’,‘2H’,‘3D’,‘2W’ |
start_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
end_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
time_window |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} |
Relative window (e.g. ‘6M’,‘12M’,‘24M’,‘5Y’) |
start_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
end_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
include_extended_hours |
query | No | {"type": "boolean", "default": false} |
Include pre/post-market data |
max_bars_to_close |
query | No | {"type": "integer", "default": 50} |
0 = no limit; otherwise cap lookahead to N bars |
use_close_prices |
query | No | {"type": "boolean", "default": false} |
Use CLOSE-based touch/fill logic instead of wicks |
include_excursion |
query | No | {"type": "boolean", "default": false} |
Include the available movement profile when supported. |
Responses
Section titled “Responses”{ "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }}GET /stats/fvg/doc
Section titled “GET /stats/fvg/doc”Fvg Doc
Responses
Section titled “Responses”{ "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }}GET /stats/fvg/multi_top
Section titled “GET /stats/fvg/multi_top”Fvg Multi Top
Return the strongest filled/advanced FVGs across multiple symbols, sorted by fill_ratio desc, then bars_to_full_fill asc, then gap_size desc.
Parameters
Section titled “Parameters”| Name | In | Required | Type / constraints | Description |
|---|---|---|---|---|
symbols |
query | Yes | {"type": "string"} |
Comma-separated list of symbols, e.g. AAPL,TSLA,MSFT |
timeframe |
query | No | {"type": "string", "default": "15m"} |
|
limit |
query | No | {"type": "integer", "maximum": 500, "minimum": 1, "default": 50} |
|
start_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
end_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
time_window |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} |
|
start_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
end_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
include_extended_hours |
query | No | {"type": "boolean", "default": false} |
|
max_bars_to_close |
query | No | {"type": "integer", "default": 50} |
0 = no limit; otherwise cap lookahead to N bars |
use_close_prices |
query | No | {"type": "boolean", "default": false} |
Use CLOSE-based touch/fill logic instead of wicks |
Responses
Section titled “Responses”{ "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }}GET /stats/fvg/summary
Section titled “GET /stats/fvg/summary”Fvg Summary
Parameters
Section titled “Parameters”| Name | In | Required | Type / constraints | Description |
|---|---|---|---|---|
symbol |
query | Yes | {"type": "string"} |
|
timeframe |
query | No | {"type": "string", "default": "15m"} |
|
start_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
end_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
time_window |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} |
|
start_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
end_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
include_extended_hours |
query | No | {"type": "boolean", "default": false} |
|
max_bars_to_close |
query | No | {"type": "integer", "default": 50} |
0 = no limit; otherwise cap lookahead to N bars |
use_close_prices |
query | No | {"type": "boolean", "default": false} |
Use CLOSE-based touch/fill logic instead of wicks |
include_excursion |
query | No | {"type": "boolean", "default": false} |
Include the available movement profile when supported. |
Responses
Section titled “Responses”{ "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }}GET /stats/fvg/top
Section titled “GET /stats/fvg/top”Fvg Top
Parameters
Section titled “Parameters”| Name | In | Required | Type / constraints | Description |
|---|---|---|---|---|
symbol |
query | Yes | {"type": "string"} |
|
timeframe |
query | No | {"type": "string", "default": "15m"} |
|
direction |
query | No | {"type": "string", "default": "bullish"} |
‘bullish’ or ‘bearish’ |
limit |
query | No | {"type": "integer", "maximum": 100, "minimum": 1, "default": 5} |
|
start_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
end_date |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
YYYY-MM-DD |
time_window |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}], "default": "12M"} |
|
start_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
end_time |
query | No | {"anyOf": [{"type": "string"}, {"type": "null"}]} |
UTC HH:MM (intraday only). If omitted, session-aware defaults are used. |
include_extended_hours |
query | No | {"type": "boolean", "default": false} |
Responses
Section titled “Responses”{ "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }}