• Home
  • Knowledgebase
  • Blog
  • My Account
  • Try VertexFX
  • Home
  • Knowledgebase
  • Blog
  • My Account
  • Try VertexFX

VertexFX BackOffice WCF Service

home/Knowledge Base/Technical Support/API/BackEnd API's/VBL/VertexFX BackOffice WCF Service/VertexFX BackOffice WCF Service/GetClientParam

GetClientParam

115 views 0 Updated on September 20, 2023 hybrid-solutions

Syntax

Public Function GetClientParam(ClientID As Long) As String

Description

This function is used to get the parameter for the given client ID which the logged-in dealer has privilege.

Parameters

Name Description Required
ClientID
  • The client number to get his parameters
  • Type: Long
  • Default: None
Yes

Response Elements

Name Description
Result The operation returns a JSON object of type ClientParameter in a case successfully otherwise an explicit error code is returned if the SymbolID is less than 0.

The following are the client parameter data member.

  • SymbolID: The symbol number that the value of the parameter belongs to, the value of type long
  • Spread: the differences between ask and bid , the value of type String, if it empty String that means the spread equal the source plus value
  • SpreadFlag: To detect if the spread is inherited or overridden, 2 means Override, otherwise it is inherited
  • LimitOffset: number of pips which should be away from the current market price to place limit orders. Value of type Double
  • LimitOffsetFlag: To detect if the Limit Offset is inherited or overridden. , 2 means Override, otherwise, it is inherited
  • StopOffest: number of pips which should be away from the current market price to place the stop orders. Value of type Double
  • StopOffestFlag To detect if the Stop Offset is inherited or overridden.
    2 means Override, otherwise, it is inherited
  • InitMarginReq: Amount that the client should have in his effective margin to be able to buy 1 lot, Value of type String. If contains % that means the initial margin is a percentage initial margin type.
  • InitMarginReqFlag: To detect if the Initial Margin is inherited or overridden, 2 means Override, otherwise it is inherited
  • MntnMarginReq : Effective margin amount. Value of type Double.
  • MntnMarginReqFlag: To detect if the Maintenance Margin is inherited or overridden. 2 means Override, otherwise it is inherited
  • Visible: To detect if the symbol is visible or not, Value of type Boolean.
  • VisibleFlag: To detect if the visible parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • Comm : Client Commission value. The value of type is Double.
  • CommFlag : To detect if the commission parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • MaxLot: Maximum amount for each deal to trade on. Value of type Double.
  • MaxLotFlag: To detect if the Max lot parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • MinLot: Minimum amount for each deal to trade on. Value of type Double.
  • MinLotFlag: To detect if the Min lot parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • AutoBroker: The market orders auto broker, value of type Double.
    -1: means auto broker on

    -2: means auto broker off
  • AutoBrokerFlag To detect if the AutoBroker parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • SourcePlus: the feed prices value. Value of type Double
  • SourcePlusFlag: To detect if the SourcePlus parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • LOAutoBroker: the pending order auto broker, value of type double.
    -1: means auto broker on
    -2: means auto broker off
  • LOAutoBrokerFlag: To detect if the LOAutoBroker parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • BinaryPayout: the percentage of the profit to loss value for the binary
  • BinaryPayoutFlag: To detect if the BinaryPayout parameter is inherited or overridden. 2 means Override, otherwise it is inherited
  • BinaryPeriod: the period that the binary order will remain before goes to close
  • BinaryPeriodFlag: To detect if the BinaryPeriod parameter is inherited or overridden. 2 means Override, otherwise it is inherited
Loading …

 

See Also

  • GetClientParam
  • GetGeneralClientParam
  • BackOfficeLogin

VertexFX BackOffice WCF Service Index

Was this helpful?

Yes  No
Leave A Comment Cancel reply

  GetClient

GetGeneralClientParam  

About
VertexFX Trader has a closed-loop trading structure with BackOffice dealing desk, Client Terminals, Dedicated Hosting, White Labelling and Bridging Capabilities. Through VertexFX Risk Management Bridge...
Categories
  • Release Notes
  • Technical Support
  • VertexFX Pro Setup
  • Mobile Trader
  • Lite VertexFX Mobile Trader
Community
  • Blog
  • Media Center
Need Support?
If you need any further help, don't hesitate to send a support request to our support team.
Contact Support
  • Privacy Policy
  • Brokers Terms
  • Traders EULA
  • ISV Terms
  • Plugins EULA
  • Copyright 2024 hybridsolutions.com. All Rights Reserved.