Qualify contract
qualify_contractRead-only
Resolve an ambiguous contract spec into a single IBKR contract with its con_id, confirming the intended instrument before quoting or ordering.
Instructions
Resolve a contract spec to exactly one IBKR contract and return it with its con_id.
Use it to check a spec before quoting or ordering, or to turn a symbol into a con_id;
later calls can then pass just the con_id. The returned `description` is the long name
(e.g. APPLE INC) to confirm it is the intended instrument.
If several contracts match (e.g. a stock listed on two exchanges, or an option spec
without trading class), the call fails with ambiguous_contract and the message lists
up to 20 candidates with their con_ids: retry with the right con_id or more fields
(primary_exchange, currency, trading_class...). An unknown spec fails with not_found;
a combo (BAG) with invalid_request (qualify each leg by con_id instead).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| contract | Yes | The instrument. A con_id alone is unambiguous; otherwise give symbol and sec_type, plus expiry, strike and right for options. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| right | No | ||
| con_id | Yes | IBKR contract id (None if not yet qualified). | |
| strike | No | ||
| symbol | Yes | ||
| currency | No | ||
| exchange | No | ||
| sec_type | Yes | ||
| combo_legs | No | ||
| multiplier | No | ||
| description | No | ||
| local_symbol | No | ||
| trading_class | No | ||
| primary_exchange | No | ||
| last_trade_date_or_contract_month | No |