IBKR Account Management Web API¶

Source: https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/ Last Updated: 2026-02-26

Table of Contents¶

• Introduction
• Authentication
• Connectivity
• Rate Limiting
• Account Endpoints
• Funding and Banking
• Reporting
• Single Sign On (SSO)
• Error Handling

Introduction¶

The IBKR Account Management API provides programmatic access to account-related operations for Introducing Brokers, Financial Advisors, and Institutional clients. This API allows you to:

• Register and manage client accounts
• Handle funding and banking operations
• Access account statements and reports
• Manage user authentication and permissions

***Note**: This API is primarily designed for institutional use. Individual traders should use the Client Portal Gateway instead.

Authentication¶

OAuth 2.0 Authentication¶

IBKR uses OAuth 2.0 with private_key_jwt client authentication (RFC 7521/7523).

Authentication Flow¶

1. Generate a signed JWT (client_assertion)
2. POST to the authorization server with the JWT
3. Receive an access token
4. Include the access token in subsequent requests

Token Endpoint¶

POST /oauth/token

Request Headers:

Content-Type: application/json

Request Body:

{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_assertion": "SIGNED_JWT_TOKEN",
  "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
}

Response:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "read write"
}

Connectivity¶

Base URLs¶

Request Format¶

• ***Protocol**: HTTPS only
• ***Method**: RESTful HTTP verbs (GET, POST, PUT, PATCH, DELETE)
• ***Content-Type**: application/json
• ***Encoding**: UTF-8

Response Format¶

• ***Content-Type**: application/json
• ***Status Codes**: Standard HTTP status codes

Rate Limiting¶

Global Rate Limits¶

When rate limits are exceeded, the API returns HTTP 429.

Response Headers¶

X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Account Endpoints¶

Get Accounts¶

Retrieve account information for authenticated user.

GET /gw/api/v1/accounts

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | status | string | No | Filter by account status (e.g., "A", "N", "O", "C", "P", "R", "Q", "E") | | limit | integer | No | Maximum number of results | | offset | integer | No | Pagination offset |

Response:

{
  "accounts": [
    {
      "accountId": "U1234567",
      "accountAlias": "My Account",
      "accountType": "INDIVIDUAL",
      "status": "O",
      "currency": "USD",
      "tradingPermissions": ["STK", "OPT", "FUT"],
      "createdDate": "2020-01-15"
    }
  ],
  "totalCount": 1
}

Account Status Codes¶

Get Account Details¶

Retrieve detailed information for a specific account.

GET /gw/api/v1/accounts/{accountId}

Path Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | IBKR Account ID |

Response:

{
  "accountId": "U1234567",
  "accountAlias": "My Account",
  "accountType": "INDIVIDUAL",
  "status": "O",
  "currency": "USD",
  "tradingPermissions": ["STK", "OPT", "FUT"],
  "marginType": "REG",
  "createdDate": "2020-01-15",
  "updatedDate": "2024-01-15",
  "accountOwner": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  },
  "beneficiaries": []
}

Update Account¶

Update account information (requires proper permissions).

PATCH /gw/api/v1/accounts/{accountId}

Request Body:

{
  "accountAlias": "New Alias",
  "marginType": "PORT",
  "tradingPermissions": ["STK", "OPT", "FUT", "CASH"]
}

Close Account¶

Close an account (requires cleared balance and specific conditions).

POST /gw/api/v1/accounts/{accountId}/close

Request Body:

{
  "reason": "Customer request"
}

Funding and Banking¶

Get Bank Instructions¶

Retrieve saved bank instructions for withdrawals and deposits.

GET /gw/api/v1/bank-instructions/query

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | Account ID | | method | string | No | "WITHDRAW" or "DEPOSIT" |

Response:

{
  "instructions": [
    {
      "instructionId": "12345",
      "bankName": "Chase Bank",
      "accountNumber": "****1234",
      "accountType": "CHECKING",
      "currency": "USD",
      "defaultInstruction": true
    }
  ]
}

Create Withdraw Request¶

Create a request to withdraw funds.

POST /gw/api/v1/withdraw-request

Request Body:

{
  "accountId": "U1234567",
  "amount": 1000.00,
  "currency": "USD",
  "instructionId": "12345",
  "notes": "Monthly withdrawal"
}

Create Deposit Request¶

Create a request to deposit funds (for notifications/checks).

POST /gw/api/v1/deposit-request

Request Body:

{
  "accountId": "U1234567",
  "amount": 5000.00,
  "currency": "USD",
  "method": "CHECK",
  "notes": "Initial funding"
}

Internal Transfer¶

Transfer funds or positions between accounts.

POST /gw/api/v1/internal-transfer

Request Body:

{
  "fromAccountId": "U1234567",
  "toAccountId": "U7654321",
  "transferType": "CASH",
  "amount": 1000.00,
  "currency": "USD"
}

For Position Transfers:

{
  "fromAccountId": "U1234567",
  "toAccountId": "U7654321",
  "transferType": "POSITION",
  "transfers": [
    {
      "conid": 265598,
      "quantity": 100
    }
  ]
}

Reporting¶

Get Activity Statements¶

Retrieve available activity statements for an account.

GET /gw/api/v1/statements

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | Account ID | | startDate | string | Yes | Format: YYYY-MM-DD | | endDate | string | Yes | Format: YYYY-MM-DD |

Response:

{
  "statements": [
    {
      "statementId": "12345",
      "period": "2024-01-01 to 2024-01-31",
      "type": "ACTIVITY",
      "url": "<https://...",>
      "generatedDate": "2024-02-01"
    }
  ]
}

Get Tax Documents¶

Retrieve available tax documents.

GET /gw/api/v1/tax-documents/available

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | Account ID | | taxYear | integer | Yes | Tax year |

Response:

{
  "documents": [
    {
      "documentType": "1099",
      "taxYear": 2023,
      "availableDate": "2024-02-15",
      "url": "<https://...">
    }
  ]
}

Trade Confirmations¶

Generate trade confirmation PDFs for a date range.

GET /gw/api/v1/trade-confirmations

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | Account ID | | startDate | string | Yes | Format: YYYY-MM-DD (max 365 day range) | | endDate | string | Yes | Format: YYYY-MM-DD |

Single Sign On (SSO)¶

SSO URL Generation¶

Generate an SSO URL to redirect users to the IBKR Portal for completing actions not supported via API.

GET /gw/api/v1/sso/url

Query Parameters: | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | accountId | string | Yes | Account ID | | targetUrl | string | Yes | Destination URL in Portal | | showNavBar | boolean | No | Hide navigation bar (for IFRAME embedding) |

Response:

{
  "ssoUrl": "<https://portal.interactivebrokers.com/sso/login?token=...",>
  "expiresIn": 300
}

Error Handling¶

Error Response Format¶

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid account ID format",
    "details": {
      "field": "accountId",
      "reason": "Must start with 'U' followed by digits"
    }
  },
  "timestamp": "2024-01-15T10:30:00Z",
  "path": "/gw/api/v1/accounts/INVALID"
}

Common Error Codes¶

System Availability¶

Maintenance Windows¶

Support¶

Contact Information¶

• ***Email**: am-api@interactivebrokers.com
• ***Documentation**: https://www.interactivebrokers.com/campus/ibkr-api-page/web-api-account-management/
• ***API Reference**: https://www.interactivebrokers.com/api/doc.html

Troubleshooting Checklist¶

Before contacting support:

• Verify authentication credentials are valid
• Check account status is "Open" (O)
• Confirm request is within rate limits
• Verify account has required permissions
• Check if currently in maintenance window