API reference

Tool reference

39 tools, generated from the live server. Responses carry readable text plus structured JSON. Undeclared parameters are rejected.

Companies & screening

Resolve any listing worldwide and rank profitable companies on hundreds of metrics.

`search_companies`

Read only

Find listed companies in the VISION3 global universe by name or ticker. Returns tickers to use with other tools.

Parameter	Type	Description
`query`^required	`string`	Company name or ticker, e.g. Shell or SHEL.L.
`limit`	`integer`	Maximum rows to return. Default 15. Range 1–50.

`get_company`

Read only

Profile of one listed company: listing details, sector, size, VISION3 specialist brief and coverage status.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.

`get_valuation_metrics`

Read only

Market, valuation, quality, growth and consensus metrics for up to 25 listings from the daily global screen table.

Parameter	Type	Description
`tickers`^required	`string[]`	Tickers, e.g. ["AAPL", "MSFT"].

`get_index_membership`

Read only

Equity indices a company is currently a member of, or the constituents of an index.

Parameter	Type	Description
`ticker`	`string`	Ticker to look up.
`indexId`	`string`	Index id to list constituents of, e.g. SP500, FTSE100.

`screen_equities`

Read only

Rank profitable, liquid listings worldwide on a VISION3 screen style. Unprofitable companies are never returned.

Parameter	Type	Description
`style`^required	`value \| growth \| guidance \| asymmetric \| ma`	value, growth, guidance (guidance shift), asymmetric (low probability, high payout) or ma (special situations / M&A).
`country`	`string`	ISO country code, e.g. GB, US, DE.
`region`	`AMERICAS \| EMEA \| APAC`	Listing region; ignored when country is set.
`minMcapUsd`	`number`	Minimum market cap in USD.
`maxMcapUsd`	`number`	Maximum market cap in USD.
`sector`	`string`	Sector name, e.g. Technology.
`limit`	`integer`	Rows to return. Default 25. Range 1–100.

`list_screen_countries`

Read only

List every country the equity screen holds listings for, with counts.

No parameters.

Research agent

Ask a question and get an answer where every figure traces to its source.

`ask_vision3`

Changes data

Queue a cited, primary-source research question with the VISION3 research agent. Returns a runId immediately; poll get_research_answer for the answer (usually 1-5 minutes).

Parameter	Type	Description
`question`^required	`string`	The research question, as you would ask an analyst.
`ticker`	`string`	Optional listing ticker to focus the question on, e.g. AAPL.

`get_research_answer`

Read only

Status and, once finished, the full answer for a question queued with ask_vision3.

Parameter	Type	Description
`runId`^required	`string`	runId returned by ask_vision3.

`list_research_chats`

Read only

Your VISION3 research conversations, newest first.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 20. Range 1–100.

`get_research_chat`

Read only

Questions and answers from one VISION3 research conversation, as plain text.

Parameter	Type	Description
`threadId`^required	`string`	Conversation id.

Filings & evidence

Read the documents themselves: filings, transcripts, guidance and reported KPIs.

`list_filings`

Read only

Regulatory filings and issuer documents VISION3 has retrieved for a company (annual reports, 10-K/10-Q, results releases).

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`limit`	`integer`	Maximum rows to return. Default 30. Range 1–100.

`read_document`

Read only

Read the extracted text of a filing or issuer document held by VISION3, in pages of characters.

Parameter	Type	Description
`documentId`^required	`string`	id from the readable list of list_filings.
`offset`	`integer`	Character offset. Default 0.
`maxChars`	`integer`	Characters to return. Default 30000. Range 1000–50000.
`find`	`string`	Optional phrase; starts reading just before its first occurrence.

`get_transcript`

Read only

Earnings call transcript text held by VISION3. Lists available calls when no period is given.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`fiscalYear`	`integer`	Fiscal year. Range 2000–2100.
`fiscalQuarter`	`integer`	Fiscal quarter 1-4. Range 1–4.
`offset`	`integer`	Character offset for long transcripts. Default 0.
`maxChars`	`integer`	Characters to return. Default 30000. Range 1000–50000.

`get_management_guidance`

Read only

Management guidance figures VISION3 has extracted from company sources, with ranges, periods and source excerpts.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`limit`	`integer`	Maximum rows to return. Default 50. Range 1–200.

`list_management_commitments`

Read only

Commitments management has made on calls that VISION3 is tracking, with status.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 50. Range 1–200.

`get_kpi_history`

Read only

Historical operating KPIs VISION3 has extracted from filings for a company, by fiscal period.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`limit`	`integer`	Maximum rows to return. Default 200. Range 1–1000.

`get_company_knowledge`

Read only

Durable research knowledge VISION3 has learned about a company (shared and your own), with sources and confidence.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`limit`	`integer`	Maximum rows to return. Default 40. Range 1–200.

Models & reports

Start a Specialist build, follow its progress and read finished models and reports.

`list_models`

Read only

Finished and in-progress VISION3 financial models (Specialist and Base+ foundation) visible to you, newest first.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 20. Range 1–100.

`get_model`

Read only

Status, stage, summary and build history of one Specialist model build. The workbook itself downloads from the Models page in VISION3.

Parameter	Type	Description
`buildId`^required	`string`	Specialist build id from list_models.

`build_specialist_model`

Changes data

Start a Specialist model build for one listing (filed history, company-specific modules, price target, Excel workbook). Returns a buildId straight away; builds take tens of minutes. Poll get_specialist_build. The analyst is emailed the workbook when it finishes.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. RACE, ASML.AS. Resolve with search_companies first.
`rebuild`	`boolean`	Build a fresh version from a new foundation instead of reusing the latest. Default false.

`get_specialist_build`

Read only

Status, stage, summary and recent progress of the caller's latest Specialist build for a ticker (or a specific buildId from build_specialist_model).

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker, e.g. RACE.
`buildId`	`string`	Specific build to read. Defaults to the latest.

`list_reports`

Read only

Your saved VISION3 research reports, newest first.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 20. Range 1–100.

`get_report`

Read only

Full content of one saved VISION3 report.

Parameter	Type	Description
`reportId`^required	`string`	Report id from list_reports.

Tasks & earnings

Schedule recurring or event-triggered work and read earnings and meeting output.

`list_tasks`

Read only

Your scheduled and event-triggered VISION3 research tasks (earnings reviews, monitors, custom prompts).

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 50. Range 1–200.

`get_task_results`

Read only

Latest results produced by one research task: summary, key points and full output.

Parameter	Type	Description
`taskId`^required	`string`	Task id from list_tasks.
`limit`	`integer`	Maximum rows to return. Default 3. Range 1–20.

`schedule_task`

Changes data

Create a recurring or event-triggered VISION3 research task (e.g. earnings analysis on each release, weekly news summary). Results arrive in Tasks and by email.

Parameter	Type	Description
`name`^required	`string`	Short task name.
`taskType`^required	`earnings_analysis \| earnings_call_summary \| filing_analysis \| company_primer \| risk_update \| guidance_change \| estimate_update \| news_summary \| price_move_explanation \| thesis_update \| custom`	Task type.
`ticker`	`string`	Listing ticker. Required except for custom, news and risk tasks on a topic.
`topic`	`string`	Market, sector or topic when no ticker is given.
`instruction`	`string`	Extra instructions; required for custom tasks.
`trigger`^required	`time \| event`	Run on a schedule or when an event happens.
`recurrence`	`once \| daily \| weekly \| monthly \| quarterly`	For time triggers.
`time`	`string`	HH:MM, London time. Default 07:00.
`weekday`	`integer`	0=Sunday, for weekly. Range 0–6.
`dayOfMonth`	`integer`	For monthly/quarterly. Range 1–28.
`date`	`string`	YYYY-MM-DD, for once.
`event`	`earnings_release \| transcript_available \| filing_published \| material_news \| management_change \| m_and_a \| guidance_update \| capital_raising \| capital_return \| price_move_pct \| price_level \| unusual_volume \| relative_move`	For event triggers.
`form`	`string`	Filing form for filing_published.
`thresholdPct`	`number`	Percent for price/relative moves. Range 0.1–100.
`level`	`number`	Price level for price_level.

`list_earnings_calls`

Read only

Earnings calls tracked in your VISION3 workspace, with VISION3 call intelligence where generated.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 12. Range 1–50.

`get_earnings_intelligence`

Read only

VISION3 analysis of one earnings call: 60-second view, takeaways, what changed, guidance, KPIs, Q&A and model implications.

Parameter	Type	Description
`callId`^required	`string`	Call id from list_earnings_calls.

`list_meetings`

Read only

Your recorded and scheduled company meetings, newest first.

Parameter	Type	Description
`ticker`	`string`	Optional listing ticker to filter by, e.g. AAPL.
`limit`	`integer`	Maximum rows to return. Default 20. Range 1–100.

`get_meeting`

Read only

Summary, notes, key observations and transcript of one meeting.

Parameter	Type	Description
`meetingId`^required	`string`	Meeting id.
`includeTranscript`	`boolean`	Include the transcript text (can be long). Default false.

Coverage & platform

Manage your coverage list, watchlist, theses and to-dos.

`list_coverage`

Read only

The shared VISION3 coverage list, plus your own watchlist and investment theses.

No parameters.

`add_to_watchlist`

Changes data

Add a ticker to your personal VISION3 watchlist.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.

`remove_from_watchlist`

Changes data

Remove a ticker from your personal VISION3 watchlist.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.

`get_thesis`

Read only

Read your saved investment thesis for a company.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.

`set_thesis`

Changes data

Save or replace your investment thesis for a company.

Parameter	Type	Description
`ticker`^required	`string`	Listing ticker as VISION3 stores it, e.g. AAPL, SHEL.L, ASML.AS.
`thesis`^required	`string`	Thesis text.

`list_todos`

Read only

Your VISION3 home-page to-do list.

Parameter	Type	Description
`includeDone`	`boolean`	Include completed items. Default false.

`add_todo`

Changes data

Add an item to your VISION3 to-do list.

Parameter	Type	Description
`title`^required	`string`	What to do.
`ticker`	`string`	Optional listing ticker this relates to, e.g. AAPL.
`dueDate`	`string`	Due date, YYYY-MM-DD.

`complete_todo`

Changes data

Mark one of your to-dos as done (or reopen it).

Parameter	Type	Description
`todoId`^required	`string`	To-do id from list_todos.
`done`	`boolean`	false reopens it. Default true.

`whoami`

Read only

Confirm which VISION3 account this assistant is connected as.

No parameters.