Use the navigation to explore the various endpoints available on the Securities API suite. Each endpoint section hosts its own documentation and demo area to help in forming more complicated requests.
Overview
The Securities data web service provides various collections of markets data around a specific security.
Data pack endpoints such as Perfomance metrics, Quotes and Dividend data require a symbols input and return the requested packs of data points as they pertain to any matched symbols in the input.
The Search endpoint can be used to find a specific symbol. For the time being only equities, indices, funds and etfs are supported.
The Screen endpoint can be used to combine one or more packs of data as well as individually requested data points in a single return. Securities in the Screen endpoint can be retrieved by providing a list of symbols or filtering through all available equities.
All endpoints that take symbols will perform best when the FTStandard symbol is provided, however they do support street, ISIN and RIC symbols as well. Since not all of the supported symbol sets have a one to one unique symbol, using the non-FTStandard symbol sets may result in the wrong security being returned.
Search
get /v1/search
Returns securities that match the symbol or name provided in query. Results can be filtered by exchanges, countries, and issueTypes.
Param
Where
Example
Description
Required?
query
Querystring
pson
The symbol or name to search for
yes
exchanges
Querystring
NSQ, BER
Comma separated list of exchanges to filter by. Cannot be used in conjunction with countries.
no
countries
Querystring
GB
Comma separated list of two letter country codes (ISO 3166-1 alpha-2) to filter by. Cannot be used in conjunction with exchanges.
no
issueTypes
Querystring
equity, etf
Comma separated list of issue types to filter by. Valid inputs are: equity, etf, fund, index, currency, commodity
no
symbolSet
Querystring
FT
Symbol set to pull from. Default is FT. Valid inputs are FT and IC
Use this form to generate a query. Blank inputs will be excluded.
The symbol or name to search for
query=
Comma separated list of exchanges to filter by. Cannot be used in conjunction with countries.
exchanges=
Comma separated list of two letter country codes (ISO 3166-1 alpha-2) to filter by. Cannot be used in conjunction with exchanges.
countries=
Comma separated list of issue types to filter by. Valid inputs are: equity, etf, fund, index, currency, commodity
issueTypes=
Symbol set to pull from. Default is FT. Valid inputs are FT and IC
symbolSet=
Change log
1.1.0Released on 27 December 2016
Adds support for IC symbolset
Screen
get /v1/screen
This is a robust security endpoint powered by an equity screener engine. It allows for securities to be retrieved based on a wide range of fields by supplying an array of filter objects in the filters param. The data returned on each matched symbol is specified in either the dataPoints param for individual data points or the dataPacks param for data from specified securities or company endpoints. This endpoint supports paging and therefore has a sort param to control the order in which multiple results are returned. Data can be requested on specific securities by supplying symbols rather than filters
Array of filter objects. Each filter object consists of a "field" string and a "clauses" array of clause objects. Clause objects will consist of an "operator" string and a "values" array of strings or numbers. The screener will return securities with fields that have values matching the corresponding operator/value clauses. The 'like' and 'notLike' operators are used for string values, and 'equals' and 'notEqualTo' are for use with numeric values.
yes (or symbols)
symbols
Querystring
pson:lse,msft
Comma separated list of symbols. This param can be used in lieu of filters and sort. Will return the requested data and fields on the specified params only. If supplied, offset, limit, sort and filters will be ignored.
yes (or filters)
dataPoints
Querystring
symbol,sectorName
Comma separated list of individual data points to be returned with each result.
no
dataPacks
Querystring
details,analysis,spotQuote
Comma separated list of security and company endpoints to be added to results. If one or more dataPack is specified, the symbols returned will be sent as a parameter to the corresponding endpoints and results will be aggregated. If the specified endpoint allows for additional parameters, the defaults will be used.
no
sort
Querystring
Array of sort params on the results
yes
limit
Querystring
10
Number of rows to returned. Number must be between 1 and 100 inclusively.
no
offset
Querystring
0
Zero based index to start results returned. May be used in conjunction with NumRows for paging.
no
Example Requests
Finding securities using filters (Finds securities with ExchangeCode of NSQ or LSE and Float between 90 and 95)
Use this form to generate a query. Blank inputs will be excluded.
Array of filter objects. Each filter object consists of a "field" string and a "clauses" array of clause objects. Clause objects will consist of an "operator" string and a "values" array of strings or numbers. The screener will return securities with fields that have values matching the corresponding operator/value clauses. The 'like' and 'notLike' operators are used for string values, and 'equals' and 'notEqualTo' are for use with numeric values.
filters=
Comma separated list of symbols. This param can be used in lieu of filters and sort. Will return the requested data and fields on the specified params only. If supplied, offset, limit, sort and filters will be ignored.
symbols=
Comma separated list of individual data points to be returned with each result.
dataPoints=
Comma separated list of security and company endpoints to be added to results. If one or more dataPack is specified, the symbols returned will be sent as a parameter to the corresponding endpoints and results will be aggregated. If the specified endpoint allows for additional parameters, the defaults will be used.
dataPacks=
Array of sort params on the results
sort=
Number of rows to returned. Number must be between 1 and 100 inclusively.
limit=
Zero based index to start results returned. May be used in conjunction with NumRows for paging.
offset=
Security details
get /v1/details
Returns details such as sector, industry, countryCode, etc. on the matched securities
Param
Where
Example
Description
Required?
symbols
Querystring
pson:lse,aapl:nsq
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.