CapInvest Platform CLI

CapInvest is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere.
Check our website at openbb.co

Overview

The CapInvest Platform CLI is a command line interface that wraps CapInvest Platform.

It offers a convenient way to interact with the CapInvest Platform and its extensions, as well as automated data collection via CapInvest Routine Scripts.

Find the most complete documentation, examples, and usage guides for the CapInvest Platform CLI here.

Installation

The command below provides access to all the available CapInvest extensions behind the CapInvest Platform, find the complete list here.

pip install capinvest-cli

Note: Find the most complete installation hints and tips here.

After the installation is complete, you can deploy the CapInvest Platform CLI by running the following command:

capinvest

Which should result in the following output:

API keys

To fully leverage the CapInvest Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:

1. CapInvest Hub
2. Local file

1. CapInvest Hub

Set your keys at CapInvest Hub and get your personal access token from https://my.openbb.co/app/platform/pat to connect with your account.

Once you log in, on the Platform CLI (through the /account menu, all your credentials will be in sync with the CapInvest Hub.)

2. Local file

You can specify the keys directly in the ~/.capinvest_platform/user_settings.json file.

Populate this file with the following template and replace the values with your keys:

{
  "credentials": {
    "fmp_api_key": "REPLACE_ME",
    "polygon_api_key": "REPLACE_ME",
    "benzinga_api_key": "REPLACE_ME",
    "fred_api_key": "REPLACE_ME"
  }
}