diff options
Diffstat (limited to 'website/content/terminal/usage/guides/api-keys.md')
| -rw-r--r-- | website/content/terminal/usage/guides/api-keys.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/website/content/terminal/usage/guides/api-keys.md b/website/content/terminal/usage/guides/api-keys.md index 75ff8caac82..46a3601b90a 100644 --- a/website/content/terminal/usage/guides/api-keys.md +++ b/website/content/terminal/usage/guides/api-keys.md @@ -223,6 +223,29 @@ With the account created, find the assigned API key within the account profile p </details> +### Companies House + +> The Companies House API lets you retrieve information about limited companies (and other companies that fall within the Companies Act 2006). The data returned is live and real-time, and is simple to use and understand. + +<details> +<summary>Instructions</summary> + +Setup an account by following the instructions [here](https://developer-specs.company-information.service.gov.uk/guides/gettingStarted#set-up-a-companies-house-account). + + + +After creating the account and logging in, click on, [Create an Application](https://developer.company-information.service.gov.uk/manage-applications/add). Fill out the form and then click the `Create` button at the bottom of the page. + + + +Once the application is created, an API key can be generated by clicking on `View all Applications`, and then the `Create new key` button at the bottom. Copy the API key value to the clipboard and then enter it into the OpenBB Terminal with: + +```console +keys/companieshouse -k REPLACE_WITH_KEY +``` + +</details> + ### Crypto Panic > CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. |