Skip to content

Latest commit

 

History

History
264 lines (148 loc) · 9.98 KB

OrderApi.md

File metadata and controls

264 lines (148 loc) · 9.98 KB

\OrderApi

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

Method HTTP request Description
iserver_account_account_id_order_order_id_delete delete /iserver/account/{accountId}/order/{orderId} Cancel Order
iserver_account_account_id_order_order_id_post post /iserver/account/{accountId}/order/{orderId} Modify Order
iserver_account_account_id_order_post post /iserver/account/{accountId}/order Place Order
iserver_account_account_id_order_whatif_post post /iserver/account/{accountId}/order/whatif Preview Order
iserver_account_account_id_orders_post post /iserver/account/{accountId}/orders Place Orders (Support bracket orders)
iserver_account_orders_fa_group_post post /iserver/account/orders/{faGroup} Place Orders for Financial Advisor Groups
iserver_account_orders_get get /iserver/account/orders Live Orders
iserver_reply_replyid_post post /iserver/reply/{replyid} Place Order Reply

iserver_account_account_id_order_order_id_delete

crate::models::InlineResponse20016 iserver_account_account_id_order_order_id_delete(account_id, order_id) Cancel Order

Cancels an open order. Must call /iserver/accounts endpoint prior to cancelling an order. Use /iservers/account/orders endpoint to review open-order(s) and get latest order status.

Parameters

Name Type Description Required Notes
account_id String account id, or fa group if deleting a group order [required]
order_id String Customer order id, use /iservers/account/orders endpoint to query orderId. [required]

Return type

crate::models::InlineResponse20016

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_order_order_id_post

Veccrate::models::InlineResponse20015 iserver_account_account_id_order_order_id_post(account_id, order_id, body) Modify Order

Modifies an open order. Must call /iserver/accounts endpoint prior to modifying an order. Use /iservers/account/orders endpoint to review open-order(s).

Parameters

Name Type Description Required Notes
account_id String account id, or fa group if modifying a group order [required]
order_id String Customer order id, use /iservers/account/orders endpoint to query orderId. [required]
body ModifyOrder modify-order request [required]

Return type

Veccrate::models::InlineResponse20015

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_order_post

Veccrate::models::InlineResponse20012 iserver_account_account_id_order_post(account_id, body) Place Order

Please note here, sometimes this endpoint alone can't make sure you submit the order successfully, you could receive some questions in the response, you have to to answer them in order to submit the order successfully. You can use "/iserver/reply/{replyid}" endpoint to answer questions

Parameters

Name Type Description Required Notes
account_id String account id [required]
body OrderRequest order request info [required]

Return type

Veccrate::models::InlineResponse20012

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_order_whatif_post

crate::models::InlineResponse20014 iserver_account_account_id_order_whatif_post(account_id, body) Preview Order

This endpoint allows you to preview order without actually submitting the order and you can get commission information in the response.

Parameters

Name Type Description Required Notes
account_id String account id [required]
body OrderRequest order info [required]

Return type

crate::models::InlineResponse20014

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_account_id_orders_post

Veccrate::models::InlineResponse20012 iserver_account_account_id_orders_post(account_id, body) Place Orders (Support bracket orders)

You can pass a list of orders here

Parameters

Name Type Description Required Notes
account_id String account id [required]
body InlineObject4 [required]

Return type

Veccrate::models::InlineResponse20012

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_orders_fa_group_post

Veccrate::models::InlineResponse20012 iserver_account_orders_fa_group_post(fa_group, body) Place Orders for Financial Advisor Groups

Financial Advisors can use this endpoint to place an order for a specified group. To place an order for a specified account use the endpoint /iserver/account/{accountId}/order. More information about groups can be found in the TWS Users' Guide:.

Parameters

Name Type Description Required Notes
fa_group String financial advisor group [required]
body OrderRequest order request info [required]

Return type

Veccrate::models::InlineResponse20012

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_account_orders_get

crate::models::InlineResponse20011 iserver_account_orders_get(body) Live Orders

The endpoint is meant to be used in polling mode, e.g. requesting every x seconds. The response will contain two objects, one is notification, the other is orders. Orders is the list of live orders (cancelled, filled, submitted). Notifications contains information about execute orders as they happen, see status field. To receive streaming live orders the endpoint /ws can be used. Refer to Streaming WebSocket Data for details.

Parameters

Name Type Description Required Notes
body Option<InlineObject3>

Return type

crate::models::InlineResponse20011

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

iserver_reply_replyid_post

Veccrate::models::InlineResponse20013 iserver_reply_replyid_post(replyid, body) Place Order Reply

Reply to questions when placing orders and submit orders

Parameters

Name Type Description Required Notes
replyid String Please use the "id" from the response of "Place Order" endpoint [required]
body InlineObject5 [required]

Return type

Veccrate::models::InlineResponse20013

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]