Broker API Checklist

Understand what Stockey checks before describing broker readiness.

Stockey reviews broker documentation to evaluate historical-data access, instrument coverage, authentication flows, rate limits, credential boundaries, and export assumptions before a broker is described as verified.

Explore broker setupRead credential safety docs

Broker Capability Review Console

Verification stage, user boundaries, and review scope.

Needs broker documentation check

Review areas

Official API documentation
Authentication/session flow
Historical candles
Instrument master
Equity/F&O/MCX coverage
Rate limits
Error handling
Static IP / app approval
Credential safety
Package export readiness

Current posture

How Stockey labels thisNeeds verification
Stockey SaaS order placementNot provided
Broker secretsNot stored permanently by default
Historical dataUser-authorized session
Package setupSelf-hosted
Live modeDisabled by default
Final statusNeeds broker documentation check

User boundary

User chooses broker
User authorizes data access
User controls credentials
User validates exported package
User controls their own environment
User accepts broker/API limitations
Broker documentation check neededHistorical-data focusNo SaaS-side order placementUser-controlled credentialsBroker support not guaranteedNot investment advice
/brokers

Broker setup overview

Product-facing overview for temporary historical-data setup and package preparation.

/broker-api-checklist

Public review guide

How Stockey explains broker checks before a broker is described as verified.

/docs/brokers/overview/

Durable broker docs

Reference docs for credential safety, historical sessions, and data availability.

Why Stockey reviews broker APIs carefully

Broker descriptions stay conservative until documentation checks, product checks, and user-facing warnings are complete.

Broker APIs differ across authentication, historical candles, instrument master coverage, rate limits, static IP rules, and account permissions. Stockey marks unknowns clearly instead of implying a broker setup has already been verified.

Verification stages

1
Unknown
2
Research
3
Broker documentation check
4
Dry-run package check
5
Historical-data verified
6
Export readiness verified
7
Ready to describe as verified

Capability matrix

Broker capability review matrix

The matrix ties each broker capability to a review question, user impact, public label, and current status.

Official documentation URL

Evidence source for every public broker statement.

Needs verificationUnknown

Authentication method

Defines user authorization steps and session boundaries.

Needs broker documentation checkNeeds verification

Token/session expiry

Prevents stale assumptions about access windows.

Needs broker documentation checkNeeds verification

Static IP requirement

Affects local setup and app approval planning.

Needs verificationNeeds verification

Historical candle availability

Determines whether historical testing can be configured.

Verified after broker documentation checkNeeds verification

Intraday data availability

Limits timeframe selection and backtest range.

Verified after broker documentation checkNeeds verification

Daily data availability

Defines long-range test feasibility.

Verified after broker documentation checkNeeds verification

Instrument master

Protects symbol mapping and contract selection.

Verified after broker documentation checkNeeds verification

Equity support

Keeps segment wording specific.

Verified after broker documentation checkNeeds verification

Futures support

Avoids assuming derivatives coverage.

Verified after broker documentation checkNeeds verification

Options support

Separates option-chain and candle assumptions.

Verified after broker documentation checkNeeds verification

MCX/commodity support

Prevents unsupported commodity wording.

Unknown until checkedUnknown

Rate limits

Shapes retry, batching, and user-facing warnings.

Needs verificationNeeds verification

Symbol mapping

Prevents mismatched instruments in historical testing.

Needs verificationNeeds verification

Error model

Lets the UI explain broker failures without leaking secrets.

Needs verificationFuture check

Sandbox/test mode if any

Clarifies whether dry-run setup can be checked safely.

Not applicable until documentedUnknown

Package export readiness

Checks local config, dry-run defaults, and example values.

Future checkFuture check

Credential storage posture

Keeps broker access user-controlled.

User-controlledUser-controlled

Self-hosted package compatibility

Confirms whether exported packages can be configured locally.

Future checkFuture check

Verification stages used by Stockey

A broker name on Stockey is not a guarantee of compatibility, account access, or live-trading readiness.

Unknown

Stockey has not described this broker capability yet.

Research

The broker is known, but details have not been checked enough for user-facing setup guidance.

Broker documentation check

Broker documentation is checked for historical data, authentication, instruments, and operational constraints.

Historical-data setup target

Stockey may plan a historical-data setup flow, but it remains qualified until verified.

Export readiness check

Generated packages must be checked for local .env, broker setup assumptions, and dry-run safety.

Verified for public setup guidance

Used only after broker documentation, product checks, security review, and user-facing warnings are complete.

Caution

Do not treat a broker name on Stockey as a guarantee of compatibility, account access, or live-trading readiness. Public descriptions stay conservative until broker documentation, security review, and product checks are complete.

Credential and session safety

The broker checklist is designed around user-controlled broker access, temporary historical-data sessions, and exported packages that use example configuration values.

Broker credentials should not be permanently stored by default. Historical data sessions should be temporary and scoped. Exported packages should use .env.example values and require configuration in the user's own environment.

Do not send broker passwords, OTPs, API secrets, access tokens, private keys, or trading PINs to Stockey support.

broker_session_boundary.env
broker secrets: not stored by default
Stockey SaaS orders: not placed
historical data: user-authorized session
exported .env: example values only
package: run in your own environment
live mode: disabled by default

Historical-data questions every broker must answer

Historical testing depends on available historical data and assumptions. It is not predictive and does not guarantee live outcomes.

Which segments expose historical candles?
Which intervals are available?
How far back can historical data be fetched?
Are equity, futures, options, and MCX handled differently?
Is open interest available?
Are corporate actions adjusted?
How are missing candles reported?
How are symbols/instruments mapped?
What are the request limits?
What happens when token/session expires?
Are exchange holidays handled?
Does the broker require app approval or static IP?

Broker coverage posture

These are generic review cards. They do not represent verified broker setup, broker approval, or live-trading readiness.

Zerodha

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Dhan

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Angel One

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Upstox

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Fyers

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Shoonya

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Kotak Neo

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

ICICI Breeze

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

5paisa

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

Groww

Needs verificationNeeds verificationNeeds verificationFuture checkShown as research until verified

How the checklist connects to Stockey

The checklist separates review work, user-authorized broker data, historical testing, AI-assisted review, and self-hosted package preparation.

1
Broker documentation
Review
2
What has been checked
Review
3
Credential/session boundary
User-authorized data
4
Historical-data setup screen
Historical testing
5
Data availability check
Historical testing
6
StrategySchema test
User review required
7
AI-assisted review
User review required
8
Self-hosted package
Own environment
9
Deployment handoff
Own environment

Broker checklist boundaries

The checklist helps users understand historical-data and self-hosted package assumptions. It is not a broker service or account operation flow.

Stockey may help review

  • broker documentation
  • historical-data setup
  • authentication assumptions
  • instrument mapping
  • data availability
  • package setup assumptions
  • dry-run-first readiness
  • user-facing warnings

Stockey does not provide

  • broker services
  • broker account operation
  • investment advice
  • trade recommendations
  • live order placement from SaaS
  • account operation services
  • guaranteed broker compatibility
  • guaranteed historical-data completeness
  • emergency broker support
  • client-money handling

Related broker and safety resources

Use these public pages and docs to connect broker setup, credential safety, data availability, risk boundaries, and support routing.

Broker setup overview

How temporary broker historical-data setup fits the product.

Broker docs overview

The durable broker documentation hub for setup and safety references.

Credential safety docs

What not to send and how session-limited access should be handled.

Historical-data sessions

The intended lifecycle for user-requested broker data access.

Data availability

How data windows, gaps, and segment limits affect historical testing.

Risk Disclosure

Product limitations and user responsibility.

Contact support

Safe support routing without sharing broker secrets.

Keep broker descriptions conservative until verified.

Use this checklist to understand how Stockey separates broker descriptions, historical-data review, credential safety, and self-hosted package preparation.

Explore broker setupRead docs