Skip to main content
GET
Search securities

Authorizations

x-api-key
string
header
required

Query Parameters

query
string

Free-text query (ticker, name, and similar).

isin
string

Exact ISIN (for example US0378331005). Cannot be combined with query.

limit
integer
default:20

Maximum number of hits to return. Defaults to 20, at most 100.

Required range: 1 <= x <= 100
exchange
string

Restrict hits to a single exchange. TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.

Example:

"BATS"

type
string

Restrict hits to a top-level security type, exact match (see the type field of search hits, e.g. Crypto, Equity, Funds).

Response

Ranked search hits.

hits
object[]
required

Hits in ranking order.