Skip to content

Commit 6b96907

Browse files
tkimtkim
committed
TOMS book name & px num
Added descriptions for the upcoming TOMS book name and px# elements.
1 parent 8ab9881 commit 6b96907

File tree

6 files changed

+58
-14
lines changed

6 files changed

+58
-14
lines changed

‎build/doctrees/environment.pickle‎

28 Bytes
Binary file not shown.

‎build/doctrees/programmable/emsxFeatures.doctree‎

4.26 KB
Binary file not shown.

‎build/html/_sources/programmable/emsxFeatures.rst.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,12 @@ The EMSX element definitions will include the type of the element and will infor
196196
+-----------------------------+------------------------------------------------------------------------+
197197
|``EMSX_BLOCK_ID`` | | ``STRING`` ``ORDER`` The EMSX Block ID |
198198
+-----------------------------+------------------------------------------------------------------------+
199+
|``EMSX_BOOKNAME`` | | ``STRING`` This element is used to specify TOMS book name while |
200+
| | | using ``CreateOrderAndRouteEx``, ``RouteEx``, and ``GroupRouteEx`` |
201+
| | | requests. This element requires ``EMSX_TOMS_PXNUM`` element to |
202+
| | | specify the TOMS px#. This element is not available from the order |
203+
| | | or route subscription services. |
204+
+-----------------------------+------------------------------------------------------------------------+
199205
|``EMSX_BROKER`` | | ``STRING`` ``O,R`` The code for the broker with whom the order is |
200206
| | | routed. This field is applicable to trades on an order and/or route |
201207
| | | level, and does not populate on a per security basis. |
@@ -719,6 +725,12 @@ EMSX Element Definition (N to Z)
719725
+-------------------------------+----------------------------------------------------------------------+
720726
|``EMSX_TIME_STAMP_MICROSEC`` | | ``FLOAT64`` ``O,R`` ``EMSX_TIME_STAMP`` in microseconds. |
721727
+-------------------------------+----------------------------------------------------------------------+
728+
|``EMSX_TOMS_PXNUM`` | | ``INT32`` This element allows the user to insert the TOMS PX# |
729+
| | | while using ``CreateOrderAndRouteEx``, ``RouteEx``, and |
730+
| | | ``GroupRouteEx`` requests. This element is required to use |
731+
| | | ``EMSX_BOOKNAME`` to specify the TOMS book name. This element is |
732+
| | | not available from the order or route subscription services. |
733+
+-------------------------------+----------------------------------------------------------------------+
722734
|``EMSX_TRAD_UUID`` | | ``INT32`` ``ORDER`` The UUID of the EMSX Trader. This field is |
723735
| | | equivalent to ``EMSX_TRADER_UUID`` in the elements in the |
724736
| | | request/response. |

‎build/html/programmable/emsxFeatures.html‎

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -459,15 +459,25 @@ <h1>EMSX Element Definition (A to M)<a class="headerlink" href="#emsx-element-de
459459
</div>
460460
</td>
461461
</tr>
462-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER</span></code></td>
462+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BOOKNAME</span></code></td>
463+
<td><div class="first last line-block">
464+
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> This element is used to specify TOMS book name while</div>
465+
<div class="line">using <code class="docutils literal notranslate"><span class="pre">CreateOrderAndRouteEx</span></code>, <code class="docutils literal notranslate"><span class="pre">RouteEx</span></code>, and <code class="docutils literal notranslate"><span class="pre">GroupRouteEx</span></code></div>
466+
<div class="line">requests. This element requires <code class="docutils literal notranslate"><span class="pre">EMSX_TOMS_PXNUM</span></code> element to</div>
467+
<div class="line">specify the TOMS px#. This element is not available from the order</div>
468+
<div class="line">or route subscription services.</div>
469+
</div>
470+
</td>
471+
</tr>
472+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER</span></code></td>
463473
<td><div class="first last line-block">
464474
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">O,R</span></code> The code for the broker with whom the order is</div>
465475
<div class="line">routed. This field is applicable to trades on an order and/or route</div>
466476
<div class="line">level, and does not populate on a per security basis.</div>
467477
</div>
468478
</td>
469479
</tr>
470-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_COMM</span></code></td>
480+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_COMM</span></code></td>
471481
<td><div class="first last line-block">
472482
<div class="line"><code class="docutils literal notranslate"><span class="pre">FLOAT64</span></code> <code class="docutils literal notranslate"><span class="pre">O,R</span></code> The amount of commission charged by the broker</div>
473483
<div class="line">for the order or route. This field is applicable to trades on an</div>
@@ -476,27 +486,27 @@ <h1>EMSX Element Definition (A to M)<a class="headerlink" href="#emsx-element-de
476486
</div>
477487
</td>
478488
</tr>
479-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_LEI</span></code></td>
489+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_LEI</span></code></td>
480490
<td><div class="first last line-block">
481491
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ROUTE</span></code> Broker Legal Entity Identifier in MiFID II.</div>
482492
</div>
483493
</td>
484494
</tr>
485-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_SI</span></code></td>
495+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_SI</span></code></td>
486496
<td><div class="first last line-block">
487497
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ROUTE</span></code> Broker Systematic Internalizer in MiFID II.</div>
488498
</div>
489499
</td>
490500
</tr>
491-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_STATUS</span></code></td>
501+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BROKER_STATUS</span></code></td>
492502
<td><div class="first last line-block">
493503
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ROUTE</span></code> Broker status in EMSX. This element will</div>
494504
<div class="line">populate one of the three values: <code class="docutils literal notranslate"><span class="pre">CXRPRJ</span></code>, <code class="docutils literal notranslate"><span class="pre">CXLREJ</span></code>, and</div>
495505
<div class="line"><code class="docutils literal notranslate"><span class="pre">MODIFIED</span></code>. More details can be found in <a class="reference external" href="https://emsx-api-doc.readthedocs.io/en/latest/programmable/emsxSubscription.html#description-of-the-child-route-status-messages">here</a>.</div>
496506
</div>
497507
</td>
498508
</tr>
499-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BSE_AVG_PRICE</span></code></td>
509+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BSE_AVG_PRICE</span></code></td>
500510
<td><div class="first last line-block">
501511
<div class="line"><code class="docutils literal notranslate"><span class="pre">FLOAT64</span></code> <code class="docutils literal notranslate"><span class="pre">STATIC</span></code> <code class="docutils literal notranslate"><span class="pre">O,R</span></code> The EMSX Bombay Stock Exchange</div>
502512
<div class="line">Average Price. Average price of the fills completed for the order or</div>
@@ -506,7 +516,7 @@ <h1>EMSX Element Definition (A to M)<a class="headerlink" href="#emsx-element-de
506516
</div>
507517
</td>
508518
</tr>
509-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BSE_FILLED</span></code></td>
519+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BSE_FILLED</span></code></td>
510520
<td><div class="first last line-block">
511521
<div class="line"><code class="docutils literal notranslate"><span class="pre">INT32</span></code> <code class="docutils literal notranslate"><span class="pre">O,R</span></code> The EMSX Bombay Stock Exchange Filled. Total</div>
512522
<div class="line">quantity of the fills completed for the order or route on the Bombay</div>
@@ -515,13 +525,13 @@ <h1>EMSX Element Definition (A to M)<a class="headerlink" href="#emsx-element-de
515525
</div>
516526
</td>
517527
</tr>
518-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BUYSIDE_LEI</span></code></td>
528+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_BUYSIDE_LEI</span></code></td>
519529
<td><div class="first last line-block">
520530
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">O,R</span></code> The buyside Legal Entity Identifier in MiFID II.</div>
521531
</div>
522532
</td>
523533
</tr>
524-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CFD_FLAG</span></code></td>
534+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CFD_FLAG</span></code></td>
525535
<td><div class="first last line-block">
526536
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ORDER</span></code> The EMSX Contract For Difference Flag.</div>
527537
<div class="line">Indicates if the order is a contract for differences (CFD) trade.</div>
@@ -530,15 +540,15 @@ <h1>EMSX Element Definition (A to M)<a class="headerlink" href="#emsx-element-de
530540
</div>
531541
</td>
532542
</tr>
533-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CLEARING_ACCOUNT</span></code></td>
543+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CLEARING_ACCOUNT</span></code></td>
534544
<td><div class="first last line-block">
535545
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ROUTE</span></code> The clearing account defined on a futures or</div>
536546
<div class="line">option route. This field is applicable to trades on a route level,</div>
537547
<div class="line">and does not populate on a per security basis.</div>
538548
</div>
539549
</td>
540550
</tr>
541-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CLEARING_FIRM</span></code></td>
551+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_CLEARING_FIRM</span></code></td>
542552
<td><div class="first last line-block">
543553
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> <code class="docutils literal notranslate"><span class="pre">ROUTE</span></code> The clearing firm defined on a futures or</div>
544554
<div class="line">options route. This field is applicable to trades on a route level,</div>
@@ -1536,15 +1546,25 @@ <h1>EMSX Element Definition (N to Z)<a class="headerlink" href="#emsx-element-de
15361546
</div>
15371547
</td>
15381548
</tr>
1539-
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_TRAD_UUID</span></code></td>
1549+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_TOMS_PXNUM</span></code></td>
1550+
<td><div class="first last line-block">
1551+
<div class="line"><code class="docutils literal notranslate"><span class="pre">INT32</span></code> This element allows the user to insert the TOMS PX#</div>
1552+
<div class="line">while using <code class="docutils literal notranslate"><span class="pre">CreateOrderAndRouteEx</span></code>, <code class="docutils literal notranslate"><span class="pre">RouteEx</span></code>, and</div>
1553+
<div class="line"><code class="docutils literal notranslate"><span class="pre">GroupRouteEx</span></code> requests. This element is required to use</div>
1554+
<div class="line"><code class="docutils literal notranslate"><span class="pre">EMSX_BOOKNAME</span></code> to specify the TOMS book name. This element is</div>
1555+
<div class="line">not available from the order or route subscription services.</div>
1556+
</div>
1557+
</td>
1558+
</tr>
1559+
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_TRAD_UUID</span></code></td>
15401560
<td><div class="first last line-block">
15411561
<div class="line"><code class="docutils literal notranslate"><span class="pre">INT32</span></code> <code class="docutils literal notranslate"><span class="pre">ORDER</span></code> The UUID of the EMSX Trader. This field is</div>
15421562
<div class="line">equivalent to <code class="docutils literal notranslate"><span class="pre">EMSX_TRADER_UUID</span></code> in the elements in the</div>
15431563
<div class="line">request/response.</div>
15441564
</div>
15451565
</td>
15461566
</tr>
1547-
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">EMSX_TRADE_DESK</span></code></td>
1567+
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">EMSX_TRADE_DESK</span></code></td>
15481568
<td><div class="first last line-block">
15491569
<div class="line"><code class="docutils literal notranslate"><span class="pre">STRING</span></code> `` STATIC`` <code class="docutils literal notranslate"><span class="pre">ORDER</span></code> The name of the trading desk on</div>
15501570
<div class="line">the order. This field is applicable to trades on an order level,</div>

‎build/html/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎source/programmable/emsxFeatures.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,12 @@ The EMSX element definitions will include the type of the element and will infor
196196
+-----------------------------+------------------------------------------------------------------------+
197197
|``EMSX_BLOCK_ID`` | | ``STRING`` ``ORDER`` The EMSX Block ID |
198198
+-----------------------------+------------------------------------------------------------------------+
199+
|``EMSX_BOOKNAME`` | | ``STRING`` This element is used to specify TOMS book name while |
200+
| | | using ``CreateOrderAndRouteEx``, ``RouteEx``, and ``GroupRouteEx`` |
201+
| | | requests. This element requires ``EMSX_TOMS_PXNUM`` element to |
202+
| | | specify the TOMS px#. This element is not available from the order |
203+
| | | or route subscription services. |
204+
+-----------------------------+------------------------------------------------------------------------+
199205
|``EMSX_BROKER`` | | ``STRING`` ``O,R`` The code for the broker with whom the order is |
200206
| | | routed. This field is applicable to trades on an order and/or route |
201207
| | | level, and does not populate on a per security basis. |
@@ -719,6 +725,12 @@ EMSX Element Definition (N to Z)
719725
+-------------------------------+----------------------------------------------------------------------+
720726
|``EMSX_TIME_STAMP_MICROSEC`` | | ``FLOAT64`` ``O,R`` ``EMSX_TIME_STAMP`` in microseconds. |
721727
+-------------------------------+----------------------------------------------------------------------+
728+
|``EMSX_TOMS_PXNUM`` | | ``INT32`` This element allows the user to insert the TOMS PX# |
729+
| | | while using ``CreateOrderAndRouteEx``, ``RouteEx``, and |
730+
| | | ``GroupRouteEx`` requests. This element is required to use |
731+
| | | ``EMSX_BOOKNAME`` to specify the TOMS book name. This element is |
732+
| | | not available from the order or route subscription services. |
733+
+-------------------------------+----------------------------------------------------------------------+
722734
|``EMSX_TRAD_UUID`` | | ``INT32`` ``ORDER`` The UUID of the EMSX Trader. This field is |
723735
| | | equivalent to ``EMSX_TRADER_UUID`` in the elements in the |
724736
| | | request/response. |

0 commit comments

Comments
 (0)