Crypto market data, 200 indicators, order flow and a chart link. No account, no API key.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Prepare a price, indicator, chart-drawing, news, calendar or Founder whale-group alert and get a link that sets it in Basis in one click. Use it whenever the person wants to be told when something happens -- a level breaks, RSI crosses 70, price crosses a trend line, a high-impact ETF headline lands, or an event approaches. Pass exactly one of price, conditions, drawingId or eventTrigger. Give the URL as a link and say in one line what it watches. Nothing is armed until they open it and confirm. Market alerts can run in an open tab; background and event alerts require a signed-in Basis account. The link lasts seven days.
What the person sees when it fires. Chosen for you if omitted.
With price. Omit to pick the crossing from where price is now.
How conditions combine. Default all.
Shorthand for a price-level alert.
e.g. BTCUSDT. Defaults to the chart you are building.
Optional note carried into the notification.
ID returned by drawing_add. Supports horizontalLine, horizontalRay, trendLine, ray and extendedLine.
Default once: fires, then switches itself off.
Bars the alert is checked on. Free presets: 1m, 3m, 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M. Founder-only custom intervals: 1–1440 minutes (17m), 1–168 hours (7h), 1–365 days (2d).
Instead of price. Each {left, operator, right}. An operand is a number, a price field ("close"), an indicator name ("rsi", "ema50"), or {"type":"indicator","studyId":"macd","plotKey":"histogram","params":{}}. rising and falling need no right; changeUpPercent and changeDownPercent take a percent.
Instead of market conditions. A news, Basis calendar or Founder whale-group event filter.
With frequency cooldown.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Tool list last changed Oct 23, 2026.
Prepare a price, indicator, chart-drawing, news, calendar or Founder whale-group alert and get a link that sets it in Basis in one click. Use it whenever the person wants to be told when something happens -- a level breaks, RSI crosses 70, price crosses a trend line, a high-impact ETF headline lands, or an event approaches. Pass exactly one of price, conditions, drawingId or eventTrigger. Give the URL as a link and say in one line what it watches. Nothing is armed until they open it and confirm. Market alerts can run in an open tab; background and event alerts require a signed-in Basis account. The link lasts seven days.
| Argument | Type | Description |
|---|---|---|
| name | string | What the person sees when it fires. Chosen for you if omitted. |
| when | string | With price. Omit to pick the crossing from where price is now. |
| match | string | How conditions combine. Default all. |
| price | number | Shorthand for a price-level alert. |
| market | string | |
| symbol | string | e.g. BTCUSDT. Defaults to the chart you are building. |
| message | string | Optional note carried into the notification. |
| exchange | string | |
| drawingId | string | ID returned by drawing_add. Supports horizontalLine, horizontalRay, trendLine, ray and extendedLine. |
| frequency | string | Default once: fires, then switches itself off. |
| timeframe | string | Bars the alert is checked on. Free presets: 1m, 3m, 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M. Founder-only custom intervals: 1–1440 minutes (17m), 1–168 hours (7h), 1–365 days (2d). |
| conditions | array | Instead of price. Each {left, operator, right}. An operand is a number, a price field ("close"), an indicator name ("rsi", "ema50"), or {"type":"indicator","studyId":"macd","plotKey":"histogram","params":{}}. rising and falling need no right; changeUpPercent and changeDownPercent take a percent. |
| eventTrigger | object | Instead of market conditions. A news, Basis calendar or Founder whale-group event filter. |
| cooldownMinutes | number | With frequency cooldown. |
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "What the person sees when it fires. Chosen for you if omitted."
},
"when": {
"enum": [
"crossesAbove",
"crossesBelow",
"above",
"below"
],
"type": "string",
"description": "With price. Omit to pick the crossing from where price is now."
},
"match": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "How conditions combine. Default all."
},
"price": {
"type": "number",
"description": "Shorthand for a price-level alert."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "e.g. BTCUSDT. Defaults to the chart you are building."
},
"message": {
"type": "string",
"description": "Optional note carried into the notification."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"drawingId": {
"type": "string",
"description": "ID returned by drawing_add. Supports horizontalLine, horizontalRay, trendLine, ray and extendedLine."
},
"frequency": {
"enum": [
"once",
"oncePerBar",
"cooldown"
],
"type": "string",
"description": "Default once: fires, then switches itself off."
},
"timeframe": {
"type": "string",
"description": "Bars the alert is checked on. Free presets: 1m, 3m, 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M. Founder-only custom intervals: 1–1440 minutes (17m), 1–168 hours (7h), 1–365 days (2d)."
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator"
],
"properties": {
"left": {},
"right": {},
"operator": {
"enum": [
"crossesAbove",
"crossesBelow",
"above",
"below",
"equal",
"rising",
"falling",
"changeUpPercent",
"changeDownPercent"
],
"type": "string"
}
}
},
"description": "Instead of price. Each {left, operator, right}. An operand is a number, a price field (\"close\"), an indicator name (\"rsi\", \"ema50\"), or {\"type\":\"indicator\",\"studyId\":\"macd\",\"plotKey\":\"histogram\",\"params\":{}}. rising and falling need no right; changeUpPercent and changeDownPercent take a percent."
},
"eventTrigger": {
"type": "object",
"required": [
"type"
],
"properties": {
"side": {
"enum": [
"any",
"long",
"short"
],
"type": "string"
},
"type": {
"enum": [
"news",
"calendar",
"whale"
],
"type": "string"
},
"coins": {
"type": "array",
"items": {
"type": "string"
},
"description": "Whale: exact Hyperliquid coins, preserving HIP-3 prefixes."
},
"assets": {
"type": "array",
"items": {
"type": "string"
},
"description": "News asset symbols, e.g. BTC, ETH."
},
"minUsd": {
"type": "number",
"description": "Whale minimum absolute position change notional; default 50000."
},
"topics": {
"type": "array",
"items": {
"enum": [
"regulation",
"macro",
"security",
"etf",
"stablecoins",
"exchanges",
"defi",
"institutions",
"mining",
"markets"
],
"type": "string"
}
},
"whales": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Founders only: opaque account IDs from founder_whales or founder_whale_research."
},
"actions": {
"type": "array",
"items": {
"enum": [
"opened",
"added",
"reduced",
"closed",
"flipped"
],
"type": "string"
}
},
"sources": {
"type": "array",
"items": {
"type": "string"
}
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "News: literal phrases in title or summary."
},
"together": {
"type": "integer",
"description": "Distinct accounts moving on the same coin and side. Default 1."
},
"minImpact": {
"description": "News: 0-100 score. Calendar: low, medium or high."
},
"titleMode": {
"enum": [
"all",
"any"
],
"type": "string"
},
"categories": {
"type": "array",
"items": {
"enum": [
"macro",
"network",
"derivatives"
],
"type": "string"
}
},
"keywordMode": {
"enum": [
"all",
"any"
],
"type": "string"
},
"leadMinutes": {
"type": "number",
"description": "Calendar: notify this many minutes before the event."
},
"titleContains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Calendar: literal title/description phrases."
},
"windowMinutes": {
"type": "integer",
"description": "Whale concurrence window, 5–1440; default 60."
}
},
"description": "Instead of market conditions. A news, Basis calendar or Founder whale-group event filter."
},
"cooldownMinutes": {
"type": "number",
"description": "With frequency cooldown."
}
}
}Prepare a PRIVATE sharing package of the current chart image, editable analysis and social caption. Only use when asked for something shareable. Returns a private review link, NOT a public link. The person must open it, edit/review and explicitly publish; you cannot publish or post on their behalf. Chart annotations are included. Do not include private account information.
| Argument | Type | Description |
|---|---|---|
| body* | string | Plain-text analysis: evidence, timeframe, venue, data timestamp, alternative scenario and invalidation. Only use verified tool results. Never include account balances, keys or private notes. |
| title* | string | A specific, factual title. No return promises. |
| levels | array | Prices to mark as horizontal lines, or {price, label, color}. |
| market | string | |
| symbol | string | Optional: set the instrument in this call. |
| caption* | string | Editable social caption in the user’s language, ideally under 220 characters for X. Invite discussion, not a trade. Do not add a URL; the review page adds the public link after approval. |
| exchange | string |
Backtest one built-in strategy with one set of parameters. Fills happen at the next bar's open and costs are charged per side. Returns risk-adjusted metrics alongside the raw return — judge on those, not on total return.
| Argument | Type | Description |
|---|---|---|
| ref | string | Reuse a handle from market_candles instead of loading. |
| feeBps | number | Per side. Default 4. |
| market | string | Default: the chart. |
| params | object | |
| symbol | string | Default: the chart. |
| exchange | string | |
| direction | string | |
| timeframe | string | e.g. 1h, 4h. Default: the chart. |
| strategyId* | string | |
| maxBarsHeld | number |
Past calendar dates: FOMC rate decisions, US CPI and non-farm payroll releases from the Fed's and BLS's published calendars (February 2025 on), plus reconstructed conventions (options expiry, CME settlement). Dates only: NOT actual, forecast or previous economic values. No historical funding or halving feed. Use calendar_upcoming for future events.
| Argument | Type | Description |
|---|---|---|
| to | string | A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise. |
| from* | string | A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise. |
{
"type": "object",
"required": [
"from"
],
"properties": {
"to": {
"type": "string",
"description": "A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise."
},
"from": {
"type": "string",
"description": "A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise."
}
}
}Scheduled events ahead: FOMC rate decisions, US CPI and non-farm payrolls from the Fed's and BLS's published calendars, the next funding settlements for a contract, the Bitcoin halving projected from live block height, difficulty retargets, monthly options expiry and CME settlement. Every row states where its date came from — live, an official schedule, a published rule, an estimate, or the user — because a halving projected from block arrival and an expiry fixed by convention are not equally certain. Use it before saying anything about what happens next; nothing else here looks forward.
| Argument | Type | Description |
|---|---|---|
| days | number | Horizon ahead. Default 30, max 365. |
| limit | number | Default 20, max 50. |
| impact | string | Only events at or above this impact. |
| symbol | string | Contract for funding settlements. Defaults to the charted symbol. |
{
"type": "object",
"properties": {
"days": {
"type": "number",
"description": "Horizon ahead. Default 30, max 365."
},
"limit": {
"type": "number",
"description": "Default 20, max 50."
},
"impact": {
"enum": [
"high",
"medium",
"low"
],
"type": "string",
"description": "Only events at or above this impact."
},
"symbol": {
"type": "string",
"description": "Contract for funding settlements. Defaults to the charted symbol."
}
}
}Full detail for one catalogue entry: an indicator's parameters and defaults, a formula function's signature, a strategy's parameters, or drawing anchor order/text/style. Call this before passing parameters you have not seen.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| kind | string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"kind": {
"enum": [
"indicator",
"formula",
"strategy",
"drawing"
],
"type": "string"
}
}
}Search what Basis can do: indicators, formula functions, built-in strategies, the extra series available inside strategy expressions, and the drawing tools with the number of anchors each one takes. This is a catalogue of chart objects, not callable agent functions: use tools_load for function groups. Exact counts are in the system prompt catalogue. Use this before assuming something does or does not exist — and always before drawing a new type, because a drawing tool id you guessed is refused. Reuse a type already verified in this conversation. An empty query lists a kind; no kind searches them all.
| Argument | Type | Description |
|---|---|---|
| kind | string | |
| limit | number | Default 25, max 100. |
| query | string | Free text; matches name, description and category. |
{
"type": "object",
"properties": {
"kind": {
"enum": [
"indicator",
"formula",
"strategy",
"variable",
"drawing",
"workflow",
"chartType"
],
"type": "string"
},
"limit": {
"type": "number",
"description": "Default 25, max 100."
},
"query": {
"type": "string",
"description": "Free text; matches name, description and category."
}
}
}Put an indicator on the chart. studyId is an id or a common name ("ema20", "bollinger"); catalog_describe lists parameters. Omitted ones use the default. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| params | object | |
| studyId* | string |
{
"type": "object",
"required": [
"studyId"
],
"properties": {
"params": {
"type": "object"
},
"studyId": {
"type": "string"
}
}
}See the chart you are building: returns a PNG of it -- candles, volume, every indicator and drawing -- rendered the way Basis draws it, plus the exact figures it shows. Use it to check structure, levels and what you drew before you describe them. Build first with the chart tools, or pass symbol, timeframe, indicators and levels to build and look in one call. Pixels are for shape; quote numbers from the figures or the data tools.
| Argument | Type | Description |
|---|---|---|
| bars | number | Bars to show, 20-500. Default 150, widened to include every drawing. |
| size | string | small 800x480, medium 1200x720 (default), large 1600x960. |
| levels | array | Prices to mark as horizontal lines, or {price, label, color}. |
| market | string | |
| symbol | string | Optional: set the instrument in this call. |
| exchange | string | |
| timeframe | string | Optional, e.g. 15m, 4h, 1d. |
| indicators | array | Ids or common names ("ema50", "rsi", "bollinger"), or {studyId, params}. |
Publish the chart and get a URL the person can open in Basis. Call it at the end of any answer about a market: the chart is half the answer. Either build first with the chart tools, or pass symbol, timeframe, indicators and levels here to build and publish in one call. Give the URL as a link and say in one line what it shows. No account needed; the link lasts seven days.
| Argument | Type | Description |
|---|---|---|
| note | string | One line describing what this chart shows, for your own reply. Not stored and not shown on the chart. |
| levels | array | Prices to mark as horizontal lines, or {price, label, color}. |
| market | string | |
| symbol | string | Optional: set the instrument in this call. |
| exchange | string | |
| timeframe | string | Optional, e.g. 15m, 4h, 1d. |
| indicators | array | Ids or common names ("ema50", "rsi", "bollinger"), or {studyId, params}. |
{
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "One line describing what this chart shows, for your own reply. Not stored and not shown on the chart."
},
"levels": {
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"description": "Prices to mark as horizontal lines, or {price, label, color}."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "Optional: set the instrument in this call."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "Optional, e.g. 15m, 4h, 1d."
},
"indicators": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
}
]
},
"description": "Ids or common names (\"ema50\", \"rsi\", \"bollinger\"), or {studyId, params}."
}
}
}Delete an indicator instance from the chart. Use chart_state to find its instance id. To temporarily hide it instead, use chart_toggle_indicator. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string |
{
"type": "object",
"required": [
"instanceId"
],
"properties": {
"instanceId": {
"type": "string"
}
}
}Point the chart at a market. Venue and symbol as the exchange writes them, e.g. BTCUSDT on binance. This changes the chart you are building, which the person opens through chart_link.
| Argument | Type | Description |
|---|---|---|
| market | string | |
| symbol* | string | |
| exchange | string |
{
"type": "object",
"required": [
"symbol"
],
"properties": {
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbol": {
"type": "string"
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
}
}
}Change the chart timeframe, e.g. 15m, 1h, 4h, 1d. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| timeframe* | string |
{
"type": "object",
"required": [
"timeframe"
],
"properties": {
"timeframe": {
"type": "string"
}
}
}Change how price is drawn — candles, heikin ashi, line, renko, footprint and others. A wrong id is refused, and the refusal lists every one that works. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| chartType* | string |
{
"type": "object",
"required": [
"chartType"
],
"properties": {
"chartType": {
"type": "string"
}
}
}The chart you are building for this person: venue, symbol, timeframe, chart type, every indicator with its instance id and parameters, and every drawing. Start here when you need an instance id, and call it again after changes to confirm what landed. Finish with chart_link to give the person something to open.
No arguments.
{
"type": "object",
"properties": {}
}Hide or show an indicator without removing it — useful for comparing a chart with and without something. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| instanceId* | string |
{
"type": "object",
"required": [
"instanceId"
],
"properties": {
"instanceId": {
"type": "string"
}
}
}Edit the parameters of an existing indicator instance. First call chart_state to get its instance id; use catalog_describe for supported parameters. To delete use chart_remove_indicator, to hide/show use chart_toggle_indicator. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| params* | object | |
| instanceId* | string |
{
"type": "object",
"required": [
"instanceId",
"params"
],
"properties": {
"params": {
"type": "object"
},
"instanceId": {
"type": "string"
}
}
}Domain knowledge for a crypto analysis: the constraints of the topic, the Basis tool chain, and — the part worth calling for — findings Basis has actually measured, each with its sample and verdict, plus the conventional readings it has NOT measured, marked as such. Call it before analysing a chart pattern, interpreting an indicator level, designing a strategy or judging a result that looks strong. It carries no live market data.
| Argument | Type | Description |
|---|---|---|
| topic* | string |
{
"type": "object",
"required": [
"topic"
],
"properties": {
"topic": {
"enum": [
"workflow",
"market-structure",
"chart-patterns",
"indicator-meaning",
"volatility-regime",
"volume-orderflow",
"derivatives",
"whale-positioning",
"strategy-research",
"cross-market",
"risk-execution"
],
"type": "string"
}
}
}Run one symmetric long/short scan over the same top-volume universe and return rule-independent breadth, 24h liquidity semantics and ranked directional candidates. Use this first for comprehensive day-trade or scalp discovery; then deep-dive only the shortlist with derivatives/order-flow tools. For a general scalp request use style:"scalp" and omit longRules/shortRules to use transparent RSI/EMA defaults. For explicit user filters use screener_run instead. Near misses never satisfy all rules.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| quote | string | |
| style | string | scalp defaults to 5m; daytrade to 15m. Explicit timeframe overrides this. |
| market | string | Defaults to the chart. Perpetuals are futures. |
| exchange | string | Defaults to the chart. |
| lookback | number | Default 300. |
| longRules | array | |
| timeframe | string | Default 5m for scalp, otherwise 15m; does not inherit the open chart. |
Draw measured geometry or explain it with text, note, callout or emoji. Points are {time, price} in chart coordinates — time in seconds, matching the candle timestamps a data handle reports. A horizontal line needs one point; a trendline or box needs two. Measured anchors must be copied from a tool result — a summary's max with its maxAt, a crossing with its time — never read off your own prose or carried over from a different computation. A note/text position or callout second anchor is layout, not a measured price; place it in spare chart space. The result echoes back what was drawn: check it against the figures you are about to quote, because a line that disagrees with the paragraph beside it is worse than no line. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| ref | string | A handle from market_candles. Measured anchors are checked against its window. A callout checks its first/event anchor; its second/label anchor and note/text positions are layout, not measured prices. Pass it whenever coordinates came from a computation. |
| fill | string | Palette fill colour, or “none”. |
| text | string | Required for text/note/callout: concise words, with for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters. |
| tool* | string | A tool id from catalog_search with kind "drawing" — e.g. text, note, callout, emoji, arrow, ellipse, priceZone, horizontalLine, trendLine, rectangle, fibRetracement, longPosition or shortPosition. Prefer position_draw_on_chart for an entry/stop/target box. Separators and capitalisation are forgiven; an id that names no tool is refused. |
Delete a drawing. This cannot be undone — the shape is not recoverable — so the user is asked first. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| id* | string | |
| symbol | string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
}Create one or more precise freehand strokes as a single undoable composition. A stroke accepts arbitrary chart points; line accepts two endpoints; ellipse and rectangle accept two opposite corners and are generated smoothly. Use highlighter for translucent emphasis and brush for circles, paths and marks. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| ref | string | |
| fill | string | Palette fill colour, or “none”. |
| mode | string | |
| text | string | Required for text/note/callout: concise words, with for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters. |
| color | string | A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement. |
| width | number | Stroke width in pixels, 1 to 6. |
| symbol | string | |
| opacity | number | Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision. |
Edit only the requested properties of an existing drawing; all others are preserved. For a text edit send just {id,text,fontSize}; never copy the entire stored style or its hex colours. Get the id from chart_state. Use it to keep several drawings apart — a measured level and a projected one should not be the same colour, and a reader has only the picture to tell them by. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| id* | string | From chart_state. |
| fill | string | Palette fill colour, or “none”. |
| text | string | Required for text/note/callout: concise words, with for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters. |
| color | string | A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement. |
| width | number | Stroke width in pixels, 1 to 6. |
| symbol | string | Defaults to the charted symbol. |
| opacity | number | Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision. |
| arrowEnd |
Draw a Fibonacci study directly on the chart with exact candle coordinates and optional custom ratios. Supports retracement, extension, channel, time, fan, circle, spiral, arc and wedge variants. Prefer swing timestamps/prices returned by market_candles computations rather than visual guesses. For a highest-high/lowest-low retracement use anchorMode high-to-low or low-to-high with ref and lookback: the tool selects exact CLOSED-candle wick coordinates. Do not substitute window start/end times. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| ref | string | |
| fill | string | Palette fill colour, or “none”. |
| text | string | Required for text/note/callout: concise words, with for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters. |
| tool* | string | |
| color | string | A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement. |
| width | number | Stroke width in pixels, 1 to 6. |
| levels | array | |
| points |
Evaluate a Basis formula expression over a loaded window. Functions are listed by catalog_search kind=formula; series named open, high, low, close, volume, returns and more. Multi-line with `let` bindings is supported; the last expression is the result.
| Argument | Type | Description |
|---|---|---|
| ref | string | Reuse a handle from market_candles instead of loading. |
| market | string | Default: the chart. |
| reduce | string | |
| symbol | string | Default: the chart. |
| exchange | string | |
| timeframe | string | e.g. 1h, 4h. Default: the chart. |
| expression* | string | |
| parameters | object | |
| includeForming | boolean |
What Basis Founders adds to this connection, and the live totals a non-member may see: how many screened Hyperliquid whales are tracked, their combined book and the coin most of them hold. Founders is an optional paid membership; this tool is free and always answers. Use it when a question needs whale positions, whale or gamma levels, more than 30 days of derivatives history, or a stock or commodity on Hyperliquid or Binance.
No arguments.
{
"type": "object",
"properties": {}
}Read current public Hyperliquid positions for a frozen, research-screened whale cohort. Returns account-normalized consensus, participation, agreement, effective-wallet count, single-wallet concentration, liquidity and optional recent fills for the focus symbol. Use this for whale/smart-money positioning as one evidence family, never as a standalone signal.
| Argument | Type | Description |
|---|---|---|
| symbol | string | Focus symbol; defaults to the charted symbol. |
| flowHours | number | Recent-flow window. Default 24h, range 1-168h. |
| topSymbols | number | Market-consensus rows to return. Default 10, max 15. |
| maxFlowWallets | number | Wallets sampled for fills. Default/max 4. |
| includeRecentFlow | boolean | Also inspect recent focus-symbol fills for at most four leading contributors. |
| minimumDayVolumeUsd | number | 24h Hyperliquid notional-volume floor. Default $5,000,000. |
{
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Focus symbol; defaults to the charted symbol."
},
"flowHours": {
"type": "number",
"description": "Recent-flow window. Default 24h, range 1-168h."
},
"topSymbols": {
"type": "number",
"description": "Market-consensus rows to return. Default 10, max 15."
},
"maxFlowWallets": {
"type": "number",
"description": "Wallets sampled for fills. Default/max 4."
},
"includeRecentFlow": {
"type": "boolean",
"description": "Also inspect recent focus-symbol fills for at most four leading contributors."
},
"minimumDayVolumeUsd": {
"type": "number",
"description": "24h Hyperliquid notional-volume floor. Default $5,000,000."
}
}
}Run any indicator in the catalogue. Returns EVERY output series it has — Donchian gives three bands, MACD gives line, signal and histogram — each reduced, plus the indicator's own conventional levels so the reading can be interpreted against its actual scale. Pass a symbol to load and compute in one call, or a handle to reuse data. The forming bar is excluded unless you ask for it.
| Argument | Type | Description |
|---|---|---|
| ref | string | Reuse a handle from market_candles instead of loading. |
| plot | string | One output only. Usually omit: the others give the reading meaning. |
| market | string | Default: the chart. |
| params | object | Defaults are used for anything omitted. |
| reduce | string | |
| symbol | string | Default: the chart. |
| studyId* | string | From catalog_search. |
| dataMode | string | Latest refreshes old handles. Snapshot preserves historical data, never live evidence. |
Load price history and return a handle to it, plus a summary. The bars themselves are deliberately not returned — pass the handle to the compute tools instead. lastClosedCandle is one exact OHLC bar; high/low are WHOLE-WINDOW wick extremes with highAt/lowAt timestamps; from/to are window boundaries, not swing anchors. bars includes a possible forming bar: request N+1 for N closed bars and check closedBars. Defaults to whatever is on the chart.
| Argument | Type | Description |
|---|---|---|
| bars | number | Default 1000, max 50000. |
| market | string | Default: the chart. |
| symbol | string | Default: the chart. |
| exchange | string | |
| timeframe | string | e.g. 15m, 1h, 4h, 1d. |
| withDerivatives | boolean | Also load funding, open interest and positioning for this contract. |
{
"type": "object",
"properties": {
"bars": {
"type": "number",
"description": "Default 1000, max 50000."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"symbol": {
"type": "string",
"description": "Default: the chart."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "e.g. 15m, 1h, 4h, 1d."
},
"withDerivatives": {
"type": "boolean",
"description": "Also load funding, open interest and positioning for this contract."
}
}
}Read current perpetual funding (fonlama/takas ücreti), open interest and positioning directly by symbol, without loading candles first. Optional ref reuses a fresh derivatives handle. Funding is a transfer between longs/shorts, NOT a maker/taker trading commission. Returns decimal and percentage rates, actual settlement interval and optional payment scenario.
| Argument | Type | Description |
|---|---|---|
| ref | string | Optional existing data handle. |
| side | string | For payment estimate; default long. |
| market | string | Default: the chart. |
| symbol | string | Default chart symbol; perpetual funding is read on futures even when the chart is spot. |
| exchange | string | |
| timeframe | string | Aggregation for OI/positioning; not the funding settlement interval. |
| notionalQuote | number | Optional hypothetical position value in quote units to estimate one funding payment. |
{
"type": "object",
"properties": {
"ref": {
"type": "string",
"description": "Optional existing data handle."
},
"side": {
"enum": [
"long",
"short"
],
"type": "string",
"description": "For payment estimate; default long."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"symbol": {
"type": "string",
"description": "Default chart symbol; perpetual funding is read on futures even when the chart is spot."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "Aggregation for OI/positioning; not the funding settlement interval."
},
"notionalQuote": {
"type": "number",
"description": "Optional hypothetical position value in quote units to estimate one funding payment."
}
}
}Current crypto market-cap structure from a server-cached aggregate source: real BTC and ETH dominance, total market cap/volume, tracked stablecoin share and leading asset shares with source and timestamps. Use this for BTC.D/rotation context. This is a current snapshot, not a historical dominance backtest series.
No arguments.
{
"type": "object",
"properties": {}
}Professional multi-asset relationship analysis on timestamp-aligned closed-bar log returns. Returns a correlation matrix plus rolling correlation, OLS beta/alpha, R-squared, upside/downside correlation, relative performance, one-bar lead/lag diagnostics and a rolling log-price spread z-score versus a benchmark. Use this for BTC correlation, beta, pairs and relative-strength work; price-level correlation is deliberately not reported.
| Argument | Type | Description |
|---|---|---|
| bars | number | Default 1500, max 10000 per market. |
| market | string | |
| symbols* | array | 2 to 10 markets, e.g. ETHUSDT, SOLUSDT. Benchmark is added if omitted. |
| exchange | string | |
| benchmark | string | Default BTCUSDT. |
| timeframe | string | Default chart timeframe. |
| rollingWindow | number | Latest return observations. Default 90. |
{
"type": "object",
"required": [
"symbols"
],
"properties": {
"bars": {
"type": "number",
"description": "Default 1500, max 10000 per market."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "2 to 10 markets, e.g. ETHUSDT, SOLUSDT. Benchmark is added if omitted."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"benchmark": {
"type": "string",
"description": "Default BTCUSDT."
},
"timeframe": {
"type": "string",
"description": "Default chart timeframe."
},
"rollingWindow": {
"type": "number",
"description": "Latest return observations. Default 90."
}
}
}Which crypto assets a piece of text refers to. Word-bounded, so "button" does not match TON and "operation" does not match OP.
| Argument | Type | Description |
|---|---|---|
| text* | string |
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
}
}
}Read archived crypto headlines, newest first, with source links. Use news_recent for live headlines. Paginate with nextBefore (ISO timestamp). Archive coverage starts when Basis began collecting; an empty page does not prove no news occurred. No full article text.
| Argument | Type | Description |
|---|---|---|
| asset | string | Base asset, e.g. BTC; supported asset tags only. |
| limit | integer | |
| topic | string | |
| before | string | A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise. |
{
"type": "object",
"properties": {
"asset": {
"type": "string",
"description": "Base asset, e.g. BTC; supported asset tags only."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 40,
"minimum": 1
},
"topic": {
"enum": [
"markets",
"regulation",
"macro",
"security",
"etf",
"stablecoins",
"exchanges",
"defi",
"institutions",
"mining"
],
"type": "string"
},
"before": {
"type": "string",
"description": "A date or timestamp, e.g. 2026-09-01 or 2026-09-01T00:00:00Z. UTC unless it says otherwise."
}
}
}Recent crypto headlines with an impact score and the assets each one touches. Impact is a keyword heuristic, not a judgement about the market. Pass hours for "today" or "the last 24 hours"; every headline says how old it is.
| Argument | Type | Description |
|---|---|---|
| asset | string | Base symbol, e.g. BTC. Omit for everything. |
| hours | number | Only headlines published in the last N hours, 1 to 168. |
| limit | number | Default 15, max 40. |
| minImpact | string |
{
"type": "object",
"properties": {
"asset": {
"type": "string",
"description": "Base symbol, e.g. BTC. Omit for everything."
},
"hours": {
"type": "number",
"description": "Only headlines published in the last N hours, 1 to 168."
},
"limit": {
"type": "number",
"description": "Default 15, max 40."
},
"minImpact": {
"enum": [
"low",
"normal",
"high",
"critical"
],
"type": "string"
}
}
}Read current displayed resting bid/ask limit orders on Binance, Bybit, OKX or Hyperliquid perpetuals. Use for resting liquidity, order book/DOM and buy/sell walls, NOT orderflow_read, which reads executed trades. Returns timestamp, spread, largest displayed levels and bounded depth coverage. Not historical depth, hidden stops or guaranteed support.
| Argument | Type | Description |
|---|---|---|
| levels | integer | Returned largest levels per side. Default 8. |
| market | string | Default: the chart. |
| symbol | string | Default: chart symbol. |
| exchange | string | |
| notionalQuote | number | Optional hypothetical order size in quote currency for depth-based VWAP/slippage. Excludes fees and funding. |
{
"type": "object",
"properties": {
"levels": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "Returned largest levels per side. Default 8."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"symbol": {
"type": "string",
"description": "Default: chart symbol."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"notionalQuote": {
"type": "number",
"description": "Optional hypothetical order size in quote currency for depth-based VWAP/slippage. Excludes fees and funding."
}
}
}EXECUTED trades only, not resting orders. For current resting liquidity or walls use orderbook_read. Aggressor-side order flow: buy and sell volume separated by who crossed the spread, delta, the footprint by price level, the point of control, and absorption or stacked imbalance. Measured from the venue aggressor tag, not inferred from bar direction — use it when the question is who is being aggressive, which candles cannot answer. For one candle pass candleTime, which reads exactly that bar; otherwise it reads the last `minutes`. Report coveredMinutes, not the minutes asked for.
| Argument | Type | Description |
|---|---|---|
| levels | number | Price rows. Default 12, max 40. |
| market | string | Default: the chart. |
| symbol | string | Default: the chart. |
| endTime | number | Window end, default now. |
| minutes | number | Default 3 for a responsive recent read, max 60. Explicit windows are preserved. |
| exchange | string | |
| timeframe | string | With candleTime. Defaults to the chart timeframe. |
| bucketSize | number |
Risk-first position sizing with quantity, notional, margin, effective leverage, fees, funding, breakeven, liquidation estimate, target R multiples and warnings. Use position_plan_on_chart instead when the user should see the plan on the chart.
| Argument | Type | Description |
|---|---|---|
| side* | string | |
| stop* | number | |
| entry* | number | |
| equity* | number | Account equity in quote currency. |
| feeBps | number | Fee per side in basis points. Default 4. |
| targets | array | Take-profit prices and the percentage closed at each. Allocations should total 100. |
| leverage | number | Selected venue leverage. Default 1. |
| fundingRate | number | Funding per settlement as a fraction, e.g. 0.0001. |
| riskPercent |
The chart-only long/short position drawing tool. Draw an entry, stop and target box immediately when those price levels are known. It needs no account equity or risk percentage, performs no position sizing and places no order. Use position_plan_on_chart instead only when the user also wants quantity and risk calculations. Without explicit timestamps the illustrative box spans recent closed candles for visibility, not future bars or an executed historical trade. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| side* | string | |
| stop* | number | |
| entry* | number | |
| symbol | string | |
| target* | number | |
| toTime | number | Optional end timestamp in seconds. |
| barsWide | number | Width when timestamps are omitted. Default 20 bars. |
| fromTime | number | Optional start timestamp in seconds. |
Calculate a risk-first long/short position and draw the entry, stop and first target directly on the live chart. The drawing retains quantity, notional, margin, costs, liquidation estimate, targets, warnings and an optional sandbox program id so later analysis reads the same plan the user sees. Without explicit timestamps this illustrative scenario spans recent closed candles for visibility, not an executed historical trade. Changes the chart you are building; finish with chart_link, or analysis_prepare for a sharing draft that needs human review.
| Argument | Type | Description |
|---|---|---|
| note | string | |
| side* | string | |
| stop* | number | |
| entry* | number | |
| equity* | number | Account equity in quote currency. |
| feeBps | number | Fee per side in basis points. Default 4. |
| symbol | string | |
| toTime | number | Optional end timestamp in seconds. |
| targets |
Historically replay a cross-sectional screen at every bar. Matching instruments form an equal-weight long or short portfolio, entered at the next bar open and held to the following bar open, then re-screened. Use this when the question is whether repeatedly trading screener matches worked — a single-symbol backtest of coins that match today is not a substitute. Costs follow actual portfolio turnover, so an unchanged holding is not charged as a fresh round trip.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| logic | string | Default all. |
| quote | string | Default USDC on Hyperliquid, USDT elsewhere. |
| rules* | array | |
| feeBps | number | Per side. Default 4. |
| market | string | Defaults to the chart. Perpetuals are futures. |
| exchange | string | Defaults to the chart. |
| lookback | number | Bars. Default 300. |
| direction |
Scan the venue's listed instruments for ones matching conditions, instead of looking at the open chart. Rules combine price fields, any indicator plot, or a formula expression, with ALL/ANY matching. This is the tool for "which coins are doing X right now". It fetches history for every instrument in the universe, so use exactly the requested filters. For "5 coins with RSI above 50", call rules: [{left:{kind:"indicator",studyId:"rsi"},operator:"above",right:50}], limit:5. Use above for a current state; crossesAbove only for a fresh crossing. limit controls returned matches, universeSize controls how many markets are searched.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| limit | number | Matches to return. Default 25, max 60. |
| logic | string | Default all. |
| order | string | With sortBy. Default desc; asc for the biggest losers. |
| quote | string | Default USDC on Hyperliquid, USDT elsewhere. |
| rules* | array | |
| market | string | Defaults to the chart. Perpetuals are futures. |
| sortBy |
Run one chronological research experiment across many built-in strategies, instruments and timeframes. Use this for broad discovery instead of many backtest_run calls — and in particular instead of testing one strategy on coin after coin, which is a search whether or not it is called one. It ranks only on a selection window, checks several subperiods, leaves an embargo, reveals held-out performance, doubles costs as a stress test, compares buy-and-hold, and corrects the selected Sharpe for every strategy/symbol/timeframe combination tried.
| Argument | Type | Description |
|---|---|---|
| bars | number | Per symbol and timeframe. Default 3000, max 10000. |
| folds | number | Selection subperiods, 2..8. Default 4. |
| feeBps | number | Per side. Default 4. |
| market | string | Default: the chart. |
| symbol | string | Defaults to the charted symbol. |
| symbols | array | Up to 8 instruments to search across, e.g. BTCUSDT, ETHUSDT. Every symbol is another trial and the deflated Sharpe accounts for it. |
| exchange | string | |
| direction |
Retrieve compact historical trade analogues for the current market state. Plans are deterministic synthetic templates, while fills, stop/target ordering, MAE/MFE and outcomes are settled on later historical candles with costs. Use it to compare similar wins and failures, never as proof of an edge.
| Argument | Type | Description |
|---|---|---|
| ref | string | Optional market_candles handle for the query state. |
| bars | number | History per symbol. Default 1500; min 300, max 3000. |
| side | string | |
| limit | number | Displayed analogues. Default 12; max 20. |
| setup | string | |
| feeBps | number | Fee per side. Default 4 basis points. |
| market | string | |
| stride | number | Evaluate one signal point every N bars. Default 4. |
| symbol | string | Query symbol; defaults to the chart. |
| timeframe | string | Optional, e.g. 15m, 4h, 1d. |
| indicators | array | Ids or common names ("ema50", "rsi", "bollinger"), or {studyId, params}. |
{
"type": "object",
"required": [
"title",
"body",
"caption"
],
"properties": {
"body": {
"type": "string",
"maxLength": 4000,
"description": "Plain-text analysis: evidence, timeframe, venue, data timestamp, alternative scenario and invalidation. Only use verified tool results. Never include account balances, keys or private notes."
},
"title": {
"type": "string",
"maxLength": 120,
"description": "A specific, factual title. No return promises."
},
"levels": {
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"description": "Prices to mark as horizontal lines, or {price, label, color}."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "Optional: set the instrument in this call."
},
"caption": {
"type": "string",
"maxLength": 1000,
"description": "Editable social caption in the user’s language, ideally under 220 characters for X. Invite discussion, not a trade. Do not add a URL; the review page adds the public link after approval."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "Optional, e.g. 15m, 4h, 1d."
},
"indicators": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
}
]
},
"description": "Ids or common names (\"ema50\", \"rsi\", \"bollinger\"), or {studyId, params}."
}
}
}| Optional time stop in bars. |
| slippageBps | number | Default 1. |
| stopLossPercent | number | Optional protective stop percentage. |
| takeProfitPercent | number | Optional profit target percentage. |
{
"type": "object",
"required": [
"strategyId"
],
"properties": {
"ref": {
"type": "string",
"description": "Reuse a handle from market_candles instead of loading."
},
"feeBps": {
"type": "number",
"description": "Per side. Default 4."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"params": {
"type": "object"
},
"symbol": {
"type": "string",
"description": "Default: the chart."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"direction": {
"enum": [
"both",
"long",
"short"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "e.g. 1h, 4h. Default: the chart."
},
"strategyId": {
"type": "string"
},
"maxBarsHeld": {
"type": "number",
"description": "Optional time stop in bars."
},
"slippageBps": {
"type": "number",
"description": "Default 1."
},
"stopLossPercent": {
"type": "number",
"description": "Optional protective stop percentage."
},
"takeProfitPercent": {
"type": "number",
"description": "Optional profit target percentage."
}
}
}{
"type": "object",
"properties": {
"bars": {
"type": "number",
"description": "Bars to show, 20-500. Default 150, widened to include every drawing."
},
"size": {
"enum": [
"small",
"medium",
"large"
],
"type": "string",
"description": "small 800x480, medium 1200x720 (default), large 1600x960."
},
"levels": {
"type": "array",
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "object"
}
]
},
"description": "Prices to mark as horizontal lines, or {price, label, color}."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "Optional: set the instrument in this call."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "Optional, e.g. 15m, 4h, 1d."
},
"indicators": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
}
]
},
"description": "Ids or common names (\"ema50\", \"rsi\", \"bollinger\"), or {studyId, params}."
}
}
}| shortRules |
| array |
| limitPerSide | number | Candidates returned per direction. Default 10, max 25. |
| universeSize | number | Default 100. |
| manualSymbols | array | Optional symbols forced into the universe before current-volume ranking. |
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"quote": {
"enum": [
"USDT",
"USDC",
"FDUSD",
"BTC",
"ETH",
"ALL"
],
"type": "string"
},
"style": {
"enum": [
"scalp",
"daytrade"
],
"type": "string",
"description": "scalp defaults to 5m; daytrade to 15m. Explicit timeframe overrides this."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Defaults to the chart. Perpetuals are futures."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string",
"description": "Defaults to the chart."
},
"lookback": {
"enum": [
300,
500,
1000,
1500
],
"type": "number",
"description": "Default 300."
},
"longRules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"right"
],
"properties": {
"left": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"name": {
"type": "string"
},
"field": {
"enum": [
"open",
"high",
"low",
"close",
"volume",
"quoteVolume",
"trades",
"change1",
"change5",
"rangePercent"
],
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": [
"number",
"string",
"boolean"
]
}
},
"plotKey": {
"type": "string",
"description": "Optional; defaults to the first indicator output."
},
"studyId": {
"type": "string",
"description": "Indicator id, e.g. rsi or ema."
},
"expression": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"strategyId": {
"type": "string"
}
},
"description": "e.g. {\"kind\":\"field\",\"field\":\"change5\"}, {\"kind\":\"indicator\",\"studyId\":\"rsi\",\"plotKey\":\"rsi\"}, or {\"kind\":\"formula\",\"name\":\"atrPct\",\"expression\":\"atr(14)/close*100\"}"
},
"right": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"kind": {
"enum": [
"constant",
"operand"
],
"type": "string"
},
"value": {
"type": "number"
},
"operand": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"field": {
"type": "string"
},
"params": {
"type": "object"
},
"plotKey": {
"type": "string"
},
"studyId": {
"type": "string"
},
"expression": {
"type": "string"
},
"strategyId": {
"type": "string"
}
}
}
}
}
],
"description": "Use a number for a threshold: RSI >50 is {left:{kind:\"indicator\",studyId:\"rsi\"},operator:\"above\",right:50}. To compare with an indicator use {kind:\"operand\",operand:{kind:\"indicator\",studyId:\"ema\",params:{period:20}}}."
},
"operator": {
"enum": [
"above",
"atOrAbove",
"below",
"atOrBelow",
"equal",
"notEqual",
"crossesAbove",
"crossesBelow",
"rising",
"falling"
],
"type": "string"
}
}
}
},
"timeframe": {
"type": "string",
"description": "Default 5m for scalp, otherwise 15m; does not inherit the open chart."
},
"shortRules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"right"
],
"properties": {
"left": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"name": {
"type": "string"
},
"field": {
"enum": [
"open",
"high",
"low",
"close",
"volume",
"quoteVolume",
"trades",
"change1",
"change5",
"rangePercent"
],
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": [
"number",
"string",
"boolean"
]
}
},
"plotKey": {
"type": "string",
"description": "Optional; defaults to the first indicator output."
},
"studyId": {
"type": "string",
"description": "Indicator id, e.g. rsi or ema."
},
"expression": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"strategyId": {
"type": "string"
}
},
"description": "e.g. {\"kind\":\"field\",\"field\":\"change5\"}, {\"kind\":\"indicator\",\"studyId\":\"rsi\",\"plotKey\":\"rsi\"}, or {\"kind\":\"formula\",\"name\":\"atrPct\",\"expression\":\"atr(14)/close*100\"}"
},
"right": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"kind": {
"enum": [
"constant",
"operand"
],
"type": "string"
},
"value": {
"type": "number"
},
"operand": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"field": {
"type": "string"
},
"params": {
"type": "object"
},
"plotKey": {
"type": "string"
},
"studyId": {
"type": "string"
},
"expression": {
"type": "string"
},
"strategyId": {
"type": "string"
}
}
}
}
}
],
"description": "Use a number for a threshold: RSI >50 is {left:{kind:\"indicator\",studyId:\"rsi\"},operator:\"above\",right:50}. To compare with an indicator use {kind:\"operand\",operand:{kind:\"indicator\",studyId:\"ema\",params:{period:20}}}."
},
"operator": {
"enum": [
"above",
"atOrAbove",
"below",
"atOrBelow",
"equal",
"notEqual",
"crossesAbove",
"crossesBelow",
"rising",
"falling"
],
"type": "string"
}
}
}
},
"limitPerSide": {
"type": "number",
"description": "Candidates returned per direction. Default 10, max 25."
},
"universeSize": {
"enum": [
20,
50,
100,
200
],
"type": "number",
"description": "Default 100."
},
"manualSymbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional symbols forced into the universe before current-volume ranking."
}
}
}| color |
| string |
| A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement. |
| width | number | Stroke width in pixels, 1 to 6. |
| levels | array | Custom Fibonacci ratios. Example: [0, 0.382, 0.5, 0.618, 0.786, 1, 1.272, 1.618]. |
| points* | array |
| symbol | string | Defaults to the charted symbol. |
| opacity | number | Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision. |
| arrowEnd | boolean |
| fontSize | number | Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size. |
| textBold | boolean |
| wrapText | boolean | Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label. |
| lineStyle | string |
| showStats | boolean |
| textColor | string |
| arrowStart | boolean |
| extendLeft | boolean |
| showLabels | boolean |
| showPrices | boolean |
| showRatios | boolean |
| extendRight | boolean |
| fillOpacity | number | Shape fill opacity from 0 to 1. |
| ratioFormat | string |
| labelPosition | string |
| labelVertical | string |
{
"type": "object",
"required": [
"tool",
"points"
],
"properties": {
"ref": {
"type": "string",
"description": "A handle from market_candles. Measured anchors are checked against its window. A callout checks its first/event anchor; its second/label anchor and note/text positions are layout, not measured prices. Pass it whenever coordinates came from a computation."
},
"fill": {
"type": "string",
"description": "Palette fill colour, or “none”."
},
"text": {
"type": "string",
"description": "Required for text/note/callout: concise words, with \n for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters."
},
"tool": {
"type": "string",
"description": "A tool id from catalog_search with kind \"drawing\" — e.g. text, note, callout, emoji, arrow, ellipse, priceZone, horizontalLine, trendLine, rectangle, fibRetracement, longPosition or shortPosition. Prefer position_draw_on_chart for an entry/stop/target box. Separators and capitalisation are forgiven; an id that names no tool is refused."
},
"color": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string",
"description": "A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement."
},
"width": {
"type": "number",
"description": "Stroke width in pixels, 1 to 6."
},
"levels": {
"type": "array",
"items": {
"type": "number"
},
"description": "Custom Fibonacci ratios. Example: [0, 0.382, 0.5, 0.618, 0.786, 1, 1.272, 1.618]."
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"time",
"price"
],
"properties": {
"time": {
"type": "number"
},
"price": {
"type": "number"
}
}
}
},
"symbol": {
"type": "string",
"description": "Defaults to the charted symbol."
},
"opacity": {
"type": "number",
"description": "Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision."
},
"arrowEnd": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"description": "Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size."
},
"textBold": {
"type": "boolean"
},
"wrapText": {
"type": "boolean",
"description": "Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label."
},
"lineStyle": {
"enum": [
"solid",
"dashed",
"dotted"
],
"type": "string"
},
"showStats": {
"type": "boolean"
},
"textColor": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string"
},
"arrowStart": {
"type": "boolean"
},
"extendLeft": {
"type": "boolean"
},
"showLabels": {
"type": "boolean"
},
"showPrices": {
"type": "boolean"
},
"showRatios": {
"type": "boolean"
},
"extendRight": {
"type": "boolean"
},
"fillOpacity": {
"type": "number",
"description": "Shape fill opacity from 0 to 1."
},
"ratioFormat": {
"enum": [
"value",
"percent"
],
"type": "string"
},
"labelPosition": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"labelVertical": {
"enum": [
"above",
"middle",
"below"
],
"type": "string"
}
}
}| strokes* |
| array |
| arrowEnd | boolean |
| fontSize | number | Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size. |
| textBold | boolean |
| wrapText | boolean | Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label. |
| lineStyle | string |
| showStats | boolean |
| textColor | string |
| arrowStart | boolean |
| extendLeft | boolean |
| showLabels | boolean |
| showPrices | boolean |
| showRatios | boolean |
| extendRight | boolean |
| fillOpacity | number | Shape fill opacity from 0 to 1. |
| ratioFormat | string |
| labelPosition | string |
| labelVertical | string |
{
"type": "object",
"required": [
"strokes"
],
"properties": {
"ref": {
"type": "string"
},
"fill": {
"type": "string",
"description": "Palette fill colour, or “none”."
},
"mode": {
"enum": [
"brush",
"highlighter"
],
"type": "string"
},
"text": {
"type": "string",
"description": "Required for text/note/callout: concise words, with \n for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters."
},
"color": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string",
"description": "A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement."
},
"width": {
"type": "number",
"description": "Stroke width in pixels, 1 to 6."
},
"symbol": {
"type": "string"
},
"opacity": {
"type": "number",
"description": "Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision."
},
"strokes": {
"type": "array",
"items": {
"type": "object",
"required": [
"shape",
"points"
],
"properties": {
"shape": {
"enum": [
"stroke",
"line",
"ellipse",
"rectangle"
],
"type": "string"
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"time",
"price"
],
"properties": {
"time": {
"type": "number"
},
"price": {
"type": "number"
}
}
}
}
}
}
},
"arrowEnd": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"description": "Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size."
},
"textBold": {
"type": "boolean"
},
"wrapText": {
"type": "boolean",
"description": "Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label."
},
"lineStyle": {
"enum": [
"solid",
"dashed",
"dotted"
],
"type": "string"
},
"showStats": {
"type": "boolean"
},
"textColor": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string"
},
"arrowStart": {
"type": "boolean"
},
"extendLeft": {
"type": "boolean"
},
"showLabels": {
"type": "boolean"
},
"showPrices": {
"type": "boolean"
},
"showRatios": {
"type": "boolean"
},
"extendRight": {
"type": "boolean"
},
"fillOpacity": {
"type": "number",
"description": "Shape fill opacity from 0 to 1."
},
"ratioFormat": {
"enum": [
"value",
"percent"
],
"type": "string"
},
"labelPosition": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"labelVertical": {
"enum": [
"above",
"middle",
"below"
],
"type": "string"
}
}
}| boolean |
| fontSize | number | Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size. |
| textBold | boolean |
| wrapText | boolean | Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label. |
| lineStyle | string |
| showStats | boolean |
| textColor | string |
| arrowStart | boolean |
| extendLeft | boolean |
| showLabels | boolean |
| showPrices | boolean |
| showRatios | boolean |
| extendRight | boolean |
| fillOpacity | number | Shape fill opacity from 0 to 1. |
| ratioFormat | string |
| labelPosition | string |
| labelVertical | string |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "From chart_state."
},
"fill": {
"type": "string",
"description": "Palette fill colour, or “none”."
},
"text": {
"type": "string",
"description": "Required for text/note/callout: concise words, with \n for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters."
},
"color": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string",
"description": "A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement."
},
"width": {
"type": "number",
"description": "Stroke width in pixels, 1 to 6."
},
"symbol": {
"type": "string",
"description": "Defaults to the charted symbol."
},
"opacity": {
"type": "number",
"description": "Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision."
},
"arrowEnd": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"description": "Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size."
},
"textBold": {
"type": "boolean"
},
"wrapText": {
"type": "boolean",
"description": "Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label."
},
"lineStyle": {
"enum": [
"solid",
"dashed",
"dotted"
],
"type": "string"
},
"showStats": {
"type": "boolean"
},
"textColor": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string"
},
"arrowStart": {
"type": "boolean"
},
"extendLeft": {
"type": "boolean"
},
"showLabels": {
"type": "boolean"
},
"showPrices": {
"type": "boolean"
},
"showRatios": {
"type": "boolean"
},
"extendRight": {
"type": "boolean"
},
"fillOpacity": {
"type": "number",
"description": "Shape fill opacity from 0 to 1."
},
"ratioFormat": {
"enum": [
"value",
"percent"
],
"type": "string"
},
"labelPosition": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"labelVertical": {
"enum": [
"above",
"middle",
"below"
],
"type": "string"
}
}
}| array |
| symbol | string |
| opacity | number | Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision. |
| arrowEnd | boolean |
| fontSize | number | Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size. |
| lookback | number | Number of most recent CLOSED bars for automatic anchors. Load at least this many closed bars first. |
| textBold | boolean |
| wrapText | boolean | Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label. |
| lineStyle | string |
| showStats | boolean |
| textColor | string |
| anchorMode | string | Default explicit uses points. Automatic modes support fibRetracement only and require ref. |
| arrowStart | boolean |
| extendLeft | boolean |
| showLabels | boolean |
| showPrices | boolean |
| showRatios | boolean |
| extendRight | boolean |
| fillOpacity | number | Shape fill opacity from 0 to 1. |
| ratioFormat | string |
| labelPosition | string |
| labelVertical | string |
{
"type": "object",
"required": [
"tool"
],
"properties": {
"ref": {
"type": "string"
},
"fill": {
"type": "string",
"description": "Palette fill colour, or “none”."
},
"text": {
"type": "string",
"description": "Required for text/note/callout: concise words, with \n for short lines. For emoji: one Unicode emoji, e.g. 👀 or ⚠️. Max 500 characters."
},
"tool": {
"enum": [
"fibRetracement",
"fibExtension",
"fibChannel",
"fibTimeZone",
"fibSpeedFan",
"fibTimeExtension",
"fibCircles",
"fibSpiral",
"fibSpeedArcs",
"fibWedge"
],
"type": "string"
},
"color": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string",
"description": "A palette name. “up” and “down” are the reserved green and red — they assert a bullish or bearish claim, so use them for position zones and not for a measurement."
},
"width": {
"type": "number",
"description": "Stroke width in pixels, 1 to 6."
},
"levels": {
"type": "array",
"items": {
"type": "number"
}
},
"points": {
"type": "array",
"items": {
"type": "object",
"required": [
"time",
"price"
],
"properties": {
"time": {
"type": "number"
},
"price": {
"type": "number"
}
}
}
},
"symbol": {
"type": "string"
},
"opacity": {
"type": "number",
"description": "Strength of the whole drawing, 0.1 to 1. Fade a level that is context rather than the decision."
},
"arrowEnd": {
"type": "boolean"
},
"fontSize": {
"type": "number",
"description": "Size 9–160px, normally 12–16 for readable text. Emoji render at twice this size."
},
"lookback": {
"type": "number",
"maximum": 50000,
"minimum": 2,
"description": "Number of most recent CLOSED bars for automatic anchors. Load at least this many closed bars first."
},
"textBold": {
"type": "boolean"
},
"wrapText": {
"type": "boolean",
"description": "Default true: wrap long annotation lines for readability. False only for an explicitly requested single-line label."
},
"lineStyle": {
"enum": [
"solid",
"dashed",
"dotted"
],
"type": "string"
},
"showStats": {
"type": "boolean"
},
"textColor": {
"enum": [
"blue",
"orange",
"violet",
"aqua",
"yellow",
"magenta",
"neutral",
"white",
"up",
"down"
],
"type": "string"
},
"anchorMode": {
"enum": [
"explicit",
"high-to-low",
"low-to-high"
],
"type": "string",
"description": "Default explicit uses points. Automatic modes support fibRetracement only and require ref."
},
"arrowStart": {
"type": "boolean"
},
"extendLeft": {
"type": "boolean"
},
"showLabels": {
"type": "boolean"
},
"showPrices": {
"type": "boolean"
},
"showRatios": {
"type": "boolean"
},
"extendRight": {
"type": "boolean"
},
"fillOpacity": {
"type": "number",
"description": "Shape fill opacity from 0 to 1."
},
"ratioFormat": {
"enum": [
"value",
"percent"
],
"type": "string"
},
"labelPosition": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"labelVertical": {
"enum": [
"above",
"middle",
"below"
],
"type": "string"
}
}
}{
"type": "object",
"required": [
"expression"
],
"properties": {
"ref": {
"type": "string",
"description": "Reuse a handle from market_candles instead of loading."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"reduce": {
"enum": [
"last",
"summary",
"tail",
"crossings"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "Default: the chart."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "e.g. 1h, 4h. Default: the chart."
},
"expression": {
"type": "string"
},
"parameters": {
"type": "object"
},
"includeForming": {
"type": "boolean"
}
}
}| exchange |
| string |
| timeframe | string | e.g. 1h, 4h. Default: the chart. |
| includeForming | boolean |
{
"type": "object",
"required": [
"studyId"
],
"properties": {
"ref": {
"type": "string",
"description": "Reuse a handle from market_candles instead of loading."
},
"plot": {
"type": "string",
"description": "One output only. Usually omit: the others give the reading meaning."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"params": {
"type": "object",
"description": "Defaults are used for anything omitted."
},
"reduce": {
"enum": [
"last",
"summary",
"tail",
"crossings"
],
"type": "string"
},
"symbol": {
"type": "string",
"description": "Default: the chart."
},
"studyId": {
"type": "string",
"description": "From catalog_search."
},
"dataMode": {
"enum": [
"latest",
"snapshot"
],
"type": "string",
"description": "Latest refreshes old handles. Snapshot preserves historical data, never live evidence."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "e.g. 1h, 4h. Default: the chart."
},
"includeForming": {
"type": "boolean"
}
}
}| Price bucket width. Omit unless matching a footprint on screen. |
| candleTime | number | A bar open time, s or ms: reads that whole candle. |
| includeSignals | boolean | Absorption and stacked imbalance. Default true. |
{
"type": "object",
"properties": {
"levels": {
"type": "number",
"description": "Price rows. Default 12, max 40."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"symbol": {
"type": "string",
"description": "Default: the chart."
},
"endTime": {
"type": "number",
"description": "Window end, default now."
},
"minutes": {
"type": "number",
"description": "Default 3 for a responsive recent read, max 60. Explicit windows are preserved."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "With candleTime. Defaults to the chart timeframe."
},
"bucketSize": {
"type": "number",
"description": "Price bucket width. Omit unless matching a footprint on screen."
},
"candleTime": {
"type": "number",
"description": "A bar open time, s or ms: reads that whole candle."
},
"includeSignals": {
"type": "boolean",
"description": "Absorption and stacked imbalance. Default true."
}
}
}| number |
| Equity risked if the stop fills, in percent. |
| holdingHours | number | Expected holding time for the funding estimate. |
| fundingPerDay | number | Funding settlements per day. Default 3. |
| maintenanceMarginRate | number | Fraction used for approximate liquidation. Default 0.005. |
{
"type": "object",
"required": [
"side",
"equity",
"riskPercent",
"entry",
"stop"
],
"properties": {
"side": {
"enum": [
"long",
"short"
],
"type": "string"
},
"stop": {
"type": "number"
},
"entry": {
"type": "number"
},
"equity": {
"type": "number",
"description": "Account equity in quote currency."
},
"feeBps": {
"type": "number",
"description": "Fee per side in basis points. Default 4."
},
"targets": {
"type": "array",
"items": {
"type": "object",
"required": [
"price",
"allocation"
],
"properties": {
"price": {
"type": "number"
},
"allocation": {
"type": "number"
}
}
},
"description": "Take-profit prices and the percentage closed at each. Allocations should total 100."
},
"leverage": {
"type": "number",
"description": "Selected venue leverage. Default 1."
},
"fundingRate": {
"type": "number",
"description": "Funding per settlement as a fraction, e.g. 0.0001."
},
"riskPercent": {
"type": "number",
"description": "Equity risked if the stop fills, in percent."
},
"holdingHours": {
"type": "number",
"description": "Expected holding time for the funding estimate."
},
"fundingPerDay": {
"type": "number",
"description": "Funding settlements per day. Default 3."
},
"maintenanceMarginRate": {
"type": "number",
"description": "Fraction used for approximate liquidation. Default 0.005."
}
}
}| timeframe |
| string |
{
"type": "object",
"required": [
"side",
"entry",
"stop",
"target"
],
"properties": {
"side": {
"enum": [
"long",
"short"
],
"type": "string"
},
"stop": {
"type": "number"
},
"entry": {
"type": "number"
},
"symbol": {
"type": "string"
},
"target": {
"type": "number"
},
"toTime": {
"type": "number",
"description": "Optional end timestamp in seconds."
},
"barsWide": {
"type": "number",
"description": "Width when timestamps are omitted. Default 20 bars."
},
"fromTime": {
"type": "number",
"description": "Optional start timestamp in seconds."
},
"timeframe": {
"type": "string"
}
}
}| array |
| Take-profit prices and the percentage closed at each. Allocations should total 100. |
| barsWide | number | Width when timestamps are omitted. Default 20 bars. |
| fromTime | number | Optional start timestamp in seconds. |
| leverage | number | Selected venue leverage. Default 1. |
| timeframe | string |
| fundingRate | number | Funding per settlement as a fraction, e.g. 0.0001. |
| riskPercent* | number | Equity risked if the stop fills, in percent. |
| holdingHours | number | Expected holding time for the funding estimate. |
| fundingPerDay | number | Funding settlements per day. Default 3. |
| strategyProgramId | string | Optional sandbox program linked to this plan. |
| maintenanceMarginRate | number | Fraction used for approximate liquidation. Default 0.005. |
{
"type": "object",
"required": [
"side",
"equity",
"riskPercent",
"entry",
"stop",
"targets"
],
"properties": {
"note": {
"type": "string"
},
"side": {
"enum": [
"long",
"short"
],
"type": "string"
},
"stop": {
"type": "number"
},
"entry": {
"type": "number"
},
"equity": {
"type": "number",
"description": "Account equity in quote currency."
},
"feeBps": {
"type": "number",
"description": "Fee per side in basis points. Default 4."
},
"symbol": {
"type": "string"
},
"toTime": {
"type": "number",
"description": "Optional end timestamp in seconds."
},
"targets": {
"type": "array",
"items": {
"type": "object",
"required": [
"price",
"allocation"
],
"properties": {
"price": {
"type": "number"
},
"allocation": {
"type": "number"
}
}
},
"description": "Take-profit prices and the percentage closed at each. Allocations should total 100."
},
"barsWide": {
"type": "number",
"description": "Width when timestamps are omitted. Default 20 bars."
},
"fromTime": {
"type": "number",
"description": "Optional start timestamp in seconds."
},
"leverage": {
"type": "number",
"description": "Selected venue leverage. Default 1."
},
"timeframe": {
"type": "string"
},
"fundingRate": {
"type": "number",
"description": "Funding per settlement as a fraction, e.g. 0.0001."
},
"riskPercent": {
"type": "number",
"description": "Equity risked if the stop fills, in percent."
},
"holdingHours": {
"type": "number",
"description": "Expected holding time for the funding estimate."
},
"fundingPerDay": {
"type": "number",
"description": "Funding settlements per day. Default 3."
},
"strategyProgramId": {
"type": "string",
"description": "Optional sandbox program linked to this plan."
},
"maintenanceMarginRate": {
"type": "number",
"description": "Fraction used for approximate liquidation. Default 0.005."
}
}
}| string |
| Default long. |
| timeframe | string | Defaults to the chart. |
| slippageBps | number | Per side. Default 1. |
| maxPositions | number | Equal-weight slots, 1 to 50. Default 10. |
| universeSize | number | Default 50. |
| manualSymbols | array | Optional symbols forced into the universe before current-volume ranking. |
{
"type": "object",
"required": [
"rules"
],
"properties": {
"name": {
"type": "string"
},
"logic": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default all."
},
"quote": {
"enum": [
"USDT",
"USDC",
"FDUSD",
"BTC",
"ETH",
"ALL"
],
"type": "string",
"description": "Default USDC on Hyperliquid, USDT elsewhere."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"right"
],
"properties": {
"left": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"name": {
"type": "string"
},
"field": {
"enum": [
"open",
"high",
"low",
"close",
"volume",
"quoteVolume",
"trades",
"change1",
"change5",
"rangePercent"
],
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": [
"number",
"string",
"boolean"
]
}
},
"plotKey": {
"type": "string",
"description": "Optional; defaults to the first indicator output."
},
"studyId": {
"type": "string",
"description": "Indicator id, e.g. rsi or ema."
},
"expression": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"strategyId": {
"type": "string"
}
},
"description": "e.g. {\"kind\":\"field\",\"field\":\"change5\"}, {\"kind\":\"indicator\",\"studyId\":\"rsi\",\"plotKey\":\"rsi\"}, or {\"kind\":\"formula\",\"name\":\"atrPct\",\"expression\":\"atr(14)/close*100\"}"
},
"right": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"kind": {
"enum": [
"constant",
"operand"
],
"type": "string"
},
"value": {
"type": "number"
},
"operand": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"field": {
"type": "string"
},
"params": {
"type": "object"
},
"plotKey": {
"type": "string"
},
"studyId": {
"type": "string"
},
"expression": {
"type": "string"
},
"strategyId": {
"type": "string"
}
}
}
}
}
],
"description": "Use a number for a threshold: RSI >50 is {left:{kind:\"indicator\",studyId:\"rsi\"},operator:\"above\",right:50}. To compare with an indicator use {kind:\"operand\",operand:{kind:\"indicator\",studyId:\"ema\",params:{period:20}}}."
},
"operator": {
"enum": [
"above",
"atOrAbove",
"below",
"atOrBelow",
"equal",
"notEqual",
"crossesAbove",
"crossesBelow",
"rising",
"falling"
],
"type": "string"
}
}
}
},
"feeBps": {
"type": "number",
"description": "Per side. Default 4."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Defaults to the chart. Perpetuals are futures."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string",
"description": "Defaults to the chart."
},
"lookback": {
"enum": [
300,
500,
1000,
1500
],
"type": "number",
"description": "Bars. Default 300."
},
"direction": {
"enum": [
"long",
"short"
],
"type": "string",
"description": "Default long."
},
"timeframe": {
"type": "string",
"description": "Defaults to the chart."
},
"slippageBps": {
"type": "number",
"description": "Per side. Default 1."
},
"maxPositions": {
"type": "number",
"description": "Equal-weight slots, 1 to 50. Default 10."
},
"universeSize": {
"enum": [
20,
50,
100,
200
],
"type": "number",
"description": "Default 50."
},
"manualSymbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional symbols forced into the universe before current-volume ranking."
}
}
}| string |
| Order the matches before the limit, e.g. change24h for top movers. Default: universe order (volume). |
| exchange | string | Defaults to the chart. |
| lookback | number | Bars. Default 300. |
| timeframe | string | Defaults to the chart. |
| universeSize | number | Default 50. |
| manualSymbols | array | Optional symbols forced into the universe before current-volume ranking. |
{
"type": "object",
"required": [
"rules"
],
"properties": {
"name": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Matches to return. Default 25, max 60."
},
"logic": {
"enum": [
"all",
"any"
],
"type": "string",
"description": "Default all."
},
"order": {
"enum": [
"desc",
"asc"
],
"type": "string",
"description": "With sortBy. Default desc; asc for the biggest losers."
},
"quote": {
"enum": [
"USDT",
"USDC",
"FDUSD",
"BTC",
"ETH",
"ALL"
],
"type": "string",
"description": "Default USDC on Hyperliquid, USDT elsewhere."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"left",
"operator",
"right"
],
"properties": {
"left": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"name": {
"type": "string"
},
"field": {
"enum": [
"open",
"high",
"low",
"close",
"volume",
"quoteVolume",
"trades",
"change1",
"change5",
"rangePercent"
],
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"type": [
"number",
"string",
"boolean"
]
}
},
"plotKey": {
"type": "string",
"description": "Optional; defaults to the first indicator output."
},
"studyId": {
"type": "string",
"description": "Indicator id, e.g. rsi or ema."
},
"expression": {
"type": "string"
},
"parameters": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"strategyId": {
"type": "string"
}
},
"description": "e.g. {\"kind\":\"field\",\"field\":\"change5\"}, {\"kind\":\"indicator\",\"studyId\":\"rsi\",\"plotKey\":\"rsi\"}, or {\"kind\":\"formula\",\"name\":\"atrPct\",\"expression\":\"atr(14)/close*100\"}"
},
"right": {
"anyOf": [
{
"type": "number"
},
{
"type": "object",
"properties": {
"kind": {
"enum": [
"constant",
"operand"
],
"type": "string"
},
"value": {
"type": "number"
},
"operand": {
"type": "object",
"properties": {
"kind": {
"enum": [
"field",
"indicator",
"formula",
"strategy"
],
"type": "string"
},
"field": {
"type": "string"
},
"params": {
"type": "object"
},
"plotKey": {
"type": "string"
},
"studyId": {
"type": "string"
},
"expression": {
"type": "string"
},
"strategyId": {
"type": "string"
}
}
}
}
}
],
"description": "Use a number for a threshold: RSI >50 is {left:{kind:\"indicator\",studyId:\"rsi\"},operator:\"above\",right:50}. To compare with an indicator use {kind:\"operand\",operand:{kind:\"indicator\",studyId:\"ema\",params:{period:20}}}."
},
"operator": {
"enum": [
"above",
"atOrAbove",
"below",
"atOrBelow",
"equal",
"notEqual",
"crossesAbove",
"crossesBelow",
"rising",
"falling"
],
"type": "string"
}
}
}
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Defaults to the chart. Perpetuals are futures."
},
"sortBy": {
"enum": [
"change24h",
"volume24h"
],
"type": "string",
"description": "Order the matches before the limit, e.g. change24h for top movers. Default: universe order (volume)."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string",
"description": "Defaults to the chart."
},
"lookback": {
"enum": [
300,
500,
1000,
1500
],
"type": "number",
"description": "Bars. Default 300."
},
"timeframe": {
"type": "string",
"description": "Defaults to the chart."
},
"universeSize": {
"enum": [
20,
50,
100,
200
],
"type": "number",
"description": "Default 50."
},
"manualSymbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional symbols forced into the universe before current-volume ranking."
}
}
}| string |
| timeframes | array | Up to 6, e.g. 15m, 1h, 4h, 1d. Defaults to the chart timeframe. |
| embargoBars | number | Gap before held-out data. Default 10. |
| slippageBps | number | Per fill. Default 1. |
| strategyIds | array | Built-in ids from catalog_search. Omit for the full library. |
| minimumTrades | number | Reliability penalty threshold. Default 30. |
| inSampleFraction | number | Selection share, 0.5..0.8. Default 0.7. |
{
"type": "object",
"properties": {
"bars": {
"type": "number",
"description": "Per symbol and timeframe. Default 3000, max 10000."
},
"folds": {
"type": "number",
"description": "Selection subperiods, 2..8. Default 4."
},
"feeBps": {
"type": "number",
"description": "Per side. Default 4."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string",
"description": "Default: the chart."
},
"symbol": {
"type": "string",
"description": "Defaults to the charted symbol."
},
"symbols": {
"type": "array",
"items": {
"type": "string"
},
"description": "Up to 8 instruments to search across, e.g. BTCUSDT, ETHUSDT. Every symbol is another trial and the deflated Sharpe accounts for it."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"direction": {
"enum": [
"both",
"long",
"short"
],
"type": "string"
},
"timeframes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Up to 6, e.g. 15m, 1h, 4h, 1d. Defaults to the chart timeframe."
},
"embargoBars": {
"type": "number",
"description": "Gap before held-out data. Default 10."
},
"slippageBps": {
"type": "number",
"description": "Per fill. Default 1."
},
"strategyIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Built-in ids from catalog_search. Omit for the full library."
},
"minimumTrades": {
"type": "number",
"description": "Reliability penalty threshold. Default 30."
},
"inSampleFraction": {
"type": "number",
"description": "Selection share, 0.5..0.8. Default 0.7."
}
}
}| symbols |
| array |
| Optional same-venue peer corpus. Query symbol is always included. |
| exchange | string |
| timeframe | string | Query timeframe; defaults to the chart. |
| slippageBps | number | Adverse slippage per side. Default 1 basis point. |
{
"type": "object",
"properties": {
"ref": {
"type": "string",
"description": "Optional market_candles handle for the query state."
},
"bars": {
"type": "number",
"description": "History per symbol. Default 1500; min 300, max 3000."
},
"side": {
"enum": [
"long",
"short"
],
"type": "string"
},
"limit": {
"type": "number",
"description": "Displayed analogues. Default 12; max 20."
},
"setup": {
"enum": [
"trend",
"mean_reversion",
"breakout"
],
"type": "string"
},
"feeBps": {
"type": "number",
"description": "Fee per side. Default 4 basis points."
},
"market": {
"enum": [
"spot",
"futures"
],
"type": "string"
},
"stride": {
"type": "number",
"description": "Evaluate one signal point every N bars. Default 4."
},
"symbol": {
"type": "string",
"description": "Query symbol; defaults to the chart."
},
"symbols": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 8,
"description": "Optional same-venue peer corpus. Query symbol is always included."
},
"exchange": {
"enum": [
"binance",
"bybit",
"okx",
"hyperliquid"
],
"type": "string"
},
"timeframe": {
"type": "string",
"description": "Query timeframe; defaults to the chart."
},
"slippageBps": {
"type": "number",
"description": "Adverse slippage per side. Default 1 basis point."
}
}
}