How to connect your broker
ScoutDex uses the key only to read prices. It can’t place orders, see balances or move money.
You do this once per computer. Indexes come in a later version.
1. Apply for API access at your broker
The API key comes with an account at the broker, so this applies if you already have one there. The key is usually not issued inside the broker’s own program or app (HTS or MTS). It is applied for separately, on the broker’s website or its developer site. Where and how is listed for each broker above. Some brokers also issue keys for a practice (paper) account.
2. Get what your broker issues
Most brokers give you two values: a key (often called App Key or API Key) and a secret (App Secret or Secret Key). Some show the secret only once, so copy it before you close the page. A few brokers, such as Interactive Brokers and Futu/moomoo, issue no key: you sign in to their own program on your computer, and ScoutDex connects to that program.
Treat a key like a password. ScoutDex only reads prices and market data. It cannot place, change or cancel orders, read balances, move money or transfer assets, whatever else the key allows at the broker. Where your broker offers a read-only or quote-only key, use that.
3. Open the connection window in the app
In the ScoutDex app, open Settings → Connections, choose Add a broker, and pick your broker. The studio on this site can’t do this step: its Open in the ScoutDex app button only shows a message for now, so open the app yourself.
The app then asks for what that broker uses: a key and a secret, or a sign-in to the broker’s own program.
The key goes into the app and nowhere else. It is never typed into a web page, which is why this step isn’t on the site.
4. Connect and check what opened
Once your broker accepts it, the broker appears under Stocks · brokers with the countries it reaches and what live prices cost there. The key is then kept in Windows Credential Manager. It is never in a backup, a log or a deck you share, and we can’t see or recover it.
From then on, prices come from the broker straight to this computer. Our server isn’t on that route, so it never sees your key or your prices, and if it goes down your prices keep coming.
Some brokers send live prices to one program at a time. Connecting ScoutDex can stop live prices in the broker’s own app.
One broker price feed comes with Deck. More come in a later version.
5. Back in the studio
Return to the studio. The top of the components column shows the broker as connected, and in a stock component each country it reaches carries an API tag naming that broker.
On a second computer, paste the key again. It is never copied between devices.
Crypto price feeds
Why no connection is needed
Crypto exchanges publish their prices openly, as public price feeds. ScoutDex reads those prices and shows them; it has no account at any exchange and can’t buy, sell or hold crypto. Deck includes price feeds from five public exchanges, and you pick them. There is no account to create and nothing to paste.
What “adding more” means
Adding more price feeds doesn’t involve a key either. It means ticking more exchanges as price sources in your connections:
- Open Settings → Connections → Crypto · price feeds.
- Five places are included. Tick the exchanges whose public prices you want in them.
- For more than five, add five more price feeds ($10 a year), up to ten in all.
- Crypto components in your decks can then show prices from those feeds. The ticker shows them once the deck is on a line.
In a component, the list of price feeds follows the settlement currency you choose, so a pair that doesn’t exist can’t be picked.
News from public feeds
No key
News sources publish public feeds. Your computer reads them directly, so there is nothing to sign up for.
Why it’s done in the app
Browsers are blocked from reading most RSS feeds directly. The studio in the app reads them without that limit, so steps that read feeds run there. The studio on this site is a preview and doesn’t hand over to the app yet; open the app yourself to build a news deck.
Choosing sources
- In the app, open the studio and start a news component.
- Pick a language and a country, then a topic. Markets & economy is the default; other topics come from feeds you add yourself.
- Tick the sources you want. Only those appear on the line.
News from public sources comes with Deck. A news service you already pay for, with its own key, comes in a later version.