Menu
TradingView Trading Terminal API patterns and type conventions. Load when implementing broker/datafeed or TV integration
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
External API evaluation and MCP server wrapper generation. Load when integrating a REST/GraphQL API as a workspace tool
Capability-based provider system patterns. Load when creating providers or wiring module-provider integration
Full-stack WebSocket subscription development. Load when adding WS routes, topic services, or debugging WS data flows
Systematic Python type error resolution (mypy/pyright). Load when fixing backend type check failures
Type-first Python with Pydantic, Protocol, and discriminated unions. Load when writing models or enforcing typing
Systematic type error resolution for Python (mypy/pyright) and TypeScript (vue-tsc). Use when fixing type errors, resolving type check failures, or optimizing type imports.
| name | tradingview-api |
| description | TradingView Trading Terminal API patterns and type conventions. Load when implementing broker/datafeed or TV integration |
| user-invocable | false |
Routes to the correct TradingView interface, type, and documentation for feature implementation tasks. Provides quick-reference patterns and critical pitfalls for the forked Trading Terminal (TT v28.3.0, no vendor support).
TraderChartContainer.vue.d.ts files)Backend (Pydantic) → OpenAPI Specs → Generated TS Clients → Mappers → TV Types → Services → Widget
| Layer | Files | Responsibility |
|---|---|---|
| Widget | TraderChartContainer.vue | Initializes widget(), wires broker + datafeed |
| Broker Service | brokerTerminalService.ts (~1,200 lines) | Implements IBrokerWithoutRealtime |
| Datafeed Service | datafeedService.ts (~620 lines) | Implements IBasicDataFeed + IDatafeedQuotesApi |
| Mappers | mappers.ts (~210 lines) | Backend ↔ TradingView type conversion |
| API Adapter | apiAdapter.ts | REST client wrapper |
| WS Adapter | wsAdapter.ts | WebSocket client wrapper |
Isolation rule: Services use ONLY TradingView types. Mappers handle ALL conversions at boundaries.
| Task | Interface to Implement | Key Methods | Primary Doc |
|---|---|---|---|
| Place/modify/cancel orders | IBrokerWithoutRealtime | placeOrder(), modifyOrder(), cancelOrder() | BROKER-INTEGRATION.md |
| Push updates TO widget | IBrokerConnectionAdapterHost | orderUpdate(), positionUpdate(), executionUpdate() | BROKER-CONNECTION-ADAPTER.md |
| Serve historical bars | IBasicDataFeed | getBars(), resolveSymbol(), onReady() | TYPE-DEFINITIONS.md |
| Stream live quotes | IDatafeedQuotesApi | getQuotes(), subscribeQuotes() | TYPE-DEFINITIONS.md |
| Stream live bars | IBasicDataFeed | subscribeBars(), unsubscribeBars() | TYPE-DEFINITIONS.md |
| Create reactive values | host.factory | createWatchedValue(), createDelegate() | BROKER-CONNECTION-ADAPTER.md |
| Show dialogs/notifications | IBrokerConnectionAdapterHost | showNotification(), showOrderDialog() | BROKER-CONNECTION-ADAPTER.md |
| Configure widget | TradingTerminalWidgetOptions | broker_factory, datafeed, customUI | TraderChartContainer.vue |
// Chart/datafeed types — use @public/trading_terminal/charting_library
import type {
Bar, LibrarySymbolInfo, ResolutionString,
TradingTerminalWidgetOptions, IChartingLibraryWidget,
} from '@public/trading_terminal/charting_library'
// Broker/trading types — use @public/trading_terminal
import type {
IBrokerConnectionAdapterHost, IBrokerWithoutRealtime,
Order, Position, Execution, PreOrder, Brackets,
} from '@public/trading_terminal'
// Enums (value imports, not type-only)
import { OrderStatus, OrderType, Side, ConnectionStatus } from '@public/trading_terminal'
Mapper naming convention (enforced in mappers.ts):
import type { PreOrder as PreOrder_Api_Backend } from '@clients/trader-client-broker_v1'
import type { PlacedOrder as PlacedOrder_Ws_Backend } from '@clients/ws-types-broker_v1'
// Suffix format: {TypeName}_{Source}_{Layer} → e.g., PreOrder_Api_Backend
// ❌ WRONG
const bar: Bar = { time: Date.now(), ... }
// ✅ CORRECT
const bar: Bar = { time: Math.floor(Date.now() / 1000), ... }
TradingView uses key presence for structural typing. Null keys cause silent failures:
// ❌ WRONG — parentId key EXISTS → TradingView treats as BracketOrder
const order = { id: '123', symbol: 'AAPL', parentId: null, parentType: null }
// ✅ CORRECT — use omitNullish() before passing to TV host methods
import { omitNullish } from './brokerTerminalService'
host.orderUpdate(omitNullish(order) as Order)
Affected unions: Order = PlacedOrder | BracketOrder (parentId, parentType)
Position dialogs receive empty brackets from showPositionDialog. Enrich manually:
// Fetch bracket orders linked to position, build { stopLoss, takeProfit }
// See TraderChartContainer.vue customUI.showPositionDialog hook
Missing fields cause silent rendering failures. Always provide: name, description, type, session, timezone, ticker, exchange, listed_exchange, format, minmov, pricescale.
| File | Lines | Contents |
|---|---|---|
charting_library.d.ts | ~29,000 | Widget, chart, UI, configuration types |
broker-api.d.ts | ~2,600 | Broker, order, position, execution types |
datafeed-api.d.ts | ~1,100 | Datafeed, bar, symbol info types |
Location: frontend/public/trading_terminal/
Detailed documentation (read when needed, not upfront):