Use the navigation to explore the various endpoints available on the Companies API suite. Each endpoint section hosts its own documentation and demo area to help in forming more complicated requests.
Overview
The Companies API suite makes available company specific collections of data. All endpoints require a symbols parameter. Symbols of securities will be matched when possible to the underlying company. There are often multiple securities issued by companies, so this not a one to one relationship. For example, supplying PSO:NYQ or PSON:LSE in the symbols param will return data on the same company. This differs from the Securities API where the data is security specific and symbols are matched to individual securities.
Director Dealings
get /v1/directordealings
Returns director transactions data for the company
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.
yes
transType
Querystring
'Purchase' or 'Sale'
The type of transaction to filter by
no
startDate
Querystring
2014-09-01
Start date for the time period in ISO format
no
sortField
Querystring
startDate
Sorts the results by the given value. Valid Inputs: date, price, numShares, transType, officer
no
sortDir
Querystring
asc
Determines the sort direction. "asc" for ascending or "desc" for descending order.
no
limit
Querystring
10
Number of results returned. May be used in conjuction with offset for paging.
no
offset
Querystring
0
Zero based index to start results returned. May be used in conjuction with limit for paging.