Interactive Brokers · OAuth Scopes

Interactive Brokers OAuth Scopes

OAuth 2.0 searched

Interactive Brokers publishes 18 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Interactive Brokers API on a user’s behalf.

Tokens are issued from https://www.interactivebrokers.com/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

BrokerageMarket DataOrdersPortfolioTrading
Scopes: 18 Flows: authorizationCode Method: searched

OAuth endpoints

Authorization URL
https://www.interactivebrokers.com/authorize
Token URL
https://www.interactivebrokers.com/token
Flows
authorizationCode

Scopes (18)

ScopeDescriptionFlows
accounts.read View brokerage account information.
accounts.write Create a brokerage account.
bank-instructions.read Listed in IBKR's documented token-request scope string; no individual description published.
bank-instructions.write Add banking instructions.
clients.read Listed in IBKR's documented token-request scope string; no individual description published.
clients.write Listed in IBKR's documented token-request scope string; no individual description published.
echo.read Listed in IBKR's documented token-request scope string; no individual description published.
echo.write Listed in IBKR's documented token-request scope string; no individual description published.
fee-templates.read Listed in IBKR's documented token-request scope string; no individual description published.
fee-templates.write Listed in IBKR's documented token-request scope string; no individual description published.
instructions.read View fund transfer.
instructions.write Listed in IBKR's documented token-request scope string; no individual description published.
statements.read View client statement.
transfers.read Listed in IBKR's documented token-request scope string; no individual description published.
transfers.write Transfer funds.
sso-sessions.write Create an SSO session used for placing trades (documented in prose as "sso.sessions.write").
sso-browser-sessions.write Create an SSO session to the IBKR Portal.
enumerations.read Listed in IBKR's documented token-request scope string; no individual description published.

Source

OAuth Scopes

interactive-brokers-scopes.yml Raw ↑
generated: '2026-07-11'
method: searched
source: openapi/interactive-brokers-web-api-openapi.yml
docs: https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
schemes:
- name: oauth2
  source: openapi/interactive-brokers-web-api-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: https://www.interactivebrokers.com/authorize
    tokenUrl: https://www.interactivebrokers.com/token
scopes:
- scope: accounts.read
  description: View brokerage account information.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: accounts.write
  description: Create a brokerage account.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: bank-instructions.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: bank-instructions.write
  description: Add banking instructions.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: clients.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: clients.write
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: echo.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: echo.write
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: fee-templates.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: fee-templates.write
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: instructions.read
  description: View fund transfer.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: instructions.write
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: statements.read
  description: View client statement.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: transfers.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: transfers.write
  description: Transfer funds.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: sso-sessions.write
  description: Create an SSO session used for placing trades (documented in prose
    as "sso.sessions.write").
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: sso-browser-sessions.write
  description: Create an SSO session to the IBKR Portal.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
- scope: enumerations.read
  description: Listed in IBKR's documented token-request scope string; no individual
    description published.
  sources:
  - https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
note: Scopes apply to the OAuth 2.0 client_credentials token request (POST https://api.ibkr.com/oauth2/api/v1/token
  with private_key_jwt client assertion) documented on IBKR's Account Management Web
  API page; the trading Web API docs do not publish additional scope values.