ib 3.0.0

A Rust client to the Interactive Brokers HTTP REST API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

# \ContractApi

All URIs are relative to *https://localhost:5000/v1/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**iserver_contract_conid_algos_get**](ContractApi.md#iserver_contract_conid_algos_get) | **Get** /iserver/contract/{conid}/algos | IB Algo Params
[**iserver_contract_conid_info_and_rules_get**](ContractApi.md#iserver_contract_conid_info_and_rules_get) | **Get** /iserver/contract/{conid}/info-and-rules | Info and Rules
[**iserver_contract_conid_info_get**](ContractApi.md#iserver_contract_conid_info_get) | **Get** /iserver/contract/{conid}/info | Contract Details
[**iserver_secdef_info_get**](ContractApi.md#iserver_secdef_info_get) | **Get** /iserver/secdef/info | Secdef Info
[**iserver_secdef_search_post**](ContractApi.md#iserver_secdef_search_post) | **Post** /iserver/secdef/search | Search by Symbol or Name
[**iserver_secdef_strikes_get**](ContractApi.md#iserver_secdef_strikes_get) | **Get** /iserver/secdef/strikes | Search Strikes
[**trsrv_futures_get**](ContractApi.md#trsrv_futures_get) | **Get** /trsrv/futures | Security Futures by Symbol
[**trsrv_secdef_post**](ContractApi.md#trsrv_secdef_post) | **Post** /trsrv/secdef | Secdef by Conid
[**trsrv_secdef_schedule_get**](ContractApi.md#trsrv_secdef_schedule_get) | **Get** /trsrv/secdef/schedule | Get trading schedule for symbol
[**trsrv_stocks_get**](ContractApi.md#trsrv_stocks_get) | **Get** /trsrv/stocks | Security Stocks by Symbol


# **iserver_contract_conid_algos_get**
> Vec<::models::InlineResponse20022> iserver_contract_conid_algos_get(conid, optional)
IB Algo Params

Returns supported IB Algos for contract. Must be called a second time to query the list of available parameters.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **conid** | **String**| IBKR contract identifier | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conid** | **String**| IBKR contract identifier | 
 **algos** | **String**| List of algo ids delimited by \&quot;;\&quot; to filter by. Max of 8 algos ids can be specified. | 
 **add_description** | **String**| Whether or not to add algo descriptions to response. Set to 1 for yes, 0 for no. | 
 **add_params** | **String**| Whether or not to show algo parameters.  Set to 1 for yes, 0 for no. | 

### Return type

[**Vec<::models::InlineResponse20022>**](inline_response_200_22.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **iserver_contract_conid_info_and_rules_get**
> ::models::InlineResponse20023 iserver_contract_conid_info_and_rules_get(conid, is_buy)
Info and Rules

Returns trading related rules and info for contract

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **conid** | **String**| IBKR contract identifier | 
  **is_buy** | **bool**| Side of the market rules apply too. Set to true for Buy Orders, set to false for Sell Orders | 

### Return type

[**::models::InlineResponse20023**](inline_response_200_23.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **iserver_contract_conid_info_get**
> ::models::Contract iserver_contract_conid_info_get(conid)
Contract Details

Using the Contract Identifier get contract info. You can use this to prefill your order before you submit an order

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **conid** | **String**| contract id | 

### Return type

[**::models::Contract**](contract.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **iserver_secdef_info_get**
> Value iserver_secdef_info_get(conid, sectype, optional)
Secdef Info

Provides Contract Details of Futures, Options, Warrants, Cash and CFDs based on conid. To get the strike price for Options/Warrants use \"/iserver/secdef/strikes\" endpoint. Must call /secdef/search for the underlying contract first.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **conid** | **String**| underlying contract id | 
  **sectype** | **String**| FUT/OPT/WAR/CASH/CFD | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conid** | **String**| underlying contract id | 
 **sectype** | **String**| FUT/OPT/WAR/CASH/CFD | 
 **month** | **String**| contract month, only required for FUT/OPT/WAR in the format MMMYY, example JAN00 | 
 **exchange** | **String**| optional, default is SMART | 
 **strike** | **String**| optional, only required for OPT/WAR | 
 **right** | **String**| C for call, P for put | 

### Return type

[**Value**](Value.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **iserver_secdef_search_post**
> Vec<::models::InlineResponse20029> iserver_secdef_search_post(symbol)
Search by Symbol or Name

Search by underlying symbol or company name. Relays back what derivative contract(s) it has. This endpoint must be called before using /secdef/info. If company name is specified will only receive limited response: conid, companyName, companyHeader and symbol. 

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **symbol** | [**Symbol**](Symbol.md)| Symbol or Company Name to be searched | 

### Return type

[**Vec<::models::InlineResponse20029>**](inline_response_200_29.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **iserver_secdef_strikes_get**
> ::models::InlineResponse20030 iserver_secdef_strikes_get(conid, sectype, month, optional)
Search Strikes

Query strikes for Options/Warrants. For the conid of the underlying contract, available contract months and exchanges use \"/iserver/secdef/search\"

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **conid** | **String**| contract id of the underlying contract | 
  **sectype** | **String**| OPT/WAR | 
  **month** | **String**| contract month | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conid** | **String**| contract id of the underlying contract | 
 **sectype** | **String**| OPT/WAR | 
 **month** | **String**| contract month | 
 **exchange** | **String**| optional, default is SMART | 

### Return type

[**::models::InlineResponse20030**](inline_response_200_30.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **trsrv_futures_get**
> ::models::InlineResponse20036 trsrv_futures_get(symbols)
Security Futures by Symbol

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

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **symbols** | **String**| list of case-sensitive symbols separated by comma | 

### Return type

[**::models::InlineResponse20036**](inline_response_200_36.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **trsrv_secdef_post**
> ::models::Secdef trsrv_secdef_post(body)
Secdef by Conid

Returns a list of security definitions for the given conids

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **body** | [**Body11**](Body11.md)| request body | 

### Return type

[**::models::Secdef**](secdef.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **trsrv_secdef_schedule_get**
> ::models::InlineResponse20037 trsrv_secdef_schedule_get(asset_class, symbol, optional)
Get trading schedule for symbol

Returns the trading schedule up to a month for the requested contract

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **asset_class** | **String**| specify the asset class of the contract. Available values-- Stock: STK, Option: OPT, Future: FUT, Contract For Difference: CFD, Warrant: WAR, Forex: SWP, Mutual Fund: FND, Bond: BND, Inter-Commodity Spreads: ICS  | 
  **symbol** | **String**| Underlying Symbol for specified contract, for example &#39;AAPL&#39; for US Stock - Apple Inc. | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **asset_class** | **String**| specify the asset class of the contract. Available values-- Stock: STK, Option: OPT, Future: FUT, Contract For Difference: CFD, Warrant: WAR, Forex: SWP, Mutual Fund: FND, Bond: BND, Inter-Commodity Spreads: ICS  | 
 **symbol** | **String**| Underlying Symbol for specified contract, for example &#39;AAPL&#39; for US Stock - Apple Inc. | 
 **exchange** | **String**| Native exchange for contract, for example &#39;NASDAQ&#39; for US Stock - Apple Inc. | 
 **exchange_filter** | **String**| Response only returns trading schedule for specified exchange | 

### Return type

[**::models::InlineResponse20037**](inline_response_200_37.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **trsrv_stocks_get**
> ::models::InlineResponse20038 trsrv_stocks_get(symbols)
Security Stocks by Symbol

Returns an object contains all stock contracts for given symbol(s)

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **symbols** | **String**| list of upper-sensitive symbols separated by comma | 

### Return type

[**::models::InlineResponse20038**](inline_response_200_38.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)