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

# \CCPBetaApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**ccp_account_get**](CCPBetaApi.md#ccp_account_get) | **Get** /ccp/account | Brokerage Accounts
[**ccp_auth_init_post**](CCPBetaApi.md#ccp_auth_init_post) | **Post** /ccp/auth/init | Start CCP Session
[**ccp_auth_response_post**](CCPBetaApi.md#ccp_auth_response_post) | **Post** /ccp/auth/response | Complete CCP Session
[**ccp_order_delete**](CCPBetaApi.md#ccp_order_delete) | **Delete** /ccp/order | Delete Order
[**ccp_order_post**](CCPBetaApi.md#ccp_order_post) | **Post** /ccp/order | Submit Order
[**ccp_order_put**](CCPBetaApi.md#ccp_order_put) | **Put** /ccp/order | Update Order
[**ccp_orders_get**](CCPBetaApi.md#ccp_orders_get) | **Get** /ccp/orders | Order Status
[**ccp_positions_get**](CCPBetaApi.md#ccp_positions_get) | **Get** /ccp/positions | Positions
[**ccp_status_get**](CCPBetaApi.md#ccp_status_get) | **Get** /ccp/status | CCP Status
[**ccp_trades_get**](CCPBetaApi.md#ccp_trades_get) | **Get** /ccp/trades | Trades


# **ccp_account_get**
> ::models::InlineResponse200 ccp_account_get()
Brokerage Accounts

Provides the list of tradeable accounts

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**::models::InlineResponse200**](inline_response_200.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)

# **ccp_auth_init_post**
> ::models::InlineResponse2001 ccp_auth_init_post(optional)
Start CCP Session

Initiate a brokerage session to CCP. Only one brokerage session type can run at a time. If an existing brokerage session to iServer is running then call the endpoint /logout first. Note at this time only order management is possible from CCP session, market data and scanner endpoints can't be used since they are only available from iServer session. Work is in progress to provide new CCP endpoints for market data and scanners.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **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
------------- | ------------- | ------------- | -------------
 **compete** | **bool**| Allow competing CCP session to run | 
 **locale** | **String**| Concatenate value for language and region, set to \"en_US\" | 
 **mac** | **String**| Local MAC Address | 
 **machine_id** | **String**| Local machine ID | 
 **username** | **String**| Login user, set to dash \"-\" | 

### Return type

[**::models::InlineResponse2001**](inline_response_200_1.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/x-www-form-urlencoded
 - **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)

# **ccp_auth_response_post**
> ::models::InlineResponse2002 ccp_auth_response_post(optional)
Complete CCP Session

Session Token Authentication

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **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
------------- | ------------- | ------------- | -------------
 **auth** | [**Auth**](Auth.md)|  | 

### Return type

[**::models::InlineResponse2002**](inline_response_200_2.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)

# **ccp_order_delete**
> ::models::OrderData ccp_order_delete(acct, id)
Delete Order

Sends an Order cancellation request. The status of the order can be queried through /ccp/order. Passing arguments as GET is also supported (requires passing action=delete) (GET is meant for development only) 

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **acct** | **String**| Account Number | 
  **id** | **f32**| Order Identifier of original submit order | 

### Return type

[**::models::OrderData**](order-data.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **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)

# **ccp_order_post**
> ::models::OrderData ccp_order_post(acct, conid, ccy, exchange, qty, optional)
Submit Order

Submits an Order. 

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **acct** | **String**| User Account | 
  **conid** | **f32**| Contract identifier from IBKR's database. | 
  **ccy** | **String**| Contract Currency | 
  **exchange** | **String**| Exchange | 
  **qty** | **f32**| Order Quantity | 
 **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
------------- | ------------- | ------------- | -------------
 **acct** | **String**| User Account | 
 **conid** | **f32**| Contract identifier from IBKR's database. | 
 **ccy** | **String**| Contract Currency | 
 **exchange** | **String**| Exchange | 
 **qty** | **f32**| Order Quantity | 
 **_type** | **String**| Order Price; required if order type is limit | 
 **side** | **String**| Side | 
 **price** | **f32**| Order Price; required if order type is limit | 
 **tif** | **String**| Time in Force | 

### Return type

[**::models::OrderData**](order-data.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **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)

# **ccp_order_put**
> ::models::OrderData ccp_order_put(acct, id)
Update Order

Updates an Order. Updating an order requires the same arguments as placing an order besides the conid. Note: The status of the order can be queried through GET /ccp/order. 

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **acct** | **String**| User Account | 
  **id** | **f32**| Order ID to be modified | 

### Return type

[**::models::OrderData**](order-data.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **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)

# **ccp_orders_get**
> ::models::InlineResponse2003 ccp_orders_get(acct, optional)
Order Status

Get status for all orders

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **acct** | **String**| User Account | 
 **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
------------- | ------------- | ------------- | -------------
 **acct** | **String**| User Account | 
 **cancelled** | **bool**| Return only Rejected or Cancelled orders since today midnight | 

### Return type

[**::models::InlineResponse2003**](inline_response_200_3.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)

# **ccp_positions_get**
> ::models::PositionData ccp_positions_get()
Positions

List of positions

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**::models::PositionData**](position-data.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)

# **ccp_status_get**
> ::models::InlineResponse2004 ccp_status_get()
CCP Status

Provide the current CCP session status. When using the Gateway this endpoint will also initiate a brokerage session to CCP by sending /auth/init and response.

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**::models::InlineResponse2004**](inline_response_200_4.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)

# **ccp_trades_get**
> ::models::InlineResponse2003 ccp_trades_get(optional)
Trades

Get a list of Trades, by default, the list is from today midnight to Date.now(). 

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **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
------------- | ------------- | ------------- | -------------
 **from** | **String**| From Date (YYYYMMDD-HH:mm:ss) or offset (-1,-2,-3..) | 
 **to** | **String**| To Date (YYYYMMDD-HH:mm:ss) or offset (-1,-2,-3..). To value should be bigger than from value.  | 

### Return type

[**::models::InlineResponse2003**](inline_response_200_3.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)