Login
Try VertexFX
  • Home
  • Knowledgebase
  • Blog
  • Forum
  • Home
  • Knowledgebase
  • Blog
  • Forum

VertexFX Client WCF Service

home/Knowledge Base/Technical Support/API/Client API's/VTL/VertexFX Client WCF Service./VertexFX Client WCF Service/GetAllSymbols

GetAllSymbols

5 views 0 December 16, 2021 hybrid-solutions

Syntax

GetAllSymbols (AccountID As Long, Optional WithGroups As Boolean = False)

Description

The GetAllSymbols operation is used to return a List of symbols for the logged in client according to the given account id parameter.

Request Parameters

Name Description Required
AccountID
  • The intended account identifier.
  • Type: Long.
  • Constraints: Must be a valid account ID, and accessible by logged in client.
Yes
WithGroups

  • True if group type’s needed, False if not.
  • Type: Boolean.
No

Response Elements

Name Description
Symbols

This operation returns Symbols upon success as list (of type Symbol). The following are the Symbol’s data members:

  • RefSymbol: Reference symbol.
  • SymbolFactor: Contract size.
  • PriceCase: To indicates direct/indirect setting:
    1: Price case is direct.
    -1:Price case is indirect.
  • RefPriceCase: To indicate Ref symbol calculation. It can be one of the following:
    -1: Which mean Division.
    1: Which mean Multiplication.
  • Type: Indicates to symbol type as the below conditions:
    If the value type equals 1, then symbol type is symbol.
    If the value type equals 2, the symbol type is a group, which means it is a parent for the child symbols.
  • Name : Symbol Name.
  • SpreadOffset: The spread offset value.
  • PriceOffset: Price offset value.
  • SpreadType: spread calculation type:
    1: Spread type is from bid.
    2: Spread type is from Average.
  • StopTradeIfNoPrices: Indicates if trading onsymbol should stop when no price.
  • StopTradeAfterSeconds: Indicates after how many seconds trading on symbol should occur.
  • MaxAmountPerDeal: Maximum lots amount to deal.
  • MinAmountPerDeal: Minimum lots amount to deal.
  • AskWithSpread: Ask price with spread value.
  • BidWithSpread: Bid price with spread value.
  • Commission: Commission value.
  • LimitOffset: How much the limit order prices should be far from the market price.
  • StopOffset: How much the SLTP order prices should be far from the market price.
  • PipLocation: Indicates the pips value. i.e. Pips(-5) for EUR/USD is 0.0005.
  • Spread: To get the amount of pips between bidprice and ask price.
  • IsUsed: Defined as Used in the backoffice symbol settings.
  • IsDisplay: Defined as a display in the BackOffice symbol settings.
  • HasPriv: detect if the logged in client has a privilege to trade on the symbol.
  • JustClose: If the returned value is true, trading type is just close, otherwise the trading type is full trade.
  • BuyOnly: If the returned value is true, start trade with only buy, otherwise the trading with buy and sell.
  • IsDelivery: If the returned value is true, the symbol accepts the physical trading.
  • ID: Symbol ID.
  • Bid: Bid price.
  • Ask: Ask price.
  • High: High price.
  • Low: Low price.
  • LastQuoteTime: Indicates the last quote time.
  • MainUnitFactor : to get the main unit factory of the symbol.
  • BinaryPayout : to get the binary payout parameter value of the symbol.
  • BinaryPeriod : to get the binary period parameter value of the symbol.
  • TickPip : detected the tick pip value of the symbol.
  • ExpDate : detected the expiry date for the symbol.
  • ParentID : detected the symbol parent id.
  • SymbolDesc : Symbol Description

Otherwise, an expliciterror codeis returned.

Type: JSON object as List (of Symbol).


Sample

GetAllSymbols
Username: Password:
AccountID: WithGroup:
Loading ...


See Also

  • GetClientGeneralParam
  • GetHistory
  • GetNewTick


VertexFX WCF Service Index

GetAllSymbols
Username: Password:
AccountID: WithGroup:
Loading ...

Was this helpful?

Yes  No
Leave A Comment Cancel reply

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
  • Technical Support
  • Social Trading
  • VertexFX Pro Setup
  • Mobile Trader
  • Lite VertexFX Mobile Trader
Community
  • Blog
  • Forum
  • 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 2022 hybridsolutions.com. All Rights Reserved.