Knowledgebase
Knowledgebase : Technical Support > API > Client API's/VTL > VertexFX Client API (ActiveX DLL) > Methods
SYNTAX
Public Function CloseAllByHedge(AccountID As Integer, BuyTickets As String, SellTickets As String, BuyLots as String, SellLots as String, SymbolID as Integer) CallingResultsEnum
Description
The CloseAllByHedge function is used to close the giv...
SYNTAX
Public Function GetDepartments() As CallingResultsEnum
DESCRIPTION
This function is used to get all departments that have privilege on
the logged in client After the GetDepartments method executes the
DepartmentsResultReceived
[https://www.hybri...
SYNTAX
Public Function BinaryPayout(SymbolID As Integer) As String
DESCRIPTION
This function is used to get the prestige of the profit to the loss
value.
PARAMETERS
Parameter
Description
SymbolID
Symbol identifier to get the binary pay...
SYNTAX
Public Function BinaryPeriod(SymbolID As Integer) As String
DESCRIPTION
This function is used to get the period that the order will be remains
before goes to close.
PARAMETERS
Parameter
Description
SymbolID
Symbol identifier to g...
SYNTAX
Public Function DeliveryItemsCount(SymID As Integer) As Integer
DESCRIPTION
This function is used to get the delivery item count for the requested
physical symbol Id.
PARAMETERS
Parameter
Description
SymID
A physical symbol iden...
SYNTAX
Public Function GetDeliveryItem(SymID As Integer, Index As Integer) As CDeliveryItem
DESCRIPTION
This function is used to get the delivery item information for the
given Symbol ID.
PARAMETERS
Parameter
Description
SymID
A physi...
SYNTAX
Public Function GetAccountStatement(AccountID As Integer, StatementType As StatementTypeEnum, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum
DESCRIPTION
This function is used to get the statement report ...
SYNTAX
Public Function LimitOffset(ByRef SymID As Integer) As Double
DESCRIPTION
This function is used to return the value of how much the limit order
prices should be away from the current market price for a specific
symbol.
PARAMETERS
Parameter...
SYNTAX
Public Function ChangePassword(ByRef OldPassword As String, ByRef NewPassword As String, ByRef ConfirmPassword As String) As CallingResultsEnum
DESCRIPTION
This function used to change the password for a user. After
ChangePassword method execut...
SYNTAX
Public Function StopOffset(ByRef symbolID As Integer) As Double
DESCRIPTION
This method is used to return the value for how much the stop orders
and the stop loss orders should be away from the current market
price.
PARAMETERS
Parameter
...
SYNTAX
Public Function Spread(ByRef symbolID As Integer) As Object
DESCRIPTION
This method is used to return the spread value for the given
symbol, this value depends on spread value for the selected
account
PARAMETERS
Parameter
Description
...
SYNTAX
Public Function MaximumAmount (ByRef symbolID As Integer) As Double
DESCRIPTION
This method is used to return the maximum amount of lots per deal for
specific symbol.
PARAMETERS
Parameter
Description
SymbolID
Trading Symbol ID ...
SYNTAX
Public Function MinimumAmount (ByRef symbolID As Integer) As Double
DESCRIPTION
This method is used to return the minimum amount of lots per deal for
specific symbol.
PARAMETERS
Parameter
Description
SymbolID
Trading Symbol ID ...
SYNTAX
Public Function Commission (ByRef symbolID As Integer) As Double
DESCRIPTION
This method is used to return the commission value for specific
symbol.
PARAMETERS
Parameter
Description
SymbolID
Trading symbol ID, value of type Inte...
SYNTAX
Public Function GetChartHistory(SymbolID As Integer, Period As PeriodNoEnum, BeforeDate As Date, NumberOfBars As Integer) As CallingResultsEnum
DESCRIPTION
This method is used to return the open, close, high and low prices for
the chart on spec...
SYNTAX
Public Function Deliver (Ticket As Integer, DeliveryItemID As String, NumberOfItems As Integer, DepID As Integer,Optional Comment As String = " ") As CallingResultsEnum
DESCRIPTION
This function delivers the physical items for specific symbol. ...
SYNTAX
Public Function RequestDeliveryItems(Optional ByRef SymID As Integer = -1) As CallingResultsEnum
DESCRIPTION
This function requests physical items for specific symbol. After
RequestedDeliveryItems method executes the DeliveryItemsUpdated
[http:/...
SYNTAX
Function CloseByHedge(ByRef Ticket1 As Integer, ByRef Ticket2 As Integer, ByRef Amount As Double) As CallingResultsEnum
DESCRIPTION
This function closes specific amount of two tickets by hedge. After
CloseByHedge method executes the CloseByHedge...
SYNTAX
Public Function GetAccountHistroy (AccountID As Integer, Optional LastXDays As Integer = -1, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum
DESCRIPTION
This function shows the entire transactions done in...
SYNTAX
Public Function SlTpRelation(ByRef OrderType As OperationTypeEnum, ByRef SlORTp As String) As String
DESCRIPTION
This function is used to determine if the given prices will be "<" or
">" from the current prices with the offset by giving the orde...
SYNTAX
Public Function LimitRelation(ByRef OrderType As OperationTypeEnum) As String
DESCRIPTION
This function use to determines if the given prices will be "<" or ">"
from the current prices with the offset by giving the order type.
PARAMETERS
Pa...
SYNTAX
Public Sub Disconnect()
DESCRIPTION
This function is used to disconnect the connected session from the
server.
PARAMETERS
No Parameters.
RETURN VALUE
No returned value.
SAMPLE
Private Sub Btn_Click(ByVal sender As System.Object, ByVal e A...
Syntax
Public Function AccountSummaries(AccountId As Integer, ByRef Balance As Double, ByRef FltPL As Double, ByRef Credit As Double, ByRef Equity As Double, ByRef MarginReq As Double, ByRef MarginLevel As Double, ByRef EffMargin As Double) As VertexFXCl...
SYNTAX
Public Function NewSLTPOrder(ByRef ticket As Integer, ByRef Lots As Double, [ByRef SL As Object = ""], [ByRef TP As Object = ""], [ByRef TransTag As String = ""]) As CallingResultsEnum
DESCRIPTION
This function is used to set a new SL/TP order ...
SYNTAX
Public Function DeleteLimitOrder(ByRef OrderID As String,ByRef TransTag As String) As CallingResultsEnum
DESCRIPTION
This function deletes a limit order. You have to select account
number before deleting the order using the selectAccount
[http:/...
SYNTAX
Public Function DeleteSLTPOrder(ByRef OrderID As String, ByRef TransTag As String) As CallingResultsEnum
DESCRIPTION
This function deletes an SL/TP order. After this method executes
the DeleteSLTPOrderResult
[http://www.hybridsolutions.com/suppo...
SYNTAX
Public Function UpdateSLTPOrder(ByRef OrderID As Integer, ByRef Lots As Double , [ByRef SL As Object = ""], [ByRef TP As Object = ""],[ByRef TransTag As String = ""]) As VertexFXClientAPI10.CallingResultsEnum
DESCRIPTION
This function updates an...
SYNTAX
Public Function UpdateLimitOrder(ByRef OrderId As Integer, ByRef Lots As Double, ByRef NewPrice As Double, [ByRef SL As Object = ""], [ByRef TP As Object = ""],[ByRef TransTag As String =""],[ByRef Note As String =""]) As CallingResultsEnum
DESC...
SYNTAX
Public Function NewSLTPOrder(ByRef Ticket As Integer , Lots As Double ,[ByRef SL As Object = ""],[ByRef TP As Object = ""],[ByRef TransTag As String = ""]) As VertexFXClientAPI.CallingResultsEnum
To make new SL/TP order.
PARAMETERS
Part
D...
SYNTAX
Public Function NewLimitOrder(ByRef OrderType As OperationTypeEnum , ByRef SymbolID As Integer, ByRef Lots As Double, ByRef Atprice As Double, [ByRef SL As Object = ""], [ByRef TP As Object = ""],[ByRef TransTag As String = ""],[ByRef Note As Str...
SYNTAX
Public Function SelectAccount(ByRef AccountID As Integer) As VertexFXClientAPI10.CallingResultsEnum
DESCRIPTION
To choose which account that want to load its pending orders and open
positions.
Note that an account must be selected before perfo...
SYNTAX
Public Function RejectOrder(OrderID As Integer) As VertexFXClientAPI.CallingResultsEnum
To reject a re-quoted order.
PARAMETERS
Part
Description
OrderID
OrderID of type integer.
If you want to know the result of RejectOrder you...
SYNTAX
Public Function AcceptOrder(ByRef OrderID As Integer) As CallingResultsEnum
DESCRIPTION
This function accepts a re-quoted order by given the order ID. After
AcceptOrder method executes the AcceptOrderResultRecieved
[http://www.hybridsolutions.co...
SYNTAX
Public Function CloseMarketOrder(ByRef ticket As string, ByRef lots As Double, ByRef TransTag As String) As CallingResultsEnum
DESCRIPTION
This function closes an open position. The account must be selected
to be able to close a market order by ...
SYNTAX
Public Function NewMarketOrder(ByRef BuySell As VertexGeneral.OperationTypeEnum, ByRef SymbolID As Integer, ByRef Lots As Double,[ByRef TransTag As String = ""],[ByRef Note As String = ""]) As VertexFXClientAPI.CallingResultsEnum
DESCRIPTION
Thi...
SYNTAX
Public Sub Login()
DESCRIPTION
This function logs in to the server and loads all data. After Login
finishes loading the AllDataAreLoaded
[http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/1995]
event is fired. Before...
SYNTAX
Public Sub SetLoginInfo (ByRef Username As String, ByRef Password As String, ByRef ServerIP As String, ByRef ServerPort As Integer)
DESCRIPTION
This function is used to set the login information that are used in
the login
[http://www.hybridsolut...
Help Desk Software by Hybrid Solutions