Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Query-String
    AssetType AssetType Route The of the instrument to get.
    ClientKey ClientKey Query-String
    FieldGroups InstrumentFieldGroup [] Query-String Specifies comma-separated list of additional fields to receive.
    Uic Uic Route The Universal Instrument Code (UIC) of the instrument to get.

  • Response Parameters

    View Response Codes
    Name Type Description
    AdditionalMinimumTradeSize Number Additional Minimum Trade Size, only available for Mutual Funds
    AdditionalMinimumTradeUnits Number Additional Minimum Trade Units, only available for Mutual Funds
    AmountDecimals Integer The trading amount supported decimals.
    AssetType AssetType AssetType (Note: OptionRoots also have an asset type (FuturesOption, StockOption, StockIndexOption).
    BondIndexRatio Number Index ratio of bonds.
    BondType BondType The type of bond.
    CanParticipateInMultiLegOrder Boolean For FxVanillaOptions and ContractOption roots (true if it supports exchange traded option strategies).
    ContractSize Number No of units of the underlying instrument covered by one contract.
    Coupon Number Coupon (relevant for bonds only)
    CouponType BondsCouponType Type of a coupon (relevant for bonds only)
    CurrencyCode String The ISO currency code of the instrument/symbol.
    CutOffTimeForSubscriptions String Cut off time for Mutual fund subscriptions, only available for Mutual Funds
    DefaultAmount Number Default amount suggested for trading this Instrument
    DefaultSlippage Number The default slippage (only set for FX DMA instruments)
    DefaultSlippageType DefaultSlippageType The default slippage type - either pips or percentage (only set for FX DMA instruments)
    DeflationFloorProtectionType LocalizedInfo Deflation floor protection, applicable only for Inflation Linked Bonds.
    Description String Description of Instrument (DAX Index - Nov 2013), in English.
    DisplayHint DisplayHintType Hint to the client application about how it should display the instrument.
    DistributionPolicy DistributionPolicy Distribution Policy, only available for Mutual Funds
    DividendPeriodicity DividendPeriodicityType Dividend Periodicity, only available for Mutual Funds
    Exchange ExchangeSummary Information about the exchange where this instrument or the underlying instrument is traded. * For most instruments this is the exchange where this instrument is traded. * For CFDs on stocks and futures, it is the exchange where the underlying instrument is traded. * For CFDs on stock indices, it is the exchange of the underlying ticker.
    ExerciseCutOffTime String The latest time at which an option can be exercised within a given day. This cutoff is specified in Exchange local time.
    ExpiryDate Date Applicable for Types: Futures, CfdOnFutures, ContractOptions
    ExpiryDateTime UtcDateTime Applicable for Types: CfdOnFutures
    Format PriceDisplayFormat Price formatting information
    FxForwardMaxForwardDate UtcDateTime The latest possible forward date for a forex instrument that can be traded as forward.
    FxForwardMinForwardDate UtcDateTime The earliest possible forward date for a forex instrument that can be traded as forward.
    FxSpotDate Obsolete UtcDateTime Spot date for a forex instrument. Applicable for Types: FxSpot, FxForwards and FxSwap Will be removed May 2019, please use standard date endpoint to get FxSpotDate
    GroupId Integer The GroupId value is used to group and structure instruments list. 0 is being used for ungrouped data.
    IncrementSize Number The rate at which price should be incremented when done in steps.
    IpoDetails IpoDetails InitialPublicOffering details
    IsComplex Boolean Is the instrument (complex)?
    IsDmaEnabled Boolean Indicates if the instrument has direct market access (only FxSpot)
    IsExtendedTradingHoursEnabled Boolean Indicate whether Extended Trading is enabled for instrument True if enabled, false otherwise.
    IsPEAEligible Boolean Indicates if the instrument is PEA Eligible
    IsPEASMEEligible Boolean Indicates if the instrument is PEA-PME Eligible
    IsPitTraded Boolean Applicable for Types: Futures
    IsRedemptionByAmounts Boolean Redemption by amounts is enabled or not, only available for Mutual Funds
    IsTradable Boolean Is the instrument (currently) tradable by the user represented in the API token?
    Legs StrategyLeg [] Strategy Legs (for Futures Strategies).
    LotSize Number The LotSize, how many contracts in a lot traded?.
    LotSizeText String Lot size description for the instrument. Futures only.
    LotSizeType LotSizeType Applicable for Types: Shares, CfdOnFutures, ContractOptions
    MaxGuaranteedStopOrderSize Number The maximum size of a (guaranteed) stop order for this instrument.
    MinimumLotSize Number Since this is only pertinent to CFDs and stocks, it should be moved to those subclasses, even though the value is defined for all instrument types. Or is it?
    MinimumOrderValue Number Value of trade (Amount * Price) must be greater than or equal to
    MinimumTradeSize Number The minimum trade size of a given contract. For CFDs and Stocks this value indicates number of contracts. For ETOs and Futures this value indicates the minimum number of lots that can be traded. In addition, the value is always 1 for ETOs and Futures. However, 1 lot can represent any number of contracts. For FX and Bonds this value indicates nominal amount.
    MinimumTradeSizeCurrency String The minimum trade size currency of MutualFund
    NonTradableReason NonTradableReasons Optional reason of why the is not tradable.
    NoticeDate Date Applicable for Types: Futures
    OptionsChainSubscriptionAllowed Boolean Options only. Is an options chain subscription allowed for this instrument.
    OrderDistances OrderDistances Minimal order distances for each order type.
    OrderSetting OrderSetting Order setting of an instrument
    PriceCurrency String Price currency of the instrument.
    PriceToContractFactor Number Applicable for Types: Futures, CfdOnFutures, ContractOptions, CfdIndices
    PrimaryListing Integer The uic of the primary listing of this instrument. For stocks and CFDs, this is the instrument traded on the exchange of the same country as issuer country. For expiring instruments, this is the next expiring instance.
    PutCall PutCall Contract options only. Indicates whether the options is a put option or a call option.
    RedemptionDays Integer Redemption Days, only available for Mutual Funds
    RedemptionDaysType DaysType Redemption Days Type, only available for Mutual Funds
    RelatedInstruments InstrumentKey [] List of related UICs and asset types.
    RelatedOptionRoots Obsolete Integer [] . Please use RelatedOptionRootsEnhanced instead. This field will be removed from December 2020.
    RelatedOptionRootsEnhanced RelatedOptionRoot [] List of related Option root id's combined with asset type.
    SettlementStyle SettlementStyle Contract options only. The settlement style of the contract option, i.e. either cash or physical delivery.
    ShortTradeDisabled Boolean Indicates whether short trade is disabled. True if disabled, false otherwise.
    StandardAmounts Number [] Standard amounts. Used for drop downs in trade tickets.
    StrategyType StrategyType Strategy Type. For calendar spreads.
    StrikePrice Number The strike price. Used on contract options.
    SubscriptionByAmounts Number SubscriptionByShares, only available for Mutual Funds
    SubscriptionByShares Number SubscriptionByShares, only available for Mutual Funds
    SubscriptionDays Integer Subscription Days, only available for Mutual Funds
    SubscriptionDaysType DaysType Subscription Days Type, only available for Mutual Funds
    SupportedOrderTypes PlaceableOrderType [] What types of orders can be placed on this instrument ( or option)
    SupportedOrderTypeSettings SupportedOrderTypeSetting [] Field Group - Order type settings for each order type supported by current instrument.
    SupportedStrategies String [] Algo order strategies which are allowed on this instrument.
    Symbol String Symbol- A combination of letters used to uniquely identify a traded instrument. e.g. ODAX/X13C8950:xeur or EURUSD.
    TickSize Number Minimum price movement of an instrument.
    TickSizeLimitOrder Number Minimum price increment when placing a limit order.
    TickSizeScheme TickSizeScheme The tick size scheme of the instrument. Relevant for Stock, CFDs on Stock and contract options.
    TickSizeStopOrder Number Minimum price increment when placing a stop order.
    TradableAs AssetType [] For instruments: How can an instrument with "this" uic also be traded.
    TradableOn String [] Specifies what accounts the calling client can trade this instrument or option space on.
    TradingSessions InstrumentTradeSessions Trading sessions of an instrument
    TradingStatus TradingStatus Indicates whether the instrument is currently tradable by the user represented in the API token.
    TradingUnitsPlural String Applicable for Types: CfdOnFutures
    TradingUnitsSingular String Applicable for Types: CfdOnFutures
    Uic Integer Universal Instrument Code.
    UnderlyingAssetType AssetType The asset type of the underlying instrument.
    UnderlyingTypeCategory UnderlyingTypeCategory Whether the instrument has more than one underlying instruments (in that case it is a Basket).

  • Request Example

    Request URL
    GET /ref/v1/instruments/details/22/FxSpot?AccountKey={AccountKey}&ClientKey={ClientKey}&FieldGroups=AnalystConsensus

  • Response Example

    Response body
    {
  "AmountDecimals": 0,
  "AssetType": "FxSpot",
  "CurrencyCode": "AUD",
  "DefaultAmount": 100000,
  "DefaultSlippage": 0.01,
  "DefaultSlippageType": "Percentage",
  "Description": "British Pound/Australian Dollar",
  "Exchange": {
    "CountryCode": "DK",
    "ExchangeId": "SBFX",
    "Name": "Inter Bank"
  },
  "ExerciseCutOffTime": "2024-04-22T00:00:00Z",
  "Format": {
    "Decimals": 4,
    "Format": "AllowDecimalPips",
    "OrderDecimals": 4
  },
  "FxForwardMaxForwardDate": "2018-05-08T00:00:00Z",
  "FxForwardMinForwardDate": "2017-05-03T00:00:00Z",
  "GroupId": 0,
  "IncrementSize": 5000,
  "IpoDetails": {
    "Denominations": [
      100,
      200,
      500
    ]
  },
  "IsRedemptionByAmounts": false,
  "IsTradable": true,
  "MinimumTradeSize": 1000,
  "NonTradableReason": "None",
  "OrderDistances": {
    "EntryDefaultDistance": 0,
    "EntryDefaultDistanceType": "Percentage",
    "LimitDefaultDistance": 0,
    "LimitDefaultDistanceType": "Percentage",
    "StopLimitDefaultDistance": 5,
    "StopLimitDefaultDistanceType": "Pips",
    "StopLossDefaultDistance": 0.5,
    "StopLossDefaultDistanceType": "Percentage",
    "StopLossDefaultEnabled": false,
    "StopLossDefaultOrderType": "Stop",
    "TakeProfitDefaultDistance": 0.5,
    "TakeProfitDefaultDistanceType": "Percentage",
    "TakeProfitDefaultEnabled": false
  },
  "SettlementStyle": "PhysicalDelivery",
  "ShortTradeDisabled": true,
  "StandardAmounts": [
    10000,
    50000,
    100000,
    250000,
    500000,
    1000000,
    2000000,
    5000000,
    10000000,
    20000000
  ],
  "SupportedOrderTypes": [
    "Market",
    "Limit",
    "Stop",
    "TrailingStop",
    "StopLimit"
  ],
  "Symbol": "GBPAUD",
  "TickSize": 5E-05,
  "TradableAs": [
    "FxSpot",
    "FxForwards",
    "FxVanillaOption",
    "FxKnockInOption",
    "FxKnockOutOption"
  ],
  "TradableOn": [
    "76940INET",
    "76940INET1",
    "76940INET2",
    "SAMGS*585220"
  ],
  "TradingStatus": "NotDefined",
  "Uic": 22
}