GetInstruments

Category: User Permissions: Public Call Type: Synchronous

Retrieves a list of instruments available on the exchange. An instrument is a pair of exchanged products (or fractions of them) such as US dollars and BitCoin.

Request

{
    "OMSId":  1,
    "InstrumentState" : "both, inactive, active"
}

Key	Value
OMSId	integer. The ID of the Order Management System on which the instruments are available.
InstrumentState	string. Could be "both", "inactive" or "active"

Response

[
    {
        "omsId":0 ,
        "instrumentId": 0,
        "symbol": "",
        "product1": 0,
        "product1Symbol": "",
        "product2": 0,
        "product2Symbol": "",
        "instrumentType": 0,
        "venueInstrumentId": 0,
        "venueId":0,"sortIndex": 0,
        "sessionStatus": 0,
        "previousSessionStatus": 0,
        "sessionStatusDateTime": "0001-01-01T00:00:00",
        "selfTradePrevention": false,
        "quantityIncrement": 0.0,
        "priceIncrement": 0.0,
        "minimumPrice":0.0, 
        "quantityIncrement":0.0, 
        "displaySymbol":"",
        "isDisable":false, 
        "masterDataId":0, 
        "allowOnlyMarketMakerCounterParty":false
    },
]

The response for GetInstruments is an array of objects listing all the instruments available on the Order Management System.

Key	Value
omsId	integer. The ID of the Order Management System on which the instrument is traded.
instrumentId	integer. The ID of the instrument.
symbol	string. Trading symbol of the instrument, for example BTCUSD.
product1	integer. The ID of the first product comprising the instrument.
product1Symbol	string. The symbol for Product 1 on the trading venue. For example, BTC.
product2	integer. The ID of the second product comprising the instrument.
product2Symbol	string. The symbol for Product 2 on the trading venue. For example, USD.
instrumentType	integer. A number representing the type of the instrument. All instrument types currently are standard, an exchange of one product for another (or unknown, an error condition), but this may expand to new types in the future. 0 Unknown (an error condition) 1 Standard
venueInstrumentId	integer A venue instrument is created at the exchange level as an instrument "template" for adding new instruments to the exchange. This is the ID of the venue instrument behind the instrument being requested.
venueId	integer. The ID of the trading venue on which the instrument trades.
sortIndex	integer. The numerical position in which to sort the returned list of instruments on a visual display. Since this call returns information about a single instrument, SortIndex should return 0.
sessionStatus	integer. Is the market for this instrument currently open and operational? Returns one of: 0 Unknown 1 Running 2 Paused 3 Stopped 4 Starting
previousSessionStatus	string. What was the previous session status for this instrument? One of: 0 Unknown 1 Running 2 Paused 3 Stopped 4 Starting
sessionStatusDateTime	string. The time and date at which the session status was reported, in Microsoft Ticks format.
selfTradePrevention	Boolean. An account that is trading with itself still incurs fees. If this instrument prevents an account from trading the instrument with itself, the value returns true; otherwise defaults to false.
quantityIncrement	real. The smallest tradeable increment of the instrument. For example, for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the quantity increment might be 50.
priceIncrement	real. The amount by which the instrument can rise or fall in the market.
minimumPrice	float. The minimum price at which the instrument can be traded.
quantityIncrement	float. The minimum increment for the order quantity.
displaySymbol	string. The symbol displayed to users for the instrument.
isDisable	boolean. A boolean flag indicating whether the instrument is disabled.
masterDataId	integer. The ID of the master data associated with the instrument.
allowOnlyMarketMakerCounterParty	boolean. A boolean flag indicating whether the allow only market maker counter party is able or not.