Syntax
GetHistory(AccountId As Long, FromDate As String, ToDate As String, lastXdays As Integer)
Description
The GetHistory operation is used to return a list that contains a given account history of a given starting date and
ending date.
Request Parameters
Name |
Description |
Required |
AccountId |
- The intended account identifier.
- Type: Long.
- Default: None.
- Constraints: Must be a valid account ID, and accessible by a logged-in client.
|
Yes |
FromDate |
- Starting date for account transactions query.
- Type: String.
- Default: 01/01/1970
- Constraints: Must be in dd/MM/yyyy or dd/MM/yyyy HH:mm:ss format.
|
Yes |
ToDate |
- Ending date for account transactions query.
- Type: String.
- Default: System date.
- Constraints: Must be in dd/MM/yyyy or dd/MM/yyyy HH:mm:ss format.
|
Yes |
lastXdays
|
- The number of days you want to get a history for, for example, the last 5 days.
- Type: Integer.
- Default: 0
- Constraints: Interval is calculated based on the current system date.
|
No |
Response Elements
Name |
Description |
Account History |
This operation returns a given account history as a list (of type AccountHistory) upon success.
The following are the AccountHistory Data members:
- Ticket: The transaction order number.
- Type: Indicate the history type as the following.
DP: Means Deposit.
AJ: Means Adjustment.
CI: Means Credit In.
WD: Means Withdrawal.
CO: Means Credit Out.
SL: Means Sell Limit.
BL: Means Buy Limit.
BS: Means Buy Stop.
SS: Means Sell Stop.
L: Means Close.
SL/TP : Means Stop loss /Take profit order
- DateTime:The date and time of the history.
- SymbolID: Trading symbolIdentifier.
- Amount: a Trading amount of lots.
- BuySell: Type of action.
If the value equals -1, then the operation type is sell.
If the value equals 1, then the operation type is buy.
- OpenTime: trading open time.
- OpenSL: OpenStop loss value.
- CloseTP: Close price or Take profit value.
- DpWdAj: The amount of money withdrawn, added, or Adjusted.
- Commission: Commission value.
- Interest: Intrest Value.
- ProfitLoss: Profit Loss.
- SymbolName: Trading symbol Name.
- RefPrice: Reference symbol price.
- Note: The comment is added when taking the order.
- OpenPrice: Order open price.
- OpenTicket: The related ticket number for the closing order
- Method: Method
- MainTicket: Main Ticket ID
- ProviderName: Provider Name
Otherwise, an explicit error code is returned.
Type: JSON object as List (of AccountHistory). |
See Also
VertexFX WCF Service Index