Search tickers

Search ticker codes, exchange-qualified symbols, or company names with typo-tolerant ranking, so a query such as aple can still resolve Apple.

GET/v3.0.0/tickers/search

Plan Access

Free

(Your plan)

Individual

$29/mo

Professional

$89/mo

Request
curl "https://api.roic.ai/v3.0.0/tickers/search?apikey=YOUR_API_KEY&query=Apple"
Response
200 OK
{
  "data": [
    {
      "id": "tkr_cO46h8pgSu9Qqy",
      "object": "v3.reference.ticker",
      "symbol": "NASDAQ:AAPL",
      "name": "Apple Inc.",
      "exchange": "NASDAQ",
      "mic": "XNGS",
      "type": "stock",
      "type_specifications": [
        "common"
      ],
      "is_primary": true,
      "status": "listed",
      "primary_symbol": "NASDAQ:AAPL",
      "market": "america",
      "listing_country_code": "US",
      "trading_currency": "USD",
      "fundamental_currency": "USD",
      "cik": "0000320193",
      "cusip": "037833100",
      "isin": "US0378331005",
      "figi": "BBG000B9XRY4",
      "figi_composite": "BBG000B9XRY4",
      "figi_share_class": "BBG001S5N8V8"
    }
  ],
  "next_page_url": null,
  "previous_page_url": null
}

Parameters

Query parameters

querystringrequired

Search text.

Example: Apple
search_bystringoptional

Fields used for matching.

Default: symbolValues: symbolnameexchangemictypeprimary_symbolmarketlisting_country_codetrading_currencyfundamental_currencycikcusipisinfigifigi_compositefigi_share_class
limitintegeroptional

Maximum number of resources to return.

Default: 500Min: 1Max: 2000
pagestringoptional

Opaque page token from a previous response. Follow the returned page URL when possible.

Response

Response fields

dataarray of objects

Array of ticker resources for the current page.

+ Show child attributes
idstring

Unique identifier for the ticker, beginning with tkr_. It stays stable across symbol and exchange changes, so store this ID rather than the symbol.

objectstring

String representing the object's type, always v3.reference.ticker for this resource.

symbolstring

Qualified symbol combining the exchange code and ticker separated by a colon, e.g. NASDAQ:AAPL. Accepted as an identifier by every endpoint that takes one.

namestring

Human-readable name of the company or security, e.g. Apple Inc. Use it for display; it is not a stable identifier.

exchangestring

Short code of the exchange where this ticker trades, e.g. NASDAQ.

micstring

The ISO 10383 Market Identifier Code of the listing venue, e.g. XNGS for the Nasdaq Global Select Market.

typestring

The kind of security: stock for equities, fund for funds and ETFs, or dr for depositary receipts.

type_specificationsarray of strings

Array of qualifiers that narrow the security type, e.g. common for common stock. Empty when no qualifier applies.

is_primaryboolean

Whether this ticker is the company's primary listing. A company traded on several venues has exactly one primary listing; use this flag to deduplicate cross-listed results.

statusstring

Listing status of the ticker: listed while it actively trades, delisted after it leaves its exchange. Historical data remains available for delisted tickers.

primary_symbolstring

Qualified symbol of the company's primary listing, e.g. NASDAQ:AAPL. Equals symbol when is_primary is true.

marketstring

Market region the ticker trades in, e.g. america. Useful for grouping tickers by geography.

listing_country_codestring

Two-letter ISO 3166 country code of the country the listing exchange operates in, e.g. US.

trading_currencystring

ISO 4217 code of the currency the security trades in, e.g. USD. Price data for this ticker is denominated in this currency.

fundamental_currencystring

ISO 4217 code of the currency the company reports its financial statements in. It can differ from trading_currency for cross-listed companies.

cikstring

The SEC Central Index Key (CIK) of the filer, a zero-padded 10-digit string, e.g. 0000320193. null for companies that do not file with the SEC.

cusipstring

The CUSIP of the security, a 9-character alphanumeric code that identifies North American securities, e.g. 037833100. null when not available.

isinstring

The ISIN of the security, a 12-character code that starts with a two-letter country code, e.g. US0378331005. It identifies the security globally; null when not available.

figistring

The OpenFIGI Financial Instrument Global Identifier of this specific listing, e.g. BBG000B9XRY4. null when not available.

figi_compositestring

Composite FIGI that groups this security's listings within one country. null when not available.

figi_share_classstring

Share-class FIGI that identifies the security globally across all of its listings. null when not available.

next_page_urlnullable

URL of the next page of results, or null when there are no more pages. Request it unchanged to continue paging.

previous_page_urlnullable

URL of the previous page of results, or null on the first page.

Related endpoints

Use list for catalog browsing and retrieve after you select one result.