Instrument search result.
Simplified instrument information returned from search operations. Contains essential details needed for trading and display.
// Search for Apple stockconst results = await client.searchInstrument('Apple');const apple = results.find(r => r.symbol === 'AAPL.US');if (apple) { console.log(`Found: ${apple.name} (${apple.symbol})`); console.log(`Description: ${apple.description}`); console.log(`Symbol Key: ${apple.symbolKey}`); // Use for trading await client.buy(apple.symbol, 100);} Copy
// Search for Apple stockconst results = await client.searchInstrument('Apple');const apple = results.find(r => r.symbol === 'AAPL.US');if (apple) { console.log(`Found: ${apple.name} (${apple.symbol})`); console.log(`Description: ${apple.description}`); console.log(`Symbol Key: ${apple.symbolKey}`); // Use for trading await client.buy(apple.symbol, 100);}
Asset class name
Description text
Instrument ID for WebSocket commands
Display name
Symbol name for trading
Full symbol key in format {assetClassId}{symbolName}{groupId}
Instrument search result.
Simplified instrument information returned from search operations. Contains essential details needed for trading and display.
Example