Trade model: Bulk Order Submission

This page describes the FX Integration API’s Bulk Order Submission trade model, as defined in the file config/OrdersAdapter/Blade/DataSource/etc/trademodels.xml in the FX Integration API Kit.

This documentation is for the FX Integration API 3.40.0.

Trade models are XML-defined state machines used by the Java Trading API, the C Trading API, and Caplin Trader’s Trading API to manage trading workflows. For more information on trade model XML definitions, see the Trade model XML schema reference.

State diagram

The state diagram for the Bulk Order Submission trade model is shown below. To simplify the diagram, the Timeout and Error states have been omitted.

InitialSubmittedQueuedPendingAcceptAcceptedSubmitSubmitAckAcceptingAcceptAcceptLegendTransitions initiated by the client are inyellow.Transitions initiated by the server are inblue.

Messages: client → server

Trade-channel messages sent by StreamLink clients to the FX API DataSource.

Submit
MsgType
String
Example: Submit
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
TradingSubProtocol
string

Messages: server → client

Trade-channel messages sent by the FX API DataSource to StreamLink clients.

Accept
MsgType
String
Example: Accept
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
Accepting
MsgType
String
Example: Accepting
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model
SubmitAck
MsgType
String
Example: SubmitAck
Name of the transition
RequestID
String
The RequestID. A Unique identifier, must remain the same for each event in the trade model