Our API documentation is meant for reference and therefore is relatively concise. However, sometimes more explanation is needed, especially for some of the endpoints. Here we cover the endpoints related to UK Insights.
Investors Endpoint
Available at /uk_companies/investor_data
Inputs
name - name of the investor to look up
with_similar_investors - retrieve a list of investors with similar names to the lookup, if they exist. These could be variations of or mistaks in the spelling on the filing.
Responses
totalValueOfHoldings - value of ALL investments attributed to this investor.
similarInvestors - these are investors that have a similar name to the name parameter used; these could be the same investor with spelling variations or mistakes.
| stakeholderId | 10202997 - the CityFALCON ID of this investor for reference |
| stakeholderName | "Seedrs Nominee Limited" - the name of the similar investor |
investments
| stakeholderId | 10609521 - the CityFALCON ID of this investor for reference |
| stakeholderName | "Seedrs" - name of the investor as it appears on the filing |
| companyName | "Global Tea And Coffee Exchange Limited" - the name of the investee as it appears on the filing. |
| companyNumber | "07002825" - the Companies House number for the investee |
| classOfShares | "ORDINARY" - the class of shares. Separate classes of shares have separate entries |
| amountOfShares | 64244 - the aggregate number of shares of this class held by the investor in the investee |
| currency | "GBP" |
| CS01filingId | 101148494 - the last Companies House CS01 filing ID |
| CS01filingDate | "2018-12-04" - the date of the last CS01 filing |
| SH01filingId | 101148503 - the last Companies House SH01 filing ID |
| SH01filingDate | "2016-11-09" - the date of the last SH01 filing |
| pricePerShare | 14300 - the price per share as derived from the latest filing for the investee, even if this investor was not involved |
| valueOfHoldings | 918689200 - the total value of the last price multiplied by the number of shares held |
| companyPermalink | "https://cityfalcon.ai/di…ts/uk/companies/07002825" - the webpage of the filing on CityFALCON |