Configure API credentials
setup_credentialsStores API credentials in a user config file (0600) for the stock screening server. Prompts for missing keys, saves provided values, or deletes a credential with an empty string.
Instructions
Store API credentials for this server. Call with no arguments to prompt the user for them. Call with arguments to save values the user has already given you. Values are written to a 0600 file in the user config directory, never into a project. Pass an empty string to remove a credential.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| FMP_API_KEY | No | ||
| FRED_API_KEY | No | ||
| EODHD_API_KEY | No | The only non-US quote coverage here. Free tier is 20 calls/day. https://eodhd.com/register | |
| EDINET_API_KEY | No | Japanese filings (FSA EDINET). Free and instant, but the signup has a trap: get the key at https://api.edinet-fsa.go.jp/WEEE0090.aspx — the account page renders blank because it relies on a popup. See `setup_status` for the full walkthrough. | |
| SEC_USER_AGENT | No | Required. A real name and email, e.g. "Jane Doe jane@example.com". EDGAR returns 403 without one and may block the IP. No registration needed. | |
| TIINGO_API_KEY | No | Recommended price source. Free key at https://www.tiingo.com/account/api/token | |
| FINNHUB_API_KEY | No | Quotes. The most generous free tier here — 60 calls/minute. Free key at https://finnhub.io/register | |
| POLYGON_API_KEY | No | ||
| ALPACA_API_KEY_ID | No | Quotes with the most free headroom here (200/min). Free paper-trading account, no card: https://alpaca.markets/ | |
| TWELVEDATA_API_KEY | No | ||
| ALPHAVANTAGE_API_KEY | No | ||
| ALPACA_API_SECRET_KEY | No | ||
| ETRADE_PROD_CONSUMER_KEY | No | Reads your real holdings, balances and transactions. Read-only — this server never places an order. Obtain at https://developer.etrade.com/getting-started; `setup_status` spells out the three-form process. | |
| ETRADE_PROD_CONSUMER_SECRET | No | ||
| ETRADE_SANDBOX_CONSUMER_KEY | No | Synthetic data, for proving the connection works. Instant and self-service at https://us.etrade.com/etx/ris/apikey | |
| ETRADE_SANDBOX_CONSUMER_SECRET | No |