Barchart Price Data API

openapi: 3.2.0
info:
  title: OnDemand Price Data API
  version: 1.0.1
  description: Barchart features a diverse set of market and information APIs that can be easily integrated into your website. Whether you're looking for a small, medium, large or enterprise solution, we'll create a custom package for you that exceeds your expectations.
  contact:
    name: onDemand API Support
    url: https://www.barchart.com/ondemand
    email: support@barchart.com
  termsOfService: https://www.barchart.com/solutions/company/terms-and-privacy
servers:
- url: https://ondemand.websol.barchart.com
tags:
- name: Price Data
paths:
  /getQuote.json:
    get:
      tags:
      - Price Data
      summary: getQuote
      operationId: get-getQuote
      description: The getQuote API is used to request price data, either real-time, delayed or end-of-day, by symbol on stocks, indexes, mutual funds, ETFs, futures, foreign exchange, or cryptocurrencies.
      parameters:
      - in: query
        name: apikey
        description: Enter the secret API key.
        required: true
        schema:
          type: string
          example: YOUR_API_KEY
      - in: query
        name: symbols
        description: A symbol or code that identifies a financial instrument.  Multiple symbols separated by a comma may be used.  For futures, notation such as <root_symbol*0> for the active contract or <root_symbol*1> for the first nearby is supported, as is <root_symbol^F> for all futures contracts for a given root symbol, as is <root_symbol^O> for all options contracts for a given underlying futures symbol.
        required: true
        schema:
          type: string
          example: AAPL,GOOG
      - in: query
        name: fields
        description: The fields requested.
        required: false
        schema:
          type: string
          example: fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate
      - in: query
        name: mode
        description: Parameter to change quote type to real-time ("R"), delayed ("I") or end-of-day ("D") if available.
        required: false
        schema:
          type: string
          example: I
      - in: query
        name: jerq
        description: Whether to merge with JERQ data.
        required: false
        schema:
          type: string
          example: 'false'
      - in: query
        name: exchangeFilter
        description: Returns all quotes for specified exchanges (symbols are ignored).
        required: false
        schema:
          type: string
          example: NYSE,CME
      - in: query
        name: only
        description: Returns only specified fields
        required: false
        schema:
          type: string
          example: symbol,name
      - in: query
        name: shareClassFigi
        description: The unique share class code identifying an instrument globally.
        required: false
        schema:
          type: string
          example: BBG001S5S399
      - in: query
        name: figi
        description: The unique code identifying an instrument across all exchanges in a country.
        required: false
        schema:
          type: string
          example: BBG000BLNQ16
      - in: query
        name: compositeFigi
        description: N/A
        required: false
        schema:
          type: string
          example: BBG000BLNNH6
      responses:
        '200':
          description: OK (Success)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: object
                    description: The status object when an error occurs or when a response is successful.
                    required:
                    - code
                    - message
                    properties:
                      code:
                        description: The status code of the response.
                        type: integer
                        example: 200
                      message:
                        description: The status message corresponding to the status code.
                        type: string
                        example: Success.
                  results:
                    description: The results object of the API operation.
                    type: array
                    uniqueItems: true
                    items:
                      type: object
                      properties:
                        symbol:
                          description: A symbol or code that identifies a financial instrument.
                          type:
                          - string
                          - 'null'
                          example: AAPL
                        name:
                          description: The type of symbol used.
                          type:
                          - string
                          - 'null'
                          example: Apple Inc
                        dayCode:
                          description: The day code for the session.  Day codes are "1-9" for days 1 through 9, "0" (zero) for the 10th of the month, and "A - U" for days 11 through 31.
                          type:
                          - string
                          - 'null'
                          example: G
                        serverTimestamp:
                          description: The time the message was generated on the server.
                          type:
                          - string
                          - 'null'
                          example: '2021-02-17T16:06:30-06:00'
                        mode:
                          description: An indicator representing if the quote is real-time ("R"), delayed ("I") or end-of-day ("D") if available.
                          type:
                          - string
                          - 'null'
                          example: i
                        lastPrice:
                          description: The last price the instrument traded.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 130.84
                        tradeSize:
                          description: The size of the last traded price / transaction.
                          type:
                          - integer
                          - 'null'
                          example: 3566575
                        tradeTimestamp:
                          description: The exchange timestamp for the last traded price.
                          type:
                          - string
                          - 'null'
                          example: '2021-02-17T16:00:00-06:00'
                        tradeDate:
                          description: The settlement trade date for the quote price.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-02-17'
                        netChange:
                          description: The difference between the last traded price and the previous close.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: -2.35
                        percentChange:
                          description: The percent difference between the last traded price and the previous close.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: -1.76
                        tick:
                          description: An indicator representing whether the last traded price was up ("+"), the same (".") or below ("-") the previous last price.
                          type:
                          - string
                          - 'null'
                          example: .
                        previousLastPrice:
                          description: The price previous to the current last price.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 133.19
                        previousTimestamp:
                          description: The exchange timestamp of the previous last price.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-02-16'
                        bid:
                          description: The current bid price.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 130.85
                        bidSize:
                          description: The size (quantity) of the current bid price.
                          type:
                          - integer
                          - 'null'
                          example: 1000
                        ask:
                          description: The current ask price.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 130.87
                        askSize:
                          description: The size (quantity) of the current ask price.
                          type:
                          - integer
                          - 'null'
                          example: 300
                        unitCode:
                          description: The corresponding unit code.
                          type:
                          - string
                          - 'null'
                          example: '2'
                        open:
                          description: The opening (first) price for the session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 131.25
                        high:
                          description: The highest traded price for the session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 132.22
                        low:
                          description: The lowest traded price for the session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 129.47
                        close:
                          description: The last traded price for the session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 130.84
                        numTrades:
                          description: The number of individual transactions over the course of a trading session.
                          type:
                          - integer
                          - 'null'
                          example: 965940
                        dollarVolume:
                          description: The current Dollar Volume.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 13061554630.89
                        flag:
                          description: 'If present, can be one of the following: "c" meaning that the market is closed for this instrument. "p" meaning that the market is in a pre-open state. This occurs when there are bids and offers being placed, but no trade has occurred yet. This is normally seen shortly before the official opening time for busy markets, but can also be seen throughout the day for lightly traded markets. "s" meaning that the instrument has settled, and that this is the final, settlement price.

                            '
                          type:
                          - string
                          - 'null'
                          example: s
                        previousOpen:
                          description: The opening (first) price for the previous session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 135.49
                        previousHigh:
                          description: The highest traded price for the previous session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 136.01
                        previousLow:
                          description: The lowest traded price for the previous session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 132.79
                        previousClose:
                          description: The last traded price for the previous session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 133.19
                        previousNetChange:
                          description: The difference between the Last Price, and the Last Price from 1 day ago.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        previousPercentChange:
                          description: The percent change from 1 day ago.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        settlement:
                          description: The settlement price determined by the exchange.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 130.84
                        previousSettlement:
                          description: The settlement price for the previous session.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 133.19
                        volume:
                          description: The quantity of shares or contracts traded.
                          type:
                          - integer
                          - 'null'
                          example: 97730392
                        previousVolume:
                          description: The quantity of shares or contracts traded from the previous day.
                          type:
                          - integer
                          - 'null'
                          example: 80576305
                        openInterest:
                          description: The quantity of open interest for futures.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        previousOpenInterest:
                          description: The quantity of open interest for futures from the previous day.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        fiftyTwoWkHigh:
                          description: The highest price over the past 52 weeks.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        fiftyTwoWkHighDate:
                          description: The date in which the high price was reached over the past 52 weeks.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        fiftyTwoWkLow:
                          description: The low price over the past 52 weeks.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 53.15
                        fiftyTwoWkLowDate:
                          description: The date in which the low price was reached over the past 52 weeks.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2020-03-23'
                        avgVolume:
                          description: The average year-to-date daily volume.
                          type:
                          - integer
                          - 'null'
                          example: 103347133
                        impliedVolatility:
                          description: The estimated volatility of a security's price. Only returns a value for futures.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        twentyDayAvgVol:
                          description: The 20-Day Average Volume.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 100959203
                        month:
                          description: Contract month returned for futures.
                          type:
                          - string
                          - 'null'
                          example: null
                        year:
                          description: Contract year returned for futures.
                          type:
                          - string
                          - 'null'
                          example: null
                        expirationDate:
                          description: The expiration date for the futures contract. Only returns a value for futures.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: null
                        lastTradingDay:
                          description: The last trading day of the futures contract. Only returns a value for futures.
                          type:
                          - string
                          - 'null'
                          example: null
                        twelveMnthPct:
                          description: The 1-year Change.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 60.92
                        twelveMnthPctDate:
                          description: The 1-year Change %.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2020-02-18'
                        preMarketPrice:
                          description: The pre market price for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        preMarketNetChange:
                          description: The pre market net change for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        preMarketPercentChange:
                          description: The pre market percent change for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        preMarketTimestamp:
                          description: The pre market price for the instrument
                          type:
                          - string
                          - 'null'
                          example: null
                        afterHoursPrice:
                          description: The after hour price for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        afterHoursNetChange:
                          description: The after hour net change for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        afterHoursPercentChange:
                          description: The after hour percent change for the instrument
                          type:
                          - number
                          - 'null'
                          format: double
                          example: null
                        afterHoursTimestamp:
                          description: The after hour price for the instrument
                          type:
                          - string
                          - 'null'
                          example: null
                        averageWeeklyVolume:
                          description: The average volume for the last five trading days.
                          type:
                          - integer
                          - 'null'
                          example: 69943086
                        averageMonthlyVolume:
                          description: The average one month volume.
                          type:
                          - integer
                          - 'null'
                          example: 98105781
                        averageQuarterlyVolume:
                          description: The average 3 month volume.
                          type:
                          - integer
                          - 'null'
                          example: 102564875
                        exchangeMargin:
                          description: The margin maintenance required for the future.
                          type:
                          - string
                          - 'null'
                          example: null
                        oneMonthHigh:
                          description: The highest price over the last month.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        oneMonthHighDate:
                          description: The date when the high price was reached over the last month.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        oneMonthLow:
                          description: The lowest price over the last month.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 126.94
                        oneMonthLowDate:
                          description: The date when the low price was reached over the last month.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-19'
                        threeMonthHigh:
                          description: The highest price over the last 3 months.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        threeMonthHighDate:
                          description: The date when the high price was reached over the last 3 months.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        threeMonthLow:
                          description: The lowest price over the last 3 months.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 112.59
                        threeMonthLowDate:
                          description: The date when the low price was reached over the last 3 months.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2020-11-24'
                        sixMonthHigh:
                          description: The highest price over the last 6 months.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        sixMonthHighDate:
                          description: The date when the high price was reached over the last 6 months.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        sixMonthLow:
                          description: The lowest price over the last 6 months.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 103.1
                        sixMonthLowDate:
                          description: The date when the low price was reached over the last 6 months.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2020-09-21'
                        fiveDayHigh:
                          description: The highest price over the last 5 days.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 136.39
                        fiveDayHighDate:
                          description: The date when the high price was reached over the last 5 days.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-02-11'
                        fiveDayLow:
                          description: The lowest price over the last 5 days.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 127.41
                        fiveDayLowDate:
                          description: The date when the low price was reached over the last 5 days.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-02-18'
                        yearToDateHigh:
                          description: The year-to-date highest price reached.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        yearToDateHighDate:
                          description: The date when year-to-date high price was reached.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        yearToDateLow:
                          description: The year-to-date lowest price reached.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 126.38
                        yearToDateLowDate:
                          description: The date when year-to-date low price was reached.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-06'
                        twoYearHigh:
                          description: The highest price over the last two years.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 145.09
                        twoYearHighDate:
                          description: The date when the high price was reached over the last two years.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2021-01-25'
                        twoYearLow:
                          description: The lowest price over the last two years.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 42.37
                        twoYearLowDate:
                          description: The date when the low price was reached over the last two years.
                          type:
                          - string
                          - 'null'
                          format: date
                          example: '2019-02-19'
                        exchange:
                          description: Exchange code for the marketplace where the financial instruments are listed.
                          type:
                          - string
                          - 'null'
                          example: NASDAQ
                        weeklyClose:
                          description: The end-of-day last price the instrument traded this week.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 128.12
                        weeklyPreviousClose:
                          description: The last price the instrument traded at last week.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 135.37
                        weeklyPreviousHigh:
                          description: The high price the instrument traded at last week.
                          type:
                          - number
                          - 'null'
                          format: double
                          example: 137.88
                        weeklyPreviousLow:
                          description: The low price the instrument traded at last week.
                          type:
                          - number
                          - 'null'
                  

# --- truncated at 32 KB (214 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/barchart/refs/heads/main/openapi/barchart-price-data-api-openapi.yml