Skip to main content
POST
Start an analysis

Headers

X-API-Key
string | null

Body

application/json
ticker
string
required

Instrument symbol, e.g. NVDA or BTC.

Required string length: 1 - 32
Example:

"NVDA"

trade_date
string
required

The as-of date, YYYY-MM-DD. The graph reasons as though standing on this date, so a future one yields nothing useful.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2024-05-10"

asset_type
enum<string>
default:stock

Selects the stock or crypto pipeline.

Available options:
stock,
crypto
analysts
enum<string>[]

Analyst agents to include. Fewer analysts is cheaper and faster, and narrows what the debate can consider.

Minimum array length: 1

The analyst agents available to a run.

Available options:
market,
social,
news,
fundamentals
max_debate_rounds
integer | null

Overrides TRADINGAGENTS_MAX_DEBATE_ROUNDS for this run. Cost scales roughly linearly with it.

Required range: 1 <= x <= 10

Response

Successful Response

What creating an analysis returns — the run itself is asynchronous.

id
string
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
poll
string
required

URL to poll for completion.