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.
Otherwise, an expliciterror codeis returned.
Type: JSON object as List (of Symbol).
|
Sample
GetAllSymbols
Loading ...
See Also
VertexFX WCF Service Index
GetAllSymbols
Loading ...