Guide
API & integrations
API keys, usage, REST, MCP and request troubleshooting.
Quick steps
- Open the API console. Keys manages credentials; Usage shows consumption; Docs and Examples explain requests.
- On an eligible plan, generate a named key and save its one-time secret securely.
- Use Studio or the documented REST/MCP examples. Check the response and remaining daily row allowance.
Creating and managing API keys
- Settings → API points to the API console. Keys can create, rename and revoke keys; the raw secret is shown only once when generated.
- If a secret is lost, create a replacement, update your integration and revoke the old key. Renaming a key changes its label, not the secret. Revocation stops clients using that key.
- The Keys page shows active-key and daily-creation limits. If your account changes during generation, return to the original account and review its key list before creating another.
- Never paste a key into StreamBot, support email, a public repository or browser-side application code. If it was exposed, revoke it and replace it through the console.
Usage, Studio and MCP
- REST, MCP and exports share the daily row allowance. Usage shows consumption and reset information. Buying or using StreamBot research requests does not add API rows.
- Studio helps construct requests; Docs and Examples show supported endpoints, fields, filters, pagination and MCP setup. Use their exact current schema rather than guessing field names.
- MCP gives a compatible client access to the documented Stream Markets tools with your API credential. It retains the same plan and usage limits.
- Credits controls depend on deployment availability. Do not assume an absent Credits tab can be used to top up the daily allowance.
Request failures
- For 400 errors, check the exact error and the documented endpoint, parameters, filter operators, units and dates. Remove unsupported fields and retry a smaller query.
- For 401, check for a missing or invalid credential. For 403, check whether the key was revoked or your plan lacks access; a valid key does not override access limits.
- For 404, check the documented endpoint and record identifier. A 402 credits message is separate from the current daily row allowance; follow the response and check Usage rather than assuming a top-up is available.
- For 429, distinguish a short request-rate throttle from daily row exhaustion using the response. Honour any retry/reset information and avoid a tight retry loop.
- For an unavailable service or repeated server error, retry later and record the request time and returned error. Do not repeatedly generate new keys to troubleshoot an outage.
- When contacting hello@stream-markets.com, send the endpoint, a redacted request, status/error code and time. Remove the Authorization header and all secrets.