Expand description
Enumerations of the BCS API.
The broker writes most of its enums as strings of digits ("1" for buy) or as upper-case names.
These types serialize to exactly that, so you can use them in requests and read them from replies.
Enums that read replies have an Unknown variant (through #[serde(other)]), so a value the
broker adds later does not break parsing of a whole frame.
Enums§
- Exchange
- Exchange code, as the broker writes it in the
exchangefields. - Execution
Type - Type of an execution report (
executionType): why the broker sent this message. - Instrument
Type - Instrument type, as the broker names it in its upper-case form.
- Order
Side - Side of an order: buy or sell. The wire form is the digit as a string.
- Order
Status - State of an order in an event or a state reply (
orderStatus). The wire form is a digit string. - Order
Type - Type of an order as it appears in order events of the WebSocket (
orderTypeof an order message). - Portfolio
Position Type - Kind of a portfolio record (
typeof a portfolio position), in camelCase. - Subscribe
Type - Kind of a market data subscription command: subscribe or unsubscribe.
- Time
Frame - Candle time frame, in the names of the broker.
- Trade
Side - Side of a trade on the anonymous trades tape (WebSocket
sideas text). - Trading
Session Status - Status of a trading session:
OPENorCLOSE. - Upper
Type - Top-level kind of a portfolio position (the
upperTypefield).