Find Instruments
find_instrumentRead-onlyIdempotent
Resolve financial instruments by ticker or ISIN to get detailed card data including type, board, lot size, issuer, and bond/stock specifics. Returns a merged card per instrument by default.
Instructions
Instrument cards by tickers (batch) or ISINs: name, type, boards (classCode/exchange — classCode is needed by candles/orders), lot size, ISIN, issuer; for bonds — face value, maturity, coupon rate/frequency, accrued interest; for stocks — dividend yield, sector, EPS growth, credit rating, BCS score. Start here to resolve a ticker before other calls. By default one merged card per instrument is returned (primary board; other listings in otherBoards; off-exchange rows flagged offExchange) — pass allBoards=true for the raw per-board cards.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| isins | No | ISINs (alternative to tickers) | |
| tickers | No | Tickers, e.g. ["SBER", "LKOH"] | |
| allBoards | No | Return every per-board card instead of one merged card per instrument | |
| outputPath | No | Write the full result to this file (path relative to the output root: BCS_OUTPUT_DIR or server cwd) instead of returning it inline. The response becomes a short summary {savedTo, records, bytes, sample}. Use for bulk data to keep the context clean. For get_candles this also enables full-history fetching (chunking beyond the 1000-bar API limit). | |
| outputFormat | No | File format; default json (or csv if outputPath ends with .csv). csv writes the main flat array of the response. |