Knowledgebase:
MarketOrdersHistoryReport
Posted by Mohammad Rahhal, Last modified by Rawan Al Hourani on 06 August 2018 11:10 AM

Syntax

 Public function MarketOrdersHistoryReport(ClientID As Integer, FromDate As String, ToDate As String, OrderID As Integer, Ticket As Integer, AccountID As Integer, TransType As String, OrderType As Integer, Amount As Double, SymbolID As Integer, Price As Double, IPAddress As String, Status As Integer, WhoID As Integer,TransTag As String) As CallingResultsEnum

This function used to get market order history report that shows the entire market orders done in your whole system or for a certain account(s)/ office(s). After MarketOrdersHistoryReport executes the ReportDataReceived event fire.

Parameters

Parameter Description 
ClientID The report will show the entire market orders done for all accounts under this client
FromDate

Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means from the beginning 

ToDate Specify the duration
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means till now 
OrderID The report will show the transactions for this order
0 means for all orders
Ticket The report will show this position
0 means for all position
AccountID The report will show the market orders for this Account.
0 means for all Account
TransType 

The Type of the transaction
"" All
"CP" for liquidate 
"OP" for New
"DL" for Delivery order

OrderType The report will show the market orders of  this type
0 means for all
-1 sell type
1 buy type
Amount The report will show the market orders of this amount
0 means for all amount
SymbolID The report will show the market orders of  this symbol
0 means for all symbols
Price The report will show the market orders of  this price
0 means for all prices
IP Address The report will show the market orders of this IP
“” means for all IPs
Status The report will show the market orders of  this status
0 All 
20 New Accepted
21 invalid price
44 quoted then Timer expired
45 reqauted then client reject

WhoID The ID of Dealer/client
0   All
-1 System 
TransTag String value used to mark the requested report when the result came from server

Return value
Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult.

Sample

 Private Sub PeOrRe_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles PeOrRe.Click

    ‘BOAPI is a predefined variable as CVertexBOAPI10

         Dim vSymbol As COSymbol

         VSymbol = BOAPI.SymbolByName ("DOLLAR ")

         If (vSymbol IsNot Nothing) Then   

           Dim Result As CallingResultsEnum

          Result= BOAPI.MarketOrdersHistoryReport(BOAPI.RootID, "01/02/2016 00:00:00", "", 0, 0, 0, "CP", 1, 0,vSymbol.ID, 0, "", 20, 0,"")

       End if      

 End Sub 

Results  

The result of this report contains many details, the following table shows each column description:

Data rows Index Column Name Description
1 Order Shows the order ID for each market order
2 Ticket The ticket ID which will be assigned for each market order after the acceptance
3 Account The client account ID for each requested market order
4 Type The type of each market order, either New or close
"CP" for liquidate 
"OP" for New
"DL" for Delivery
5 Status The action which was done on each market order by the dealer (Accepted, Invalid Price) or by the client (Price Changed-Time Expired, Price Changed-Client Reject)

20 New Accepted
21 invalid price 
44 requoted then Timer expired 
45 requoted then client reject
6 Trade The order type (Buy/Sell).
1 : means Buy 
-1 : means Sell
7 Amount Order amount
8 Symbol ID The ID for the order symbol
9 Price The accepted price from the dealer or client side of each market order
10 Old Price The requested price from the client side, before re-quoting the market order from the dealing room side
11 Who The dealer ID who handled each market order
12 Requested Time The date and time when each market order was requested from the client side
13 Catch Time The time when each market order was received to the chatting screen of the dealing room
14 Dealer Time The time when each market order was handled from the dealer side
15 Client Time The time when each re-quoted market order was handled from the client side
16 IP The IP address for the dealer who handled the each market order, or the IP address for client who accepted or rejected each re-quoted market order
17 Symbol name The name of  the symbol name
18 Client ID The client ID for the account
19 Delivery items Delivery items for this delivery  order
20 TransTag The same string which sent by the requested report.

See Also


VertexFX Backoffice API Index

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions