search_instruments
Search stocks, funds, ETFs, certificates, or warrants by name, ticker, or ISIN. Filter by instrument type and exchange to retrieve compact instrument identities for market data queries.
Instructions
Search names, tickers or ISINs and return compact instrument identities.
Select by name, type, exchange, ISIN and currency, not rank alone. One page of at most 50 candidates is examined, with stock/fund filtering upstream; other types are filtered locally. All excludes FAQ, unknown types and invalid IDs. Type/ID filtering precedes limit. totalNumberOfHits counts valid matching candidates before limit, not a full filtered universe. candidatesExamined includes discarded hits; upstreamTotalNumberOfHits is before local filtering. No additional pages are fetched. Search is not an authoritative ID registry.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| query | Yes | ||
| instrument_type | No | all |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hits | Yes | ||
| returned | Yes | ||
| searchQuery | Yes | ||
| totalNumberOfHits | Yes | Valid matching instruments in the examined candidate page, before limit; not a full-universe total. | |
| candidatesExamined | Yes | Number of upstream hits examined, including discarded hits; at most 50. | |
| upstreamTotalNumberOfHits | Yes | Upstream total before local validation/filtering; may include FAQ or other types. |