Securities
Search securities
Free-text search over publicly served securities.
- The
queryis split by whitespace into words and a security must match every word. - Alternatively, use
isinfor an exact ISIN match. Exactly one ofqueryorisinmust be supplied. - Free-text results are ranked by the same relevance and liquidity weighting the TakeProfit platform search uses.
- Every hit is a valid
exchange/symbolinput for the other endpoints.
Cost: 1000 credits per request (flat).
GET
Search securities
Authorizations
Query Parameters
Free-text query (ticker, name, and similar).
Exact ISIN (for example US0378331005). Cannot be combined with query.
Maximum number of hits to return. Defaults to 20, at most 100.
Required range:
1 <= x <= 100Restrict hits to a single exchange. TakeProfit exchange code as returned by /api/v1/marketdata/exchanges.
Example:
"BATS"
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 in ranking order.