User Tools

Site Tools

Trace:
pproapi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
pproapi [2023/02/06 14:47] – [GetTraderInfo] hammedpproapi [2024/01/10 09:08] (current) – [CancelOrder] hammed
Line 68: Line 68:
 **Notes:** **Notes:**
  
-  * For IMBALANCE / OSTAT / ORDEREVENT / PAPIORDER, messages pass the region parameter+  * For OSTAT / ORDEREVENT / PAPIORDER, messages pass the region parameter 
 +  * For IMBALANCE / SCRIPTS, messages pass the market parameter
   * For L1, L2, or TOS data, messages must pass the symbol parameter   * For L1, L2, or TOS data, messages must pass the symbol parameter
   * Lv1 and Tos are deprecated but still available, please update your scripts to use L1 and TOS, respectively   * Lv1 and Tos are deprecated but still available, please update your scripts to use L1 and TOS, respectively
Line 146: Line 147:
  
 <code>SetOutput?feedtype=NEWS&output=bykey&status=on</code> <code>SetOutput?feedtype=NEWS&output=bykey&status=on</code>
 +
 +===Scripts (SCRIPTS)===
 +
 +This command registers the API to register scripts. This will require you to set an output, and after doing so will create a file where all the scripts will be written.
 +
 +Example:
 +
 +<code>Register?feedtype=SCRIPTS</code>
 +
 ====SetOutput==== ====SetOutput====
  
 Use this command to set the output information for the symbol and define where the data should be written, either **bykey** or **bytype**. Use this command to set the output information for the symbol and define where the data should be written, either **bykey** or **bytype**.
 +
 +Please note that the data will be written to a log file, which will be generated in PPro8 folder.
  
 **New:** the SetOutput command is now supported for Manager accounts, for the OSTAT and ORDEREVENT feed types only. For OSTAT / ORDEREVENT, messages pass the region parameter. **New:** the SetOutput command is now supported for Manager accounts, for the OSTAT and ORDEREVENT feed types only. For OSTAT / ORDEREVENT, messages pass the region parameter.
Line 154: Line 166:
 Syntax:  Syntax: 
  
-<code>SetOutput?symbol=<symbol.extension> & region=[1|2|3|4] & feedtype=[L1|TOS|L2|IMBALANCE|OSTAT|ORDEREVENT|PAPIORDER|NEWS] & output=[bykey|bytype|<port>] & status=[on|off]</code>+<code>SetOutput?symbol=<symbol.extension> & region=[1|2|3|4] & feedtype=[L1|TOS|L2|IMBALANCE|OSTAT|ORDEREVENT|PAPIORDER|NEWS|SCRIPTS] & output=[bykey|bytype|<port>] & status=[on|off]</code>
  
 Example: Example:
Line 162: Line 174:
 ===Notes=== ===Notes===
  
-  * For IMBALANCE / OSTAT / ORDEREVENT / PAPIORDER, messages pass the region parameter.+  * For OSTAT / ORDEREVENT / PAPIORDER / SCRIPTS, messages pass the region parameter. 
 +  * For IMBALANCE, messages pass the market parameter.
   * For L1, L2, or TOS data, must pass the symbol parameter.   * For L1, L2, or TOS data, must pass the symbol parameter.
   * 'Lv1' and 'Tos' are deprecated but still available. Update your scripts to use 'L1' and 'TOS'.   * 'Lv1' and 'Tos' are deprecated but still available. Update your scripts to use 'L1' and 'TOS'.
Line 298: Line 311:
 ====Imbalance (IMBALANCE)==== ====Imbalance (IMBALANCE)====
  
-Example: <code>Register?region=1&feedtype=IMBALANCE</code>+Example: <code>Register?symbol=*.NQ,*.E1,*.TO&feedtype=IMBALANCE</code>
  
 This command registers the API to receive all Imbalance data. This command registers the API to receive all Imbalance data.
  
-Messages for IMBALANCE must pass the region parameter.+Messages for IMBALANCE must pass the market parameter.
  
 **Note:** NASDAQ and NYSE information is dynamic, while TSX/TSX-V information is static. AMEX information is not available at this time. **Note:** NASDAQ and NYSE information is dynamic, while TSX/TSX-V information is static. AMEX information is not available at this time.
Line 454: Line 467:
  
 <code>Deregister?symbol=ZVZZT.NQ&feedtype=NEWS</code> <code>Deregister?symbol=ZVZZT.NQ&feedtype=NEWS</code>
-<code>Deregister?region=1&feedtype=IMBALANCE</code>+<code>Deregister?symbol=\*.NQ,\*.E1,\*.TO&feedtype=IMBALANCE</code>
  
 ===Notes=== ===Notes===
  
-  * For IMBALANCE messages, define region, not symbol+  * For IMBALANCE messages, define market, not region or symbol
   * Regional data centers: 1 = NewJersey, 2 = London, 3 = Hong Kong, 4 = Sydney   * Regional data centers: 1 = NewJersey, 2 = London, 3 = Hong Kong, 4 = Sydney
   * For L1, L2, or TOS data, define symbol   * For L1, L2, or TOS data, define symbol
Line 648: Line 661:
  
 **Note:** for Futures symbols, this command now returns Display Price instead of Contract Size. **Note:** for Futures symbols, this command now returns Display Price instead of Contract Size.
 +
 +====ValidateSymbol====
 +
 +Use this command to check if Symbol is available in Ppro8, and the time parameter is just how long the client can wait for a response from the server before it fails.
 +
 +Syntax : <code>ValidateSymbol?symbol=<symbol.extension> & time=<milliseconds></code>
 +Return : <validation status>
 +
 +Examples:
 +
 +  * http://localhost:8080/ValidateSymbol?symbol=BMO.TO
 +  * http://localhost:8080/ValidateSymbol?symbol=BMO.TO&time=1000
  
 =====Order-related commands===== =====Order-related commands=====
Line 721: Line 746:
   * <Side=Sell> to cancel only Sell orders.   * <Side=Sell> to cancel only Sell orders.
   * <Side=ShortSell> to cancel only Short Sell orders.   * <Side=ShortSell> to cancel only Short Sell orders.
 +  * <Side=Offer> to cancel both Sell orders and Short Sell orders.
  
 ===Notes=== ===Notes===
Line 880: Line 906:
  
 This command exports the information to a CSV file named <logged-on user>_<tool id>.log. This example retrieves information on GODOT's position in F.NY from Summary_1, which can be set up by Trader:Symbol in layer settings. This command exports the information to a CSV file named <logged-on user>_<tool id>.log. This example retrieves information on GODOT's position in F.NY from Summary_1, which can be set up by Trader:Symbol in layer settings.
 +
 +=====Data Output Format=====
 +
 +Data through the API can be exported into two formats: JSON, and XML. 
 +
 +====JSON====
 +
 +To output data as JSON, please take the following steps:
 +
 +Copy and call the following syntax into your script:
 +
 +<code>SetJSonON</code>
 +
 +====XML====
 +
 +To output data as XML, please take the following steps:
 +
 +Copy and call the following syntax into your script:
 +
 +<code>SetXMLON</code>
 +
 +  * Note: You cannot call both of these functions at the same time.
 +
  
 =====Additional Notes===== =====Additional Notes=====
  
   * For more information about markets currently available for trading with the PProAPI, see the __{{pproapi_markets_list.xlsx|PProAPI Markets List}}__.   * For more information about markets currently available for trading with the PProAPI, see the __{{pproapi_markets_list.xlsx|PProAPI Markets List}}__.
pproapi.1675712820.txt.gz · Last modified: 2023/02/06 14:47 by hammed