Updated: 2017-05-22

getInstrumentDefinition

By Barchart

    The getInstrumentDefinition API is available to request meta data on financial instruments by symbol, exchange, or exchange MIC. Meta data includes instrument names, exchange codes, tick increments, base codes, expiration dates and more.

    Query Parameters

    Parameter Description Data Type
    exchangeMics Market Indicator Code for the marketplace where the financial instruments are listed.
    exchanges Exchange code for the marketplace where the financial instruments are listed.
    maxRecords The maximum number of records requested.
    offset A value denoting where to start results from.
    symbols A symbol or code that identifies a financial instrument.

    Response Fields

    Field Description Data Type
    baseCode Indicates the fractional or decimal precision of the instrument. string
    exchange Exchange code for the marketplace where the financial instruments are listed. string
    exchangeCode The smallest increment at which the financial instrument can be traded. string
    exchangeName The name of the exchange. string
    guid description string
    id description string
    pointValue An indicator representing the value of one point in dollar terms. This applies to futures. int
    symbol A symbol or code that identifies a financial instrument. string
    symbolCFI The symbol's classification of financial instruments code. string
    symbolDdf description string
    symbolExpiration The last day that the financial instrument is traded. date
    symbolHistorical description string
    symbolName The full name of the instrument. string
    symbolRealtime description string
    tickIncrement The number of units that make up one tick. For example, U.S. equities are quotes in decimals, and tick in decimals, and can go up +/- .01. So the tick increment is 1. But the e-mini S&P futures contract, though quoted in decimals, goes up in .25 increments, so the tick increment is 25. int
    unitCode The corresponding unit code i

    About the Vendor

    From market data feeds to website content solutions and trading software to our flagship financial portal, Barchart.com, and individual subscription services, Barchart is the definitive source for comprehensive financial data and information.