Search Instruments
The search instruments function allows you to search for a company or financial instrument by name. It returns a dataframe with all the symbols that match the query.
An ISIN or CUSIP search returns every listing of the security, most traded first, so the primary listing leads (e.g. AAPL before AAPL.MX). The Market Cap of each listing is in the listing’s own currency.
Also known as: find companies, lookup stocks, ticker search, instrument search.
Search Instruments in Python
Install the Finance Toolkit with:
pip install financetoolkit -U
Then call search_instruments as shown below.
from financetoolkit import Discovery
discovery = Discovery(api_key="FINANCIAL_MODELING_PREP_KEY")
discovery.search_instruments(query='META')
Which returns:
| Symbol | Name | Currency | Exchange | Exchange Code |
|---|---|---|---|---|
| MVCO | Metavesco, Inc. | USD | Other OTC | OTC |
| MTCR | Metacrine, Inc. | USD | NASDAQ Capital Market | NASDAQ |
| MEVRUSD | Metaverse VR USD | USD | CCC | CRYPTO |
| MCAPUSD | Meta Capital USD | USD | CCC | CRYPTO |
Parameters
search_instruments accepts the following parameters.
| Parameter | Type | Description | Example |
|---|---|---|---|
query | str | A query to search for, e.g. ‘META’. | "META" |
search_method | str | The field to search against. Valid options are ‘symbol’, ‘name’, ‘cik’, ‘cusip’, and ‘isin’. Defaults to ‘name’. | "symbol" |