IBKR API

https://ibkrcampus.com/ibkr-api-page/
Admin
IBKR API provides a suite of API tools and documentation from Interactive Brokers, including Web...
Tokens:216,368
Snippets:1,446
Trust Score:7.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /v1/api/iserver/marketdata/snapshot

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get live market data snapshot for the given conid(s). A pre-flight request must be made prior to ever receiving data. The endpoint /iserver/accounts must be called prior to /iserver/marketdata/snapshot. For derivative contracts the endpoint /iserver/secdef/search must be called first.

```APIDOC
## GET /v1/api/iserver/marketdata/snapshot

### Description
Get live market data snapshot for the given conid(s). A pre-flight request must be made prior to ever receiving data. The endpoint /iserver/accounts must be called prior to /iserver/marketdata/snapshot. For derivative contracts the endpoint /iserver/secdef/search must be called first.

### Method
GET

### Endpoint
/v1/api/iserver/marketdata/snapshot

### Parameters
#### Query Parameters
- **conids** (string) - Required - Contract identifiers for the contracts of interest. May provide a comma-separated series of contract identifiers.

### Request Example
GET /v1/api/iserver/marketdata/snapshot?conids=12345,67890

### Response
#### Success Response (200)
- **conid** (integer) - Contract identifier.
- **symbol** (string) - Symbol of the contract.
- **last** (number) - Last traded price.
- **bid** (number) - Current bid price.
- **ask** (number) - Current ask price.
- **volume** (integer) - Trading volume.
- **timestamp** (integer) - Timestamp of the snapshot.

#### Response Example
{
  "conid": 12345,
  "symbol": "AAPL",
  "last": 212.33,
  "bid": 212.30,
  "ask": 212.36,
  "volume": 266616,
  "timestamp": 1747229400000
}
```

--------------------------------

### GET /v1/api/iserver/account/allocation/presets

Source: https://api.ibkr.com/gw/api/v3/api-docs

Retrieve the preset behavior for allocation groups for specific events.

```APIDOC
## GET /v1/api/iserver/account/allocation/presets

### Description
Retrieve the preset behavior for allocation groups for specific events.

### Method
GET

### Endpoint
/v1/api/iserver/account/allocation/presets

### Parameters
None

### Response
#### Success Response (200)
- **success** (boolean) - Signifies that the request was successfully submitted.

#### Response Example
{
  "success": true
}

```

--------------------------------

### GET /iserver/snapshot

Source: https://api.ibkr.com/gw/api/v3/api-docs

Returns market data snapshots for the requested contract IDs.

```APIDOC
## GET /iserver/snapshot

### Description
Returns market data snapshots for the requested contract IDs.

### Method
GET

### Endpoint
/iserver/snapshot

### Parameters
#### Query Parameters
- **conids** (string) - Required - Comma-separated list of contract IDs to retrieve snapshots for.

### Request Example
GET /iserver/snapshot?conids=265598,265599

### Response
#### Success Response (200)
Returns an array of objects, each containing:
- **conidEx** (string) - Returns the contract identifier or contract identifier@exchange depending on the request.
- **conid** (integer) - Returns the contract identifier of the request.
- **6509** (string) - Market Data Availability. The field may contain three chars. First char defines: R = RealTime, D = Delayed, Z = Frozen, Y = Frozen Delayed, N = Not Subscribed, i - incomplete, v - VDR Exempt (Vendor Display Rule 603c). Second char defines: P = Snapshot, p = Consolidated. Third char defines: B = Book. RealTime Data is relayed back in real time without delay, market data subscription(s) are required. Delayed - Data is relayed back 15-20 min delayed. Frozen - Last recorded data at market close. relayed back in real time. Frozen Delayed - Last recorded data at market close, relayed back delayed. Not Subscribed - User does not have the required market data subscription(s) to relay back either real time or delayed data. Snapshot - Snapshot request is available for contract. Consolidated - Market data is aggregated across multiple exchanges or venues.

#### Response Example
[
  {
    "conidEx": "265598@SMART",
    "conid": 265598,
    "6509": "RPS"
  }
]
```

--------------------------------

### GET /v1/api/portfolio/{accountId}/meta

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get a single account's attributes and capabilities.

```APIDOC
## GET /v1/api/portfolio/{accountId}/meta

### Description
Get a single account's attributes and capabilities.

### Method
GET

### Endpoint
/v1/api/portfolio/{accountId}/meta

### Parameters
#### Path Parameters
- **accountId** (string) - Required - Account ID whose attributes are requested.

### Response
#### Success Response (200)
- **accountAttributes** (object) - An account's attributes.

#### Response Example
{
  "PrepaidCrypto-Z": false,
  "PrepaidCrypto-P": false,
  "accountAlias": "Retirement",
  "accountId": "DU123456",
  "accountStatus": 1590724800000,
  "accountVan": "DU123456",
  "accountTitle": "John Smith, LLC",
  "acctCustType": "LLC",
  "brokerageAccess": false,
  "businessType": "IB_SALES",
  "clearingStatus": "O",
  "covestor": false,
  "currency": "USD",
  "desc": "DU123456",
  "displayName": "John Smith, LLC",
  "faclient": false,
  "ibEntity": "IBLLC-US",
  "id": "DU123456",
  "noClientTrading": false,
  "parent": {
    "mmc": [],
    "accountId": "",
    "isMParent": false,
    "isMChild": false,
    "isMultiplex": false
  },
  "tradingType": "STKNOPT",
  "trackVirtualFXPortfolio": true,
  "type": "DEMO"
}
```

--------------------------------

### POST /iserver/auth/ssodh/init

Source: https://api.ibkr.com/gw/api/v3/api-docs

Initializes a brokerage session. Optionally publishes the session token and can compete with other sessions.

```APIDOC
## POST /iserver/auth/ssodh/init

### Description
Initializes a brokerage session. Optionally publishes the session token and can compete with other sessions.

### Method
POST

### Endpoint
/iserver/auth/ssodh/init

### Parameters
#### Request Body
- **publish** (boolean) - Optional - Publish brokerage session token at the same time when brokerage session initialized. If set false, then session token should be published before calling init. Setting true is preferred way.
- **compete** (boolean) - Optional - Determines if other brokerage sessions should be disconnected to prioritize this connection.

### Request Example
{
  "publish": true,
  "compete": false
}

### Response
#### Success Response (200)
- **authenticated** (boolean) - Returns whether your brokerage session is authenticated or not.
- **established** (boolean) - Returns whether your brokerage session is fully established and ready to handle requests. Set to true when the login message is received from underlying brokerage infrastructure, indicating authentication is complete and account information is loaded.
- **competing** (boolean) - Returns whether you have a competing brokerage session in another connection.
- **connected** (boolean) - Returns whether you are connected to the gateway or not.
- **message** (string) - A message about your authenticate status if any.
- **MAC** (string) - Device MAC information.
- **serverInfo** (object) - Contains server information.
  - **serverName** (string) - IBKR server information. Internal use only.
  - **serverVersion** (string) - IBKR version information.

#### Response Example
{
  "authenticated": true,
  "established": true,
  "competing": false,
  "connected": true,
  "message": "Authenticated",
  "MAC": "00:1A:2B:3C:4D:5E",
  "serverInfo": {
    "serverName": "server1",
    "serverVersion": "v3"
  }
}
```

--------------------------------

### GET /v1/api/portfolio/{accountId}/position/{conid}

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get position for a given instrument in a single account.

```APIDOC
## GET /v1/api/portfolio/{accountId}/position/{conid}

### Description
Get position for a given instrument in a single account.

### Method
GET

### Endpoint
/v1/api/portfolio/{accountId}/position/{conid}

### Parameters
#### Path Parameters
- **accountId** (string) - Required - Account ID whose position in the given instrument is requested.
- **conid** (integer) - Required - Conid of the instrument whose position in the account is requested.

#### Query Parameters
- **model** (string) - Optional - Model code to be used with the request.
```

--------------------------------

### POST /v1/api/iserver/auth/ssodh/init

Source: https://api.ibkr.com/gw/api/v3/api-docs

Initializes a brokerage session after retrieving the access token and Live Session Token. Returns an array of objects detailing contract information.

```APIDOC
## POST /v1/api/iserver/auth/ssodh/init

### Description
After retrieving the access token and subsequent Live Session Token, customers can initialize their brokerage session with the ssodh/init endpoint.

### Method
POST

### Endpoint
/v1/api/iserver/auth/ssodh/init

### Parameters
#### Request Body
- **brokerageSessionInitRequest** (object) - Required - The request body for initializing the brokerage session.

### Request Example
{
  "brokerageSessionInitRequest": {}
}

### Response
#### Success Response (200)
- **authenticated** (boolean) - Indicates if the session is authenticated.
- **established** (boolean) - Indicates if the session is established.
- **competing** (boolean) - Indicates if there is a competing session.
- **connected** (boolean) - Indicates if connected.
- **message** (string) - Status message.
- **MAC** (string) - MAC address.
- **serverInfo** (object) - Server information including serverName and serverVersion.

#### Response Example
{
  "authenticated": true,
  "established": true,
  "competing": false,
  "connected": true,
  "message": "",
  "MAC": "98:F2:B3:23:BF:A0",
  "serverInfo": {
    "serverName": "JifN19053",
    "serverVersion": "Build 10.25.0p, Dec 5, 2023 5:48:12 PM"
  }
}

### Error Responses
- **401** - Unauthorized
- **500** - Internal Server Error
- **503** - Service Unavailable

### Security
- ssoBearer
```

--------------------------------

### GET /v1/api/portfolio/{accountId}/ledger

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get the given account's ledger data detailing its balances by currency.

```APIDOC
## GET /v1/api/portfolio/{accountId}/ledger

### Description
Get the given account's ledger data detailing its balances by currency.

### Method
GET

### Endpoint
/v1/api/portfolio/{accountId}/ledger

### Parameters
#### Path Parameters
- **accountId** (string) - Required - Account ID whose ledger data is requested.

#### Query Parameters
- **model** (string) - Optional - Model code to be used with the request.

### Response
#### Success Response (200)
- **balances** (object) - Balances by currency.

#### Response Example
{
  "balances": {}
}
```

--------------------------------

### GET /gw/api/v1/instructions/recent

Source: https://api.ibkr.com/gw/api/v3/api-docs

Queries recent instructions for an account. Requires the 'instructions.read' scope and a Signed JWT security policy.

```APIDOC
## GET /gw/api/v1/instructions/recent

### Description
Queries recent instructions for an account. Requires the 'instructions.read' scope and a Signed JWT security policy.

### Method
GET

### Endpoint
/gw/api/v1/instructions/recent

### Parameters
#### Path Parameters
- **clientId** (string) - Required - The client ID (from path parameter reference).

#### Query Parameters
- **instructionType** (string) - Optional - The type of instruction to filter by (e.g., QUERY_RECENT_INSTRUCTIONS).

### Request Example
No request body required.

### Response
#### Success Response (200)
- **instructionResult** (object) - Contains clientInstructionId, instructionType, instructionStatus, instructionId.
- **instructionSetId** (integer) - The instruction set ID.
- **status** (integer) - HTTP status code.

#### Response Example
{
  "instructionResult": {
    "clientInstructionId": 12000610,
    "instructionType": "QUERY_RECENT_INSTRUCTIONS",
    "instructionStatus": "REJECTED",
    "instructionId": 43092429,
    "error": {
      "errorCode": "ERROR_PERMISSION_DENIED",
      "errorMessage": "Permission denied- Insufficient rights for using resource"
    }
  },
  "instructionSetId": 2445,
  "status": 403
}

#### Error Responses
- **403**: Forbidden - Insufficient rights.
- **422**: Business error - Invalid data.
- **500**: Internal server error.
```

--------------------------------

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

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get account information for a specific account ID. Requires the 'accounts.read' scope and HTTPS security policy.

```APIDOC
## GET /gw/api/v1/accounts/{accountId}/details

### Description
Get account information for a specific account.

### Method
GET

### Endpoint
/gw/api/v1/accounts/{accountId}/details

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Response
#### Success Response (200)
- **AccountDetailsResponse** (object) - The response containing account details.

#### Error Responses
- **400** - Returns error description representing bad request.
- **401** - Returns error description representing access issue.
- **403** - Returns error description representing access issue.
- **415** - Unsupported Media Type.
- **500** - Returns error description representing internal server error.

### Security
- **OAuth2 Bearer** - Required
- **Scope**: `accounts.read`
- **Security Policy**: `HTTPS`
```

--------------------------------

### POST /instructions

Source: https://api.ibkr.com/gw/api/v3/api-docs

Creates a new instruction asynchronously. The request body must include an instructionType and an instruction object with clientInstructionId, accountId, and other type-specific fields. The response returns an instructionResult with clientInstructionId, instructionType, instructionStatus, and instructionId, along with an instructionSetId.

```APIDOC
## POST /instructions

### Description
Creates a new instruction asynchronously. The request body must include an instructionType and an instruction object with clientInstructionId, accountId, and other type-specific fields. The response returns an instructionResult with clientInstructionId, instructionType, instructionStatus, and instructionId, along with an instructionSetId.

### Method
POST

### Endpoint
/instructions

### Parameters
#### Request Body
- **instructionType** (string) - Required - The type of instruction to create. Possible values: ACH_INSTRUCTION, TRADITIONAL_BANK_INSTRUCTION_VERIFICATION, DELETE_BANK_INSTRUCTION, PREDEFINED_DESTINATION_INSTRUCTION, EDDA_INSTRUCTION, OPEN_BANKING_INSTRUCTION, WITHDRAWAL_INSTRUCTION.
- **instruction** (object) - Required - The instruction details. Must include clientInstructionId (integer), accountId (string), and other type-specific fields.

### Request Example
{
  "instructionType": "ACH_INSTRUCTION",
  "instruction": {
    "clientInstructionId": 80009,
    "accountId": "U46377",
    "currency": "USD",
    "achType": "ACH",
    "bankInstructionName": "Bank of America",
    "clientAccountInfo": {
      "accountId": "123456789",
      "routingNumber": "021000021"
    }
  }
}

### Response
#### Success Response (202)
- **instructionResult** (object) - Contains clientInstructionId (integer), instructionType (string), instructionStatus (string), instructionId (integer), and optional details.
- **instructionSetId** (integer) - The ID of the instruction set.
- **status** (integer) - HTTP status code.

#### Response Example
{
  "instructionResult": {
    "clientInstructionId": 80009,
    "instructionType": "ACH_INSTRUCTION",
    "instructionStatus": "PENDING",
    "instructionId": 43092478
  },
  "instructionSetId": 2487,
  "status": 202
}

#### Error Responses
- **400 Bad Request**: Returns a Problem detail instance representing a bad request. Example fields: type, title, status, detail, invalidArguments.
- **403 Forbidden**: Returns a Problem detail instance representing a forbidden request. Example fields: type, title, status, detail, instructionSetId, instructionResult.
- **422 Unprocessable Entity**: Returns a Problem detail instance representing a business error. Example fields: type, title, status, detail, instructionSetId, instructionResult.
- **500 Internal Server Error**: Returns a Problem detail instance representing an internal server error.
```

--------------------------------

### GET /v1/api/iserver/secdef/strikes

Source: https://api.ibkr.com/gw/api/v3/api-docs

Retrieves potential option strikes for a given underlying contract. This endpoint is used to get call and put strike prices for options on a specified instrument.

```APIDOC
## GET /v1/api/iserver/secdef/strikes

### Description
Retrieves potential option strikes for a given underlying contract. This endpoint is used to get call and put strike prices for options on a specified instrument.

### Method
GET

### Endpoint
/v1/api/iserver/secdef/strikes

### Parameters
#### Query Parameters
- **conid** (integer) - Required - Contract identifier of the underlying instrument.
- **secType** (string) - Required - Security type of the underlying (e.g., 'OPT', 'FUT').
- **month** (string) - Required - Expiration month of the option contract. Expiration months can be retrieved from /iserver/secdef/search under an {object}/sections/{object}/months. Example: JAN24.
- **exchange** (string) - Optional - Exchange from which derivatives should be retrieved. This field is mandatory when requesting Futures Options strikes. Default: SMART. Example: CME.

### Response
#### Success Response (200)
- **call** (array of number) - Array containing a series of comma separated values representing potential call strikes for the instrument.
- **put** (array of number) - Array containing a series of comma separated values representing potential put strikes for the instrument.

#### Response Example
{
  "call": [70.0, 75.0, 80.0, 85.0, 90.0, 95.0, 100.0],
  "put": [70.0, 75.0, 80.0, 85.0, 90.0, 95.0, 100.0]
}

```

--------------------------------

### GET /gw/api/v1/client-instructions/{clientInstructionId}

Source: https://api.ibkr.com/gw/api/v3/api-docs

Retrieves the status of a request by clientInstructionId. Requires the 'instructions.read' scope and HTTPS security policy.

```APIDOC
## GET /gw/api/v1/client-instructions/{clientInstructionId}

### Description
Retrieve status of request by clientInstructionId.

### Method
GET

### Endpoint
/gw/api/v1/client-instructions/{clientInstructionId}

### Parameters
#### Path Parameters
- **clientId** (string) - Required - The client identifier.
- **clientInstructionId** (string) - Required - The client instruction identifier.

### Response
#### Success Response (200)
- **InstructionPollingResponse** - The status of an instruction.
- **InstructionResponse** - The status of an instruction.
- **QueryRecentInstructionResponse** - The status of an instruction.
- **DepositFundsPollingResponse** - The status of an instruction.
- **QueryIRAContributionsResponse** - The status of an instruction.

#### Response Example
```json
{
  "schema": "#/components/schemas/InstructionPollingResponse"
}
```

### Security
- **OAuth2 Bearer** - Required
- **Scope**: `instructions.read`
- **Security Policy**: `HTTPS`
```

--------------------------------

### GET /v1/api/portfolio/{accountId}/ledger

Source: https://api.ibkr.com/gw/api/v3/api-docs

Get the ledger data for a specific account. Optionally, use the model parameter to query ledger data within a specific model portfolio.

```APIDOC
## GET /v1/api/portfolio/{accountId}/ledger

### Description
Get the ledger data for a specific account. Optionally, use the model parameter to query ledger data within a specific model portfolio.

### Method
GET

### Endpoint
/v1/api/portfolio/{accountId}/ledger

### Parameters
#### Path Parameters
- **accountId** (string) - Required - Account ID whose ledger data is requested.

#### Query Parameters
- **model** (string) - Optional - Model code to query ledger data within a specific model portfolio. Example: MP.Sample-Model

### Response
#### Success Response (200)
- **ledger** (object) - Ledger data keyed by currency.

#### Response Example
{
  "AUD": {
    "acctcode": "DU5240685",
    "cashbalance": 223911.11,
    "cashbalancefxsegment": 0.0,
    "commoditymarketvalue": 0.0,
    "corporatebondsmarketvalue": 0.0,
    "cryptocurrencyvalue": 0.0,
    "currency": "AUD",
    "dividends": 0.0,
    "exchangerate": 0.650378,
    "funds": 0.0,
    "futuremarketvalue": 0.0,
    "futureoptionmarketvalue": 0.0,
    "futuresonlypnl": 0.0,
    "interest": 83.04,
    "issueroptionsmarketvalue": 0.0,
    "key": "LedgerList",
    "moneyfunds": 0.0,
    "netliquidationvalue": 223994.16,
    "realizedpnl": 0.0,
    "secondkey": "AUD",
    "sessionid": 1,
    "settledcash": 223911.11,
    "severity": 0,
    "stockmarketvalue": 0.0,
    "stockoptionmarketvalue": 0.0,
    "tbillsmarketvalue": 0.0,
    "tbondsmarketvalue": 0.0,
    "timestamp": 1754948718,
    "unrealizedpnl": 0.0,
    "warrantsmarketvalue": 0.0
  },
  "BASE": {
    "acctcode": "DU5240685",
    "cashbalance": 2.18093824E8,
    "cashbalancefxsegment": 0.0,
    "commoditymarketvalue": 0.0,
    "corporatebondsmarketvalue": 2094.11,
    "cryptocurrencyvalue": 0.0,
    "currency": "BASE",
    "dividends": 0.0,
    "exchangerate": 1,
    "funds": 0.0,
    "futuremarketvalue": 2750.1,
    "futureoptionmarketvalue": 0.0,
    "futuresonlypnl": 2750.1,
    "interest": 150856.48,
    "issueroptionsmarketvalue": 0.0,
    "key": "LedgerList",
    "moneyfunds": 0.0,
    "netliquidationvalue": 2.1944928E8,
    "realizedpnl": 0.0,
    "secondkey": "BASE",
    "sessionid": 1,
    "settledcash": 2.18093824E8,
    "severity": 0,
    "stockmarketvalue": 1202347.1,
    "stockoptionmarketvalue": 906.95,
    "tbillsmarketvalue": 0.0,
    "tbondsmarketvalue": 0.0,
    "timestamp": 1754948718,
    "unrealizedpnl": 154673.2,
    "warrantsmarketvalue": 0.0
  },
  "USD": {
    "acctcode": "DU5240685",
    "cashbalance": 2.1337544E8,
    "cashbalancefxsegment": 0.0,
    "commoditymarketvalue": 0.0,
    "corporatebondsmarketvalue": 2094.11,
    "cryptocurrencyvalue": 0.0,
    "currency": "USD",
    "dividends": 0.0,
    "endofbundle": 1,
    "exchangerate": 1,
    "funds": 0.0,
    "futuremarketvalue": 2750.1,
    "futureoptionmarketvalue": 0.0,
    "futuresonlypnl": 2750.1,
    "interest": 150009.97,
    "issueroptionsmarketvalue": 0.0,
    "key": "LedgerList",
    "moneyfunds": 0.0,
    "netliquidationvalue": 2.14730048E8,
    "realizedpnl": 0.0,
    "secondkey": "USD",
    "sessionid": 1,
    "settledcash": 2.1337544E8,
    "severity": 0,
    "stockmarketvalue": 1202347.1,
    "stockoptionmarketvalue": 906.95,
    "tbillsmarketvalue": 0.0,
    "tbondsmarketvalue": 0.0,
    "timestamp": 1754948718,
    "unrealizedpnl": 154673.2,
    "warrantsmarketvalue": 0.0
  }
}
```

--------------------------------

### POST /api/v3/instructions

Source: https://api.ibkr.com/gw/api/v3/api-docs

Submits a new instruction to the Funds and Banking system. The request body must conform to the instruction schema, and the response acknowledges the submission with an instruction ID and status.

```APIDOC
## POST /api/v3/instructions

### Description
Submits a new instruction to the Funds and Banking system. The request body must conform to the instruction schema, and the response acknowledges the submission with an instruction ID and status.

### Method
POST

### Endpoint
/api/v3/instructions

### Parameters
#### Request Body
- **clientInstructionId** (number) - Required - Client-assigned identifier for this instruction; must be a positive number and unique within the request.
- **instructionType** (string) - Required - Type of the instruction. Enum: ACH_INSTRUCTION, CANCEL_INSTRUCTION, COMPLEX_ASSET_TRANSFER, DELETE_BANK_INSTRUCTION, DEPOSIT, DWAC, EXTERNAL_POSITION_TRANSFER, FOP, QUERY_RECENT_INSTRUCTIONS, QUERY_WITHDRAWABLE_FUNDS, INTERNAL_POSITION_TRANSFER, INTERNAL_CASH_TRANSFER, MICRO_AMOUNT, OPEN_BANKING_INSTRUCTION, PREDEFINED_DESTINATION_INSTRUCTION, TRADITIONAL_BANK_INSTRUCTION_VERIFICATION, WITHDRAWAL, WITHDRAWAL_INSTRUCTION, QUERY_IRA_CONTRIBUTIONS, EDDA_INSTRUCTION, QUERY_RECENT_RECURRING_EVENTS, QUERY_RECURRING_INSTRUCTIONS, QUERY_ACCOUNT_BALANCES, QUERY_BANK_INSTRUCTION, QUERY_WITHDRAWABLE_CASH_EQUITY, ISA_TRANSFER
- **sourceAccountId** (string) - Required - Interactive Brokers account the funds are transferred from. Example: U46377
- **targetAccountId** (string) - Required - Interactive Brokers account the funds are transferred to. Example: U15667
- **amount** (number) - Required - Monetary amount for the transaction. Example: 123
- **currency** (string) - Required - ISO 4217 currency code (e.g. "USD"). Example: GBP
- **clientNote** (string) - Optional - Optional free-text note attached to the transfer. Example: Note
- **dateTimeToOccur** (string) - Optional - Requested date-time to execute the instruction, in ISO 8601 format.

### Request Example
{
  "clientInstructionId": 1012983,
  "instructionType": "INTERNAL_CASH_TRANSFER",
  "sourceAccountId": "U46377",
  "targetAccountId": "U15667",
  "amount": 123,
  "currency": "GBP",
  "clientNote": "Note",
  "dateTimeToOccur": "2023-01-01T00:00:00Z"
}

### Response
#### Success Response (200)
- **clientInstructionId** (number) - Client-assigned identifier for this instruction.
- **instructionType** (string) - Type of the instruction.
- **instructionStatus** (string) - Processing state of the instruction. Enum: PENDING, PROCESSED, REJECTED, PENDING_VERIFICATION
- **instructionId** (number) - Funds and Banking identifier of the instruction.
- **ibReferenceId** (number) - Interactive Brokers global identifier of the request.
- **description** (string) - Human-readable note about the result (e.g. polling guidance).
- **processedTimestamp** (string) - Timestamp at which the instruction was processed.
- **details** (object) - Present only for OPEN_BANKING_INSTRUCTION and WITHDRAWAL_INSTRUCTION instruction types.
- **depositDetails** (object) - Present only for the DEPOSIT instruction type.

#### Response Example
{
  "clientInstructionId": 1012983,
  "instructionType": "INTERNAL_CASH_TRANSFER",
  "instructionStatus": "PENDING",
  "instructionId": 45123654,
  "ibReferenceId": 23456745,
  "description": "Please poll for status after 10 minutes",
  "processedTimestamp": "2023-01-01T00:00:00Z"
}
```

--------------------------------

### POST /bulk-instruction-set

Source: https://api.ibkr.com/gw/api/v3/api-docs

Creates a bulk instruction set for asynchronous processing. The request body contains an array of instructions, each with a clientInstructionId and instructionType. The response provides an instructionSetId and per-instruction results with status and instruction IDs.

```APIDOC
## POST /bulk-instruction-set

### Description
Creates a bulk instruction set for asynchronous processing. The request body contains an array of instructions, each with a clientInstructionId and instructionType. The response provides an instructionSetId and per-instruction results with status and instruction IDs.

### Method
POST

### Endpoint
/bulk-instruction-set

### Parameters
#### Request Body
- **clientInstructionId** (integer) - Required - Client-provided instruction identifier.
- **instructionType** (string) - Required - Type of instruction (e.g., FOP, DWAC, EXTERNAL_POSITION_TRANSFER, COMPLEX_ASSET_TRANSFER).

### Request Example
{
  "instructions": [
    {
      "clientInstructionId": 12003434,
      "instructionType": "FOP"
    }
  ]
}

### Response
#### Success Response (202)
- **status** (integer) - HTTP status code (202).
- **instructionSetId** (integer) - Unique identifier for the instruction set.
- **instructionResults** (array) - List of results for each instruction.
  - **status** (integer) - HTTP status code for the instruction.
  - **instructionSetId** (integer) - Identifier of the instruction set.
  - **instructionResult** (object) - Details of the instruction result.
    - **clientInstructionId** (integer) - Client-provided instruction identifier.
    - **instructionType** (string) - Type of instruction.
    - **instructionStatus** (string) - Status of the instruction (e.g., PENDING).
    - **instructionId** (integer) - System-generated instruction identifier.

#### Response Example
{
  "status": 202,
  "instructionSetId": 1526,
  "instructionResults": [
    {
      "status": 202,
      "instructionSetId": 1526,
      "instructionResult": {
        "clientInstructionId": 12003434,
        "instructionType": "FOP",
        "instructionStatus": "PENDING",
        "instructionId": 11132295
      }
    }
  ]
}

#### Partial Success Response (207)
- **status** (integer) - HTTP status code (207).
- **instructionSetId** (integer) - Unique identifier for the instruction set.
- **instructionResults** (array) - List of results for each instruction, some may be rejected.
  - **status** (integer) - HTTP status code for the instruction (202 or 422).
  - **instructionSetId** (integer) - Identifier of the instruction set.
  - **instructionResult** (object) - Details of the instruction result.
    - **clientInstructionId** (integer) - Client-provided instruction identifier.
    - **instructionType** (string) - Type of instruction.
    - **instructionStatus** (string) - Status of the instruction (e.g., PENDING or REJECTED).
    - **instructionId** (integer) - System-generated instruction identifier.
    - **error** (object) - Error details if rejected.
      - **errorCode** (string) - Error code.
      - **errorMessage** (string) - Error message.

#### Response Example (207)
{
  "status": 207,
  "instructionSetId": 1527,
  "instructionResults": [
    {
      "status": 202,
      "instructionSetId": 1527,
      "instructionResult": {
        "clientInstructionId": 12003438,
        "instructionType": "FOP",
        "instructionStatus": "PENDING",
        "instructionId": 11132298
      }
    },
    {
      "type": "/simple",
      "title": "Business Error",
      "status": 422,
      "instructionSetId": 1527,
      "instructionResult": {
        "clientInstructionId": 12003440,
        "instructionType": "FOP",
        "instructionStatus": "REJECTED",
        "instructionId": 11132300,
        "error": {
          "errorCode": "ERROR_ACCOUNT_CP_NOT_RELATED",
          "errorMessage": "Account U463773 not related to counterparty qatester"
        }
      }
    }
  ]
}
```

--------------------------------

### POST /gw/api/v1/sso-browser-sessions

Source: https://api.ibkr.com/gw/api/v3/api-docs

Creates a Single Sign-On (SSO) browser session to access the IBKR hosted portal (White Branded). Requires the `sso-browser-sessions.write` scope.

```APIDOC
## POST /gw/api/v1/sso-browser-sessions

### Description
Creates a Single Sign-On (SSO) browser session to access the IBKR hosted portal (White Branded). Requires the `sso-browser-sessions.write` scope.

### Method
POST

### Endpoint
/gw/api/v1/sso-browser-sessions

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer token: Signed JWT.

#### Request Body
- **CreateBrowserSessionRequestBody** - Required - The request body for creating a browser session.

### Request Example
```
{
  "someField": "value"
}
```

### Response
#### Success Response (200)
- **CreateBrowserSessionResponse** - The response containing the SSO browser session details.

#### Response Example
```
{
  "sessionId": "string",
  "url": "string"
}
```

#### Error Responses
- **400** - Bad request. Returns a Problem detail instance.
- **401** - Unauthorized. Returns a Problem detail instance.
- **403** - Forbidden. Returns a Problem detail instance.
- **500** - Internal server error. Returns a Problem detail instance.

### Security
- **OAuth2 Bearer** - Required
- **Scope**: `sso-browser-sessions.write`
- **Security Policy**: `Signed JWT`
```

--------------------------------

### GET /v1/api/trsrv/futures

Source: https://api.ibkr.com/gw/api/v3/api-docs

Returns a list of non-expired future contracts for given symbol(s).

```APIDOC
## GET /v1/api/trsrv/futures

### Description
Returns a list of non-expired future contracts for given symbol(s).

### Method
GET

### Endpoint
/v1/api/trsrv/futures

### Parameters
#### Query Parameters
- **symbols** (string) - Required - Indicate the symbol(s) of the underlier you are trying to retrieve futures on.

### Response
#### Success Response (200)
No response schema provided in the source.

#### Response Example
No response example provided in the source.
```

--------------------------------

### POST /iserver/scanner/run

Source: https://api.ibkr.com/gw/api/v3/api-docs

Runs a market scanner request based on the provided parameters and returns matching contracts.

```APIDOC
## POST /iserver/scanner/run

### Description
Runs a market scanner request based on the provided parameters and returns matching contracts.

### Method
POST

### Endpoint
/iserver/scanner/run

### Parameters
#### Request Body
- **instrument** (string) - Required - Instrument type as the target of the market scanner request. Found in the "instrument_list" section of the /iserver/scanner/params response.
- **type** (string) - Required - Scanner value the market scanner is sorted by. Based on the "scan_type_list" section of the /iserver/scanner/params response.
- **location** (string) - Required - Location value the market scanner is searching through. Based on the "location_tree" section of the /iserver/scanner/params response.
- **filter** (array) - Optional - Contains any additional filters that should apply to response.
  - **code** (string) - Required - Code value of the filter. Based on the "code" value within the "filter_list" section of the /iserver/scanner/params response.
  - **value** (string|integer|boolean|number) - Required - Value corresponding to the input for "code".

### Request Example
{
  "instrument": "STK",
  "type": "TOP_PERC_GAIN",
  "location": "STK.US.MAJOR",
  "filter": [
    {
      "code": "priceAbove",
      "value": 10
    }
  ]
}

### Response
#### Success Response (200)
- **contracts** (array) - Contains contracts related to the market scanner request.
  - **server_id** (string) - Contract's index in relation to the market scanner type's sorting priority.
  - **column_name** (string) - Always returned for the first contract.
  - **symbol** (string) - Returns the contract's ticker symbol.
  - **conidex** (string) - Returns the contract ID of the contract.
  - **con_id** (integer) - Returns the contract ID of the contract.
  - **available_chart_periods** (string) - Internal Use Only
  - **company_name** (string) - Returns the company long name.
  - **contract_description_1** (string) - For derivatives like Futures, the local symbol of the contract will be returned.
  - **listing_exchange** (string) - Returns the primary listing exchange of the contract.
  - **sec_type** (string) - Returns the security type of the contract.
- **scan_data_column_name** (string) - Internal Use Only

#### Response Example
{
  "contracts": [
    {
      "server_id": "string",
      "column_name": "string",
      "symbol": "string",
      "conidex": "string",
      "con_id": 0,
      "available_chart_periods": "string",
      "company_name": "string",
      "contract_description_1": "string",
      "listing_exchange": "string",
      "sec_type": "string"
    }
  ],
  "scan_data_column_name": "string"
}
```

--------------------------------

### POST /api/v3/instructions/bulk

Source: https://api.ibkr.com/gw/api/v3/api-docs

Creates multiple position transfer instructions in one request. The request body must include an instructionType and an array of instructions. Supported types are DWAC, FOP, COMPLEX_ASSET_TRANSFER, and EXTERNAL_POSITION_TRANSFER.

```APIDOC
## POST /api/v3/instructions/bulk

### Description
Creates multiple position transfer instructions in a single request. The request body must include an instructionType and an array of instructions. Supported types are DWAC, FOP, COMPLEX_ASSET_TRANSFER, and EXTERNAL_POSITION_TRANSFER.

### Method
POST

### Endpoint
/api/v3/instructions/bulk

### Parameters
#### Request Body
- **instructionType** (string) - Required - The type of instruction. Enum: ["DWAC", "FOP", "COMPLEX_ASSET_TRANSFER", "EXTERNAL_POSITION_TRANSFER"]
- **instructions** (array) - Required - Array of instruction objects. Each object contains fields specific to the instruction type.

### Request Example
{
  "instructionType": "FOP",
  "instructions": [
    {
      "clientInstructionId": 7013027,
      "direction": "IN",
      "accountId": "U46377",
      "contraBrokerAccountId": "12345678A",
      "contraBrokerDtcCode": "534",
      "quantity": 1000,
      "tradingInstrument": {
        "tradingInstrumentDescription": {
          "securityIdType": "ISIN",
          "securityId": "459200101",
          "assetType": "STK"
        },
        "currency": "USD"
      }
    },
    {
      "clientInstructionId": 7013028,
      "direction": "IN",
      "accountId": "U46377",
      "contraBrokerAccountId": "12345678A",
      "contraBrokerDtcCode": "534",
      "quantity": 1000,
      "tradingInstrument": {
        "conid": 12123,
        "currency": "USD"
      }
    }
  ]
}

### Response
#### Success Response (202)
- **description** (string) - Accepts all instructions in Bulk request to create them

#### Response Example
{
  "description": "Accepts all instructions in Bulk request to create them"
}
```

--------------------------------

### GET /gw/api/v1/instruction-sets/{instructionSetId}

Source: https://api.ibkr.com/gw/api/v3/api-docs

Retrieves the status of all requests associated with a given instructionSetId. Requires the 'instructions.read' scope and HTTPS security policy.

```APIDOC
## GET /gw/api/v1/instruction-sets/{instructionSetId}

### Description
Retrieves the status of all requests associated with a given instructionSetId. Requires the 'instructions.read' scope and HTTPS security policy.

### Method
GET

### Endpoint
/gw/api/v1/instruction-sets/{instructionSetId}

### Parameters
#### Path Parameters
- **clientId** (string) - Required - The client identifier.
- **instructionSetId** (integer) - Required - The instruction set identifier.

### Response
#### Success Response (200)
- **BulkMultiStatusResponse** (object) - The response containing the status of multiple instructions.

#### Response Example
{
  "status": 200,
  "instructionSetId": 9094,
  "instructionResults": [
    {
      "status": 202,
      "instructionSetId": 9094,
      "instructionResult": {
        "clientInstructionId": 1012983,
        "instructionType": "INTERNAL_CASH_TRANSFER",
        "instructionStatus": "PENDING",
        "instructionId": 45123654
      }
    }
  ]
}

#### Error Responses
- **404** - Not Found
- **500** - Internal Server Error
```

--------------------------------

### GET /v1/api/trsrv/all-conids

Source: https://api.ibkr.com/gw/api/v3/api-docs

Send out a request to retrieve all contracts made available on a requested exchange.

```APIDOC
## GET /v1/api/trsrv/all-conids

### Description
Send out a request to retrieve all contracts made available on a requested exchange.

### Method
GET

### Endpoint
/v1/api/trsrv/all-conids

### Parameters
#### Query Parameters
- **exchange** (string) - Required - The exchange to retrieve contracts for.

### Response
#### Success Response (200)
- **conid** (string) - Contract identifier
- **symbol** (string) - Symbol
- **description** (string) - Description
- **assetClass** (string) - Asset class
- **secType** (string) - Security type
- **currency** (string) - Currency
- **exchange** (string) - Exchange

#### Response Example
{
  "conid": "265598",
  "symbol": "AAPL",
  "description": "APPLE INC",
  "assetClass": "STK",
  "secType": "STK",
  "currency": "USD",
  "exchange": "NASDAQ"
}
```
Tokens:
Raw