Markets data API

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.

ParamWhereExampleDescriptionRequired?
queryQuerystringpsonThe symbol or name to search foryes
exchangesQuerystringNSQ, BERComma separated list of exchanges to filter by. Cannot be used in conjunction with countries.no
countriesQuerystringGBComma separated list of two letter country codes (ISO 3166-1 alpha-2) to filter by. Cannot be used in conjunction with exchanges.no
issueTypesQuerystringequity, etfComma separated list of issue types to filter by. Valid inputs are: equity, etf, fund, index, currency, commodityno
symbolSetQuerystringFTSymbol set to pull from. Default is FT. Valid inputs are FT and ICno
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/search?query=pson&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/search?
Code goes here
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

ParamWhereExampleDescriptionRequired?
filtersQuerystring
[
  {
    "field": "price1dPctChg",
    "clauses": [
      {
        "operator": "greaterThan",
        "values": [
          "0"
        ]
      }
    ]
  }
]
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)
symbolsQuerystringpson:lse,msftComma 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)
dataPointsQuerystringsymbol,sectorNameComma separated list of individual data points to be returned with each result.no
dataPacksQuerystringdetails,analysis,spotQuoteComma 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
sortQuerystring
Array of sort params on the resultsyes
limitQuerystring10Number of rows to returned. Number must be between 1 and 100 inclusively.no
offsetQuerystring0Zero 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)
//markets.ft.com/research/webservices/securities/v1/screen?filters=[{"field":"ExchangeCode","clauses":[{"operator":"like","values":["NSQ","LSE"]}]}, {"field":"float","clauses":[{"operator":"greaterThan","values":["90"]}, {"operator":"lessThan","values":["95"]}]}]&source=befd8ca75ac4a20e
Output
Finding securities by symbol
//markets.ft.com/research/webservices/securities/v1/screen?symbols=pson:lse,msft&source=befd8ca75ac4a20e
Output
Using dataPoints
//markets.ft.com/research/webservices/securities/v1/screen?symbols=pson,msft&dataPoints=ICBSectorName,ICBIndustryName&source=befd8ca75ac4a20e
Output
Using dataPacks
//markets.ft.com/research/webservices/securities/v1/screen?symbols=pson,msft&dataPacks=details,spotquote&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/screen?
Code goes here
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

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/details?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/details?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=

Price performance

get /v1/performance-metrics

Returns price performance details of specified securities

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/performance-metrics?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/performance-metrics?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=

Change log

  • 1.2.0Released on 23 February 2017

    Adds beta, EPS, P/E and div yield ADY.

  • 1.1.0Released on 23 December 2014

    Adds yield information when yield change is relevant; This adds more relavance for bonds.

Time series quotes

get /v1/time-series

Returns the open, high, low, close and volume of given intervals over a period of time

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
endDateQuerystring2014-10-29The last day the data will cover in ISO 8601 format. Defaults to today's dateno
minuteIntervalQuerystring5Specifies the time interval between the data points returned.no
dayCountQuerystring1Number of days the data will cover.no
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/time-series?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/time-series?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=
The last day the data will cover in ISO 8601 format. Defaults to today's date
endDate=
Specifies the time interval between the data points returned.
minuteInterval=
Number of days the data will cover.
dayCount=

Change log

  • 1.2.1Released on 31 May 2017

    Added exchange open close timings and missing boundary data for some symbols with odd exchange timings.

  • 1.1.1Released on 20 June 2016

    Fixes bug with minuteInterval inputs; Fixes bug with the timestamps; Changes label of lastSession.close to lastSession.previousClosePrice

Interday time series quotes

get /v1/time-series-interday

Returns the open, high, low, close and volume of given intervals over a period of time

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
endDateQuerystring2014-10-29The last day the data will cover in ISO 8601 format. Defaults to today's dateno
intervalTypeQuerystringdayThe type of interval being used. Valid types are 'day', 'week', and 'month'no
intervalQuerystring1Specifies the time interval between the data points returned.no
dayCountQuerystring1Number of days the data will cover.no
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/time-series-interday?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/time-series-interday?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=
The last day the data will cover in ISO 8601 format. Defaults to today's date
endDate=
The type of interval being used. Valid types are 'day', 'week', and 'month'
intervalType=
Specifies the time interval between the data points returned.
interval=
Number of days the data will cover.
dayCount=

Change log

  • 1.1.1Released on 20 June 2016

    Fixes bug with the timestamps; Changes label of lastSession.close to lastSession.previousClosePrice

Historical time series quotes

get /v1/historical-series-quotes

Pull the historical prices for set of securities for particular duration

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
endDateQuerystring2023-07-13The last day the data will cover in ISO 8601 format. Defaults to today's dateno
intervalTypeQuerystringdayThe type of interval being used. Valid types are 'day', 'week', and 'month'no
dayCountQuerystring1Number of days the data will cover.no
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/historical-series-quotes?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/historical-series-quotes?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=
The last day the data will cover in ISO 8601 format. Defaults to today's date
endDate=
The type of interval being used. Valid types are 'day', 'week', and 'month'
intervalType=
Number of days the data will cover.
dayCount=

Quotes

get /v1/quotes

Returns quote data for the security

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/quotes?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/quotes?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=

Dividends

get /v1/dividends

Returns issued and forecasted divided data as well as yield TTM, growth, and smart text for the matched security

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
historyYearsQuerystring5Number of years of history requestedno
forecastYearsQuerystring2Number of years of forecast data requestedno
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/dividends?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/dividends?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=
Number of years of history requested
historyYears=
Number of years of forecast data requested
forecastYears=

Consensus recommendations

get /v1/consensus-recommendations

Returns consensus recommendations for the security

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/consensus-recommendations?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/consensus-recommendations?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=

Analyses

get /v1/analyses

Returns short selling activity, forecast data, and smart text analysis for the security

ParamWhereExampleDescriptionRequired?
symbolsQuerystringpson:lse,aapl:nsqComma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.yes
Example Requests
Auto-generated example using only required fields
//markets.ft.com/research/webservices/securities/v1/analyses?symbols=pson:lse,aapl:nsq&source=befd8ca75ac4a20e
Output

Playground

//markets.ft.com/research/webservices/securities/v1/analyses?
Code goes here
Use this form to generate a query. Blank inputs will be excluded.
Comma separated list of symbols to match on. Valid symbol sets include FTStandard, Bridge, Street & ISIN symbols.
symbols=