openapi: 3.0.3 info: title: OnDemand APIs 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 - name: Cryptocurrency Data - name: Profiles and Financial Data - name: Splits, Dividends, and Earnings - name: Leaderboards and Lists - name: Charts and Analytics - name: ETFs - name: News and Filings - name: Metadata - name: Other 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 for the active contract or for the first nearby is supported, as is for all futures contracts for a given root symbol, as is 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 nullable: true example: 'AAPL' name: description: The type of symbol used. type: string nullable: true 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 nullable: true example: 'G' serverTimestamp: description: The time the message was generated on the server. type: string nullable: true 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 nullable: true example: 'i' lastPrice: description: The last price the instrument traded. type: number format: double nullable: true example: 130.84 tradeSize: description: The size of the last traded price / transaction. type: integer nullable: true example: 3566575 tradeTimestamp: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-17T16:00:00-06:00' tradeDate: description: The settlement trade date for the quote price. type: string format: date nullable: true example: '2021-02-17' netChange: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: -2.35 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true 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 nullable: true example: '.' previousLastPrice: description: The price previous to the current last price. type: number format: double nullable: true example: 133.19 previousTimestamp: description: The exchange timestamp of the previous last price. type: string format: date nullable: true example: '2021-02-16' bid: description: The current bid price. type: number format: double nullable: true example: 130.85 bidSize: description: The size (quantity) of the current bid price. type: integer nullable: true example: 1000 ask: description: The current ask price. type: number format: double nullable: true example: 130.87 askSize: description: The size (quantity) of the current ask price. type: integer nullable: true example: 300 unitCode: description: The corresponding unit code. type: string nullable: true example: '2' open: description: The opening (first) price for the session. type: number format: double nullable: true example: 131.25 high: description: The highest traded price for the session. type: number format: double nullable: true example: 132.22 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 129.47 close: description: The last traded price for the session. type: number format: double nullable: true example: 130.84 numTrades: description: The number of individual transactions over the course of a trading session. type: integer nullable: true example: 965940 dollarVolume: description: The current Dollar Volume. type: number format: double nullable: true 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 nullable: true example: 's' previousOpen: description: The opening (first) price for the previous session. type: number format: double nullable: true example: 135.49 previousHigh: description: The highest traded price for the previous session. type: number format: double nullable: true example: 136.01 previousLow: description: The lowest traded price for the previous session. type: number format: double nullable: true example: 132.79 previousClose: description: The last traded price for the previous session. type: number format: double nullable: true example: 133.19 previousNetChange: description: The difference between the Last Price, and the Last Price from 1 day ago. type: number format: double nullable: true example: null previousPercentChange: description: The percent change from 1 day ago. type: number format: double nullable: true example: null settlement: description: The settlement price determined by the exchange. type: number format: double nullable: true example: 130.84 previousSettlement: description: The settlement price for the previous session. type: number format: double nullable: true example: 133.19 volume: description: The quantity of shares or contracts traded. type: integer nullable: true example: 97730392 previousVolume: description: The quantity of shares or contracts traded from the previous day. type: integer nullable: true example: 80576305 openInterest: description: The quantity of open interest for futures. type: number format: double nullable: true example: null previousOpenInterest: description: The quantity of open interest for futures from the previous day. type: number format: double nullable: true example: null fiftyTwoWkHigh: description: The highest price over the past 52 weeks. type: number format: double nullable: true example: 145.09 fiftyTwoWkHighDate: description: The date in which the high price was reached over the past 52 weeks. type: string format: date nullable: true example: '2021-01-25' fiftyTwoWkLow: description: The low price over the past 52 weeks. type: number format: double nullable: true example: 53.15 fiftyTwoWkLowDate: description: The date in which the low price was reached over the past 52 weeks. type: string format: date nullable: true example: '2020-03-23' avgVolume: description: The average year-to-date daily volume. type: integer nullable: true example: 103347133 impliedVolatility: description: The estimated volatility of a security's price. Only returns a value for futures. type: number format: double nullable: true example: null twentyDayAvgVol: description: The 20-Day Average Volume. type: number format: double nullable: true example: 100959203 month: description: Contract month returned for futures. type: string nullable: true example: null year: description: Contract year returned for futures. type: string nullable: true example: null expirationDate: description: The expiration date for the futures contract. Only returns a value for futures. type: string format: date nullable: true example: null lastTradingDay: description: The last trading day of the futures contract. Only returns a value for futures. type: string nullable: true example: null twelveMnthPct: description: The 1-year Change. type: number format: double nullable: true example: 60.92 twelveMnthPctDate: description: The 1-year Change %. type: string format: date nullable: true example: '2020-02-18' preMarketPrice: description: The pre market price for the instrument type: number format: double nullable: true example: null preMarketNetChange: description: The pre market net change for the instrument type: number format: double nullable: true example: null preMarketPercentChange: description: The pre market percent change for the instrument type: number format: double nullable: true example: null preMarketTimestamp: description: The pre market price for the instrument type: string nullable: true example: null afterHoursPrice: description: The after hour price for the instrument type: number format: double nullable: true example: null afterHoursNetChange: description: The after hour net change for the instrument type: number format: double nullable: true example: null afterHoursPercentChange: description: The after hour percent change for the instrument type: number format: double nullable: true example: null afterHoursTimestamp: description: The after hour price for the instrument type: string nullable: true example: null averageWeeklyVolume: description: The average volume for the last five trading days. type: integer nullable: true example: 69943086 averageMonthlyVolume: description: The average one month volume. type: integer nullable: true example: 98105781 averageQuarterlyVolume: description: The average 3 month volume. type: integer nullable: true example: 102564875 exchangeMargin: description: The margin maintenance required for the future. type: string nullable: true example: null oneMonthHigh: description: The highest price over the last month. type: number format: double nullable: true example: 145.09 oneMonthHighDate: description: The date when the high price was reached over the last month. type: string format: date nullable: true example: '2021-01-25' oneMonthLow: description: The lowest price over the last month. type: number format: double nullable: true example: 126.94 oneMonthLowDate: description: The date when the low price was reached over the last month. type: string format: date nullable: true example: '2021-01-19' threeMonthHigh: description: The highest price over the last 3 months. type: number format: double nullable: true example: 145.09 threeMonthHighDate: description: The date when the high price was reached over the last 3 months. type: string format: date nullable: true example: '2021-01-25' threeMonthLow: description: The lowest price over the last 3 months. type: number format: double nullable: true example: 112.59 threeMonthLowDate: description: The date when the low price was reached over the last 3 months. type: string format: date nullable: true example: '2020-11-24' sixMonthHigh: description: The highest price over the last 6 months. type: number format: double nullable: true example: 145.09 sixMonthHighDate: description: The date when the high price was reached over the last 6 months. type: string format: date nullable: true example: '2021-01-25' sixMonthLow: description: The lowest price over the last 6 months. type: number format: double nullable: true example: 103.1 sixMonthLowDate: description: The date when the low price was reached over the last 6 months. type: string format: date nullable: true example: '2020-09-21' fiveDayHigh: description: The highest price over the last 5 days. type: number format: double nullable: true example: 136.39 fiveDayHighDate: description: The date when the high price was reached over the last 5 days. type: string format: date nullable: true example: '2021-02-11' fiveDayLow: description: The lowest price over the last 5 days. type: number format: double nullable: true example: 127.41 fiveDayLowDate: description: The date when the low price was reached over the last 5 days. type: string format: date nullable: true example: '2021-02-18' yearToDateHigh: description: The year-to-date highest price reached. type: number format: double nullable: true example: 145.09 yearToDateHighDate: description: The date when year-to-date high price was reached. type: string format: date nullable: true example: '2021-01-25' yearToDateLow: description: The year-to-date lowest price reached. type: number format: double nullable: true example: 126.38 yearToDateLowDate: description: The date when year-to-date low price was reached. type: string format: date nullable: true example: '2021-01-06' twoYearHigh: description: The highest price over the last two years. type: number format: double nullable: true example: 145.09 twoYearHighDate: description: The date when the high price was reached over the last two years. type: string format: date nullable: true example: '2021-01-25' twoYearLow: description: The lowest price over the last two years. type: number format: double nullable: true example: 42.37 twoYearLowDate: description: The date when the low price was reached over the last two years. type: string format: date nullable: true example: '2019-02-19' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NASDAQ' weeklyClose: description: The end-of-day last price the instrument traded this week. type: number format: double nullable: true example: 128.12 weeklyPreviousClose: description: The last price the instrument traded at last week. type: number format: double nullable: true example: 135.37 weeklyPreviousHigh: description: The high price the instrument traded at last week. type: number format: double nullable: true example: 137.88 weeklyPreviousLow: description: The low price the instrument traded at last week. type: number format: double nullable: true example: 133.69 monthlyClose: description: The end-of-day last price the instrument traded this month. type: number format: double nullable: true example: 130.84 monthlyPreviousClose: description: The last price the instrument traded at last month. type: number format: double nullable: true example: 131.96 monthlyPreviousHigh: description: The high price the instrument traded at last month. type: number format: double nullable: true example: 145.09 monthlyPreviousLow: description: The low price the instrument traded at last month. type: number format: double nullable: true example: 126.38 basis: description: The basis range in cents. type: number format: double nullable: true example: null previousBasis: description: The previous basis range in cents. type: number format: double nullable: true example: null commodityDataDelivery: description: The Commodity delivery date. type: string nullable: true example: null commodityDataCurrency: description: The Commodity data currency. type: string nullable: true example: null volumeFractional: description: The quantity of shares traded, included fractional shares. This field is only available for US Stock Markets (AMEX, NASDAQ & NYSE). type: integer nullable: true example: 916 previousVolumeFractional: description: The quantity of shares traded in the previous day, included fractional shares. This field is only available for US Stock Markets (AMEX, NASDAQ & NYSE). type: integer nullable: true example: 913 required: - symbol - name - dayCode - serverTimestamp - mode - lastPrice - tradeTimestamp - netChange - percentChange - unitCode - open - high - low - close - numTrades - dollarVolume - flag - volume - previousVolume '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getHistory.json: get: tags: - Price Data summary: getHistory operationId: get-getHistory description: The getHistory API is used to request historical time series data on stocks, indexes, mutual funds, ETFs, futures, foreign exchange, or cryptocurrencies. Historical data is available as tick, minute bars or end-of-day data. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'AAPL' - in: query name: type description: The type of historical data to return, including tick data, minute data, and end-of-day data. required: true schema: type: string enum: - 'ticks' - 'minutes' - 'nearbyMinutes' - 'formTMinutes' - 'daily' - 'dailyNearest' - 'dailyContinue' - 'weekly' - 'weeklyNearest' - 'weeklyContinue' - 'monthly' - 'monthlyNearest' - 'monthlyContinue' - 'quarterly' - 'quarterlyNearest' - 'quarterlyContinue' - 'yearly' - 'yearlyNearest' - 'yearlyContinue' example: 'minutes' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the beginning of the day specified in the end parameter, if end is specified, or to the beginning of the current day, if end is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20100101' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, but not including, this value). If not set, the value will default to the end of the day specified in the start parameter, if specified, or to the end of the current day, if start is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20130101' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. If not specified, there number of records returned will be determined by the date/time parameters specified as well as any defaults that apply to the query. required: false schema: type: integer example: 10 - in: query name: interval description: The number of minutes for a minute query. required: false schema: type: integer example: 60 - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. If this parameter is not specified, the order results is not guaranteed. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' - in: query name: sessionFilter description: This parameter modifies the default session codes/sale conditions used to return ticks for each exchange. For NYSE and AMEX, the default session filter is "@EFKX56V9" (meaning all ticks with sale conditions corresponding to one of the characters in the filter are included in the results), for NASDAQ the default is "@ABDEFKOSXY156", and for everything else all session codes/sale conditions are returned except the settle (session code '*'). If the session filter is set to a string of valid session codes (i.e. "EFK"), only ticks with the specified session codes are included in the results. If the string is prefixed with character '!' (i.e."!EFK"), all session codes except those in the string are included in the results. If the string is prefixed with character '+' (i.e. "+T"), then all the default session codes in addition to the ones specified in the string are included in the results. And if the string is prefixed with character '-' (i.e. "-EF") then all default session codes except the ones specified are included in the results. Please note that the '+' character should be escaped (to %2B) when entering the URL in a web browser or executing the query in an API that does not escape it by default. required: false schema: type: string example: 'EFK' - in: query name: splits description: An adjustment of stock value due to corporate action. This parameter only applies to stocks and specifies whether the data returned should be adjusted for splits or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: dividends description: A distribution of a portion of a company's earnings. This parameter only applies to stocks and specifies whether the data returned should be adjusted for dividends or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: volume description: The quantity of shares or contracts traded. For futures, this parameter can be set to one of two values (contract and total) in order to specify whether the volume returned should be the contract volume or the total volume. For aggregates (such as weekly, monthly or yearly), this returns the average volume for the period specified. If the value is preceded by 'sum' (sumcontract and sumtotal), then it returns the sum of the volumes in each daily bar during the period specified. If not specified, the value will default to contract. For aggregate equities queries (such as weekly, monthly or yearly), this parameter can be set to sum to return the sum of the volumes in each daily bar during the period specified. If not specified, then the average volume is returned. required: false schema: type: string enum: - 'total' - 'sum' - 'contract' - 'sumcontract' - 'sumtotal' example: 'sum' - in: query name: nearby description: This parameter specifies the offset from the front month for 'nearest' queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest and yearlynearest). The default value for this parameter is 1, which sets nearest queries to the most current front month. If set to a value greater than 1, then the nth front month is used (for example, in August of 2010, ESU10 would be the current front month, so nearby=2 would use ESZ10, nearby=3 would use ESH11, etc.) This parameter is ignored for all other queries. Alternatively, the same functionality provided by the nearby parameter can be achieved using the symbol notation symbol=RS*n, where RS is the root symbol and n is the nth front month (i.e. symbol=ES*1, symbol=YM*3, etc.). When using this notation on the symbol parameter, the nearby parameter should be omitted. required: false schema: type: integer example: 1 - in: query name: jerq description: Whether to merge with JERQ data. required: false schema: type: string example: 'true' - in: query name: exchange description: The list of valid exchange codes to limit symbol search. required: false schema: type: string example: 'NYSE,AMEX,NASDAQ' - in: query name: backAdjust description: This parameter specifies whether the contracts in the series will be adjusted based on the roll-gap between the closing prices of the current contract and the previous contract on the day of the switch. Valid values are true and false. If not specified, the default value is false resulting in a non-adjusted query. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - 'true' - 'false' example: 'false' - in: query name: daysToExpiration description: This parameter specifies the number of calendar days prior to a contract expiration when the series of contracts will be switched to the next contract in the series. Valid values are 0 through 60. A value of 0 will tell the system to use the day of expiration. If not specified, the default value (1) is used, resulting in each contract in the series to run until (and including) the day prior to its expiration. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' example: '1' - in: query name: contractRoll description: For futures, multi-contract nearest queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest or yearlynearest), this parameter can be set to one of two values (expiration, combined), and determines how the switch from one contract to the next in the series is calculated. When the value specified is 'expiration', the switch from one contract to the next in the series will be based on the expiration date (and the value of the 'daysToExpiration' parameter if specified). When the value specified is 'combined', a combination of volume and openinterest will be used to determine when to switch from one contract to the next in the series (when using this value, the 'daysToExpiration' parameter is ignored). required: false schema: type: string enum: - 'expiration' - 'combined' example: 'expiration' 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 nullable: true example: 'AAPL' timestamp: description: | The exchange time of the price. Format: HH:MM:SS.FFF type: string nullable: true example: '2021-02-18T13:49:33-05:00' tradingDay: description: | The date of the trade. Format: YYYY-MM-DD type: string format: date nullable: true example: '2021-02-18' sessionCode: description: A code used to differentiate between composite market prices, overnight session prices, and day session prices for futures. Not all futures exchanges use session codes. "G" is electronic session and "R" is pit session. type: string nullable: true example: '@' tickPrice: description: The price traded for a single transaction. type: number format: double nullable: true example: 128.68 tickSize: description: The volume traded for a single transaction. type: integer nullable: true example: 101 open: description: The opening (first) price for the period. type: number format: double nullable: true example: 132.0335 high: description: The highest traded price for the period. type: number format: double nullable: true example: 132.3023 low: description: The lowest traded price for the period. type: number format: double nullable: true example: 131.9229 close: description: The last traded price for the period. type: number format: double nullable: true example: 132.2524 volume: description: The quantity of shares or contracts traded per the period. type: integer nullable: true example: 430918 openInterest: description: The total number of options and/or futures contracts that have not been offset. type: integer nullable: true example: null required: - symbol - timestamp - tradingDay '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getClosePrice.json: get: tags: - Price Data summary: getClosePrice operationId: get-getClosePrice description: The getClosePrice API provides the close price for given instruments for the given date. 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. required: true schema: type: string example: 'IBM,AAPL,GOOG' - in: query name: date description: The date of the historical data query. The value should conform to the format yyyymmdd. required: false schema: type: string format: date example: '2010-01-01' - in: query name: splits description: An adjustment of stock value due to corporate action. This parameter only applies to stocks and specifies whether the data returned should be adjusted for splits or not. Set to true to query for adjusted the data, or to false for non-adjusted data. required: false schema: type: string example: 'true' - in: query name: dividends description: A distribution of a portion of a company's earnings. This parameter only applies to stocks and specifies whether the data returned should be adjusted for dividends or not. Set to true to query for adjusted the data, or to false for non-adjusted data. required: false schema: type: string example: 'true' 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: The symbol or code that identifies a financial instrument type: string nullable: true example: 'IBM' closePrice: description: The last price the instrument traded. type: number format: double nullable: true example: 120.68 date: description: The date of the price. type: string format: date nullable: true example: '2021-02-18' required: - symbol - closePrice - date '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getQuoteEod.json: get: tags: - Price Data summary: getQuoteEod operationId: get-getQuoteEod description: The getQuoteEod API is used to request end-of-day price data, by combined exchange and symbol, on stocks, indexes, mutual funds, ETFs, futures, foreign exchange, or cryptocurrencies. Historical data is available as tick, minute bars or end-of-day data. 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: An MIC code or a Country code plus the symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. For futures, notation such as for the active contract or for the first nearby is supported, as is for all futures contracts for a given root symbol. If no country code or MIC is passed then the API will behave the same as the getQuote API. required: true schema: type: string example: 'XASE:SPY,US:IBM' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'previousClose' - in: query name: exchange description: The list of valid exchange codes to limit symbol search. required: false schema: type: string example: 'NYSE,AMEX' 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 nullable: true example: 'SPY' name: description: The type of symbol used. type: string nullable: true example: 'S\u0026P 500 SPDR' date: description: The price date. type: string format: date nullable: true example: '2021-02-17' open: description: The opening (first) price for the session. type: number format: double nullable: true example: 390.42 high: description: The highest traded price for the session. type: number format: double nullable: true example: 392.66 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 389.33 close: description: The last traded price for the session. type: number format: double nullable: true example: 392.39 netChange: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: 0.09 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: 0.02 volume: description: The quantity of shares or contracts traded. type: integer nullable: true example: 52806602 totaltrades: description: Total number of trades executed since the starting point of the indicator strategy. type: integer nullable: true example: 176003 datasource: description: | Where the data is coming from: Exchange Date or Barchart. type: string nullable: true example: 'Barchart' previousClose: description: The close price from the previous trading day. type: number format: double nullable: true example: 392.3 tradeTimestamp: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-17T18:40:00-06:00' openInterest: description: The quantity of open interest for futures. type: number format: double nullable: true example: null exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NASDAQ' month: description: Contract month returned for futures. type: string nullable: true example: null year: description: Contract year returned for futures. type: string nullable: true example: null settlement: description: The settlement price determined by the exchange. type: number format: double nullable: true example: 130.84 required: - symbol - name - date - open - high - low - close - volume - totaltrades - datasource '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEquitiesByExchange.json: get: tags: - Price Data summary: getEquitiesByExchange operationId: get-getEquitiesByExchange description: Receive all real-time or delayed equities market data by exchange through a single onDemand query with the getEquitiesByExchangeAPI from Barchart OnDemand. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchange description: A valid exchange code. required: true schema: type: string enum: - 'INDEX' - 'INDEX-NY' - 'INDEX-NQ' - 'SPECIAL' - 'INDEX-DOW' - 'INDEX-CBOE' - 'INDEX-SP' - 'INDEX-RL' - 'INDEX-TSX' - 'NYSE' - 'BATS' - 'OTHER OTC' - 'NASDAQ' - 'AMEX' - 'OTC-BB' - 'LSE' - 'TSX' - 'TSX-V' - 'ASX' - 'CNSX' - 'NEO' - 'EURNXT_EQ_BE' - 'EURNXT_EQ_FR' - 'EURNXT_EQ_NL' - 'EURNXT_EQ_PT' example: 'INDEX-NQ' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'settlement' - in: query name: fileDate description: The specific date for which data should be returned. The requested date cannot be more than 30 days back. required: false schema: type: string format: date example: '2026-07-20' 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: The instrument symbol. type: string nullable: true example: '$BANK' name: description: The name of the instrument. type: string nullable: true example: 'Nasdaq Bank Index' open: description: The open price for the instrument. type: number format: double nullable: true example: 4158.48 high: description: The high price for the day. type: number format: double nullable: true example: 4195.09 low: description: The low price for the day. type: number format: double nullable: true example: 4152.24 last: description: The last/close price for the instrument. type: number format: double nullable: true example: 4170.21 netChange: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: -8.46 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: -0.2 volume: description: The volume of the instrument. type: integer nullable: true tradeTime: description: The trade time of the last trade for the instrument. type: string format: time nullable: true example: '16:15:00' tradeDate: description: The trade date of the last trade for the instrument. type: string format: date nullable: true example: '2021-02-17' exchange: description: The exchange code on which the instrument trades. type: string nullable: true example: 'INDEX-NQ' settlement: description: Flag to indicate if the prices are settled. type: string nullable: true example: 's' previousClose: description: Previous day's closing price. type: number format: double nullable: true example: 4160.11 required: - symbol - name - open - high - low - last - netChange - percentChange - volume - tradeTime - tradeDate - exchange '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesByExchange.json: get: tags: - Price Data summary: getFuturesByExchange operationId: get-getFuturesByExchange description: Receive all real-time or delayed, or end-of-day futures data by exchange through a single onDemand query with the get FuturesByExchange API from Barchart OnDemand. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchange description: The exchange code for which the list of commodities are required. required: true schema: type: string enum: - 'LIFFE' - 'IOM' - 'CROSS' - 'CME' - 'CBOT' - 'MIAX' - 'NYMEX' - 'CASH' - 'CBOE' - 'CFE' - 'ICEUS' - 'LME' - 'WCE' - 'GBLX' - 'IMM' - 'BMF' - 'ROFEX' - 'EUIDX' - 'SFE' - 'ICEFI' - 'ICE' - 'SIMEX' - 'EUREX' - 'MEFF' - 'COMEX' - 'HKFE' - 'ENDEX' - 'TIFFE' - 'MDEX' - 'SAFEX' - 'OMX' - 'CXMI' - 'NYMI' - 'TFEX' - 'MNTRL' - 'JPX' - 'TAIWA' - 'CBOTM' - 'MATIF' - 'LCE' - 'KFE' - 'ISE' - 'BSE' - 'SHFE' - 'NCDEX' - 'NZX' - 'EEX' - 'CZCE' - 'DCE' - 'TURK' - 'MATBA' - 'TOCOM' - 'DGCX' - 'MCX' - 'CFFEX' - 'NSE' - 'EEX_POWER' - 'SGCOM' - 'SGXFX' - 'SGXNZ' - 'SGIDX' example: 'BMF' - in: query name: category description: Category of the commodity. required: false schema: type: string example: 'Meats' - in: query name: fields description: Request additional optional fields. required: false schema: type: string example: 'openInterest' 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 nullable: true example: 'DPH21' name: description: The type of symbol used. type: string nullable: true example: '1-Day Interbank Dep.' 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 nullable: true example: 'H' mode: description: An indicator representing if the quote is real-time ("R"), delayed ("I") or end-of-day ("D"). type: string nullable: true example: 'i' lastPrice: description: The last price the instrument traded. type: number format: double nullable: true example: 1.9 tradeTimestamp: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-18T15:12:00-06:00' netChange: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: -0.002 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: -0.11 unitCode: description: The corresponding unit code. type: string nullable: true example: '3' open: description: The opening (first) price for the session. type: number format: double nullable: true example: 1.902 high: description: The highest traded price for the session. type: number format: double nullable: true example: 1.906 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 1.9 close: description: The last traded price for the session. type: number format: double nullable: true example: 1.9 numTrades: description: The number of individual transactions over the course of a trading session. type: integer nullable: true example: 6 dollarVolume: description: The current Dollar Volume. type: number format: double nullable: true 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 nullable: true example: 's' volume: description: The quantity of shares or contracts traded. type: integer nullable: true example: 1350 previousVolume: description: The quantity of shares or contracts traded from the previous day. type: integer nullable: true example: 39500 previousOpenInterest: description: The quantity of open interest for futures from the previous day. type: number format: double nullable: true example: 1097077 required: - symbol - name - dayCode - mode - lastPrice - tradeTimestamp - netChange - percentChange - unitCode - open - high - low - close - numTrades - dollarVolume - flag - volume - previousVolume - previousOpenInterest '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesOptions.json: get: tags: - Price Data summary: getFuturesOptions operationId: get-getFuturesOptions description: The getFuturesOptions API provides intraday options data such as strike price, closing price, expiration date, volume, volatility etc on futures contracts. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: root description: A symbol or code that identifies an option root. required: false schema: type: string example: 'ZC' - in: query name: contract description: A symbol or code that identifies an options contract. required: false schema: type: string example: 'ZCN27' - in: query name: symbols description: A symbol or code that identifies an option. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'ZCK210C,ZCK210P' - in: query name: exchange description: Exchange code for the marketplace where the financial instruments are listed. required: false schema: type: string example: 'CME' - in: query name: type description: The type of option desired, Call or Put. required: false schema: type: string example: 'Call' - in: query name: expirationMonth description: The numeric representation of the expiration month. required: false schema: type: integer example: 07 - in: query name: expirationDay description: The numeric date for of the expiration day. required: false schema: type: integer example: 22 - in: query name: fields description: Additional fields requested. required: false schema: type: string example: 'premium,openInterest' - 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: returnExtendedSymbol description: Parameter to include the new barchart options symbology that allows users to map to the dataset from the marketreplay system. required: false schema: type: string 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 the futures contract. type: string nullable: true example: 'ZCK210C' root: description: The root symbol for the future. type: string nullable: true example: 'ZC' contract: description: The symbol for the futures contract. type: string nullable: true example: 'ZCK21' contractName: description: The name of the futures contract. type: string nullable: true example: 'Corn' contractMonth: description: The month code for this option's contract. type: string nullable: true example: 'K' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'CBOT' type: description: Either Call or Put. type: string nullable: true example: 'Call' strike: description: The option's strike price. type: number format: double nullable: true example: 210 expirationDate: description: The expiration date. type: string format: date nullable: true example: '2021-04-23' date: description: The price date. type: string format: date nullable: true example: '2021-02-17' impliedVolatility: description: The estimated volatility of a security's price. type: number format: double nullable: true example: 85.597534179688 delta: description: The option's delta value. type: number format: double nullable: true example: 0.99991863344742 gamma: description: The option's gamma value. type: number format: double nullable: true example: 2.4122911850812E-25 theta: description: The option's theta value. type: number format: double nullable: true example: -4.9772727839208E-24 vega: description: The option's vega value. type: number format: double nullable: true example: 2.96107832152E-23 bid: description: The current bid price. type: number format: double nullable: true example: null bidSize: description: The size (quantity) of the current bid price. type: integer nullable: true example: null ask: description: The current ask price. type: number format: double nullable: true example: null askSize: description: The size (quantity) of the current ask price. type: integer nullable: true example: null open: description: The opening (first) price for the session. type: number format: double nullable: true example: 340.875 high: description: The highest traded price for the session. type: number format: double nullable: true example: 340.875 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 334.75 last: description: The last price the instrument traded. type: number format: double nullable: true example: 340.875 previousClose: description: The last price the instrument traded. type: number format: double nullable: true example: 339.875 change: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: 1 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: 0.29 premium: description: The option's premium. type: number format: double nullable: true example: 340.875 flag: description: The option's settled flag. type: string nullable: true example: 's' volume: description: The trade volume of the option. type: integer nullable: true openInterest: description: Open interest of the option type: integer nullable: true example: 1 settlement: description: The settlement price determined by the exchange. type: number format: double nullable: true example: 130.84 previousSettlement: description: The settlement price for the previous session. type: number format: double nullable: true example: 133.19 previousSettlementDate: description: The date for the previous session. type: string format: date nullable: true example: '2026-06-01' extendedSymbol: description: The new barchart options symbol. type: string nullable: true example: 'ZC|Z2026|200-0|C' longSymbol: description: The new barchart long symbol. type: string nullable: true example: 'ZC|Z26|200C' required: - symbol - root - contract - contractName - contractMonth - exchange - type - strike - expirationDate - date - impliedVolatility - delta - gamma - theta - vega - open - high - low - last - previousClose - change - percentChange - volume - longSymbol '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesOptionsEOD.json: get: tags: - Price Data summary: getFuturesOptionsEOD operationId: get-getFuturesOptionsEOD description: The getFuturesOptionsEOD API provides end-of-day options data such as strike price, closing price, expiration date, volume, volatility etc on futures contracts. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: root description: A symbol or code that identifies an option root. required: false schema: type: string example: 'ZC' - in: query name: contract description: A symbol or code that identifies an options contract. required: false schema: type: string example: 'ZCK25' - in: query name: symbols description: A symbol or code that identifies an option. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'ZCK210C,ZCK210P' - in: query name: type description: The type of option desired, Call or Put. required: false schema: type: string example: 'Call' - in: query name: expirationMonth description: The numeric representation of the expiration month. required: false schema: type: integer example: 07 - in: query name: expirationDay description: The numeric date for of the expiration day. required: false schema: type: integer example: 22 - in: query name: fields description: Additional fields requested. required: false schema: type: string example: 'premium,openInterest' - 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: returnExtendedSymbol description: Parameter to include the new barchart options symbology that allows users to map to the dataset from the marketreplay system. required: false schema: type: string 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 the futures contract. type: string nullable: true example: 'ZCK210C' root: description: The root symbol for the future. type: string nullable: true example: 'ZC' contract: description: The symbol for the futures contract. type: string nullable: true example: 'ZCK21' underlyingFuture: description: The symbol for the underlying futures contract. type: string nullable: true example: 'ZCK21' contractName: description: The name of the futures contract. type: string nullable: true example: 'Corn' contractMonth: description: The month code for this option's contract. type: string nullable: true example: 'K' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'CBOT' type: description: Either Call or Put. type: string nullable: true example: 'Call' strike: description: The option's strike price. type: number format: double nullable: true example: 210 expirationDate: description: The expiration date. type: string format: date nullable: true example: '2021-04-23' date: description: The price date. type: string format: date nullable: true example: '2021-02-17' impliedVolatility: description: The estimated volatility of a security's price. type: number format: double nullable: true example: 85.597534179688 delta: description: The option's delta value. type: number format: double nullable: true example: 0.99991863344742 gamma: description: The option's gamma value. type: number format: double nullable: true example: 2.4122911850812E-25 theta: description: The option's theta value. type: number format: double nullable: true example: -4.9772727839208E-24 vega: description: The option's vega value. type: number format: double nullable: true example: 2.96107832152E-23 open: description: The opening (first) price for the session. type: number format: double nullable: true example: 340.875 high: description: The highest traded price for the session. type: number format: double nullable: true example: 340.875 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 334.75 last: description: The last price the instrument traded. type: number format: double nullable: true example: 340.875 previousClose: description: The last price the instrument traded. type: number format: double nullable: true example: 339.875 change: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: 1 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: 0.29 premium: description: The option's premium. type: number format: double nullable: true example: 340.875 volume: description: The trade volume of the option. type: integer nullable: true openInterest: description: Start of the day Open Interest of the option symbol type: integer nullable: true example: 1 settlement: description: The settlement price determined by the exchange. type: number format: double nullable: true example: 130.84 previousSettlement: description: The settlement price for the previous session. type: number format: double nullable: true example: 133.19 extendedSymbol: description: The new barchart options symbol. type: string nullable: true example: 'ZC|Z2026|200-0|C' required: - symbol - root - contract - underlyingFuture - contractName - contractMonth - exchange - type - strike - expirationDate - date - impliedVolatility - delta - gamma - theta - vega - open - high - low - last - previousClose - change - percentChange - volume '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesSpreads.json: get: tags: - Price Data summary: getFuturesSpreads operationId: get-getFuturesSpreads description: The getFuturesSpreads API returns all active futures spread for the requested commodity. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: root description: A sequence of characters based on the future contract root symbol. required: true schema: type: string example: 'ZC' - in: query name: fields description: A comma separated list of the optional output fields that should be included in the query response. required: false schema: type: string example: 'open,high,ask,askSize' 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 nullable: true example: '_S_SP_ZCH1_ZCK1' symbolName: description: The name of the instrument. type: string nullable: true example: 'Corn Futures Standard Spread' type: description: The type of spread in which the data is returned. For a list of valid values and their meaning please click here. type: string nullable: true example: 'SP' leg1: description: The first leg of the futures spread. type: string nullable: true example: 'ZCH1' leg2: description: The second leg of the futures spread. type: string nullable: true example: 'ZCK1' leg3: description: The third leg of the futures spread. type: string nullable: true example: null leg4: description: The fourth leg of the futures spread. type: string nullable: true example: null lastPrice: description: The last price at which the spread traded. type: number format: double nullable: true example: 2.75 change: description: The net difference between the last traded price and previous close. type: number format: double nullable: true example: 0.5 volume: description: The quantity of shares or contracts traded. type: integer nullable: true example: 37954 tradeTime: description: The exchagne timestamp for the last traded price. type: string nullable: true example: '2021-02-17T13:19:59-06:00' serverTimestamp: description: The time the message was generated on the server. type: string nullable: true example: '2021-02-17T15:18:10-06:00' bid: description: The current bid price. type: number format: double nullable: true example: 2.5 bidSize: description: The size (quantity) of the current bid price. type: integer nullable: true example: 42600 ask: description: The current ask price. type: number format: double nullable: true example: 2.75 askSize: description: The size (quantity) of the current ask price. type: integer nullable: true example: 159500 open: description: The opening (first) price for the session. type: number format: double nullable: true example: 2.25 high: description: The highest traded price for the session. type: number format: double nullable: true example: 3.5 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 2.25 previousClose: description: The settlement price for the previous day. type: number format: double nullable: true example: 2.25 flag: description: Determines the market state. If no flag, then the instrument is active and trades have been made. 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 offical 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 nullable: true example: '' required: - symbol - symbolName - type - leg1 - leg2 - leg3 - leg4 - lastPrice - change - volume - tradeTime - serverTimestamp - open - high - low - previousClose - flag '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSpecialOptions.json: get: tags: - Price Data summary: getSpecialOptions operationId: get-getSpecialOptions description: The getSpecialOptionsClassification API provides the classification for weekly and special options by commodity. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: root description: A symbol or code that identifies a option root. required: false schema: type: string example: 'BCD' - in: query name: contract description: A symbol or code that identifies an options contract. required: false schema: type: string example: 'BCDK2026' - in: query name: type description: The type of option desired, Call or Put. required: false schema: type: string example: 'Call' - in: query name: premiumRange description: Optionally filter the results by premium with a price range. required: false schema: type: string example: '500.50-1000' - in: query name: mode description: Delayed ("I") or end-of-day ("D"). required: false schema: type: string example: 'D' - in: query name: fields description: | Additional fields requested. NOTE: ALL fields will be returned for contract requests. required: false schema: type: string example: 'open,high,low,last' - in: query name: sortDirection description: Whether to sort the options in ascending or descending order based of the expiration date. required: false schema: type: string enum: - 'ASC' - 'DESC' example: 'ASC' 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 the futures contract. type: string nullable: true example: 'BCDH1|200C' underlying_future: description: A symbol or code that identifies the underlying futures contract. type: string nullable: true example: 'ZCZ21' root: description: The root symbol for the future. type: string nullable: true example: 'BCD' contract: description: The symbol for the futures contract. type: string nullable: true example: 'BCDH21' contractName: description: The name of the futures contract. type: string nullable: true example: 'Corn Short Dated New Crop Options' contractMonth: description: The month code for this option's contract. type: string nullable: true example: 'H' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'CBOT' type: description: Either Call or Put. type: string nullable: true example: 'Call' strike: description: The option's strike price. type: number format: double nullable: true example: 200 expirationDate: description: The expiration date. type: string format: date nullable: true example: '2021-02-19' date: description: The most recent update date. type: string format: date nullable: true example: '2021-02-18' tradeDate: description: The price date. type: string format: date nullable: true example: '2021-02-18' impliedVolatility: description: The estimated volatility of a security's price. type: number format: double nullable: true delta: description: The option's delta value. type: number format: double nullable: true example: 0.99991863344742 gamma: description: The option's gamma value. type: number format: double nullable: true example: 2.4122911850812E-25 theta: description: The option's theta value. type: number format: double nullable: true example: -4.9772727839208E-24 vega: description: The option's vega value. type: number format: double nullable: true example: 2.96107832152E-23 bid: description: The current bid price. type: number format: double nullable: true example: null bidSize: description: The size (quantity) of the current bid price. type: integer nullable: true example: null ask: description: The current ask price. type: number format: double nullable: true example: null askSize: description: The size (quantity) of the current ask price. type: integer nullable: true example: null open: description: The opening (first) price for the session. type: number format: double nullable: true high: description: The highest traded price for the session. type: number format: double nullable: true example: 260.125 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 260.125 last: description: The last price the instrument traded. type: number format: double nullable: true example: 260.125 change: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: 2.375 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: 0.92 premium: description: The option's premium. type: number format: double nullable: true example: 13006.25 volume: description: The volume of the option. type: integer nullable: true openInterest: description: The open interest for the option. type: number format: double nullable: true flag: description: The option's settled flag. type: string nullable: true example: 'p' required: - symbol - underlying_future - root - contract - contractName - contractMonth - exchange - type - strike - expirationDate - date '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEquityOptions.json: get: tags: - Price Data summary: getEquityOptions operationId: get-getEquityOptions description: The getEquityOptions API from Barchart OnDemand provides intraday or end-of-day options data such as strike price, closing price, expiration date, volume and volatility, etc. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: underlying_symbols description: A valid equity symbol. A maximum of 5 tickers per request. required: true schema: type: string example: 'AAPL' - in: query name: type description: The type of option desired, Call or Put. required: false schema: type: string example: 'Call' - in: query name: strikePrice description: The strike price of the option. required: false schema: type: number format: double nullable: true example: 37.5 - in: query name: expirationMonth description: The numeric representation of the expiration month. required: false schema: type: string example: '05' - in: query name: expirationDate description: The numeric date for of the expiration day. required: false schema: type: string example: '2026-11-07' - in: query name: optionType description: | Type of option to be returned. Possible Values: Monthly, Weekly. By default both are returned. required: false schema: type: string example: 'Monthly' - in: query name: fields description: Additional fields requested. required: false schema: type: string example: 'bid,bidSize,ask,askSize' - in: query name: onlyStrikes description: To return only the strike prices. required: false schema: type: string example: '1' - in: query name: legacySymbols description: Whether to return our new symbology (AAPL|20200417|250.00C) or legacy symbology (AAPL200417C00250000). Only applies to customers starting before April 13, 2020, newer customers should request the legacySymbol field. required: false schema: type: string - in: query name: returnActualLegacySymbol description: Traditionally our legacy symbols have ignored ".X" or "-X" syntax from preferred equities. If you would like the options symbol to include it, please pass this parameter with a value of 1. required: false schema: type: string 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: underlying_symbol: description: The actual equity symbol. type: string nullable: true example: 'AAPL' symbol: description: | The option symbol (example: AAPL|20200417|250.00C). type: string nullable: true example: 'AAPL|20220617|75.00C' legacySymbol: description: | The option symbol based on our legacy symbology (example: AAPL200417C00250000). type: string nullable: true example: 'AAPL220617C00075000' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'NASDAQ' type: description: Either Call or Put. type: string nullable: true example: 'Call' strike: description: The option's strike price. type: number format: double nullable: true example: 75 expirationDate: description: The expiration date. type: string format: date nullable: true example: '2022-06-17' expirationType: description: The expiration type. type: string nullable: true example: 'monthly' date: description: The price date. type: string format: date nullable: true example: '2021-02-18' volatility: description: The estimated volatility of a security's price. type: number format: double nullable: true example: 0.4404 delta: description: The option's delta value. type: number format: double nullable: true example: 0.904775 gamma: description: The option's gamma value. type: number format: double nullable: true example: 0.002558 theta: description: The option's theta value. type: number format: double nullable: true example: -0.00987 vega: description: The option's vega value. type: number format: double nullable: true example: 0.241477 rho: description: The option's rho value. type: number format: double nullable: true example: 0.520656 bid: description: The current bid price. type: number format: double nullable: true example: 56.8 bidSize: description: The size (quantity) of the current bid price. type: integer nullable: true example: 105 bidDate: description: The date of the current bid price. type: string format: date nullable: true example: '2021-02-18' ask: description: The current ask price. type: number format: double nullable: true example: 57.15 askSize: description: The size (quantity) of the current ask price. type: integer nullable: true example: 105 askDate: description: The date of the current ask price. type: string format: date nullable: true example: '2021-02-18' open: description: The opening (first) price for the session. type: number format: double nullable: true example: 56 high: description: The highest traded price for the session. type: number format: double nullable: true example: 56.65 low: description: The lowest traded price for the session. type: number format: double nullable: true example: 56 last: description: The last price the instrument traded. type: number format: double nullable: true example: 56.65 previous: description: The last price the instrument traded. type: number format: double nullable: true example: 58.17 change: description: The difference between the last traded price and the previous close. type: number format: double nullable: true example: -1.52 percentChange: description: The percent difference between the last traded price and the previous close. type: number format: double nullable: true example: -2.61 premium: description: The option's premium type: number format: double nullable: true example: null flag: description: The option's settled flag) type: string nullable: true example: null settlement: description: The option's settlement price type: number format: double nullable: true example: null lastTradeDate: description: The last trading date for the option type: string format: date nullable: true example: null volume: description: The trading volume for the option type: integer nullable: true example: 6 openInterest: description: The open interest for the option type: integer nullable: true example: 19027 lastUpdateDate: description: The timestamp for the last traded option price. type: string nullable: true example: '2021-02-18T20:26:20-06:00' required: - underlying_symbol - symbol - exchange - type - strike - expirationDate - expirationType - date - open - high - low - last - previous - change - percentChange '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEquityOptionsHistory.json: get: tags: - Price Data summary: getEquityOptionsHistory operationId: get-getEquityOptionsHistory description: The getEquityOptionsHistory API from Barchart OnDemand allows users to get historical prices for equity options. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: Any valid equity options symbol. required: true schema: type: string example: 'AAPL|20200417|250.00C' - in: query name: country description: The country in which the options exchange is located. To help distinguish when requesting a dually listed instrument. required: false schema: type: string example: 'US' - in: query name: askbid description: Boolean flag field to include ask and bid data in the result. required: false schema: type: string - in: query name: fields description: Additional fields requested. required: false schema: type: string example: 'settlement' 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 equities option. type: string nullable: true example: 'AAPL|20200417|250.00C' date: description: Price date type: string format: date nullable: true example: '2019-08-22' open: description: Opening price of the option type: number format: double nullable: true example: 5.45 high: description: High price of the option type: number format: double nullable: true example: 5.45 low: description: Low price of the option type: number format: double nullable: true example: 5.3 close: description: Closing price of the option type: number format: double nullable: true example: 5.4 volume: description: Volume of the equity option type: number format: double nullable: true example: 16 openInterest: description: Open Interest of the option type: number format: double nullable: true example: 5 trades: description: Number of trades for the option type: number format: double nullable: true example: 5 ask: description: Ask value for the option type: number format: double nullable: true example: 6 askSize: description: Ask size for the option type: number format: double nullable: true example: 1 bid: description: Bid value for the option type: number format: double nullable: true example: 4.1 bidSize: description: Bid size for the option type: number format: double nullable: true example: 10 settlement: description: The settlement price type: number format: double nullable: true volatility: description: The estimated volatility of the underlying stock over the period of the option. type: number format: double nullable: true example: 0.54176576906416 theoretical: description: The hypothetical value of the option. type: number format: double nullable: true example: 5.4 delta: description: Measures the sensitivity of an option's theoretical value to a change in the price of the underlying asset. type: number format: double nullable: true example: 0.2461031525003 gamma: description: Measures the rate of change in the delta for each one-point increase in the underlying asset. type: number format: double nullable: true example: 0.0077779255452001 theta: description: A measure of the time decay of an option, the dollar amount that an option will lose each day due to the passage of time. type: number format: double nullable: true example: -0.029368962417088 vega: description: Measures the sensitivity of the price of an option to changes in volatility. type: number format: double nullable: true example: 0.54176576906416 rho: description: The rate at which the price of a derivative changes relative to a change in the risk-free rate of interest. type: number format: double nullable: true example: 0.307014003054 required: - symbol - date - open - high - low - close - volume - openInterest - trades - ask - askSize - bid - bidSize '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEquityOptionsOverviewHistory.json: get: tags: - Price Data summary: getEquityOptionsOverviewHistory operationId: get-getEquityOptionsOverviewHistory description: The getEquityOptionsOverviewHistory API provides implied volatility (IV) options metrics for a single equity symbol at a time. It returns historical daily values such as weighted implied volatility, IV rank and percentile, total volume, open interest, and put/call ratios. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'SPY' - in: query name: fields description: N/A required: true schema: type: string example: 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume' - in: query name: startDate description: The start date of the historical options data query. required: false schema: type: string format: date example: '2026-01-22' - in: query name: endDate description: The end date of the historical options data query. required: false schema: type: string format: date example: '2026-07-22' - in: query name: maxRecords description: N/A required: false schema: type: integer example: 10 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: weightedImpliedVolatility: description: The at-the-money average implied volatility (IV) of the nearest monthly options contract that is 30 days out or more, calculated using the Binomial model. type: number format: double nullable: true example: 0.33212003972813 weightedImpliedVolatilityChange: description: The day-over-day change in the weighted implied volatility value. type: number format: double nullable: true example: -0.0062499761547806 impliedVolatilityRank1y: description: | Implied volatility (IV) rank compares the current level of IV to its historical range of values over the prior 1-year. Calculation method: IV Rank = (Current IV - IV Low) / (IV High - IV Low) x 100. type: number format: double nullable: true example: 37.487970230646 impliedVolatilityPercentile1y: description: | Implied Volatility Percentile is the percentage of days with IV closing below the current IV value over the prior 1-year. Calculation method: IV Percentile = (number of day current IV was above historical values) / (total number of days within history) * 100. type: number format: double nullable: true example: 0.64 totalVolume: description: Total volume for all option contracts (across all expiration dates) traded during the current session. type: integer nullable: true example: 49755 putCallVolumeRatio: description: Put/Call Open Interest Ratio is the total Put Open Interest divided by the total Call Open Interest (across all expiration dates). type: number format: double nullable: true example: 0.7608026329759 totalOpenInterest: description: Options Open Interest is the total open interest for all option contracts (across all expiration dates). type: integer nullable: true example: 452357 putCallOpenInterestRatio: description: The total put volume divided by the total call volume (across all expiration dates) based on contracts traded during the current session. type: number format: double nullable: true example: 0.77379598622864 date: description: The date of the data referenced. type: string format: date nullable: true example: '2026-07-22' required: - date '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEquityOptionsOverviewSummary.json: get: tags: - Price Data summary: getEquityOptionsOverviewSummary operationId: get-getEquityOptionsOverviewSummary description: The getEquityOptionsOverviewSummary API provides implied volatility option metrics for equity symbols intraday. It delivers current-day values such as weighted implied volatility, IV rank and percentile, total volume, open interest, and put/call ratios. 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. required: true schema: type: string example: 'AAPL,GOOG' - in: query name: fields description: N/A required: true schema: type: string example: 'weightedImpliedVolatility,weightedImpliedVolatilityChange,impliedVolatilityRank1y,totalVolume' 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 nullable: true example: 'AAPL' weightedImpliedVolatility: description: The at-the-money average implied volatility (IV) of the nearest monthly options contract that is 30 days out or more, calculated using the Binomial model. type: number format: double nullable: true example: 0.33212003972813 weightedImpliedVolatilityChange: description: The day-over-day change in the weighted implied volatility value. type: number format: double nullable: true example: -0.0062499761547806 impliedVolatilityRank1y: description: | Implied volatility (IV) rank compares the current level of IV to its historical range of values over the prior 1-year. Calculation method: IV Rank = (Current IV - IV Low) / (IV High - IV Low) x 100. type: number format: double nullable: true example: 37.487970230646 impliedVolatilityPercentile1y: description: | Implied Volatility Percentile is the percentage of days with IV closing below the current IV value over the prior 1-year. Calculation method: IV Percentile = (number of day current IV was above historical values) / (total number of days within history) * 100. type: number format: double nullable: true example: 0.64 totalVolume: description: Total volume for all option contracts (across all expiration dates) traded during the current session. type: integer nullable: true example: 49755 putCallVolumeRatio: description: Put/Call Open Interest Ratio is the total Put Open Interest divided by the total Call Open Interest (across all expiration dates). type: number format: double nullable: true example: 0.7608026329759 totalOpenInterest: description: Options Open Interest is the total open interest for all option contracts (across all expiration dates). type: integer nullable: true example: 452357 putCallOpenInterestRatio: description: The total put volume divided by the total call volume (across all expiration dates) based on contracts traded during the current session. type: number format: double nullable: true example: 0.77379598622864 date: description: The date of the data referenced. type: string format: date nullable: true example: '2026-07-22' required: - symbol - date '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getOptionsScreener.json: get: tags: - Price Data summary: getOptionsScreener operationId: get-getOptionsScreener description: The getOptionsScreener API allows a user to screen for specific equity and ETF option strikes using a variety of filters and parameters that highlight where unusual options activity may be occuring. Users can build powerful market scanners to implement professional trading strategies. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: instrumentType description: The type of underlying instrument of the option. If a user does not specify a particular instrument type, then stocks are returned by default. required: false schema: type: string enum: - 'stocks' - 'etfs' example: 'stocks' - in: query name: optionType description: Specify whether to return calls, puts, or both types of instruments required: false schema: type: string enum: - 'call' - 'put' - 'both' example: 'both' - in: query name: minVolume description: The minimum volume for the data set required: false schema: type: integer example: 10000 - in: query name: maxVolume description: The maximum volume for the data set required: false schema: type: integer example: 10000 - in: query name: minOpenInterest description: The minimum open interest value for the data set required: false schema: type: number format: double nullable: true example: 1.91 - in: query name: maxOpenInterest description: The maximum open interest value for the data set required: false schema: type: number format: double nullable: true example: 1.91 - in: query name: minDTE description: The minimum days to expiry (DTE) of the options returned in the dataset. DTE is based on calendar days required: false schema: type: number format: double nullable: true example: 1.12 - in: query name: maxDTE description: The maximum days to expiry (DTE) of the options returned in the dataset. DTE is based on calendar days required: false schema: type: number format: double nullable: true example: 1.21 - in: query name: minPrice description: The minimum price for a particular strike to be returned in the data set required: false schema: type: number format: double nullable: true example: 1.11 - in: query name: maxPrice description: The maximum price for a particular strike to be returned in the data set required: false schema: type: number format: double nullable: true example: 1.13 - in: query name: minVolumeOpenInterestRatio description: The minimum volume/open interest ratio for the data set required: false schema: type: number format: double nullable: true example: 1.21 - in: query name: maxVolumeOpenInterestRatio description: The maximum volume/open interest ratio for the data set required: false schema: type: number format: double nullable: true example: 1.24 - in: query name: minDelta description: The minimum delta value for the data set required: false schema: type: number format: double nullable: true example: 12.4 - in: query name: maxDelta description: The maximum delta value for the data set required: false schema: type: number format: double nullable: true example: 1.24 - in: query name: fields description: A comma separated list of the optional output fields that should be included in the result. required: false schema: type: string example: 'delta,gamma' - in: query name: limit description: The number of maximum results that should be returned required: false schema: type: string enum: - '100' - '200' - '300' - '400' - '500' example: '100' - in: query name: page description: The page number to return the results. This sets the offset for the results.s required: false schema: type: integer example: 1 - in: query name: eod description: End of day data is returned by default. Pass ‘false’ to return intraday values required: false schema: type: string 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: underlyingSymbol: description: The underlying instrument symbol type: string nullable: true example: 'MOS' instrumentType: description: String classifying the type of instrument, either 'Stocks' or 'ETF' type: string nullable: true example: 'Stock' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NYSE' type: description: The type of option, either call or put. type: string nullable: true example: 'call' strike: description: The strike price for the given option type: number format: float nullable: true example: 34 expirationDate: description: Expiration date for the option type: string format: date nullable: true example: '2021-02-19' lastPrice: description: The last price for the underlying instrument type: number format: float nullable: true example: 30.43 optionPrice: description: The last price of the option type: number format: float nullable: true example: 0.29 optionNetChange: description: Net change in the option price type: number format: float nullable: true example: -0.07 tradeTime: description: The time indicative of the price. type: string nullable: true example: '2021-02-17T16:13:43-06:00' delta: description: The ratio of change in the price of the instrument price to the corresponding change in the price of option type: number format: float nullable: true example: 0.170201 gamma: description: The rate of change in the option's delta per 1-point move in the underlying instrument's price type: number format: float nullable: true example: 0.07563 theta: description: A measure of the rate of decline in the value of the option due to the passage of time type: number format: float nullable: true example: -0.423909 vega: description: The measurement of the option's sensitivity to changes in teh volatility of the underlying instrument type: number format: float nullable: true example: 0.004034 bid: description: Current bid price type: number format: float nullable: true example: 0.27 ask: description: Current ask price type: number format: float nullable: true example: 0.37 volume: description: The volume of the option type: integer nullable: true example: 9769 openInterest: description: Current open intereset for the option type: number format: float nullable: true example: 121 volumeOpenInterestRatio: description: Ratio of volume to open interest type: number format: float nullable: true example: 80.74 volatility: description: The statistical measure of the dispersion of returns for the option type: number format: float nullable: true example: 2.1022 required: - underlyingSymbol - instrumentType - exchange - type - strike - expirationDate - lastPrice - optionPrice - optionNetChange - tradeTime '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getAmeriborRate.json: get: tags: - Price Data summary: getAmeriborRate operationId: get-getAmeriborRate description: AMERIBOR® is an interbank interest rate reflecting the borrowing rates based on actual transactions of the members of the American Financial Exchange (AFX). AMERIBOR® is a transaction-based short-term interest rate based on loans executed between U.S. depositories on the American Financial Exchange Electronic Trading System. The rate is calculated using the 30 trading day rolling average of the weighted average daily volume in the AFX overnight unsecured market. The rate is denoted as a 360-day annualized percentage rate up to the fifth decimal. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY 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: name: description: The name of the instrument type: string nullable: true example: 'Ameribor Rate' exchange: description: The exchange code for the instrument type: string nullable: true example: 'AFX' lastPrice: description: The end of day price type: number format: double nullable: true example: 0.08434 tradeTimestamp: description: The timestamp for the last price type: string nullable: true example: '2021-02-04T17:00:00-06:00' required: - name - exchange - lastPrice - tradeTimestamp '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getRestrictedSessionHistory.json: get: tags: - Price Data summary: getRestrictedSessionHistory operationId: get-getRestrictedSessionHistory description: The getRestrictedSessionHistory API is used to request historical time series data on stocks, indexes, mutual funds, ETFs, futures, foreign exchange, or cryptocurrencies. Historical data is available as minute bars data. This API also requests startMinute and endMinute parameter and will return price data for the requested date ranges for timestamp between the requested start and end minutes. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'AAPL' - in: query name: type description: The type of historical data to return, including tick data, minute data, and end-of-day data. required: true schema: type: string enum: - 'minutes' - 'nearbyMinutes' - 'formTMinutes' example: 'minutes' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the beginning of the day specified in the end parameter, if end is specified, or to the beginning of the current day, if end is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string format: date example: '2010-01-01' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, but not including, this value). If not set, the value will default to the end of the day specified in the start parameter, if specified, or to the end of the current day, if start is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string format: date example: '2013-01-01' - in: query name: startMinute description: The start time value in 24 hour format. required: false schema: type: string example: '8:30' - in: query name: endMinute description: The end time value in 24 hour format required: false schema: type: string example: '13:20' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. If not specified, there number of records returned will be determined by the date/time parameters specified as well as any defaults that apply to the query. required: false schema: type: integer example: 10 - in: query name: interval description: The number of minutes for a minute query. required: false schema: type: integer example: 60 - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. If this parameter is not specified, the order results is not guaranteed. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' - in: query name: sessionFilter description: This parameter modifies the default session codes/sale conditions used to return ticks for each exchange. For NYSE and AMEX, the default session filter is "@EFKX56V9" (meaning all ticks with sale conditions corresponding to one of the characters in the filter are included in the results), for NASDAQ the default is "@ABDEFKOSXY156", and for everything else all session codes/sale conditions are returned except the settle (session code '*'). If the session filter is set to a string of valid session codes (i.e. "EFK"), only ticks with the specified session codes are included in the results. If the string is prefixed with character '!' (i.e."!EFK"), all session codes except those in the string are included in the results. If the string is prefixed with character '+' (i.e. "+T"), then all the default session codes in addition to the ones specified in the string are included in the results. And if the string is prefixed with character '-' (i.e. "-EF") then all default session codes except the ones specified are included in the results. Please note that the '+' character should be escaped (to %2B) when entering the URL in a web browser or executing the query in an API that does not escape it by default. required: false schema: type: string example: 'EFK' - in: query name: splits description: An adjustment of stock value due to corporate action. This parameter only applies to stocks and specifies whether the data returned should be adjusted for splits or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: dividends description: A distribution of a portion of a company's earnings. This parameter only applies to stocks and specifies whether the data returned should be adjusted for dividends or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: volume description: The quantity of shares or contracts traded. For futures, this parameter can be set to one of two values (contract and total) in order to specify whether the volume returned should be the contract volume or the total volume. For aggregates (such as weekly, monthly or yearly), this returns the average volume for the period specified. If the value is preceded by 'sum' (sumcontract and sumtotal), then it returns the sum of the volumes in each daily bar during the period specified. If not specified, the value will default to contract. For aggregate equities queries (such as weekly, monthly or yearly), this parameter can be set to sum to return the sum of the volumes in each daily bar during the period specified. If not specified, then the average volume is returned. required: false schema: type: string enum: - 'total' - 'sum' - 'contract' - 'sumcontract' - 'sumtotal' example: 'sum' - in: query name: nearby description: This parameter specifies the offset from the front month for 'nearest' queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest and yearlynearest). The default value for this parameter is 1, which sets nearest queries to the most current front month. If set to a value greater than 1, then the nth front month is used (for example, in August of 2010, ESU10 would be the current front month, so nearby=2 would use ESZ10, nearby=3 would use ESH11, etc.) This parameter is ignored for all other queries. Alternatively, the same functionality provided by the nearby parameter can be achieved using the symbol notation symbol=RS*n, where RS is the root symbol and n is the nth front month (i.e. symbol=ES*1, symbol=YM*3, etc.). When using this notation on the symbol parameter, the nearby parameter should be omitted. required: false schema: type: integer example: 1 - in: query name: jerq description: Whether to merge with JERQ data. required: false schema: type: string example: 'true' - in: query name: exchange description: The list of valid exchange codes to limit symbol search. required: false schema: type: string example: 'NYSE,AMEX,NASDAQ' - in: query name: backAdjust description: This parameter specifies whether the contracts in the series will be adjusted based on the roll-gap between the closing prices of the current contract and the previous contract on the day of the switch. Valid values are true and false. If not specified, the default value is false resulting in a non-adjusted query. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - 'true' - 'false' example: 'false' - in: query name: daysToExpiration description: This parameter specifies the number of calendar days prior to a contract expiration when the series of contracts will be switched to the next contract in the series. Valid values are 0 through 60. A value of 0 will tell the system to use the day of expiration. If not specified, the default value (1) is used, resulting in each contract in the series to run until (and including) the day prior to its expiration. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' example: '1' - in: query name: contractRoll description: For futures, multi-contract nearest queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest or yearlynearest), this parameter can be set to one of two values (expiration, combined), and determines how the switch from one contract to the next in the series is calculated. When the value specified is 'expiration', the switch from one contract to the next in the series will be based on the expiration date (and the value of the 'daysToExpiration' parameter if specified). When the value specified is 'combined', a combination of volume and openinterest will be used to determine when to switch from one contract to the next in the series (when using this value, the 'daysToExpiration' parameter is ignored). required: false schema: type: string enum: - 'expiration' - 'combined' example: 'expiration' 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 nullable: true example: 'AAPL' timestamp: description: | The exchange time of the price. Format: HH:MM:SS.FFF type: string nullable: true example: '2021-02-18T13:49:33-05:00' tradingDay: description: | The date of the trade. Format: YYYY-MM-DD type: string format: date nullable: true example: '2021-02-18' sessionCode: description: A code used to differentiate between composite market prices, overnight session prices, and day session prices for futures. Not all futures exchanges use session codes. "G" is electronic session and "R" is pit session. type: string nullable: true example: '@' tickPrice: description: The price traded for a single transaction. type: number format: double nullable: true example: 128.68 tickSize: description: The volume traded for a single transaction. type: integer nullable: true example: 101 open: description: The opening (first) price for the period. type: number format: double nullable: true example: 132.0335 high: description: The highest traded price for the period. type: number format: double nullable: true example: 132.3023 low: description: The lowest traded price for the period. type: number format: double nullable: true example: 131.9229 close: description: The last traded price for the period. type: number format: double nullable: true example: 132.2524 volume: description: The quantity of shares or contracts traded per the period. type: integer nullable: true example: 430918 openInterest: description: The total number of options and/or futures contracts that have not been offset. type: integer nullable: true example: null required: - symbol - timestamp - tradingDay '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getRestrictedSessionOHLCPrices.json: get: tags: - Price Data summary: getRestrictedSessionOHLCPrices operationId: get-getRestrictedSessionOHLCPrices description: The getRestrictedSessionOHLCPrices API is used to request open,high,low and close data n stocks, indexes, mutual funds, ETFs, futures, foreign exchange, or cryptocurrencies for the time range between the startMinute and endMinute parameters for the given date range. Historical data is available as minute bars data. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'AAPL' - in: query name: symbols description: A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'AAPL,GOOGL' - in: query name: type description: The type of historical data to return, including tick data, minute data, and end-of-day data. required: true schema: type: string enum: - 'minutes' - 'nearbyMinutes' - 'formTMinutes' example: 'minutes' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the beginning of the day specified in the end parameter, if end is specified, or to the beginning of the current day, if end is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string format: date example: '2010-01-01' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, but not including, this value). If not set, the value will default to the end of the day specified in the start parameter, if specified, or to the end of the current day, if start is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string format: date example: '2013-01-01' - in: query name: startMinute description: The start time value in 24 hour format. required: false schema: type: string example: '8:30' - in: query name: endMinute description: The end time value in 24 hour format required: false schema: type: string example: '13:20' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. If not specified, there number of records returned will be determined by the date/time parameters specified as well as any defaults that apply to the query. required: false schema: type: integer example: 10 - in: query name: interval description: The number of minutes for a minute query. required: false schema: type: integer example: 60 - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. If this parameter is not specified, the order results is not guaranteed. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' - in: query name: sessionFilter description: This parameter modifies the default session codes/sale conditions used to return ticks for each exchange. For NYSE and AMEX, the default session filter is "@EFKX56V9" (meaning all ticks with sale conditions corresponding to one of the characters in the filter are included in the results), for NASDAQ the default is "@ABDEFKOSXY156", and for everything else all session codes/sale conditions are returned except the settle (session code '*'). If the session filter is set to a string of valid session codes (i.e. "EFK"), only ticks with the specified session codes are included in the results. If the string is prefixed with character '!' (i.e."!EFK"), all session codes except those in the string are included in the results. If the string is prefixed with character '+' (i.e. "+T"), then all the default session codes in addition to the ones specified in the string are included in the results. And if the string is prefixed with character '-' (i.e. "-EF") then all default session codes except the ones specified are included in the results. Please note that the '+' character should be escaped (to %2B) when entering the URL in a web browser or executing the query in an API that does not escape it by default. required: false schema: type: string example: 'EFK' - in: query name: splits description: An adjustment of stock value due to corporate action. This parameter only applies to stocks and specifies whether the data returned should be adjusted for splits or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: dividends description: A distribution of a portion of a company's earnings. This parameter only applies to stocks and specifies whether the data returned should be adjusted for dividends or not. Set to true to query for adjusted the data, or to false for non-adjusted data. If not specified, the default is true. In order to guarantee the same adjustment settings in the future, this parameter should be specified. required: false schema: type: string example: 'true' - in: query name: volume description: The quantity of shares or contracts traded. For futures, this parameter can be set to one of two values (contract and total) in order to specify whether the volume returned should be the contract volume or the total volume. For aggregates (such as weekly, monthly or yearly), this returns the average volume for the period specified. If the value is preceded by 'sum' (sumcontract and sumtotal), then it returns the sum of the volumes in each daily bar during the period specified. If not specified, the value will default to contract. For aggregate equities queries (such as weekly, monthly or yearly), this parameter can be set to sum to return the sum of the volumes in each daily bar during the period specified. If not specified, then the average volume is returned. required: false schema: type: string enum: - 'total' - 'sum' - 'contract' - 'sumcontract' - 'sumtotal' example: 'sum' - in: query name: nearby description: This parameter specifies the offset from the front month for 'nearest' queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest and yearlynearest). The default value for this parameter is 1, which sets nearest queries to the most current front month. If set to a value greater than 1, then the nth front month is used (for example, in August of 2010, ESU10 would be the current front month, so nearby=2 would use ESZ10, nearby=3 would use ESH11, etc.) This parameter is ignored for all other queries. Alternatively, the same functionality provided by the nearby parameter can be achieved using the symbol notation symbol=RS*n, where RS is the root symbol and n is the nth front month (i.e. symbol=ES*1, symbol=YM*3, etc.). When using this notation on the symbol parameter, the nearby parameter should be omitted. required: false schema: type: integer example: 1 - in: query name: jerq description: Whether to merge with JERQ data. required: false schema: type: string example: 'true' - in: query name: exchange description: The list of valid exchange codes to limit symbol search. required: false schema: type: string example: 'NYSE,AMEX,NASDAQ' - in: query name: backAdjust description: This parameter specifies whether the contracts in the series will be adjusted based on the roll-gap between the closing prices of the current contract and the previous contract on the day of the switch. Valid values are true and false. If not specified, the default value is false resulting in a non-adjusted query. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - 'true' - 'false' example: 'false' - in: query name: daysToExpiration description: This parameter specifies the number of calendar days prior to a contract expiration when the series of contracts will be switched to the next contract in the series. Valid values are 0 through 60. A value of 0 will tell the system to use the day of expiration. If not specified, the default value (1) is used, resulting in each contract in the series to run until (and including) the day prior to its expiration. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' example: '1' - in: query name: contractRoll description: For futures, multi-contract nearest queries (data parameter set to dailynearest, weeklynearest, monthlynearest, quarterlynearest or yearlynearest), this parameter can be set to one of two values (expiration, combined), and determines how the switch from one contract to the next in the series is calculated. When the value specified is 'expiration', the switch from one contract to the next in the series will be based on the expiration date (and the value of the 'daysToExpiration' parameter if specified). When the value specified is 'combined', a combination of volume and openinterest will be used to determine when to switch from one contract to the next in the series (when using this value, the 'daysToExpiration' parameter is ignored). required: false schema: type: string enum: - 'expiration' - 'combined' example: 'expiration' 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 nullable: true example: 'AAPL' date: description: The date of trade for the OHLC values. type: string format: date nullable: true example: null ohlc: description: N/A nullable: true example: null required: - symbol - date - ohlc '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCrypto.json: get: tags: - Cryptocurrency Data summary: getCrypto operationId: get-getCrypto description: The getCrypto API provides price data by symbol for spot market cryptocurrencies, including Bitcoin, Ethereum, Ripple, Litecoin and more. Bitcoin futures are available through getQuote. In addition to last price, other fields such as open, high, low, close, price change, percent change are available. 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 valid cryptocurrency symbol. Multiple symbols separated by a comma may be used. required: true schema: type: string example: '^BTCUSD' 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: The symbol or code that identifies the cryptocurrency type: string nullable: true example: '^BTCUSD' name: description: The name that identifies the cryptocurrency type: string nullable: true example: 'Bitcoin - USD' lastPrice: description: The last price the cryptocurrency traded at. type: number format: double nullable: true example: 51917.12 open: description: The price at which the cryptocurrency opened for trading. type: number format: double nullable: true example: 52125.16 high: description: The highest price at which the cryptocurrency traded for the session. type: number format: double nullable: true example: 52526.57 low: description: The lowest price at which the cryptocurrency traded for the session. type: number format: double nullable: true example: 50932.95 previousClose: description: The price at which the cryptocurrency closed the previous trade day. type: number format: double nullable: true example: 52374.08 netChange: description: The price change between the last price and previous close price. type: number format: double nullable: true example: -463.46 percentChange: description: The percent change between the last price and previous close price. type: number format: double nullable: true example: -0.88 bid: description: The current bid price. type: number format: double nullable: true example: 51909.9 ask: description: The current ask price. type: number format: double nullable: true example: 51921.67 volume: description: 24 hour volume is composed of the exchanges included in our data feed and reflects the notional number of contracts traded in the prior rolling 24 hour window. Volume is measured in the asset found in the numerator of the pair. type: integer nullable: true example: 56280 serverTimestamp: description: The time the message was generated on the server. type: string nullable: true example: '2021-02-18T14:52:17-06:00' tradeTimestamp: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-18T14:52:16-06:00' required: - symbol - name - lastPrice - open - high - low - previousClose - netChange - percentChange - bid - ask - volume - serverTimestamp - tradeTimestamp '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCryptoHistory.json: get: tags: - Cryptocurrency Data summary: getCryptoHistory operationId: get-getCryptoHistory description: The getCryptoHistory API provides historical price data for spot cryptocurrencies, including Bitcoin, Ethereum, Ripple, Litecoin and more. Bitcoin futures historical data is available through the getHistory API. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A valid cryptocurrency symbol. required: true schema: type: string example: '^BTCUSD' - in: query name: type description: The type of historical data to return, including tick data, minute data, and end-of-day data. required: true schema: type: string enum: - 'ticks' - 'minutes' - 'nearbyMinutes' - 'formTMinutes' - 'daily' - 'weekly' - 'monthly' - 'quarterly' - 'yearly' example: 'minutes' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the beginning of the day specified in the end parameter, if end is specified, or to the beginning of the current day, if end is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20260721' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, but not including, this value). If not set, the value will default to the end of the day specified in the start parameter, if specified, or to the end of the current day, if start is not specified. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20260722' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. If not specified, there number of records returned will be determined by the date/time parameters specified as well as any defaults that apply to the query. required: false schema: type: integer example: 10 - in: query name: interval description: The number of minutes for a minute query. required: false schema: type: integer example: 60 - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. If this parameter is not specified, the order results is not guaranteed. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' 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 nullable: true example: '^BTCUSD' timestamp: description: | The exchange time of the price. Format: HH:MM:SS.FFF type: string nullable: true example: '2021-02-18T00:00:00-06:00' tradingDay: description: | The date of the trade. Format: YYYY-MM-DD type: string format: date nullable: true example: '2021-02-18' sessionCode: description: A code used to differentiate between composite market prices, overnight session prices, and day session prices for futures. Not all futures exchanges use session codes. "G" is electronic session and "R" is pit session. type: string nullable: true example: ' ' tickPrice: description: The price traded for a single transaction. type: number format: double nullable: true example: 52200.85 tickSize: description: The volume traded for a single transaction. type: integer nullable: true example: 1 open: description: The opening (first) price for the period. type: number format: double nullable: true example: 52200.85 high: description: The highest traded price for the period. type: number format: double nullable: true example: 52201.39 low: description: The lowest traded price for the period. type: number format: double nullable: true example: 52192.97 close: description: The last traded price for the period. type: number format: double nullable: true example: 52192.97 volume: description: 24 hour volume is composed of the exchanges included in our data feed and reflects the number of contracts traded in the prior rolling 24 hour window. Volume is measured in the asset found in the numerator of the pair. Note that historical 24 hour volume is a snapshot of this measure at 5 EST for the day in question. type: integer nullable: true example: 28 required: - symbol - timestamp - tradingDay '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getProfile.json: get: tags: - Profiles and Financial Data summary: getProfile operationId: get-getProfile description: The getProfile API is used to request information about a publicly traded company, such as sector, industry, company description, CEO, recent earnings, P/E ratio, and address, based on symbol. 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. required: true schema: type: string example: 'AAPL,GOOG' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'qtrOneEarnings,qtrTwoEarnings,qtrThreeEarnings,qtrFourEarnings' 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. Multiple symbols separated by a comma may be used. type: string nullable: true example: 'AAPL' symbolCode: description: A code denoting the financial instrument type. type: string nullable: true example: 'STK' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NASDAQ' exchangeName: description: The name of the instrument. type: string nullable: true example: 'Apple Inc' instrumentName: description: The name of the instrument. type: string nullable: true example: 'Apple Inc' sicSector: description: A four-digit code for classifying industries. type: string nullable: true example: '3571' industry: description: A code that identifies a group of businesses that produce similar products or services. type: string nullable: true example: 'Computer' subIndustry: description: A more specific group of businesses within an industry that produce similar products or services. type: string nullable: true example: 'Mini' indexMembership: description: Indices which a stock may be part of, like the DJIA or S&P 500. type: array items: anyOf: - type: string example: $DOWC - type: string example: $DOWC - type: string example: $DOWI - type: string example: $RUI - type: string example: $RUA - type: string example: $SPX - type: string example: $ONE nullable: true businessSummary: description: A description of the company. type: string nullable: true example: 'Apple Inc. is engaged in designing, manufacturing and marketing mobile communication and media devices, personal computers, and portable digital music players. The Company\u0027s products and services include iPhone, iPad, Mac, iPod, Apple TV, a portfolio of consumer and professional software applications, the iOS and Mac OS X operating systems, iCloud, and a range of accessory, service and support offerings. It sells its products worldwide through its online stores, its retail stores, its direct sales force, third-party wholesalers, and resellers. Apple Inc. is headquartered in Cupertino, California.' ceo: description: The Chief Executive Officer. type: string nullable: true example: 'Timothy D. Cook' qtrOneEarnings: description: The most recent 1st quarter earnings. type: number format: double nullable: true example: 1.68 qtrOneEarningsDate: description: The reported date of the most recent 1st quarter earnings. type: string format: date nullable: true example: '2021-01-27' qtrOneEarningsEndDate: description: The end date of the most recent 1st quarter earnings. type: string format: date nullable: true example: '2020-12-31' qtrTwoEarnings: description: The most recent 2nd quarter earnings. type: number format: double nullable: true example: 0.73 qtrTwoEarningsDate: description: The reported date of the most recent 2nd quarter earnings. type: string format: date nullable: true example: '2020-10-29' qtrTwoEarningsEndDate: description: The end date of the most recent 2nd quarter earnings. type: string format: date nullable: true example: '2020-09-30' qtrThreeEarnings: description: The most recent 3rd quarter earnings. type: number format: double nullable: true example: 0.64 qtrThreeEarningsDate: description: The reported date of the most recent 3rd quarter earnings. type: string format: date nullable: true example: '2020-07-30' qtrThreeEarningsEndDate: description: The end date of the most recent 3rd quarter earnings. type: string format: date nullable: true example: '2020-06-30' qtrFourEarnings: description: The most recent 4th quarter earnings. type: number format: double nullable: true example: 0.64 qtrFourEarningsDate: description: The reported date of the most recent 4th quarter earnings. type: string format: date nullable: true example: '2020-04-30' qtrFourEarningsEndDate: description: The end date of the most recent 4th quarter earnings. type: string format: date nullable: true example: '2020-03-31' peRatio: description: The ratio of a company's current share price relative to its earnings (price divided by earnings). type: string nullable: true example: '36.07' epsGrowth: description: The annual rate of earnings per share growth over the trailing one-year period. type: string nullable: true example: '36.410000' recentEarnings: description: The last reported quarterly earnings value. type: string nullable: true example: '1.68' annualEPS: description: The most recent annual net income divided by the number of shares outstanding. type: string nullable: true example: '3.7' address: description: The address of the company's headquarters. type: string nullable: true example: 'ONE APPLE PARK WAY' city: description: The city where the company's headquarters is located. type: string nullable: true example: 'CUPERTINO' state: description: The state where the company's headquarters is located. type: string nullable: true example: 'CA' country: description: The country where the company's headquarters is located. type: string nullable: true example: 'USA' zipCode: description: The zip code of the company's headquarters. type: string nullable: true example: '95014' phoneNumber: description: The company's main phone number. type: string nullable: true example: '408-996-1010' instrumentType: description: The type of instrument. Ex. Equity, Future or Mutual Fund etc. type: string nullable: true example: 'Equity' figi: description: This code is unique at exchange level, a pair of exchange and company is assigned a unique figi. type: string nullable: true example: 'BBG000BLNQ16 (unique code for IBM for NYSE.)' compositeFigi: description: This code is shared in all exchanges across a country for a given company. type: string nullable: true example: 'BBG000BLNNH6 (unique code for IBM for US exchanges.)' shareClassFigi: description: This code is shared in all exchanges across the world for a given company. type: string nullable: true example: 'BBG001S5S399' cik: description: The Central Index Key (CIK) is used on the SEC's computer systems to identify corporations and individual people who have filed disclosure with the SEC. type: integer nullable: true example: 1418091 required: - symbol - symbolCode - exchange - exchangeName - instrumentName - sicSector - industry - subIndustry - businessSummary - ceo - address - city - state - country - zipCode - phoneNumber - instrumentType - figi - compositeFigi - shareClassFigi '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFinancialHighlights.json: get: tags: - Profiles and Financial Data summary: getFinancialHighlights operationId: get-getFinancialHighlights description: The getFinancialHighlights API provides key financial highlights, ratios and statistics for equities based on symbol. Fields include market capitalization, revenue, net income, revenue growth and earnings per share. 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. required: true schema: type: string example: 'GOOG,YHOO' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'lastQtrEPS,annualEPS,ttmEPS' 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 nullable: true example: 'GOOG' marketCapitalization: description: The total number of outstanding shares multiplied by the current market value. In thousands. type: integer nullable: true example: 1434772640 insiderShareholders: description: The percent of stock held by insider shareholders. type: number format: double nullable: true example: 0.1299 annualRevenue: description: The company's annual revenue. In millions. type: integer nullable: true example: 182527 ttmRevenue: description: The company's revenue from the last 12 months. type: integer nullable: true example: null sharesOutstanding: description: The total number of shares outstanding. In thousands. type: integer nullable: true example: 674137 institutionalShareholders: description: The percent of stock held by institutional shareholders. type: number format: double nullable: true example: 31.940000534058 annualNetIncome: description: The company's annual income after taxes but before the payout of common and preferred dividends. type: integer nullable: true example: 40269000000 ttmNetIncome: description: The net income from the last 12 months. type: number format: double nullable: true example: 40269 ttmNetProfitMargin: description: Net income dividend by revenue from the previous 12 months. type: number format: double nullable: true example: 22.0619 oneYearReturn: description: The percent change in price over a one-year period. type: number format: double nullable: true example: 39.41 threeYearReturn: description: The percent change in price over a three-year period. type: number format: double nullable: true example: 93.05 fiveYearReturn: description: The percent change in price over a five-year period. type: number format: double nullable: true example: 201.26 fiveYearRevenueGrowth: description: The percent growth in revenue over the past 5-years. type: number format: double nullable: true example: 143.41 fiveYearEarningsGrowth: description: The percent growth in earnings over the past 5-years. type: number format: double nullable: true example: 156.61 fiveYearDividendGrowth: description: The percent growth in dividends over the past 5-years. type: number format: double nullable: true lastQtrEPS: description: The earnings per share for the most recent quarter. type: number format: double nullable: true example: 22.299999 annualEPS: description: The earnings per share for the most recent annual period. type: number format: double nullable: true example: 58.7 ttmEPS: description: The earnings per share for the previous 12-months. type: number format: double nullable: true example: 58.700001 annualDividendRate: description: The annual dividend amount. type: number format: double nullable: true annualDividendYield: description: The dividends per share over the trailing one-year period as a percentage of the current stock price. type: number format: double nullable: true twelveMonthEPSChg: description: The change in earnings per share over the past 12-months. type: number format: double nullable: true example: 17.49 peRatio: description: The current price to earnings ratio. type: number format: double nullable: true example: 35.85 recentEarnings: description: The last reported earnings per share amount. type: number format: double nullable: true example: 22.3 recentDividends: description: The amount of the most recent dividends issued per share. type: number format: double nullable: true example: 1.52 recentSplit: description: The most recent stock split and associated ratio. type: string nullable: true example: null beta: description: A measure of the volatility of a security in comparison to the volatility of the market. type: number format: double nullable: true example: 0.98 weightAlpha: description: The weighted alpha of the sector. type: number format: double nullable: true example: 56.74 required: - symbol - marketCapitalization - insiderShareholders - annualRevenue - ttmRevenue - sharesOutstanding - institutionalShareholders - oneYearReturn - threeYearReturn - fiveYearReturn - fiveYearRevenueGrowth - fiveYearEarningsGrowth - fiveYearDividendGrowth - annualEPS - annualDividendRate - annualDividendYield - weightAlpha '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFinancialRatios.json: get: tags: - Profiles and Financial Data summary: getFinancialRatios operationId: get-getFinancialRatios description: The getFinancialRatios API provides key financial ratios for equities based on symbol. The fields include earnings per share, return on equity and price to earnings. 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. required: true schema: type: string example: 'AAPL,GOOG' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'debtEquity,interestCoverage,bookValue,dividendPayout' 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 nullable: true example: 'AAPL' eps: description: Earnings per share, calculated by dividing the total net income by the company's outstanding shares. type: number format: double nullable: true example: 3.7 profitMargin: description: Net profit divided by revenue, expressed as a percentage. type: number format: double nullable: true example: 21.73 roe: description: Net income divided by shareholder equity, expressed as a percentage. type: number format: double nullable: true example: 90.59 roa: description: Net income divided by total assets, expressed as a percentage. type: number format: double nullable: true example: 19.44 priceSales: description: Market capitalization divided by revenue. type: number format: double nullable: true example: 8.14529 priceEarnings: description: Stock price divided by earnings per share. type: number format: double nullable: true example: 36.07 priceBook: description: Market capitalization divided by total book value. type: number format: double nullable: true example: 21.13 debtEquity: description: Total debt divided by equity. type: number format: double nullable: true example: 1.49916 interestCoverage: description: A measurement of a company's ability to pay interest on outstanding debt. type: number format: double nullable: true bookValue: description: Total assets less intangible assets and liabilities. type: number format: double nullable: true example: 3.94 dividendPayout: description: The percentage of net income a firm pays to its shareholders as dividends. type: number format: double nullable: true example: 21.54 required: - symbol - eps - profitMargin - roe - roa - priceSales - priceEarnings - priceBook '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getIncomeStatements.json: get: tags: - Profiles and Financial Data summary: getIncomeStatements operationId: get-getIncomeStatements description: The getIncomeStatements API from Barchart OnDemand provides access to public company financial income statements based on symbol. 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. required: true schema: type: string example: 'IBM,AAPL,GOOG' - in: query name: frequency description: The frequency of financial statement reporting, either Quarterly ("Quarter") or Annually ("Annual"). required: true schema: type: string enum: - 'Quarter' - 'Annual' example: 'Quarter' - in: query name: count description: The number of Quarterly or Annual periods of financial statements to return. required: false schema: type: integer example: 1 - in: query name: rawData description: Return raw data, otherwise sales, costs, expenses, tax, and income data is displayed in thousands. required: false schema: type: integer example: 1 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 nullable: true example: 'IBM' date: description: The date of the financial statement. type: string format: date nullable: true example: '2020-09-30' sales: description: Total revenue or sales for the Income Statement period. type: number format: double nullable: true example: 17560000 costGoods: description: The cost of goods sold. type: number format: double nullable: true example: 9130000 grossProfit: description: Sales less the cost of goods sold. type: number format: double nullable: true example: 8430000 operatingExpenses: description: Expenses related to operating the business. type: number format: double nullable: true example: 6162000 operatingIncome: description: Gross profit less operating expenses. type: number format: double nullable: true example: 2268000 interestExpense: description: The cost incurred by an entity for borrowed funds. type: number format: double nullable: true example: 323000 otherIncomeExpenses: description: Income or expenses not related to normal business operations. type: number format: double nullable: true example: -118000 preTaxIncome: description: Operating income net other income or expenses. type: number format: double nullable: true example: 1827000 incomeTax: description: The tax on the company's income. type: number format: double nullable: true example: 128000 netIncome: description: Net income less all expenses and tax. type: number format: double nullable: true example: 1697000 basicEpsContOp: description: Income from continuing operations divided by the number of shares outstanding. type: number format: double nullable: true example: 1.9 basicEpsTotalOp: description: Net income divided by the number of shares outstanding. type: number format: double nullable: true example: 1.9 dilutedEpsContOp: description: Income from continuing operations divided by the number of diluted shares outstanding. type: number format: double nullable: true example: 1.89 dilutedEpsBNRI: description: Diluted EPS Before Non-Recurring Items type: number format: double nullable: true example: 2.58 dilutedEpsTotalOp: description: Net income divided by the number of diluted shares outstanding. type: number format: double nullable: true example: 1.89 ebitda: description: Earnings before interest, depreciation and amortization. type: number format: double nullable: true example: 3951000 required: - symbol - date - sales - costGoods - grossProfit - operatingExpenses - operatingIncome - interestExpense - otherIncomeExpenses - preTaxIncome - incomeTax - netIncome - basicEpsContOp - basicEpsTotalOp - dilutedEpsContOp - dilutedEpsBNRI - dilutedEpsTotalOp - ebitda '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getBalanceSheets.json: get: tags: - Profiles and Financial Data summary: getBalanceSheets operationId: get-getBalanceSheets description: The getBalanceSheets API from Barchart OnDemand provides access to public company financial balance sheet data based on symbol. 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. required: true schema: type: string example: 'IBM,AAPL,GOOG' - in: query name: frequency description: The frequency of financial statement reporting, either Quarterly ("Quarter") or Annually ("Annual"). required: true schema: type: string enum: - 'Quarter' - 'Annual' example: 'Quarter' - in: query name: count description: The number of Quarterly or Annual periods of financial statements to return. required: false schema: type: integer example: 1 - in: query name: rawData description: Return raw data, otherwise sales, costs, expenses, tax, and income data is displayed in thousands. required: false schema: type: integer example: 1 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 nullable: true example: 'IBM' date: description: The date of the financial statement. type: string format: date nullable: true example: '2020-09-30' cash: description: Money that is immediately available to a company. type: number format: double nullable: true example: 14553000 marketableSec: description: Liquid securities that can be converted to cash. type: number format: double nullable: true example: 1200000 receivables: description: The amount of receivables due to a company. type: number format: double nullable: true example: 7022000 prepaidExpenses: description: A type of asset that arises on a balance sheet as a result of business making payments for goods and services to be received in the near future. type: number format: double nullable: true example: 2188000 inventories: description: The value of inventory on hand. type: number format: double nullable: true example: 1949000 deferredIncomeTax: description: Income tax that has been deferred. type: number format: double nullable: true example: null otherCurrentAssets: description: Miscellaneous current assets. type: number format: double nullable: true example: 12933000 totalCurrentAssets: description: The total amount of current assets. type: number format: double nullable: true example: 39845000 ppeNet: description: The net value of property, plant and equipment. type: number format: double nullable: true example: 9958000 equityOtherInvestments: description: The value of company equity and other investments. type: number format: double nullable: true example: 1944000 intangibles: description: The value of intangible assets. type: number format: double nullable: true example: 72317000 otherNonCurrentAssets: description: Miscellaneous non-current assets. type: number format: double nullable: true example: 30064000 totalNonCurrentAssets: description: The total amount of non-current assets. type: number format: double nullable: true example: 114283000 totalAssets: description: The sum of all assets. type: number format: double nullable: true example: 154128000 shorttermDebt: description: Debt due within one year. type: number format: double nullable: true example: 10285000 accountsPayable: description: The amount of payables outstanding. type: number format: double nullable: true example: 3985000 incomeTaxPayable: description: The amount of income tax outstanding. type: number format: double nullable: true example: 2375000 accruedExpenses: description: Expenses that have already been accrued. type: number format: double nullable: true example: null otherCurrentLiabilities: description: Miscellaneous current liabilities. type: number format: double nullable: true example: 9667000 totalCurrentLiabilities: description: The total amount of current liabilities. type: number format: double nullable: true example: 37993000 longTermDebt: description: Debt due in more than one-year. type: number format: double nullable: true example: 55129000 deferredLongRevenues: description: Revenue deferred for more than one-year. type: number format: double nullable: true example: 11681000 otherNonCurrentLiabilities: description: Miscellaneous non-current liabilities. type: number format: double nullable: true example: 35851000 totalNonCurrentLiabilities: description: The total amount of non-current liabilities. type: number format: double nullable: true example: 94800000 totalLiabilities: description: The sum of all liabilities. type: number format: double nullable: true example: 132794000 sharesOutstanding: description: Shares outstanding. type: number format: double nullable: true example: 891057100 commonShares: description: The par or stated value of shares outstanding. type: number format: double nullable: true example: 56366000 retainedEarnings: description: Earnings retained by the company. type: number format: double nullable: true example: 162806000 otherEquity: description: Miscellaneous equity. type: number format: double nullable: true example: -28458000 totalShareholdersEquity: description: The total value of shareholder's equity. type: number format: double nullable: true example: 21334000 totalLiabilitiesAndEquity: description: The sum of total liabilties and shareholder's equity. type: number format: double nullable: true example: 154128000 required: - symbol - date - cash - marketableSec - receivables - prepaidExpenses - inventories - deferredIncomeTax - otherCurrentAssets - totalCurrentAssets - ppeNet - equityOtherInvestments - intangibles - otherNonCurrentAssets - totalNonCurrentAssets - totalAssets - shorttermDebt - accountsPayable - incomeTaxPayable - accruedExpenses - otherCurrentLiabilities - totalCurrentLiabilities - longTermDebt - deferredLongRevenues - otherNonCurrentLiabilities - totalNonCurrentLiabilities - totalLiabilities - sharesOutstanding - commonShares - retainedEarnings - otherEquity - totalShareholdersEquity - totalLiabilitiesAndEquity '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCompetitors.json: get: tags: - Profiles and Financial Data summary: getCompetitors operationId: get-getCompetitors description: Barchart OnDemand's getCompetitors API provides a list of related stock symbols (competitors) for an underlying stock input. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'AAPL' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'fiftyTwoWkHigh,fiftyTwoWkHighDate,fiftyTwoWkLow,fiftyTwoWkLowDate' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 10 - in: query name: excludePriceAndVolumeFilter description: Pass this boolean parameter if you would like the API to exclude filter on volume and last price. required: false schema: type: string example: 'true' 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 nullable: true example: 'HPQ' name: description: The full name of the instrument. type: string nullable: true example: 'HP Inc' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NYSE' marketCap: description: The quantity of shares or contracts traded. type: integer nullable: true example: 35452101562 fiftyTwoWkHigh: description: The highest price over the past 52 weeks. type: number format: double nullable: true example: 27.68 fiftyTwoWkHighDate: description: The date in which the high price was reached over the past 52 weeks. type: string format: date nullable: true example: '2021-02-16' fiftyTwoWkLow: description: The low price over the past 52 weeks. type: number format: double nullable: true example: 12.54 fiftyTwoWkLowDate: description: The date in which the low price was reached over the past 52 weeks. type: string format: date nullable: true example: '2020-03-19' required: - symbol - name - marketCap '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getRatings.json: get: tags: - Profiles and Financial Data summary: getRatings operationId: get-getRatings description: Barchart OnDemand's getRatings API provides analysts ratings on stocks (strong buy, moderate buy, hold, moderate sell or strong sell) based on symbol. 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 for the active contract or for the first nearby is supported, as is for all futures contracts for a given root symbol, as is 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: 'strongBuy,hold,strongSell' 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 nullable: true example: 'AAPL' name: description: The type of symbol used. type: string nullable: true example: 'Apple Inc' averageRecommendation: description: The average of all ratings (Strong Buy = 1.0, Moderate Buy = 2.0, Hold = 3.0, Moderate Sell = 4.0, Strong Sell = 5.0). type: object properties: current: type: string example: '1.44' one_month_ago: type: string example: '1.5' two_months_ago: type: string example: '1.52' three_months_ago: type: string example: '1.54' nullable: true strongBuy: description: The number of Strong Buy ratings. type: object properties: current: type: string example: '18' one_month_ago: type: string example: '17' two_months_ago: type: string example: '17' three_months_ago: type: string example: '16' nullable: true moderateBuy: description: The number of Moderate Buy ratings. type: object properties: current: type: string example: '3' one_month_ago: type: string example: '2' two_months_ago: type: string example: '3' three_months_ago: type: string example: '3' nullable: true hold: description: The number of Hold ratings. type: object properties: current: type: string example: '4' one_month_ago: type: string example: '5' two_months_ago: type: string example: '5' three_months_ago: type: string example: '5' nullable: true moderateSell: description: The number of Moderate Sell ratings. type: object properties: current: type: string example: '0' one_month_ago: type: string example: '0' two_months_ago: type: string example: '0' three_months_ago: type: string example: '0' nullable: true strongSell: description: The number of Strong Sell ratings. type: object properties: current: type: string example: '0' one_month_ago: type: string example: '0' two_months_ago: type: string example: '0' three_months_ago: type: string example: '0' nullable: true required: - symbol - name - averageRecommendation '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getIndexMembers.json: get: tags: - Profiles and Financial Data summary: getIndexMembers operationId: get-getIndexMembers description: The getIndexMembers API from Barchart OnDemand returns the constituents comprising an index. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies an index. required: true schema: type: string enum: - '$ONE' - '$IDX' - '$SPX' - '$IQY' - '$RUI' - '$IUX' - '$RUA' - '$IUXX' - '$DOWC' - '$DOWT' - '$DOWU' - '$DOWI' - '$TXCX' - '$JX' - '$TXSX' - '$TTCS' - '$TOOC' - '$TXTW' - '$TTCD' - '$TTCS' - '$TTEN' - '$TTFS' - '$TTIN' - '$TTTK' - '$TTMT' - '$TTHC' - '$TTRE' - '$TTTS' - '$TTUT' - '$RTCM' - '$RTRE' example: '$SPX' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'exchange' 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: index: description: The index that the symbol belongs to. type: string nullable: true example: '$SPX' symbol: description: A symbol or code that identifies a financial instrument. type: string nullable: true example: 'AAP' name: description: The name for the financial instrument. type: string nullable: true example: 'Advance Auto Parts Inc' exchange: description: The exchange code on which the financial instrument trades. type: string nullable: true example: 'NYSE' required: - index - symbol - name '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCashFlow.json: get: tags: - Profiles and Financial Data summary: getCashFlow operationId: get-getCashFlow description: Barchart OnDemand's getCashFlow API provides information about cash flow, income and cash equivalents of publicly traded companies. 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. required: true schema: type: string example: 'AAPL,GOOG' - in: query name: reportPeriod description: Whether to return quarterly (3M) or annual (12M) reports. required: false schema: type: string enum: - '12M' - '3M' example: '12M' - in: query name: fields description: The fields requested. required: false schema: type: string - in: query name: numberOfYears description: The number of years to return data for. required: false schema: type: integer example: 4 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. Multiple symbols separated by a comma may be used. type: string nullable: true example: 'AAPL' period: description: The cash flow period. type: string nullable: true example: '09-2020' netIncome: description: The Net Income value. type: number format: double nullable: true example: 57411000000 depreciationAndAmortization: description: The depreciation and amortization value. type: number format: double nullable: true example: 11056000000 deferredIncomeTax: description: Income tax that has been deferred. type: number format: double nullable: true example: -215000000 accountsReceivable: description: The accounts receivable. type: number format: double nullable: true example: 6917000000 accountsPayable: description: The amount of payables outstanding. type: number format: double nullable: true example: -4062000000 otherWorkingCapital: description: The amount of other working capital. type: number format: double nullable: true example: 5690000000 loans: description: The amount of loans. type: number format: double nullable: true example: null otherOperatingActivities: description: The amount of other operating activity. type: number format: double nullable: true example: 3877000000 netCashFromOperatingActivities: description: The amount of net cash from operating activities. type: number format: double nullable: true example: 80674000000 changeInDepositsWithBank: description: Change in Deposits with Banks. type: number format: double nullable: true example: 5453000000 investmentsInProperty: description: Investments In Property, Plant, And Equipment. type: number format: double nullable: true example: -7309000000 netAcquisitions: description: Net Business Purchase And Sale. type: number format: double nullable: true example: -1524000000 purchasesOfInvestments: description: Purchases of Investments. type: number format: double nullable: true example: -210000000 salesOfInvestments: description: Sales/Maturities of Investments. type: number format: double nullable: true example: 92000000 purchasesAndSaleOfIntangibles: description: Purchases/Sales of Intangibles. type: number format: double nullable: true example: null netChangeInLoans: description: Change in Loans, Net. type: number format: double nullable: true example: null otherInvestingActivity: description: The amount of other investing activity. type: number format: double nullable: true example: -791000000 netCashUsedForInvestingActivities: description: Net cash used for investing activities. type: number format: double nullable: true example: -4289000000 changeInDeposits: description: Change in Deposits. type: number format: double nullable: true example: null changeInShortTermBorrowing: description: Change in Short-Term Borrowing. type: number format: double nullable: true example: null debtIssued: description: Debt Issued. type: number format: double nullable: true example: 16091000000 debtRepayment: description: Debt Repayment. type: number format: double nullable: true example: -12629000000 commonStockIssued: description: Issuance of Capital Stock. type: number format: double nullable: true example: 880000000 commonStockRepurchased: description: Repurchase of Capital Stock. type: number format: double nullable: true example: -72358000000 dividendPaid: description: Payment of Cash Dividends. type: number format: double nullable: true example: -14081000000 otherFinancingActivity: description: The amount of other financing activity. type: number format: double nullable: true example: -4723000000 netCashProvidedByFinancingActivities: description: Net cash provided by (used for) financing activities. type: number format: double nullable: true example: -86820000000 effectOfExchangeRateChanges: description: Effect of Exchange Rate Changes. type: number format: double nullable: true example: null cashAtBeginningOfPeriod: description: Cash at Beginning of Period. type: number format: double nullable: true example: 50224000000 cashAtEndOfPeriod: description: Cash at End of Period. type: number format: double nullable: true example: 39789000000 netChangeInCash: description: Net Change in Cash & Cash Equiv. type: number format: double nullable: true example: -10435000000 operatingCashFlow: description: Operating cash flow. type: number format: double nullable: true example: 80674000000 capitalExpenditure: description: Investments in property, plant, and equipment. type: number format: double nullable: true example: -7309000000 freeCashFlow: description: Free Cash Flow. type: number format: double nullable: true example: 73365000000 required: - symbol - period - netIncome - depreciationAndAmortization - deferredIncomeTax - accountsReceivable - accountsPayable - otherWorkingCapital - loans - otherOperatingActivities - netCashFromOperatingActivities - changeInDepositsWithBank - investmentsInProperty - netAcquisitions - purchasesOfInvestments - salesOfInvestments - purchasesAndSaleOfIntangibles - netChangeInLoans - otherInvestingActivity - netCashUsedForInvestingActivities - changeInDeposits - changeInShortTermBorrowing - debtIssued - debtRepayment - commonStockIssued - commonStockRepurchased - dividendPaid - otherFinancingActivity - netCashProvidedByFinancingActivities - effectOfExchangeRateChanges - cashAtBeginningOfPeriod - cashAtEndOfPeriod - netChangeInCash - operatingCashFlow - capitalExpenditure - freeCashFlow '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCorporateActions.json: get: tags: - Splits, Dividends, and Earnings summary: getCorporateActions operationId: get-getCorporateActions description: The getCorporateActions API from Barchart OnDemand provides corporate actions data on equities including splits, dividends and earnings, based on a symbol. 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. required: true schema: type: string example: 'AMZN,AAPL' - in: query name: startDate description: The beginning date for the query. required: false schema: type: string format: date example: '2013-01-01' - in: query name: endDate description: The end date for the query. required: false schema: type: string format: date example: '2013-06-30' - in: query name: eventType description: | The type of event: "split", "dividend", "earnings". required: true schema: type: string enum: - 'split' - 'dividend' - 'earnings' example: 'dividend' - in: query name: maxRecords description: The maximum number of records to return. required: false schema: type: integer example: 5 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 nullable: true example: 'AAPL' eventDate: description: The date in which the event occurred. type: string format: date nullable: true example: '2013-05-09' eventType: description: The type of event. type: string nullable: true example: 'Dividend' value: description: The split ratio, dividend amount or earnings amount. type: number format: double nullable: true example: 3.05 required: - symbol - eventDate - eventType - value '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEarningsEstimates.json: get: tags: - Splits, Dividends, and Earnings summary: getEarningsEstimates operationId: get-getEarningsEstimates description: The getEarningsEstimates API from Barchart OnDemand provides per share earnings estimates on public companies for quarterly and annual periods based on symbol. 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. required: true schema: type: string example: 'IBM,GOOG' - in: query name: fields description: Additional fields requested. required: false schema: type: string example: 'bid,bidSize,ask,askSize' 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 the futures contract. type: string nullable: true example: 'IBM' symbolName: description: The full name of the instrument. type: string nullable: true example: 'International Business Machines' period: description: The period, either quarter or annual, that the estimate pertains to. For example, Q42013 or FY122013. type: string nullable: true example: 'Qtr 2021-03-31' averageEstimate: description: The average estimated earnings per share based on all analysts. type: number format: double nullable: true example: 1.66 numAnalysts: description: The number of analysts providing earnings estimates. type: integer nullable: true example: 6 highEstimate: description: The highest earnings per share estimate amount. type: number format: double nullable: true example: 1.82 lowEstimate: description: The lowest earnings per share estimate amount. type: number format: double nullable: true example: 1.39 priorYear: description: The average earnings per share estimated last year. type: number format: double nullable: true example: 1.84 growthRateEstimate: description: The estimated growth rate in earnings based off of the average estimate (year-over-year). type: number format: double nullable: true example: -9.78 currentQtrExpectedReportDate: description: The expected report date for the most recent quarter. type: string format: date nullable: true example: '2021-01-21' expectedEarningsStatus: description: Whether the expected earnings information is late or not. type: string nullable: true example: 'Not yet reported, not yet late' expectedEarningsSource: description: The source of the expected earnings report date. type: string nullable: true example: 'Company' dividendType: description: Type of dividend payout. type: string nullable: true example: 'Cash Dividend' indicatedAnnualDvnd: description: The indicated annual dividend per share for given instrument. type: number format: double nullable: true example: 6.52 dividendStatus: description: Whether the dividend data is late or not. type: string nullable: true example: 'Not late' paymentDate: description: The dividend payment date. type: string format: date nullable: true example: '2021-03-10' recordDate: description: Date when dividend info was reported type: string format: date nullable: true example: '2021-02-10' declarationDate: description: Date when dividend info was announced. type: string format: date nullable: true example: '2021-01-26' exDividendDate: description: The last possible date to have owned shares of a stock and still be entitled to the associated dividend. type: string format: date nullable: true example: '2021-02-09' dividendRate: description: Last dividend payout amount. type: number format: double nullable: true example: 1.63 required: - symbol - symbolName - period - averageEstimate '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getDividendData.json: get: tags: - Splits, Dividends, and Earnings summary: getDividendData operationId: get-getDividendData description: The getDividendData API from Barchart OnDemand provides the most recent dividend data for requested instruments. 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. required: true schema: type: string example: 'IBM,AAPL,GOOG' 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: The instrument symbol. type: string nullable: true example: 'IBM' announcementDate: description: The date of announcement. type: string format: date nullable: true example: '2021-01-26' exDividendDate: description: The ex-dividend date. type: string format: date nullable: true example: '2021-02-09' recordDate: description: The date of the record. type: string format: date nullable: true example: '2021-02-10' paymentDate: description: The date of the payment of the dividend. type: string format: date nullable: true example: '2021-03-10' dividend: description: The dividend to be paid. type: number format: double nullable: true example: 1.63 dividendYield: description: The dividend yield. type: number format: double nullable: true example: 0.0543 dividendYieldPct: description: Dividend yield as a percentage. type: number format: double nullable: true example: 5.43 frequency: description: | The frequency of the dividend payout. The frequency numbers represent: 0: None, 1: Annual, 2: Bi-Annual, 3: Thrice Annual, 4: Quarterly, 5: Monthly, 6: Bi-Monthly, 7: To Be Determined, 8: Variable, 9: Not Available type: integer nullable: true example: 4 indicatedAnnualDividend: description: the indicated annual dividend per share. type: number format: double nullable: true example: 6.52 dividendRateForward: description: The forward dividend rate. type: number format: double nullable: true example: 6.52 required: - symbol - announcementDate - exDividendDate - recordDate - paymentDate - dividend - dividendYield - dividendYieldPct - frequency - indicatedAnnualDividend - dividendRateForward '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getDividendStocks.json: get: tags: - Splits, Dividends, and Earnings summary: getDividendStocks operationId: get-getDividendStocks description: The getDividendStocks API returns dividend info for all US instruments. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: country description: The country code for which the instruments list is to be queried and returned. required: false schema: type: string example: 'US' - in: query name: fields description: Request additional optional fields to be included in the output. required: false schema: type: string example: 'annualDividend' 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: The instrument symbol. type: string nullable: true example: 'AADR' symbolName: description: The instrument name. type: string nullable: true example: 'Advisorshares Dorsey Wright ETF' exchange: description: The exchange code were the instrument trades. type: string nullable: true example: 'AMEX' instrumentType: description: The classification of the instrument. type: string nullable: true example: 'etf' hasDividends: description: Boolean field indicating whether the instrument has dividends or not. type: string nullable: true example: '1' annualDividend: description: The annual dividend for the instrument. type: number format: double nullable: true example: 0.067 annualDividendYield: description: The annual dividend yield for the instrument. type: number format: double nullable: true example: 0.001 required: - symbol - symbolName - exchange - instrumentType - hasDividends '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCorporateActionsByExchange.json: get: tags: - Splits, Dividends, and Earnings summary: getCorporateActionsByExchange operationId: get-getCorporateActionsByExchange description: The getCorporateActions API from Barchart OnDemand provides splits or dividends data for US equities, mutual funds and Canadian equities by exchange. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: type description: Type of action for which data is being requested. required: true schema: type: string enum: - 'dividend' - 'split' example: 'dividend' - in: query name: exchanges description: | A valid exchange code.
Available values (multiple values separated by a comma may be used): *NYSE, NASDAQ, AMEX, OTC-BB, LSE, TSX, TSX-V, ASX, CNSX, FUND, CADFUNDS*. required: true schema: type: string example: 'NYSE' - in: query name: interval description: Set period in days for which the event data should be returned. required: false schema: type: string enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' example: '7' - in: query name: eventDates description: A comma separated list of dates for which event data should be returned. Dates need to be in [YYYYMMDD] format. required: false schema: type: string example: '20260722,20260630' 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 nullable: true example: 'AB' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NYSE' eventDate: description: The date in which the event occurred. type: string format: date nullable: true example: '2021-02-19' eventType: description: The type of event. type: string nullable: true example: 'dividend' value: description: The split ratio, dividend amount or earnings amount. type: number format: double nullable: true example: 0.97 required: - symbol - exchange - eventDate - eventType - value '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEarningsCalendar.json: get: tags: - Splits, Dividends, and Earnings summary: getEarningsCalendar operationId: get-getEarningsCalendar description: The getEarningsCalendar API provides the total number of upcoming earnings by date. And will also return the earnings data for the requested date. Please note that the output of this API will change based on the type of data requested. When requesting 'totals' (default type), it will return the date and total earnings for that date. And when requesting 'earnings' it will return earnings data for all symbols for the requested start date. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchange description: The exchange(s) for which the data is requested. US-ALL and CA-ALL will query for all permitted US and Canadian exchanges for your account. required: true schema: type: string enum: - 'US-ALL' - 'CA-ALL' - 'AMEX' - 'NASDAQ' - 'NYSE' - 'OTHER OTC' - 'TSX' - 'TSX-V' - 'CNSX' example: 'AMEX' - in: query name: type description: A boolean parameter that when set to true, will return all earnings data for the requested start date. If no start date is passed, it will return the data for the current date. required: true schema: type: string enum: - 'totals' - 'earnings' - in: query name: startDate description: The start date for earnings total and the date for which the earnings information will be returned. required: false schema: type: string format: date - in: query name: endDate description: The end date for earnings total. This input parameter is ignored when requesting the actual earnings information. required: false schema: type: string format: date 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: date: description: The date for the data is returned. type: string format: date nullable: true example: null totalEarnings: description: The total number of earnings data for the day. type: integer nullable: true example: null symbol: description: A symbol or code that identifies a financial instrument. type: string nullable: true example: null name: description: The name of the entity that the symbol or code represents. type: string nullable: true example: null exchange: description: N/A type: string nullable: true example: null timeCode: description: The time of day on which the earnings report is released. type: string nullable: true example: null estimatedEarnings: description: The average analysts' estimate for earnings for the current quarter. type: number format: double nullable: true example: null lastReportedEarnings: description: Last reported quarterly earnings, based on GAAP income from continuing operations. type: number format: double nullable: true example: null lastEarningsSurpriseAmount: description: The difference between the estimated and reported earnings. type: number format: double nullable: true example: null lastEarningsSurprisePercent: description: The difference between the estimated and reported earnings expressed as a percent. type: number format: double nullable: true example: null required: - date - totalEarnings '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getDividendsCalendar.json: get: tags: - Splits, Dividends, and Earnings summary: getDividendsCalendar operationId: get-getDividendsCalendar description: The getDividendsCalendar API provides the total number of upcoming dividends by date. And will also return the dividends data for the requested date. Please note that the output of this API will change based on the type of data requested. When requesting 'totals' (default type), it will return the date and total dividends for that date. And when requesting 'dividends' it will return dividend data for all symbols for the requested start date. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchange description: The exchange(s) for which the data is requested. US-ALL and CA-ALL will query for all permitted US and Canadian exchanges for your account. required: true schema: type: string enum: - 'US-ALL' - 'CA-ALL' - 'AMEX' - 'NASDAQ' - 'NYSE' - 'OTHER OTC' - 'TSX' - 'TSX-V' - 'CNSX' example: 'AMEX' - in: query name: type description: A boolean parameter that when set to true, will return all dividends data for the requested start date. If no start date is passed, it will return the data for the current date. required: true schema: type: string enum: - 'totals' - 'dividends' example: 'totals' - in: query name: startDate description: The start date for dividends total and the date for which the dividends information will be returned. required: false schema: type: string format: date - in: query name: endDate description: The end date for dividends total. This input parameter is ignored when requesting the actual dividends information. required: false schema: type: string format: date 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: date: description: The date for the data is returned. type: string format: date nullable: true example: null totalDividends: description: The total number of dividends data for the day. type: integer nullable: true example: null symbol: description: A symbol or code that identifies a financial instrument. type: string nullable: true example: null name: description: The name of the entity that the symbol or code represents. type: string nullable: true example: null exchange: description: N/A type: string nullable: true example: null amount: description: The dollar amount of the dividend. type: number format: double nullable: true example: null yield: description: Indicates how much a company pays out in dividends each year relative to its share price. Dividend yield% can be calculated by dividing the dollar value of dividends paid in a given year per share of stock held by the dollar value of one share of stock. type: number format: double nullable: true example: null exDivDate: description: Normally two business days before the recorded payable date. If you purchase a stock on or after its ex-dividend date, you will not receive the next dividend payment. type: string format: date nullable: true example: null payableDate: description: The date on which the dividend is payable. type: string format: date nullable: true example: null required: - date - totalDividends '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getEarningsAndDividendsCalendar.json: get: tags: - Splits, Dividends, and Earnings summary: getEarningsAndDividendsCalendar operationId: get-getEarningsAndDividendsCalendar description: The getEarningsAndDividendsCalendar API provides the total number of upcoming earnings and dividends by date. And will also return the earnings and dividends for the requested date. Please note that the output of this API will change based on the type of data requested. When requesting 'totals' (default type), it will return the date and total earnings and dividends for that date, when requesting 'earnings' it will return earnings data for all symbols for the requested start date, when requesting 'dividends' it will return dividend data for all symbols for the requested start date. And if the request type is 'earnings-dividends' then the output will be and earnings attribute that will have an array of objects with earnings data and a dividends attribute with an array of objects with the dividends data. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchange description: The exchange(s) for which the data is requested. US-ALL and CA-ALL will query for all permitted US and Canadian exchanges for your account. required: true schema: type: string enum: - 'US-ALL' - 'CA-ALL' - 'AMEX' - 'NASDAQ' - 'NYSE' - 'OTHER OTC' - 'TSX' - 'TSX-V' - 'CNSX' - in: query name: type description: A boolean parameter that when set to true, will return all earnings and dividends data for the requested start date. If no start date is passed, it will return the data for the current date. required: true schema: type: string enum: - 'totals' - 'earnings' - 'dividends' - 'earnings-dividends' - in: query name: startDate description: The start date for earnings and dividends total and the date for which the earnings and dividends information will be returned. required: false schema: type: string format: date - in: query name: endDate description: The end date for earnings and dividends total. This input parameter is ignored when requesting the actual earnings or dividends or earnings and dividends information. required: false schema: type: string format: date 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: date: description: The date for the data is returned. type: string format: date nullable: true example: null totalEarnings: description: The total number of earnings data for the day. type: integer nullable: true example: null totalDividends: description: The total number of dividends data for the day. type: integer nullable: true example: null earnings: description: N/A type: string nullable: true example: null dividends: description: N/A type: string nullable: true example: null required: - date - totalEarnings - totalDividends '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getLeaders.json: get: tags: - Leaderboards and Lists summary: getLeaders operationId: get-getLeaders description: Barchart OnDemand's getLeaders API provides leaderboard lists for equities, futures, forex, mutual funds and ETFs, including most active, gainers, losers, what's hot and what's not hot. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchanges description: | Exchange code for the marketplace where the financial instruments are listed.
Available values (multiple values separated by a comma may be used): *AMEX, CBOT, CBOTM, CME, COMEX, COMEX, FOREX, GBLX, ICE, ICEFI, ICEUS, WCE, CADFUNDS, FUND, INDEX, INDEX-CBOE, INDEX-DOW, INDEX-NQ, INDEX-NY, INDEX-SP, INDEX-TSX, IOM, IMM, KCBT, LCE, MIAX, NASDAQ, OTHER OTC, RATES, RATE, NYMEX, NYMI, NYSE, NLIF, TSX, TSX-V, NEO, SECTOR, CNSX, LIFFE, EUIDX, EUREX, BMF, MATIF, CXMI, CXMI, HKFE, SPECIAL, INDEX-RL, MATBA, NCDEX, ASX, ROFEX, OTC-BB, SIMEX, CZCE, CROSS, BSE, MNTRL, ECON, TOCOM, MEFF, ENDEX, SAFEX, TIFFE, CASH, MCX, NZX, MDEX, DGCX, NSE, CBOE, GME, OMX, CFE, TURK, TFEX, TAIWA, SHFE, DCE, BATS, LSE, LME, EEX, CFFEX, JPX, SFE, KFE, ISE, CRYPTO, GRBIDS, AGIDX_B_COU, AGIDX_B_CRD, AGIDX_B_NAT, AGIDX_B_REG, AGIDX_B_STA, AGIDX_P_COU, AGIDX_P_CRD, AGIDX_P_NAT, AGIDX_P_REG, AGIDX_P_STA, MTIDX_P_NAT_SY, C3, CXE, EURNXT_EQ_BE, EURNXT_EQ_FR, EURNXT_EQ_NL, EURNXT_EQ_PT, AGYIELD, CMDTY_STATS, CSTATS_BARCHART, CSTATS_BHUGHES, CSTATS_CFTC, CSTATS_ENGCORPS, CSTATS_EUSTAT, CSTATS_STATCAN, CSTATS_USBEA, CSTATS_USBLS, CSTATS_USCB, CSTATS_USDA, CSTATS_USEIA, CMENRF, CMENRF_IDX, CMENWF, CMMTPM, AGYIELD_BIW, SCB_BIOFUEL_EU, SCB_BIOFUEL_US, SCB_ETHANOL, SMALL, AGIDX_B_FCST, MER_ORG_GRN, MER_ORG_IMP, CSTATS_IBGE, PRM_GLB_BIO, PRM_LOW_CAR, AGYIELD_SA, CSTATS_CONAB, FSMK_JCB_BIOFL, FSMK_JCB_FATINT, FSMK_JCB_FATOIL, FSMK_JCB_GRNFD, FSMK_JCB_HEMP, FSMK_JCB_HIDE, FSMK_JCB_HIDINT, FSMK_JCB_ORGN, FSMK_JCB_PROT, FSMK_JCB_SSG, FSMK_JCB_VEGOIL, EEX_POWER, EEX_GAS, AGYIELD_BP_COU, AGYIELD_BP_CRD, AGYIELD_BP_NAT, AGYIELD_BP_STA, SGCOM, SGXFX, SGXNZ, SGIDX, BALTIC, AMEX, NASDAQ, NYSE*. required: false schema: type: string example: 'NYSE' - in: query name: assetType description: | The type of asset. Includes: equities ("STK"), mutual funds ("FUNDS"), ETFs ("ETF"), futures ("FUT"), forex ("FOREX") required: true schema: type: string enum: - 'STK' - 'ETF' - 'FUND' - 'FUT' - 'FOREX' example: 'STK' - in: query name: type description: The type of leaderboard to display. required: true schema: type: string enum: - 'active' - 'active_5d' - 'active_1m' - 'active_3m' - 'active_6m' - 'active_9m' - 'active_12m' - 'active_ytd' - 'gainers' - 'gainers_5d' - 'gainers_1m' - 'gainers_3m' - 'gainers_6m' - 'gainers_9m' - 'gainers_12m' - 'gainers_ytd' - 'losers' - 'losers_5d' - 'losers_1m' - 'losers_3m' - 'losers_6m' - 'losers_9m' - 'losers_12m' - 'losers_ytd' - 'hot' - 'hot_daily' - 'hot_weekly' - 'hot_monthly' - 'nothot' - 'nothot_daily' - 'nothot_weekly' - 'nothot_monthly' - 'barchart' example: 'hot' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 30 - in: query name: period description: A value representing the time period. required: false schema: type: string enum: - '5d' - '20d' - '65d' - '100d' - '260d' example: '260d' - in: query name: sortDirection description: To determine the sort direction. required: false schema: type: string enum: - 'ASC' - 'DESC' example: 'DESC' - in: query name: excludeEtfsFromStocks description: When requesting Stocks data, if you would like the API to exclude ETFs please set this parameter to true. required: false schema: type: string 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 nullable: true example: 'JMP' symbolName: description: The full name of the instrument. type: string nullable: true example: 'JMP Group Inc' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NYSE' country: description: The instrument's country of origin. type: string nullable: true example: 'USA' sicSector: description: A four-digit code for classifying industries. type: string nullable: true example: '6211' industry: description: A code that identifies a group of businesses that produce similar products or services. type: string nullable: true example: 'Finance' subIndustry: description: A more specific group of businesses within an industry that produce similar products or services. type: string nullable: true example: 'Investment Brokers' timestamp: description: The time the message was generated on the server. type: string nullable: true example: '2021-02-19T11:05:20-06:00' tradeTimestamp: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-19T11:50:20-06:00' lastPrice: description: The last price the instrument traded. type: number format: double nullable: true example: 6.86 priceNetChange: description: The difference between the last price and the previous day's settlement price. type: number format: double nullable: true example: 1.89 pricePercentChange: description: The difference between the last price and the previous day's settlement price, expressed as a percentage. type: number format: double nullable: true example: 38.03 previousClose: description: The closing value of the instrument on the previous day. type: number format: double nullable: true example: 4.97 volume: description: The number of shares or contracts traded. type: integer nullable: true example: 19281370 previousVolume: description: The number of shares or contracts traded for the previous day. type: integer nullable: true example: 2087461 standardDeviation: description: The standard deviation using the past 20-days of data. type: number format: double nullable: true example: 4.56 required: - symbol - symbolName - exchange - country - sicSector - industry - subIndustry - timestamp - tradeTimestamp - lastPrice - priceNetChange - pricePercentChange - previousClose - volume - previousVolume - standardDeviation '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getHighsLows.json: get: tags: - Leaderboards and Lists summary: getHighsLows operationId: get-getHighsLows description: The getHighsLows API from Barchart OnDemand provides lists for new 52-week highs or 52-week lows based on exchange and asset type. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: exchanges description: | Exchange code for the marketplace where the financial instruments are listed.
Available values (multiple values separated by a comma may be used): *AMEX, CBOT, CBOTM, CME, COMEX, COMEX, FOREX, GBLX, ICE, ICEFI, ICEUS, WCE, CADFUNDS, FUND, INDEX, INDEX-CBOE, INDEX-DOW, INDEX-NQ, INDEX-NY, INDEX-SP, INDEX-TSX, IOM, IMM, KCBT, LCE, MIAX, NASDAQ, OTHER OTC, RATES, RATE, NYMEX, NYMI, NYSE, NLIF, TSX, TSX-V, NEO, SECTOR, CNSX, LIFFE, EUIDX, EUREX, BMF, MATIF, CXMI, CXMI, HKFE, SPECIAL, INDEX-RL, MATBA, NCDEX, ASX, ROFEX, OTC-BB, SIMEX, CZCE, CROSS, BSE, MNTRL, ECON, TOCOM, MEFF, ENDEX, SAFEX, TIFFE, CASH, MCX, NZX, MDEX, DGCX, NSE, CBOE, GME, OMX, CFE, TURK, TFEX, TAIWA, SHFE, DCE, BATS, LSE, LME, EEX, CFFEX, JPX, SFE, KFE, ISE, CRYPTO, GRBIDS, AGIDX_B_COU, AGIDX_B_CRD, AGIDX_B_NAT, AGIDX_B_REG, AGIDX_B_STA, AGIDX_P_COU, AGIDX_P_CRD, AGIDX_P_NAT, AGIDX_P_REG, AGIDX_P_STA, MTIDX_P_NAT_SY, C3, CXE, EURNXT_EQ_BE, EURNXT_EQ_FR, EURNXT_EQ_NL, EURNXT_EQ_PT, AGYIELD, CMDTY_STATS, CSTATS_BARCHART, CSTATS_BHUGHES, CSTATS_CFTC, CSTATS_ENGCORPS, CSTATS_EUSTAT, CSTATS_STATCAN, CSTATS_USBEA, CSTATS_USBLS, CSTATS_USCB, CSTATS_USDA, CSTATS_USEIA, CMENRF, CMENRF_IDX, CMENWF, CMMTPM, AGYIELD_BIW, SCB_BIOFUEL_EU, SCB_BIOFUEL_US, SCB_ETHANOL, SMALL, AGIDX_B_FCST, MER_ORG_GRN, MER_ORG_IMP, CSTATS_IBGE, PRM_GLB_BIO, PRM_LOW_CAR, AGYIELD_SA, CSTATS_CONAB, FSMK_JCB_BIOFL, FSMK_JCB_FATINT, FSMK_JCB_FATOIL, FSMK_JCB_GRNFD, FSMK_JCB_HEMP, FSMK_JCB_HIDE, FSMK_JCB_HIDINT, FSMK_JCB_ORGN, FSMK_JCB_PROT, FSMK_JCB_SSG, FSMK_JCB_VEGOIL, EEX_POWER, EEX_GAS, AGYIELD_BP_COU, AGYIELD_BP_CRD, AGYIELD_BP_NAT, AGYIELD_BP_STA, SGCOM, SGXFX, SGXNZ, SGIDX, BALTIC, AMEX, NASDAQ, NYSE*. required: false schema: type: string example: 'NYSE,NASDAQ' - in: query name: assetType description: | The type of asset. Includes: equities ("STK"), mutual funds ("FUNDS"), ETFs ("ETF"), futures ("FUT"), forex ("FOREX") required: true schema: type: string enum: - 'STK' - 'ETF' - 'FUND' - 'FUT' - 'FOREX' - 'BARCHART' example: 'STK' - in: query name: type description: The type of high/low list to return. required: false schema: type: string enum: - 'high' - 'low' example: 'low' - in: query name: period description: A value representing the time period. required: true schema: type: string enum: - '5d' - '20d' - '65d' - '100d' - '260d' example: '260d' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 20 - in: query name: offset description: A value denoting where to start results from. required: false schema: type: integer example: 5 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 nullable: true example: 'WOOF' symbolName: description: The full name of the instrument. type: string nullable: true example: 'Petco Health and Wellness Company Inc Cl A' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NASDAQ' country: description: The instrument's country of origin. type: string nullable: true example: 'USA' timestamp: description: The exchange time of the last traded priced. type: integer nullable: true example: 1613755487 tradeTime: description: The exchange time of the last traded priced. type: string nullable: true example: '2021-02-19T12:09:40-06:00' lastPrice: description: The most recent price at which a stock or security traded. type: number format: double nullable: true example: 23.49 priceNetChange: description: The difference between the last price and the previous day's settlement price. type: number format: double nullable: true example: -0.010000000000002 pricePercentChange: description: The difference between the last price and the previous day's settlement price, expressed as a percentage. type: number format: double nullable: true example: -0.04 previousClose: description: The closing value of the instrument on the previous day. type: number format: double nullable: true example: 23.5 volume: description: The number of shares or contracts traded. type: integer nullable: true example: 684544 previousVolume: description: The number of shares or contracts traded for the previous day. type: integer nullable: true example: 2087300 selectedPeriodHighPrice: description: The high price for the selected period type: number format: double nullable: true example: 31.08 selectedPeriodHighPercent: description: The high percent change for the selected period type: number format: double nullable: true example: -24.49 selectedPeriodLowPrice: description: The low price for the selected period type: number format: double nullable: true example: 23.4 selectedPeriodLowPercent: description: The low percent change for the selected period type: number format: double nullable: true example: 0.3 required: - symbol - symbolName - exchange - country - timestamp - tradeTime - lastPrice - priceNetChange - pricePercentChange - previousClose - volume - previousVolume - selectedPeriodHighPrice - selectedPeriodHighPercent - selectedPeriodLowPrice - selectedPeriodLowPercent '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSectors.json: get: tags: - Leaderboards and Lists summary: getSectors operationId: get-getSectors description: The getSectors API from Barchart OnDemand provides returns using weighted alpha on sectors covering multiple periods, including 1-day, 1-month, 3-month, 6-month, 9-month, 12-month and year-to-date. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: sector description: The symbol of the sector. Multiple sectors separated by a comma may be used. required: false schema: type: string example: '-MEDR' - in: query name: sectorPeriod description: | The period used to calculate the weighted alpha return by the sector, includes: 1-day ("1DA"), 1-month ("1MO"), 3-month ("3MO"), 6-month ("6MO"), 9-month ("9MO"), 12-month ("12MO") and year-to-date ("YTD"). required: false schema: type: string enum: - '1DA' - '1MO' - '3MO' - '6MO' - '9MO' - '12MO' - 'YTD' example: '1DA' - in: query name: dailyData description: | Whether to include daily data: Open, High, Low, Close, Previous Close, 52-week high and 52-week low required: false schema: type: string - in: query name: components description: Whether to include components of the sector. required: false schema: type: string - in: query name: sortDir description: Sorting method that should be applied. required: false schema: type: string example: 'ASC' 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: The symbol of the sector. type: string nullable: true example: '-MEDR' sector: description: The name of the sector. type: string nullable: true example: 'Medical - Drugs' weightAlpha: description: The weighted alpha of the sector. type: number format: double nullable: true example: 36.14 lastTrade: description: The last traded price of the sector. type: number format: double nullable: true example: 35.97 change: description: The change in last traded price of the sector. type: number format: double nullable: true example: 3.74 percentChange: description: The percent change in the last traded price of the sector. type: number format: double nullable: true example: 11.6 stocks: description: The number of stocks the sector is comprised of. type: integer nullable: true example: 190 open: description: The opening price for the sector for the current day. type: number format: double nullable: true high: description: The high price for the sector for the current day. type: number format: double nullable: true example: 35.97 low: description: The low price for the sector for the current day. type: number format: double nullable: true example: 35.97 close: description: The closing price for the sector for the current day. type: number format: double nullable: true example: 36.14 previousClose: description: The closing price for the sector for the previous day. type: number format: double nullable: true example: 32.24 fiftyTwoWeekHigh: description: The highest price for the sector over the previous 52-weeks type: number format: double nullable: true example: 44.21 fiftyTwoWeekLow: description: The lowest price for the sector over the previous 52-weeks type: number format: double nullable: true example: -39.13 components: description: The symbol for a component of the sector. type: array items: properties: symbol: type: string example: ACER name: type: string example: Acer Therapeutics Inc exchange: type: string example: NASDAQ nullable: true componentSymbol: description: The symbol for a component of the sector. type: string example: null nullable: true componentName: description: The name of a component of the sector. type: string example: null nullable: true timestamp: description: The timestamp for the data. type: string nullable: true example: '2021-02-19T11:23:01-06:00' required: - symbol - sector - weightAlpha - lastTrade - change - percentChange - stocks - timestamp '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getChart.json: get: tags: - Charts and Analytics summary: getChart operationId: get-getChart description: The getChart API from Barchart OnDemand is used to request a custom chart image with variables such as chart type, size, period and technical indicators, based on a symbol. 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. required: true schema: type: string example: 'TSLA,MSFT' - in: query name: type description: | The type of chart, includes: bar chart ("BAR"), candlestick ("CANDLE"), area ("AREA") or line ("LINE") chart. required: false schema: type: string enum: - 'BAR' - 'LINE' - 'CANDLE' - 'AREA' example: 'LINE' - in: query name: width description: The width of chart in pixels. required: false schema: type: integer example: 700 - in: query name: height description: The height of the chart, in pixels, with no indicators in pixels. required: false schema: type: integer example: 550 - in: query name: volume description: An option to display the volume indicator on the chart. required: false schema: type: string example: 'false' - in: query name: period description: The period to display the chart. required: false schema: type: string enum: - '1d' - '5d' - '3d' - '10d' - '1m' - '3m' - '6m' - '1y' - '2y' - '3y' - '5y' - '10y' - '15y' - '20y' - '25y' - 'ytd' example: '1d' - in: query name: interval description: | Period type: DO (Daily Contract), DN (Daily Nearest), WO (Weekly Contract), WN (Weekly Nearest), MO (Monthly Contract), MN (Monthly Nearest). required: false schema: type: string enum: - 'DO' - 'DN' - 'WO' - 'WN' - 'MO' - 'MN' example: 'DO' - in: query name: indicators description: A semi-colon delimited list of indicators. required: false schema: type: string example: 'BBANDS(20,2);MACD(12,26,9)' - in: query name: frequencyType description: | Frequency type: DO (Daily Contract), DN (Daily Nearest), DC (Daily Continuation), WO (Weekly Contract), WN (Weekly Nearest), WC (Weekly Continuation), MO (Monthly Contract), MN (Monthly Nearest), MC (Monthly Continuation) required: false schema: type: string - in: query name: gradientTop description: The HTML color code without the preceding hashtag for the AREA chart. required: false schema: type: string - in: query name: gradientBottom description: The HTML color code without the preceding hashtag for the AREA chart. required: false schema: type: string - in: query name: bgColor description: The HTML color code without the preceding hashtag for chart background color. required: false schema: type: string 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 nullable: true example: 'YHOO' imageURL: description: The URL for the chart image. type: string nullable: true example: '////ondemand.websol.barchart.com/chart.png??symbol=YHOO\u0026barType=LINE\u0026time=1d\u0026width=700\u0026height=550\u0026volume=0\u0026indicators=BBANDS%2820%2C2%29%3BMACD%2812%2C26%2C9%29\u0026period=DO\u0026startDate=1499058000\u0026endDate=1499101199' required: - symbol - imageURL '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getTechnicals.json: get: tags: - Charts and Analytics summary: getTechnicals operationId: get-getTechnicals description: Barchart OnDemand's getTechnicals API provides technical data and statistics for equities, indices, futures, currencies, cryptocurrencies and mutual funds based on symbol. Fields include moving averages, percent changes over different time periods and stochastics. 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. required: true schema: type: string example: 'AAPL,GOOG' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'averageVolumeFiveDay,averageVolumeTwentyDay,averageVolumeFiftyDay' 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 nullable: true example: 'AAPL' movingAverageFiveDay: description: The average price of the instrument over 5 days. type: number format: double nullable: true example: 127.69 movingAverageTenDay: description: The average price of the instrument over 10 days. type: number format: double nullable: true example: 185.86 movingAverageTwentyDay: description: The average price of the instrument over 20 days. type: number format: double nullable: true example: 134.1 movingAverageFiftyDay: description: The average price of the instrument over 50 days. type: number format: double nullable: true example: 131.9 movingAverageOneHundredDay: description: The average price of the instrument over 100 days. type: number format: double nullable: true example: 124.69 movingAverageOneHundredFiftyDay: description: The average price of the instrument over 150 days. type: number format: double nullable: true example: null movingAverageTwoHundredDay: description: The average price of the instrument over 200 days. type: number format: double nullable: true example: 112.09 movingAverageOneMonth: description: The average price of the instrument over 1 month. type: number format: double nullable: true example: null movingAverageThreeMonths: description: The average price of the instrument over 3 months. type: number format: double nullable: true example: null movingAverageSixMonths: description: The average price of the instrument over 6 months. type: number format: double nullable: true example: null movingAverageNineMonths: description: The average price of the instrument over 9 months. type: number format: double nullable: true example: null movingAverageFiftyTwoWeeks: description: The average price of the instrument over 52 weeks. type: number format: double nullable: true example: null movingAverageYTD: description: The average price of the instrument since the start of the year. type: number format: double nullable: true example: 133.01 priceChangeFiveDay: description: The change in price over 5-days type: number format: double nullable: true example: -11.14 priceChangeTwentyDay: description: The change in price over 20-days. type: number format: double nullable: true example: -20.86 priceChangeFiftyDay: description: The change in price over 50-days. type: number format: double nullable: true example: 0.28 priceChangeOneHundredDay: description: The change in price over 100-days. type: number format: double nullable: true example: 7.97 priceChangeTwoHundredDay: description: The change in price over 200-days. type: number format: double nullable: true example: 46.12 priceChangeYTD: description: The change in price since the start of the year. type: number format: double nullable: true example: -10.64 priceChangeOneMonth: description: The change in price over 1 month. type: number format: double nullable: true example: -17.02 priceChangeThreeMonth: description: The change in price over 3 months. type: number format: double nullable: true example: 8.21 priceChangeSixMonth: description: The change in price over 6 months. type: number format: double nullable: true example: -2.32 priceChangeNineMonth: description: The change in price over 9 months. type: number format: double nullable: true example: 42.33 priceChangeFiftyTwoWeek: description: The change in price over 52 weeks. type: number format: double nullable: true example: 43.79 priceChangeTwoYears: description: The change in price over 2 years. type: number format: double nullable: true example: 78.81 percentChangeFiveDay: description: The percentage change in price over 5-days type: number format: double nullable: true example: -8.36 percentChangeTwentyDay: description: The percentage change in price over 20-days. type: number format: double nullable: true example: -14.6 percentChangeFiftyDay: description: The percentage change in price over 50-days. type: number format: double nullable: true example: 0.23 percentChangeOneHundredDay: description: The percentage change in price over 100-days. type: number format: double nullable: true example: 6.98 percentChangeTwoHundredDay: description: The percentage change in price over 200-days. type: number format: double nullable: true example: 60.74 percentChangeYTD: description: The percentage change in price since the start of the year. type: number format: double nullable: true example: -8.01 percentChangeOneMonth: description: The percentage change in price over 1 month. type: number format: double nullable: true example: -12.23 percentChangeThreeMonth: description: The percentage change in price over 3 months. type: number format: double nullable: true example: 7.21 percentChangeSixMonth: description: The percentage change in price over 6 months. type: number format: double nullable: true example: -1.86 percentChangeNineMonth: description: The percentage change in price over 9 months. type: number format: double nullable: true example: 53.1 percentChangeFiftyTwoWeek: description: The percentage change in price over 52 weeks. type: number format: double nullable: true example: 55.96 percentChangeTwoYears: description: The percentage change in price over 2 years. type: number format: double nullable: true example: 182.26 averageVolumeFiveDay: description: The average daily volume calculated over the past 5-days. type: number format: double nullable: true example: 95174617 averageVolumeTwentyDay: description: The average daily volume calculated over the past 20-days. type: number format: double nullable: true example: 95033719 averageVolumeFiftyDay: description: The average daily volume calculated over the past 50-days. type: number format: double nullable: true example: 104940797 averageVolumeOneHundredDay: description: The average daily volume calculated over the past 100-days. type: number format: double nullable: true example: 110668281 averageVolumeTwoHundredDay: description: The average daily volume calculated over the past 200-days. type: number format: double nullable: true example: 135862438 averageVolumeYTD: description: The average daily volume calculated since the start of the year. type: number format: double nullable: true example: 102347750 nineDayRawStochastic: description: A 9-day raw stochastic indicator. type: number format: double nullable: true example: 19.7 fourteenDayRawStochastic: description: A 14-day raw stochastic indicator. type: number format: double nullable: true example: 18.81 twentyDayRawStochastic: description: A 20-day raw stochastic indicator. type: number format: double nullable: true example: 14.15 fiftyDayRawStochastic: description: A 50-day raw stochastic indicator. type: number format: double nullable: true example: 13.73 oneHundredDayRawStochastic: description: A 100-day raw stochastic indicator. type: number format: double nullable: true example: 39.01 nineDayStochasticK: description: A 9-day stochastic %k indicator. type: number format: double nullable: true example: 15.49 fourteenDayStochasticK: description: A 14-day stochastic %k indicator. type: number format: double nullable: true example: 15.19 twentyDayStochasticK: description: A 20-day stochastic %k indicator. type: number format: double nullable: true example: 10.04 fiftyDayStochasticK: description: A 50-day stochastic %k indicator. type: number format: double nullable: true example: 25.39 oneHundredDayStochasticK: description: A 100-day stochastic %k indicator. type: number format: double nullable: true example: 49.39 nineDayStochasticD: description: A 9-day stochastic %d indicator. type: number format: double nullable: true example: 17.44 fourteenDayStochasticD: description: A 14-day stochastic %d indicator. type: number format: double nullable: true example: 16.75 twentyDayStochasticD: description: A 20-day stochastic %d indicator. type: number format: double nullable: true example: 11.1 fiftyDayStochasticD: description: A 50-day stochastic %d indicator. type: number format: double nullable: true example: 33.01 oneHundredDayStochasticD: description: A 100-day stochastic %d indicator. type: number format: double nullable: true example: 55.56 nineDayATR: description: A 9-day average true range indicator. type: number format: double nullable: true example: 3.68 fourteenDayATR: description: A 14-day average true range indicator. type: number format: double nullable: true example: 3.63 twentyDayATR: description: A 20-day average true range indicator. type: number format: double nullable: true example: 3.61 fiftyDayATR: description: A 50-day average true range indicator. type: number format: double nullable: true example: 3.59 oneHundredDayATR: description: A 100-day average true range indicator. type: number format: double nullable: true example: 3.37 twoDayRelativeStrength: description: A 2-day relative strength indicator. type: number format: double nullable: true example: null fiveDayRelativeStrength: description: A 5-day relative strength indicator. type: number format: double nullable: true example: 68.43 nineDayRelativeStrength: description: A 9-day relative strength indicator. type: number format: double nullable: true example: 19.25 fourteenDayRelativeStrength: description: A 14-day relative strength indicator. type: number format: double nullable: true example: 30.16 twentyDayRelativeStrength: description: A 20-day relative strength indicator. type: number format: double nullable: true example: 37.37 fiftyDayRelativeStrength: description: A 50-day relative strength indicator. type: number format: double nullable: true example: 48.51 oneHundredDayRelativeStrength: description: A 100-day relative strength indicator. type: number format: double nullable: true example: 52.37 nineDayPercentR: description: A 9-day percent R indicator type: number format: double nullable: true example: 80.3 fourteenDayPercentR: description: A 14-day percent R indicator type: number format: double nullable: true example: 81.19 twentyDayPercentR: description: A 20-day percent R indicator type: number format: double nullable: true example: 85.85 fiftyDayPercentR: description: A 50-day percent R indicator type: number format: double nullable: true example: 86.27 oneHundredDayPercentR: description: A 100-day percent R indicator type: number format: double nullable: true example: 60.99 nineDayHistoricVolatility: description: The 9-day historic or realized volatility. type: number format: double nullable: true example: 16.43 fourteenDayHistoricVolatility: description: The 14-day historic or realized volatility. type: number format: double nullable: true example: 21.4 twentyDayHistoricVolatility: description: The 20-day historic or realized volatility. type: number format: double nullable: true example: 25.35 thirtyDayHistoricVolatility: description: The 30-day historic or realized volatility. type: number format: double nullable: true example: 29.45 fiftyDayHistoricVolatility: description: The 50-day historic or realized volatility. type: number format: double nullable: true example: 31.54 ninetyDayHistoricVolatility: description: The 90-day historic or realized volatility. type: number format: double nullable: true example: 47.16 oneHundredDayHistoricVolatility: description: The 100-day historic or realized volatility. type: number format: double nullable: true example: 31.73 nineDayMACD: description: The 9-day moving average convergence/divergence indicator. type: number format: double nullable: true example: -4.86 fourteenDayMACD: description: The 14-day moving average convergence/divergence indicator. type: number format: double nullable: true example: -6.78 twentyDayMACD: description: The 20-day moving average convergence/divergence indicator. type: number format: double nullable: true example: -8.12 fiftyDayMACD: description: The 50-day moving average convergence/divergence indicator. type: number format: double nullable: true example: -5.92 oneHundredDayMACD: description: The 100-day moving average convergence/divergence indicator. type: number format: double nullable: true example: 1.28 standardDeviation: description: The standard deviation using the past 20-days of data. type: number format: double nullable: true example: -1.99 percentChangeOneYear: description: The one year return on the ETF type: number format: double nullable: true example: 55.96 percentChangeThreeYear: description: The three year return on the ETF type: number format: double nullable: true example: 186.02 percentChangeFiveYear: description: The five year return on the ETF type: number format: double nullable: true example: 389.27 percentChangeTenYear: description: The ten year return on the ETF type: number format: double nullable: true example: 898.84 pivotPoint: description: Pivot Point type: number format: double nullable: true example: 127.11 firstLevelResistance: description: Pivot Point 1st level resistance. type: number format: double nullable: true example: 128.61 secondLevelResistance: description: Pivot Point 2nd level resistance type: number format: double nullable: true example: 131.23 thirdLevelResistance: description: Pivot Point 3rd level resistance type: number format: double nullable: true example: 132.73 firstLevelSupport: description: Pivot Point 1st level support type: number format: double nullable: true example: 124.49 secondLevelSupport: description: Pivot Point 2nd level support type: number format: double nullable: true example: 122.99 thirdLevelSupport: description: Pivot Point 3rd level support type: number format: double nullable: true example: 120.37 fourWkRetracementHigh: description: 38.2% Fibonacci Retracement from 4 week high. type: number format: double nullable: true example: 134.89 fourWkRetracementLow: description: 38.2% Fibonacci Retracement from 4 week low. type: number format: double nullable: true example: 128.59 fourWkRetracementHighLow: description: 50% Fibonacci Retracement from 4 week high/low. type: number format: double nullable: true example: 131.74 thirteenWkRetracementHigh: description: 38.2% Fibonacci Retracement from 13 week high. type: number format: double nullable: true example: 132.67 thirteenWkRetracementLow: description: 38.2% Fibonacci Retracement from 13 week low. type: number format: double nullable: true example: 125 thirteenWkRetracementHighLow: description: 50% Fibonacci Retracement from 13 week high/low. type: number format: double nullable: true example: 128.84 fiftyTwoWkRetracementHigh: description: 38.2% Fibonacci Retracement from 52 week high. type: number format: double nullable: true example: 109.97 fiftyTwoWkRetracementLow: description: 38.2% Fibonacci Retracement from 52 week low. type: number format: double nullable: true example: 88.27 fiftyTwoWkRetracementHighLow: description: 50% Fibonacci Retracement from 52 week high/low type: number format: double nullable: true example: 99.12 standardDeviationTraditional: description: The standard deviation using the past year of data. type: number format: double nullable: true example: 24.09 gapUp: description: The current session Open is higher than the previous session's High. type: number format: double nullable: true gapUpPercent: description: The current session Open is higher than the previous session's High. type: number format: double nullable: true gapDown: description: The current session Open is lower than the previous session's Low. type: number format: double nullable: true example: -1.84 gapDownPercent: description: The current session Open is lower than the previous session's Low. type: number format: double nullable: true example: -1.46 percentVolume: description: Percentage difference between the current volume and the average volume. type: number format: double nullable: true example: -5.98 relativeStrengthTwoDay: description: N/A type: number format: double nullable: true example: null relativeStrengthFiveDay: description: N/A type: number format: double nullable: true example: null relativeStrengthNineDay: description: N/A type: number format: double nullable: true example: null relativeStrengthFourteenDay: description: N/A type: number format: double nullable: true example: null relativeStrengthTwentyDay: description: N/A type: number format: double nullable: true example: null relativeStrengthFiftyDay: description: N/A type: number format: double nullable: true example: null relativeStrengthOneHundredDay: description: N/A type: number format: double nullable: true example: null averageDailyRangeNineDay: description: N/A type: number format: double nullable: true example: null averageDailyRangeFourteenDay: description: N/A type: number format: double nullable: true example: null averageDailyRangeTwentyDay: description: N/A type: number format: double nullable: true example: null averageDailyRangeFiftyDay: description: N/A type: number format: double nullable: true example: null averageDailyRangeOneHundredDay: description: N/A type: number format: double nullable: true example: null averageDailyRangePercentNineDay: description: N/A type: number format: double nullable: true example: null averageDailyRangePercentFourteenDay: description: N/A type: number format: double nullable: true example: null averageDailyRangePercentTwentyDay: description: N/A type: number format: double nullable: true example: null averageDailyRangePercentFiftyDay: description: N/A type: number format: double nullable: true example: null averageDailyRangePercentOneHundredDay: description: N/A type: number format: double nullable: true example: null averageTrueRangeNineDay: description: N/A type: number format: double nullable: true example: null averageTrueRangeFourteenDay: description: N/A type: number format: double nullable: true example: null averageTrueRangeTwentyDay: description: N/A type: number format: double nullable: true example: null averageTrueRangeFiftyDay: description: N/A type: number format: double nullable: true example: null averageTrueRangeOneHundredDay: description: N/A type: number format: double nullable: true example: null averageTrueRangePercentNineDay: description: N/A type: number format: double nullable: true example: null averageTrueRangePercentFourteenDay: description: N/A type: number format: double nullable: true example: null averageTrueRangePercentTwentyDay: description: N/A type: number format: double nullable: true example: null averageTrueRangePercentFiftyDay: description: N/A type: number format: double nullable: true example: null averageTrueRangePercentOneHundredDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageFiveDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageTenDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageTwentyDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageFiftyDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageOneHundredDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageOneHundredFiftyDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageTwoHundredDay: description: N/A type: number format: double nullable: true example: null slopeMovingAverageYTD: description: N/A type: number format: double nullable: true example: null slopeMovingAverageOneMonth: description: N/A type: number format: double nullable: true example: null slopeMovingAverageThreeMonths: description: N/A type: number format: double nullable: true example: null slopeMovingAverageSixMonths: description: N/A type: number format: double nullable: true example: null slopeMovingAverageNineMonths: description: N/A type: number format: double nullable: true example: null slopeMovingAverageOneYear: description: N/A type: number format: double nullable: true example: null slopeMovingAverageTwoYears: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageFiveDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageTenDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageTwentyDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageFiftyDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageOneHundredDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageOneHundredFiftyDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageTwoHundredDay: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageYTD: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageOneMonth: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageThreeMonths: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageSixMonths: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageNineMonths: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageOneYear: description: N/A type: number format: double nullable: true example: null slopeExponentialMovingAverageTwoYears: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageFiveDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageTenDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageTwentyDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageFiftyDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageOneHundredDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageOneHundredFiftyDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageTwoHundredDay: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageYTD: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageOneMonth: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageThreeMonths: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageSixMonths: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageNineMonths: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageOneYear: description: N/A type: number format: double nullable: true example: null percentFromMovingAverageTwoYears: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageFiveDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageTenDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageTwentyDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageFiftyDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageOneHundredDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageOneHundredFiftyDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageTwoHundredDay: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageYTD: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageOneMonth: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageThreeMonths: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageSixMonths: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageNineMonths: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageOneYear: description: N/A type: number format: double nullable: true example: null exponentialMovingAverageTwoYears: description: N/A type: number format: double nullable: true example: null relativeVolumeFiveDay: description: N/A type: number format: double nullable: true example: null relativeVolumeTenDay: description: N/A type: number format: double nullable: true example: null relativeVolumeTwentyDay: description: N/A type: number format: double nullable: true example: null relativeVolumeFiftyDay: description: N/A type: number format: double nullable: true example: null relativeVolumeOneHundredDay: description: N/A type: number format: double nullable: true example: null relativeVolumeOneHundredFiftyDay: description: N/A type: number format: double nullable: true example: null relativeVolumeTwoHundredDay: description: N/A type: number format: double nullable: true example: null relativeVolumeYTD: description: N/A type: number format: double nullable: true example: null relativeVolumeOneMonth: description: N/A type: number format: double nullable: true example: null relativeVolumeThreeMonths: description: N/A type: number format: double nullable: true example: null relativeVolumeSixMonths: description: N/A type: number format: double nullable: true example: null relativeVolumeNineMonths: description: N/A type: number format: double nullable: true example: null relativeVolumeOneYear: description: N/A type: number format: double nullable: true example: null relativeVolumeTwoYears: description: N/A type: number format: double nullable: true example: null bollingerBandPercentTwentyDay: description: N/A type: number format: double nullable: true example: null bollingerBandRankTwentyDay: description: N/A type: number format: double nullable: true example: null keltnerBandPercentTwentyDay: description: N/A type: number format: double nullable: true example: null keltnerBandRankTwentyDay: description: N/A type: number format: double nullable: true example: null closeLowRange: description: N/A type: number format: double nullable: true example: null range: description: N/A type: number format: double nullable: true example: null rangeHighLowPercent: description: N/A type: number format: double nullable: true example: null rangeOpenClosePercent: description: N/A type: number format: double nullable: true example: null highLowDifference: description: N/A type: number format: double nullable: true example: null relativeStrengthIndexRank: description: N/A type: number format: double nullable: true example: null required: - symbol - movingAverageFiveDay - movingAverageTenDay - movingAverageTwentyDay - movingAverageFiftyDay - standardDeviation '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSignal.json: get: tags: - Charts and Analytics summary: getSignal operationId: get-getSignal description: The getSignal API provides the Barchart Technical Opinion / Signal (buy, sell or hold) based on a variety of short, medium and long-term technical indicators based on a symbol. 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 for the active contract or for the first nearby is supported, as is for all futures contracts for a given root symbol, as is 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: 'trendspotterOpinion,adi7DayOpinion,parabolic50DaySignal' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 10 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 nullable: true example: 'AAPL' name: description: The full name of the instrument. type: string nullable: true example: 'Apple Inc' trendspotterOpinion: description: The Trend Seeker® (composite indicator) buy, sell or hold opinion. type: string nullable: true example: 'Sell' trendspotterStrength: description: The Trend Seeker® Strength type: string nullable: true example: 'Maximum' trendspotterDirection: description: The Trend Seeker® Direction type: string nullable: true example: 'Strongest' adx7DayOpinion: description: 7-day Average Directional Indicator (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' adx7DayStrength: description: 7-Day Average Strengthal Indicator Strength type: string nullable: true example: 'Maximum' adx7DayDirection: description: 7 Day Average Directional Indicator Direction type: string nullable: true example: 'Strongest' maHiLo10_8DayOpinion: description: 10 - 8 Day Moving Average Hilo Channel (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' maHiLo10_8DayStrength: description: 10 - 8 Day Moving Average Hilo Channel Strength type: string nullable: true example: 'Strong' maHiLo10_8DayDirection: description: 10 - 8 Day Moving Average Hilo Channel Direction type: string nullable: true example: 'Strongest' ma20DaySignal: description: 20-Day Moving Average vs Price Indicator (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' ma20DayStrength: description: 20-Day Moving Average vs Price Strength type: string nullable: true example: 'Maximum' ma20DayDirection: description: 20-Day Moving Average vs Price Direction type: string nullable: true example: 'Strongest' macd20_50DaySignal: description: 20-50 Day MACD Oscillator (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd20_50DayStrength: description: 20-50 Day MACD Oscillator Strength type: string nullable: true example: 'Soft' macd20_50DayDirection: description: 20-50 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' macd20_200DaySignal: description: 20-200 Day MACD Oscillator (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd20_200DayStrength: description: 20-200 Day MACD Oscillator Strength type: string nullable: true example: 'Average' macd20_200DayDirection: description: 20-200 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' bbands20DaySignal: description: 20-Day Bollinger Bands (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' bbands20DayStrength: description: 20-Day Bollinger Bands Strength type: string nullable: true example: 'Strong' bbands20DayDirection: description: 20-Day Bollinger Bands Direction type: string nullable: true example: 'Weakening' shortTermAverageSignal: description: Average signal based on all short-term indicators. type: string nullable: true example: 'Buy' shortTermAveragePercent: description: The percentage / weight of the average signal. type: integer nullable: true example: 50 cci40DaySignal: description: 40-Day Commodity Channel Index (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' cci40DayStrength: description: 40-Day Commodity Channel Index Strength type: string nullable: true example: 'Maximum' cci40DayDirection: description: 40-Day Commodity Channel Index Direction type: string nullable: true example: 'Weakening' ma50DaySignal: description: 50-Day Moving Average vs Price (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' ma50DayStrength: description: 50-Day Moving Average vs Price Strength type: string nullable: true example: 'Average' ma50DayDirection: description: 50-Day Moving Average vs Price Direction type: string nullable: true example: 'Strongest' macd20_100DaySignal: description: 20 - 100 Day MACD Oscillator (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd20_100DayStrength: description: 20 - 100 Day MACD Oscillator Strength type: string nullable: true example: 'Strong' macd20_100DayDirection: description: 20 - 100 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' macd50_150DaySignal: description: 50 - 150 Day MACD Oscillator (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd50_150DayStrength: description: 50 - 150 Day MACD Oscillator Strength type: string nullable: true example: 'Average' macd50_150DayDirection: description: 50 - 150 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' macd50_200DaySignal: description: 50 - 200 Day MACD Oscillator (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd50_200DayStrength: description: 50 - 200 Day MACD Oscillator Strength type: string nullable: true example: 'Strong' macd50_200DayDirection: description: 50 - 200 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' parabolic50DaySignal: description: 50-Day Parabolic Time/Price (medium-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' parabolic50DayStrength: description: 50-Day Parabolic Time/Price Strength type: string nullable: true example: 'Maximum' parabolic50DayDirection: description: 50-Day Parabolic Time/Price Direction type: string nullable: true example: 'Strongest' mediumTermAverageSignal: description: Average signal based on all medium-term indicators. type: string nullable: true example: 'Buy' mediumTermAveragePercent: description: The percentage / weight of the average signal. type: integer nullable: true example: 50 cci60DaySignal: description: 60-Day Commodity Channel Index (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' cci60DayStrength: description: 60-Day Commodity Channel Index Strength type: string nullable: true example: 'Weak' cci60DayDirection: description: 60-Day Commodity Channel Index Direction type: string nullable: true example: 'Weakest' ma100DaySignal: description: 100-Day Moving Average vs Price (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' ma100DayStrength: description: 100-Day Moving Average vs Price Strength type: string nullable: true example: 'Weak' ma100DayDirection: description: 100-Day Moving Average vs Price Direction type: string nullable: true example: 'Strongest' ma150DaySignal: description: 150-Day Moving Average vs Price (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' ma150DayStrength: description: 150-Day Moving Average vs Price Strength type: string nullable: true example: 'Weak' ma150DayDirection: description: 150-Day Moving Average vs Price Direction type: string nullable: true example: 'Weakest' ma200DaySignal: description: 200-Day Moving Average vs Price (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' ma200DayStrength: description: 200-Day Moving Average vs Price Strength type: string nullable: true example: 'Weak' ma200DayDirection: description: 200-Day Moving Average vs Price Direction type: string nullable: true example: 'Weakest' macd50_100DaySignal: description: 50 - 100 Day MACD Oscillator (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd50_100DayStrength: description: 50 - 100 Day MACD Oscillator Strength type: string nullable: true example: 'Average' macd50_100DayDirection: description: 50 - 100 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' macd100_200DaySignal: description: 100 - 200 Day MACD Oscillator (long-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Buy' macd100_200DayStrength: description: 100 - 200 Day MACD Oscillator Strength type: string nullable: true example: 'Strong' macd100_200DayDirection: description: 100 - 200 Day MACD Oscillator Direction type: string nullable: true example: 'Weakest' longTermAverageSignal: description: Average signal based on all long-term indicators. type: string nullable: true example: 'Buy' longTermAveragePercent: description: The percentage / weight of the average signal. type: integer nullable: true example: 50 overallAverageSignal: description: Average signal based on all indicators. type: string nullable: true example: 'Buy' overallAveragePercent: description: The percentage / weight of the average signal. type: integer nullable: true example: 40 overallAverageStrength: description: Average strength based on all indicators. type: string nullable: true example: 'Weak' overallAverageDirection: description: Average direction based on all indicators. type: string nullable: true example: 'Weakest' previousDaySignal: description: Signal based on previous business day's performance. type: string nullable: true example: 'Buy' previousDayPercent: description: The percentage / weight of previous business day's signal. type: integer nullable: true example: 56 lastWeekSignal: description: Average signal based on last week's performance. type: string nullable: true example: 'Buy' lastWeekPercent: description: The percentage / weight of last week's signal. type: integer nullable: true example: 80 lastMonthSignal: description: Average signal based on last month's performance. type: string nullable: true example: 'Buy' lastMonthPercent: description: The percentage / weight of last month's signal. type: integer nullable: true example: 100 trendspotterNewSignal: description: Indicates that the symbol made a NEW Trend Seeker® signal today. type: string nullable: true example: null adx7DayNewSignal: description: 7-Day Average Directional Indicator. type: string nullable: true example: null maHiLo10_8DayNewSignal: description: 10-8-Day Moving Average Hilo ChannelÑŽ type: string nullable: true example: null ma20DayNewSignal: description: 20-Day Moving Average Versus Price. type: string nullable: true example: null macd20_50DayNewSignal: description: 20-50-Day MACD Oscillator. type: string nullable: true example: null bbands20DayNewSignal: description: 20-Day Bollinger Bands. type: string nullable: true example: null cci40DayNewSignal: description: 40-Day Commodity Channel Index. type: string nullable: true example: null ma50DayNewSignal: description: 50-Day Moving Average Versus Price. type: string nullable: true example: null macd20_100DayNewSignal: description: 20-100-Day MACD Oscillator. type: string nullable: true example: null parabolic50DayNewSignal: description: 50-Day Parabolic Time / Price. type: string nullable: true example: null cci60DayNewSignal: description: 60-Day Commodity Channel Index. type: string nullable: true example: 'Sell' ma100DayNewSignal: description: 100-Day Moving Average Versus Price. type: string nullable: true example: 'Sell' macd50_100DayNewSignal: description: 50-100 Day MACD Oscillator. type: string nullable: true example: null macd20_200DayNewSignal: description: 20-200-Day MACD Oscillator. type: string nullable: true example: null macd50_150DayNewSignal: description: 50-150-Day MACD Oscillator. type: string nullable: true example: null macd50_200DayNewSignal: description: 50-200-Day MACD Oscillator. type: string nullable: true example: null ma150DayNewSignal: description: 150-Day Moving Average Versus Price. type: string nullable: true example: null ma200DayNewSignal: description: 200-Day Moving Average Versus Price. type: string nullable: true example: null macd100_200DayNewSignal: description: 100-200-Day MACD Oscillator. type: string nullable: true example: null macd9_18DaySignal: description: 9-18 Day MACD Oscillator (short-term indicator) buy, sell or hold signal. type: string nullable: true example: 'Sell' macd9_18DayStrength: description: 9-18 Day MACD Oscillator Strength. type: string nullable: true example: 'Soft' macd9_18DayDirection: description: 9-18 Day MACD Oscillator Direction. type: string nullable: true example: 'Strongest' macd9_18DayNewSignal: description: 9-18 Day Mov Avg. type: string nullable: true example: null macd12_26_9DayStrength: description: The strength of the signal compared to its historical performance where Maximum is the strongest this signal has been and Minimum is the weakest. type: string nullable: true example: 'Maximum' macd12_26_9DayDirection: description: Indicates whether the Buy or Sell signal is strengthening or weakening or whether a Hold signal is heading towards a buy or sell signal. type: string nullable: true example: 'Strongest' macd12_26_9DaySignal: description: The signal from the 12-26-9 Day eMACD, which uses a Exponential Moving Averages in its calculation. type: string nullable: true example: 'Sell' macd12_26_9DayNewSignal: description: Indicates that the symbol made a NEW 12-26-9 Day eMACD signal today. type: string nullable: true example: null required: - symbol - name - trendspotterStrength - trendspotterDirection - shortTermAverageSignal - shortTermAveragePercent - mediumTermAverageSignal - mediumTermAveragePercent - longTermAverageSignal - longTermAveragePercent - overallAverageSignal - overallAveragePercent - overallAverageStrength - overallAverageDirection - previousDaySignal - previousDayPercent - lastWeekSignal - lastWeekPercent - lastMonthSignal - lastMonthPercent '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getMomentum.json: get: tags: - Charts and Analytics summary: getMomentum operationId: get-getMomentum description: The getMomentum API provides a daily summary on the number of advancing, declining and unchanged stocks, as well as the percentage of stocks above moving averages of different lengths. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: country description: A country code identifying a group of stocks listed in a country. required: false schema: type: string example: 'US' - in: query name: exchanges description: The code for the exchange a group of financial instruments are listed on. required: false schema: type: string example: 'NASDAQ' 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: country: description: A country code identifying a group of stocks listed in a country. type: string nullable: true example: 'US' advancesToday: description: The total number of advancing stocks for the current day. type: integer nullable: true example: 1085 advancesYesterday: description: The total number of advancing stocks for yesterday. type: integer nullable: true example: 2285 advancesLastWeek: description: The total number of advancing stocks last week. type: integer nullable: true example: 2943 advancesLastMonth: description: The total number of advancing stocks last month. type: integer nullable: true example: 3067 unchgToday: description: The total number of unchanged stocks for the current day. type: integer nullable: true example: 40 unchgYesterday: description: The total number of unchanged stocks for yesterday. type: integer nullable: true example: 80 unchgLastWeek: description: The total number of unchanged stocks last week. type: integer nullable: true example: 275 unchgLastMonth: description: The total number of unchanged stocks last month. type: integer nullable: true example: 192 declinesToday: description: The total number of declining stocks for the current day. type: integer nullable: true example: 4022 declinesYesterday: description: The total number of declining stocks for yesterday. type: integer nullable: true example: 2806 declinesLastWeek: description: The total number of declining stocks last week. type: integer nullable: true example: 1569 declinesLastMonth: description: The total number of declining stocks last month. type: integer nullable: true example: 1548 percentAbove20dMAtoday: description: The percentage of stocks above their 20-day moving average for the current day. type: number format: double nullable: true example: 54 percentAbove20dMAyesterday: description: The percentage of stocks above their 20-day moving average yesterday. type: number format: double nullable: true example: 67.01 percentAbove20dMALastWeek: description: The percentage of stocks above their 20-day moving average last week. type: number format: double nullable: true example: 63.43 percentAbove20dMALastMonth: description: The percentage of stocks above their 20-day moving average last month. type: number format: double nullable: true example: 44.45 percentAbove50dMAtoday: description: The percentage of stocks above their 50-day moving average for the current day. type: number format: double nullable: true example: 69.66 percentAbove50dMAyesterday: description: The percentage of stocks above their 50-day moving average yesterday. type: number format: double nullable: true example: 77.53 percentAbove50dMALastWeek: description: The percentage of stocks above their 50-day moving average last week. type: number format: double nullable: true example: 56.11 percentAbove50dMALastMonth: description: The percentage of stocks above their 50-day moving average last month. type: number format: double nullable: true example: 50.09 percentAbove100dMAtoday: description: The percentage of stocks above their 100-day moving average for the current day. type: number format: double nullable: true example: 82.56 percentAbove100dMAyesterday: description: The percentage of stocks above their 100-day moving average yesterday. type: number format: double nullable: true example: 86.1 percentAbove100dMALastWeek: description: The percentage of stocks above their 100-day moving average last week. type: number format: double nullable: true example: 60.12 percentAbove100dMALastMonth: description: The percentage of stocks above their 100-day moving average last month. type: number format: double nullable: true example: 58.25 percentAbove150dMAtoday: description: The percentage of stocks above their 150-day moving average for the current day. type: number format: double nullable: true example: 85.61 percentAbove150dMAyesterday: description: The percentage of stocks above their 150-day moving average yesterday. type: number format: double nullable: true example: 87.91 percentAbove150dMALastWeek: description: The percentage of stocks above their 150-day moving average last week. type: number format: double nullable: true example: 60.66 percentAbove150dMALastMonth: description: The percentage of stocks above their 150-day moving average last month. type: number format: double nullable: true example: 57.98 percentAbove200dMAtoday: description: The percentage of stocks above their 200-day moving average for the current day. type: number format: double nullable: true example: 86.25 percentAbove200dMAyesterday: description: The percentage of stocks above their 200-day moving average yesterday. type: number format: double nullable: true example: 88.85 percentAbove200dMALastWeek: description: The percentage of stocks above their 200-day moving average last week. type: number format: double nullable: true example: 60.49 percentAbove200dMALastMonth: description: The percentage of stocks above their 200-day moving average last month. type: number format: double nullable: true example: 58.05 exchange: description: The code for the exchange a group of financial instruments are listed on. type: string nullable: true example: 'NASDAQ' advancingIssues: description: The total number of advancing issues for the current day. type: integer nullable: true example: 505 decliningIssues: description: The total number of declining issues for the current day. type: integer nullable: true example: 2426 unchangedIssues: description: The total number of unchanged issues for the current day. type: integer nullable: true example: 24 advancingIssuesPct: description: The percentage of advancing issues for the current day. type: number format: double nullable: true example: 17.09 decliningIssuesPct: description: The percentage of declining issues for the current day. type: number format: double nullable: true example: 82.1 unchangedIssuesPct: description: The percentage of unchanged issues for the current day. type: number format: double nullable: true example: 0.81 advancingShares: description: The total number of advancing shares for the current day. type: integer nullable: true example: 428 decliningShares: description: The total number of declining shares for the current day. type: integer nullable: true example: 2862 unchangedShares: description: The total number of unchanged shares for the current day. type: integer nullable: true example: 6 newHighs: description: The number of new 52-week highs for the current day. type: integer nullable: true example: 101 newLows: description: The number of new 52-week highs for the current day. type: integer nullable: true example: 9 required: - country - advancesToday - advancesYesterday - advancesLastWeek - advancesLastMonth - unchgToday - unchgYesterday - unchgLastWeek - unchgLastMonth - declinesToday - declinesYesterday - declinesLastWeek - declinesLastMonth - percentAbove20dMAtoday - percentAbove20dMAyesterday - percentAbove20dMALastWeek - percentAbove20dMALastMonth - percentAbove50dMAtoday - percentAbove50dMAyesterday - percentAbove50dMALastWeek - percentAbove50dMALastMonth - percentAbove100dMAtoday - percentAbove100dMAyesterday - percentAbove100dMALastWeek - percentAbove100dMALastMonth - percentAbove150dMAtoday - percentAbove150dMAyesterday - percentAbove150dMALastWeek - percentAbove150dMALastMonth - percentAbove200dMAtoday - percentAbove200dMAyesterday - percentAbove200dMALastWeek - percentAbove200dMALastMonth '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getTechnicalIndicatorData.json: get: tags: - Charts and Analytics summary: getTechnicalIndicatorData operationId: get-getTechnicalIndicatorData description: The getTechnicalIndicatorData API from Barchart OnDemand provides the requested technical indicators data for the requested symbol. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: requestType description: The type of response requested from the API. getStudies will return the list of all available indicators with their input sources, periodicity, offset, and meta information. getStudy will return the data for the requested indicator. required: true schema: type: string enum: - 'getStudies' - 'getStudy' example: 'getStudy' - in: query name: symbol description: A symbol or code that identifies a financial instrument. required: true schema: type: string example: 'AAPL' - in: query name: studyId description: A valid indicator code that identifies a technical indicator when the argument is passed to getStudies. required: true schema: type: string example: 'MA' - in: query name: startDate description: The start date for which the indicator records should be returned. required: false schema: type: string format: date example: '2026-06-22' - in: query name: endDate description: The end date for which the indicator records should be returned. required: false schema: type: string format: date example: '2026-07-22' - in: query name: unit description: This parameter specifies whether the data to be returned should be tick, minutes (intraday), day (daily), weekly, monthly, quarterly, or yearly. required: true schema: type: string enum: - 'tick' - 'intraday' - 'day' - 'week' - 'month' - 'quarter' - 'year' - in: query name: numberOfBars description: The maximum number of records requested over the requested date range. required: false schema: type: integer example: 100 - in: query name: inputs description: You can pass any valid input values for the selected study that are not always returned via this parameter. For example, for Moving Average (MA), you can pass values as - inputs[Period]=50&inputs[Source]=Open&inputs[Offset]=1. For an input field of type enumeration, please ensure you pass a value from the provided list of values. required: false schema: type: string - in: query name: fields description: | Pass any optional price fields you would like to be included in the response.
Available values (multiple values separated by a comma may be used): *open, high, low, close, volume, open_interest*. required: false schema: type: string example: 'open,high' - in: query name: spec description: This parameter is used to specify whether the data should be plain, nearest or continuation records. Nearest and continuation are ignored for equities, and if specified the query will simply return plain records. required: false schema: type: string enum: - 'none' - 'nearest' - 'continue' - 'per_count' - 'per_volume' - 'per_range' - 'per_seconds' - 'top_of_book' - in: query name: size description: N/A required: false schema: type: integer example: 1 - in: query name: isContractVolume description: For futures, this parameter determines whether the returned volume should be the contract volume or the total volume. By default, it returns the total volume. required: false schema: type: string example: 'true' - in: query name: dividendsAdjust description: Turns on/off dividends adjustment for stock data. By default it is off. required: false schema: type: string example: 'true' - in: query name: backAdjust description: This parameter specifies whether the contracts in the series will be adjusted based on the roll-gap between the closing prices of the current contract and the previous contract on the day of the switch. Valid values are true and false. If not specified, the default value is false resulting in a non-adjusted query. Adjustments are reflected starting from the current date, regardless if an end date is set or not. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: string example: 'true' - in: query name: daysToExpiration description: This parameter specifies the number of calendar days prior to a contract expiration when the series of contracts will be switched to the next contract in the series. Valid values are 0 through 60. A value of 0 will tell the system to use the day of expiration. If not specified, the default value (1) is used, resulting in each contract in the series to run until (and including) the day prior to its expiration. This parameter only applies to multi-contract futures queries and is ignored for all other queries. required: false schema: type: integer example: 1 - in: query name: contractRoll description: For futures, this parameter determines the switch from one contract to the next in the series is calculated. When the value specified is 'expiration', the switch from one contract to the next in the series will be based on the expiration date (and the value of the 'daystoexpiration' parameter if specified). When the value specified is 'combined', a combination of volume and openinterest will be used to determine when to switch from one contract to the next in the series (when using this value, the 'daystoexpiration' parameter is ignored). required: false schema: type: string enum: - 'combined' - 'expiration' - in: query name: decimalPrecision description: The decimal precision to be applied to the requested study fields in the response. required: false schema: type: string enum: - 'auto' - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - in: query name: interval description: To aggregate sets of contiguous minute records (the number of minute records in each set is equal to the specified interval) into one record. required: false schema: type: integer example: 5 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 nullable: true example: 'AAPL' data: description: Returns timestamped values for each indicator. nullable: true required: - symbol - data '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getETFDetails.json: get: tags: - ETFs summary: getETFDetails operationId: get-getETFDetails description: Barchart OnDemand's getETFDetails API provides ETF profile information including descriptions, fund family, underlying index, inception date, alpha, beta, shares outstanding, management fee, assets under management, top 10 holdings and more. 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 valid equity symbol. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'SPY' - in: query name: categories description: A valid asset class value. Multiple asset classes separated by a comma may be used. required: false schema: type: string example: 'Equity' - in: query name: subCategories description: A valid sub-category (classification) value. Multiple values separated by a comma may be used. required: false schema: type: string example: 'Global' 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. Multiple symbols separated by a comma may be used. type: string nullable: true example: 'SPY' name: description: The name of the ETF. type: string nullable: true example: 'SPDR S\u0026P 500 ETF' fundFamily: description: The family of funds the ETF belongs to type: string nullable: true example: 'State Street Global Advisors' underlyingIndex: description: The underlying index the ETF belongs to type: string nullable: true example: 'S\u0026P 500 Index' description: description: An overview of the ETF type: string nullable: true example: 'The SPDR SP 500 ETF Trust seeks to provide investment results that, before expenses, correspond generally to the price and yield performance of the SP 500 Index.' assetClass: description: The type of assets the ETF invests in type: string nullable: true example: 'Equity' classification: description: The classification for the ETF. type: object properties: region: type: string example: North America country: type: string example: US sector: type: string example: Multi-Sector equity_index: type: string example: S\u0026P 500 leveraged_family: type: string example: SPY nullable: true sector: description: Sectors the ETF is part of type: string nullable: true example: 'Large Cap' inceptionDate: description: The launch date of the ETF type: string format: date nullable: true example: '1993-01-22' firstTradeDate: description: The first day the ETF traded type: string format: date nullable: true example: '1993-01-29' leverage: description: The leverage strategy of the ETF type: string nullable: true example: 'Long' alpha: description: The alpha of the ETF type: number format: double nullable: true example: -0.04 beta: description: The beta of the ETF type: number format: double nullable: true example: 0.99 standardDeviation: description: The standard deviation of the ETF type: number format: double nullable: true example: 33.41 sharesOutstanding: description: The number of shares outstanding type: number format: double nullable: true example: 869082.1 managedAssets: description: The amount of assets invested in the ETF type: number format: double nullable: true example: 336308704 netAssetValue: description: The net assets value of the ETF type: number format: double nullable: true example: 386.97 lastNAVUpdateDate: description: The date net asset value was last updated. type: string format: date nullable: true example: '2026-01-22' firstTradePrice: description: The first traded price of the ETF type: number format: double nullable: true example: 43.97 peRatio: description: The p/e ratio of the ETF type: number format: double nullable: true example: 23.79 managementFee: description: The management fee of the ETF type: number format: double nullable: true example: 0.09 options: description: If options are listed on the ETF type: string nullable: true example: 'Yes' latestDividend: description: The latest dividend amount of the ETF type: number format: double nullable: true example: 1.58 dividendDate: description: The date of the latest dividend for the ETF type: string format: date nullable: true example: '2020-12-18' annualDividend: description: The amount of the annual dividend for the ETF type: number format: double nullable: true example: 5.69 annualDividendYield: description: The annual dividend yield of the ETF type: number format: double nullable: true example: 1.47 latestSplit: description: The latest split ratio for the ETF type: string nullable: true example: null splitDate: description: The date of the latest split type: string format: date nullable: true example: null ytdReturn: description: The year-to-date return on the ETF type: number format: double nullable: true example: 2.64 OneyearReturn: description: The one year return on the ETF type: number format: double nullable: true example: 15.08 ThreeyearReturn: description: The three year return on the ETF type: number format: double nullable: true example: 43.83 FiveyearReturn: description: The five year return on the ETF type: number format: double nullable: true example: 93.1 TenyearReturn: description: The ten year return on the ETF type: number format: double nullable: true example: 190.67 totalHoldings: description: Total number of holdings for the given symbol. type: integer nullable: true example: 16 topHoldings1: description: The symbol for the number one holding type: string nullable: true example: 'AAPL' topHoldings1Name: description: The name of the holding type: string nullable: true example: 'Apple Inc.' topHoldings1Percent: description: The percent of holdings type: number format: double nullable: true example: 6.29 topHoldings2: description: The symbol for the number two holding type: string nullable: true example: 'MSFT' topHoldings2Name: description: The name of the holding type: string nullable: true example: 'Microsoft Corporation' topHoldings2Percent: description: The percent of holdings type: number format: double nullable: true example: 5.52 topHoldings3: description: The symbol for the number three holding type: string nullable: true example: 'AMZN' topHoldings3Name: description: The name of the holding type: string nullable: true example: 'Amazon.com Inc.' topHoldings3Percent: description: The percent of holdings type: number format: double nullable: true example: 4.2 topHoldings4: description: The symbol for the number four holding type: string nullable: true example: 'FB' topHoldings4Name: description: The name of the holding type: string nullable: true example: 'Facebook Inc. Class A' topHoldings4Percent: description: The percent of holdings type: number format: double nullable: true example: 1.91 topHoldings5: description: The symbol for the number five holding type: string nullable: true example: 'GOOGL' topHoldings5Name: description: The name of the holding type: string nullable: true example: 'Alphabet Inc. Class A' topHoldings5Percent: description: The percent of holdings type: number format: double nullable: true example: 1.9 topHoldings6: description: The symbol for the number six holding type: string nullable: true example: 'GOOG' topHoldings6Name: description: The name of the holding type: string nullable: true example: 'Alphabet Inc. Class C' topHoldings6Percent: description: The percent of holdings type: number format: double nullable: true example: 1.85 topHoldings7: description: The symbol for the number seven holding type: string nullable: true example: 'TSLA' topHoldings7Name: description: The name of the holding type: string nullable: true example: 'Tesla Inc' topHoldings7Percent: description: The percent of holdings type: number format: double nullable: true example: 1.8 topHoldings8: description: The symbol for number eight holding type: string nullable: true example: 'BRK.B' topHoldings8Name: description: The name of the holding type: string nullable: true example: 'Berkshire Hathaway Inc. Class B' topHoldings8Percent: description: The percent of holdings type: number format: double nullable: true example: 1.43 topHoldings9: description: The symbol for the number nine holding type: string nullable: true example: 'JPM' topHoldings9Name: description: The name of the holding type: string nullable: true example: 'JPMorgan Chase \u0026 Co.' topHoldings9Percent: description: The percent of holdings type: number format: double nullable: true example: 1.37 topHoldings10: description: The symbol for number ten holding type: string nullable: true example: 'JNJ' topHoldings10Name: description: The name of the holding type: string nullable: true example: 'Johnson \u0026 Johnson' topHoldings10Percent: description: The percent of holdings type: number format: double nullable: true example: 1.3 required: - symbol - name - fundFamily - underlyingIndex - description - assetClass - classification - sector - inceptionDate - firstTradeDate - leverage - alpha - beta - standardDeviation - sharesOutstanding - managedAssets - netAssetValue - lastNAVUpdateDate - firstTradePrice - peRatio - managementFee - options - latestDividend - dividendDate - annualDividend - annualDividendYield - latestSplit - splitDate - ytdReturn - OneyearReturn - ThreeyearReturn - FiveyearReturn - TenyearReturn - totalHoldings - topHoldings1 - topHoldings1Name - topHoldings1Percent - topHoldings2 - topHoldings2Name - topHoldings2Percent - topHoldings3 - topHoldings3Name - topHoldings3Percent - topHoldings4 - topHoldings4Name - topHoldings4Percent - topHoldings5 - topHoldings5Name - topHoldings5Percent - topHoldings6 - topHoldings6Name - topHoldings6Percent - topHoldings7 - topHoldings7Name - topHoldings7Percent - topHoldings8 - topHoldings8Name - topHoldings8Percent - topHoldings9 - topHoldings9Name - topHoldings9Percent - topHoldings10 - topHoldings10Name - topHoldings10Percent '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getETFConstituents.json: get: tags: - ETFs summary: getETFConstituents operationId: get-getETFConstituents description: The getETFConstituents API from Barchart OnDemand provides the complete list of constituents for a given ETF. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A valid ETF symbol. required: true schema: type: string example: 'SPY' 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: The symbol of the constituent instrument. type: string nullable: true example: 'AAPL' name: description: The name of the constituent instrument. type: string nullable: true example: 'Apple Inc' holdingsPercent: description: The percent of holdings. type: number format: double nullable: true example: 6.51 sharesHeld: description: Number of shares held. type: integer nullable: true example: 162992320 exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NASDAQ' required: - symbol - name - holdingsPercent - sharesHeld - exchange '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getNews.json: get: tags: - News and Filings summary: getNews operationId: get-getNews description: Barchart OnDemand's getNews API returns news headlines, articles and related photos based upon news sources, category, sub-category and/or keyword. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: sources description: | The news feed code.
Available values (multiple values separated by a comma may be used): *AP, APAI, BC, BCNEWS, CP, CNW, CRB, CMTX, CMTX:PCS, CMTX:PCC, CMTX:SEC, IF, USDA, PRNW, ZACKS, BRUG, AGWEB, SETZ, SPC, NASS, ESTMZ, DVND, LME-WHS, DLFRX, GLDRPT, COT, MAX, CMDTY_AGLITE, CMDTY_AG, CMDTY_ENERGY, BCCONT, SYNDTGAM, FCTGAM, BCSYND, HDLNE, HDLNEG, HDLNEP, BARCHART_PT, DJ*. required: false schema: type: string example: 'AP,IF' - in: query name: symbols description: A symbol or code that identifies a financial instrument. required: false schema: type: string example: 'AMZN,GOOG,AAPL' - in: query name: category description: A grouping of related news content. required: false schema: type: string enum: - 'companies' - 'politics' - 'geography' - 'futures' - 'economics' - 'stocks' example: 'stocks' - in: query name: subCategory description: A more specific category of related news content. required: false schema: type: string enum: - 'private companies' - ' stock equities' - 'stock trading' - 'stock options' - 'regulatory' - 'corporate events' - 'analyst ratings' - 'industries' - 'mergers & acquisitions' - 'employees' - 'financials' - 'consumer discretionary' - 'health care' - 'private equity' - 'management' - 'technology' - 'financing' - 'partnership' - 'shareholder voting' - 'media & telecom' - 'ipo' - 'industrials' - 'energy' - 'earnings' - 'technical analysis' - 'real estate' - 'insider transaction' - 'utilities' - 'consumer staples' - 'dividends' - 'analyst downgrade' - 'bankruptcies & insolvencies' - 'venture capital' - 'analyst upgrade' - 'materials' - 'elections' - 'law' - 'taxes' - 'iraq' - 'asia' - 's. korea' - 'spain' - 'russia' - 'china' - 'philippines' - 'chile' - 'peru' - 'united states' - 'australia' - 'bolivia' - 'united kingdom' - 'europe' - 'canada' - 'japan' - 'mexico' - 'germany' - 'france' - 'brazil' - 'new zealand' - 'singapore' - 'cuba' - 'argentina' - 'en' - 'equity index' - 'agriculture' - 'grain' - 'futures education' - 'options on futures' - 'futures exchange' - 'food & beverage' - 'interest rates' - 'cryptocurrencies' - 'top news' - 'lumber' - 'forex' - 'weather' - 'metals' - 'fruits & vegetables' - 'softs' - 'livestock' - 'ethanol' - 'soybean' - 'coffee' - 'canola' - 'renewable energy' - 'hogs' - 'rubber' - 'e-waste' - 'lamb' - 'batteries' - 'nuts' - 'gold' - 'ferrous metals' - 'rice' - 'sugar' - 'fruits' - 'cocoa' - 'silver' - 'corn' - 'steel' - 'poultry' - 'government debt' - 'heating oil' - 'fertilizer' - 'cattle' - 'copper' - 'sorghum' - 'crude oil' - 'scrap metal' - 'coal' - 'cotton' - 'vegetables' - 'wheat' - 'corporate debt' - 'natural gas' - 'gasoil' - 'non-ferrous metals' - 'dairy' - 'global trade' - 'employment' - 'central banks' example: 'private companies' - in: query name: series description: | A grouping of stories under a recurring news topic. e.g. Morning Call (MORNCALL).
Available values (multiple values separated by a comma may be used): *MORNCALL, COD*. required: false schema: type: string example: 'MORNCALL' - in: query name: keyword description: A term used to create searches. required: false schema: type: string example: 'tablet' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 10 - in: query name: startDate description: The beginning date for the query. required: false schema: type: string example: '2026-07-22T07:20:58' - in: query name: displayType description: | The type of new displayed: headlines only, headline and preview, or full. required: true schema: type: string enum: - 'headline' - 'preview' - 'full' example: 'preview' - in: query name: images description: An option for returning the images contained in the news article. required: false schema: type: string example: 'true' - in: query name: storyId description: | Parameter allows to get specific story by providing newsID. Parameters: sources, symbols, category, subCategory, keyword, maxRecords, startDate will be ignored. required: false schema: type: integer example: 259220 - in: query name: rss description: Parameter formats XML requests as RSS feeds. This parameter has no effect on JSON or CSV requests. required: false schema: type: string example: 'false' - in: query name: rssTitle description: Parameter overrides the default RSS feed title and description. required: false schema: type: string - in: query name: fields description: The additional fields requested. required: false schema: type: string example: 'publishDate' - in: query name: barchartClassification description: Classify stories in some categories. required: false schema: type: string example: 'FUT.SFT' - in: query name: organization description: | N/A
Available values (multiple values separated by a comma may be used): *Barchart, AgWeb, Brownfield Ag News, Successful Farming, Baystreet, Walsh Trading, Zacks, Brave NewCoin, Swift Trading Company, Best Weather Inc., CME Group, Sidwell Strategies, MarketBeat, Scrap Monster, Blue Line Futures, AI-generated - The Globe and Mail, Automated Summaries - The Globe and Mail, Grainnet, USDA Exports, USDA, Sunshine Profits, NatGasWeather.com, Sure Dividend, Taurus Trading LLC, DeCarley Trading, KeyStone Financial, Trade Precise, RJO Futures, Stock Picking, Options Trading for Income, Market Tea Leaves, Renewable Fuels Association, Elliott Wave Forecast, Total Farm Marketing, Levi Donohoe, Wavetraders, Direxion, Tradable Patterns, Prosper Trading Academy, CarbonCredits.com, Peter Knight, ElliottWaveTrader.net, The Futures Management Group, Luis Flavio Nunes, Marcus Weather Inc., The Smart Investor, Cannon Trading, GoldIRAGuide.com, Zaye Capital Markets, Due Inc., EdgeClear, The REIT Forum, CFRN, Peter Mooses, WealthUp, TradeGuidance, NO BULL, HTS Commodities, The Tokenist, Monica Kingsley, VMware Inc., My Trading IQ, Solvid, Hedder, ElliottWave-Forecast, ONE44 Analytics, Monetive Wealth, Kolhanov.com, Banghart Properties, TradingView, SpreadEdge Capital, LLC, Astocks92, Klarenbach Research, Capital Truth, Hackett Financial Advisors, Inc., Pinion Risk Management, Heartland Investor Services Inc., Tanvir Zafar, The PRICE Futures Group, IncomeInsider.org, HedgeFundTips.com, Hashtag Investing, OptionMetrics, Bull Strangle Newsletter, EW-Forecast.com, Gold Price Forecast, Coachman's Research, OTOS Inc., MoneyShow, Young & The Invested, CommodityTrends, Archna Trades, Alpine Trading, Ivan Patriki, Gold Predictors, Espacio Media Incubator, Trade The Pool, 24/7 Wall St., New York Post, Decrypt, BullionVault, OilPrice.com, mint, tastytrade, Real Estate News, Business Standard, Banking Dive, DailyFX, Financial Post, Bitcoin Magazine, Financial Express, CBS News, ETF Express, TipRanks, Benzinga, FX Street, Moneycontrol, CoinDesk, ETF Trends, Brave New Coin, Seeking Alpha, AP, Dow Jones Newswires, PR Newswire, Canadian Press, CFTC, GlobeNewswire, ACCESS Newswire, Business Wire, ACN Newswire, ACCESSWIRE, Canada Newswire, Food Dive, Beef Magazine, StockStory, Markets Insider, Sugar Online, Rigzone, The Street, Kitco, Cotton Outlook, CNBC, FreightWaves, Daily Coffee News, EIA, Packaging World, Plastics Today, Stock Target Advisor, Stocktwits, Zacks Investment Research, Invezz, Wall Street Horizon, ETF Market Canada, Tipranks, The Globe and Mail, Under 30 CEO, INK Research, KillerStartups, B-TV.com, Fundata Canada Inc., wealthyventurecapitalist.com, Plus500, AllPennyStocks.com, ValuEngine, Inc, Zacks.com, Quiver Quantitative, Inc., NewsBTC, The Associated Press, NAWG, stocknews.com, Oil Market Journal, Schaeffers Investment Research, Business Insider, Exame, TechCrunch, wallstreet online, France24.com, Bank of England, Investimentos e Noticias, Fox Business, The Guardian Nigeria, Canal Rural, El Economista, Shine News, Bloomberg, finews.ch, CEPEA, European Energy Commission, The Real Deal, Malay Mail, Economic Times (India), MarketWatch, E&E News, El Comercio Ecuador, Renewable Energy World, US Federal Reserve, CNN, The Guardian, CNET, MSNBC, Journal of Commerce, Reuters, Hellenic Shipping News Worldwide, finanzen, El Comercio Peru, Bundesbank, Fox Weather, ETF.com, Deutsche Welle, Blockworks, Barron's, Aljazeera, Quartz, Weather Channel, Investor's Business Daily, FinanceFeeds, Connect CRE, Bisnow, Finextra, Advanced Biofuels Association, Supermarket News, Globe PR Wire, GetNews, Plentisoft, Press Advantage, PRISM News, Newsfile, Barchart Impact, Worldnewswire, Financial Times, Paper Advance, BBC, Meat & Poultry, Forbes, Papnews, Bio Bio Chile, Handelsblatt, The Economist, Securities and Exchange Commission, Biodiesel Magazine, Infobae, The Jerusalem Post, Undercurrent News, Risk.net, Biofuels International, WirtschaftsWoche, Offshore Energy, Wired, Japan Times, E15, Upstream, S&P Global, The Moscow Times, American Banker, IntraFish, Energypost.eu, Engadget, AgFax, Der Spiegel, Carbon Capture Magazine, Transport Topics, Wall Street Journal, Fortune, Hubtas*. required: false schema: type: string example: 'Barchart' - in: query name: lang description: | The news story language. The stories returned will be in the requested language, if any exists.
Available values (multiple values separated by a comma may be used): *all, hi, de, ps, en-us, pt, hu, zh-cn, yo, uk, cpe, id, ur, ig, aa, uz, mr, en, am, my, es, ar, vi, ne, ja, az, fa, fa-af, ro, en-gb, en-ca, ru, rw, fr, bn, br, si, es-ec, so, gd, om, sr, ko, sw, zh-tw, pt-br, ta, gu, ky, cs, te, pa, th, ti, cy, ha, pl, tr*. required: false schema: type: string example: 'en' - in: query name: sourceFeed description: Filter results by the original sourceFeed. required: false schema: type: string example: 'CONT2' - in: query name: exactCategoryMatch description: If set to true, the api will return stories with only the requested category and ignore any that might have additional categories associated with it. required: false schema: type: string example: 'false' 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: newsID: description: The identifying news code. type: integer nullable: true example: 259220 timestamp: description: The timestamp for a news article. type: string nullable: true example: '2020-09-14T21:10:00-05:00' source: description: The origin of the news feed. type: string nullable: true example: 'CMTX' categories: description: A grouping of related news content. type: array items: anyOf: - type: string example: stocks nullable: true subCategories: description: A more specific category list of related news content. type: array items: anyOf: - type: string example: corporate - type: string example: consprod - type: string example: tech nullable: true headline: description: The title of the news article. type: string nullable: true example: 'Mitsubishi Electric Wins Trademark Infringement Lawsuit Against Factory-automation Product Counterfeiters in China' isExternal: description: A flag indicating if the news stories is from an external source. type: string nullable: true headlineURL: description: The URL of the news article. This is used for headline only feeds. type: string nullable: true example: null preview: description: A brief summary of the entire news article. type: string nullable: true example: 'Mitsubishi Electric Corporation (TOKYO:6503) announced today that the Guangzhou Intellectual Property Court has upheld an earlier ruling in Mitsubishi Electric\u0027s favor regarding infringement of the company\u0027s trademarks by Guangzhou Lingye Automation Equipment, Guangzhou Longyan Automation Technology, Guangzhou Ouye Automation Technology and their owners located in Guangzhou, Guangdong Province, China.' fullText: description: The full published text of the news article. type: string nullable: true example: '\u003Cp\u003EMitsubishi Electric Corporation (\u003Cspan class=\u0022symbol\u0022 title=\u0022TOKYO:6503\u0022\u003ETOKYO:6503\u003C\/span\u003E) announced today...' imageURL: description: The URL of the image enclosed in the news article. type: string nullable: true example: null imageCaption: description: A brief summary explaining an image. type: string nullable: true example: null imageHeight: description: The height of an image. type: integer nullable: true example: null imageWidth: description: The width of an image. type: integer nullable: true example: null pdfURL: description: The web location of PDF version of the news article. type: string nullable: true example: null publishDate: description: The actual publish date of the news story. type: string nullable: true example: '2020-09-14T21:10:00-05:00' largeImageURL: description: The URL of the alternative larger image enclosed in the article type: string nullable: true example: null largeImageHeight: description: The height of the larger image, if available. type: integer nullable: true example: null largeImageWidth: description: The width of the larger image, if available. type: integer nullable: true example: null organization: description: The news organization that published the story. type: string nullable: true example: null canonicalUrl: description: The URL of the best representative page from a group of duplicate pages, according to Google type: string nullable: true example: null relatedSymbols: description: An array of symbols related to the given story. nullable: true example: null sourceFeed: description: The original internal feed code. type: string nullable: true example: null required: - newsID - timestamp - source - categories - subCategories - headline - isExternal - organization - canonicalUrl - relatedSymbols '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getNewsSources.json: get: tags: - News and Filings summary: getNewsSources operationId: get-getNewsSources description: The getNewsSources API from Barchart OnDemand provides access to public news sources and your authorization status per source. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: strict description: Return only the authorized news sources. required: false schema: type: string example: 'true' 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: id: description: The Id of the news source. type: string nullable: true example: 'AGCOM' name: description: The name of the news source. type: string nullable: true example: 'Agriculture.com' permission: description: Your permission status for this news source. type: string nullable: true example: 'false' required: - id - name - permission '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getNewsCategories.json: get: tags: - News and Filings summary: getNewsCategories operationId: get-getNewsCategories description: Barchart OnDemand's getNewsCategories API provides access to news source category and sub-category data. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: sources description: An id or code that identifies a news source. Multiple sources separated by a comma may be used. required: false schema: type: string example: 'AP,CMTX,USDA' - in: query name: depth description: An integer that will limit how many levels of the category tree to show. By default all levels are returned. required: false schema: type: integer example: 2 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: category: description: The category symbol. type: string nullable: true example: 'Futures' subcategories: description: The sub-categories. type: array items: properties: category: type: object example: name: Dairy symbol: DRY nullable: true required: - category '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSECFilings.json: get: tags: - News and Filings summary: getSECFilings operationId: get-getSECFilings description: Barchart OnDemand's getSECFilings API provides access to quarterly, annual and other required regulatory/SEC filings for U.S. publicly traded companies based on symbol. 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. required: true schema: type: string example: 'IBM' - in: query name: filingType description: | The type of SEC filing. Includes: All Filings, except stock transaction reports ("AllEx"), All, including stock transaction reports ("All"), Annual 10-K Reports ("10k") and Quarterly 10-Q Reports ("10q"). required: true schema: type: string enum: - 'AllEx' - 'All' - '10k' - '10q' example: 'AllEx' - in: query name: maxRecords description: The maximum number of records to show in the return. required: false schema: type: integer example: 10 - in: query name: startDate description: The beginning date for the query. required: false schema: type: string format: date example: '2026-06-22' 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 nullable: true example: 'AAPL' name: description: The name for the financial instrument. type: string nullable: true example: 'Apple Inc' filingId: description: The identifying filing code. type: string nullable: true example: '14721862' date: description: The timestamp for a news article. type: string format: date nullable: true example: '2021-02-18' form: description: The type of filing. type: string nullable: true example: 'PX14A6G' description: description: The name of the filing. type: string nullable: true example: 'Notice of exempt solicitation. Definitive material.' pdfURL: description: The web location of a PDF version of the filing. type: string nullable: true example: 'https://barchart.websol.barchart.com/?module=secFilings\u0026filingid=14721862\u0026type=CONVPDF\u0026popup=1\u0026override=1\u0026symbol=AAPL' htmlURL: description: The web location of a HTML version of the filing. type: string nullable: true example: 'https://barchart.websol.barchart.com/?module=secFilings\u0026filingid=14721862\u0026type=HTML\u0026popup=1\u0026override=1\u0026symbol=AAPL' wordURL: description: The web location of a Word version of the filing. type: string nullable: true example: 'https://barchart.websol.barchart.com/?module=secFilings\u0026filingid=14721862\u0026type=RTF\u0026popup=1\u0026override=1\u0026symbol=AAPL' excelURL: description: The web location of an Excel version of the filing. type: string nullable: true example: 'https://barchart.websol.barchart.com/?module=secFilings\u0026filingid=14721862\u0026type=XLS\u0026popup=1\u0026override=1\u0026symbol=AAPL' required: - symbol - name - filingId - date - form - description - pdfURL - htmlURL - wordURL - excelURL '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getInstrumentDefinition.json: get: tags: - Metadata summary: getInstrumentDefinition operationId: get-getInstrumentDefinition description: The getInstrumentDefinition API from Barchart OnDemand is available to request metadata on financial instruments by symbol, exchange, or exchange MIC. Metadata includes instrument names, exchange codes, tick increments, base codes, expiration dates and more. 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. required: false schema: type: string - in: query name: exchanges description: | Exchange code for the marketplace where the financial instruments are listed.
Available values (multiple values separated by a comma may be used): *FOREX, RATE, RATES, SECTOR, DGCX, DME, MATBA, ROFEX, ASX, SFE, BMF, BSE, CNSX, INDEX-TSX, MNTRL, TSX, TSX-V, WCE, CFFEX, CZCE, DCE, SHFE, EEX, EUIDX, EUREX, MEFF, MATIF, HKFE, MCX, NCDEX, NSE, ISE, JPX, TOCOM, KFE, MDEX, NZX, MOEX, OMX, ICESI, TFEX, TAIWA, ICE, LCE, LIFFE, LME, LSE, AMEX, BATS, CADFUNDS, CBOT, CBOTM, CFE, CME, COMEX, CRYPTO, CXMI, ERIS, FUND, GBLX, GREEN, ICEUS, INDEX, INDEX-CBOE, INDEX-DOW, INDEX-NQ, INDEX-NY, INDEX-RL, INDEX-SP, KCBT, MIAX, NASDAQ, NYMEX, NYMI, NYSE, OTC-BB, OTHER OTC, TRADAIR, SAFEX, SIMEX, C3, C3_BUNKER, PLATTS, CXE, BXE, DXE, EURNXT_EQ_BE, EURNXT_EQ_FR, EURNXT_EQ_NL, EURNXT_EQ_PT, ENDEX, EEX_POWER, OMX_POWER, GPC_PRICES*. required: false schema: type: string example: 'CME' - in: query name: exchangeMics description: Market Indicator Code for the marketplace where the financial instruments are listed. required: false schema: type: string example: 'XCME' - in: query name: maxRecords description: The maximum number of records requested. required: false schema: type: integer example: 20 - in: query name: offset description: A value denoting where to start results from. required: false schema: type: integer example: 10 - in: query name: returnExpired description: If you would like to request data for an expired futures contract, please set this parameter to true. required: false schema: type: string example: '1' 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: guid: description: Globally Unique Identifier of a financial instrument. type: string nullable: true example: 'BRF2022' id: description: Identifier of a financial instrument. type: string nullable: true example: '131403082' symbolRealtime: description: The Realtime name of the instrument. type: string nullable: true example: 'BRF2022' symbolHistorical: description: The Historical name of the instrument. type: string nullable: true example: 'BRF22' symbolDdf: description: The DDF name of the instrument. type: string nullable: true example: 'BRF2' symbol: description: A symbol or code that identifies a financial instrument. type: string nullable: true example: 'BRF2' symbolName: description: The full name of the instrument. type: string nullable: true example: 'Brazilian Real (Pit)' symbolExpiration: description: The last day that the financial instrument is traded. type: string format: date nullable: true example: '2021-12-31' symbolCFI: description: The symbol's classification of financial instruments code. type: string nullable: true example: 'FXXXXX' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'CME' exchangeName: description: The name of the exchange. type: string nullable: true example: 'CME' exchangeCode: description: The smallest increment at which the financial instrument can be traded. type: string nullable: true example: 'M' tickIncrement: description: | 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. type: integer nullable: true example: 5 baseCode: description: Indicates the fractional or decimal precision of the instrument.

2 = 1/8 = one digit fraction, range is 0 - 7
3 = 1/16 = two digit fraction, range is 0 - 15
4 = 1/32 = two digit fraction, range is 0 - 31
5 = 1/64 = two digit fraction, range is 0 - 63
6 = 1/128 = three digit fraction, range is 0 - 127
7 = 1/256 = three digit fraction, range is 0 - 255
8 = 0 = no decimal places, a whole number
9 = 0.1 = one decimal place
A = 0.01 = two decimal places
B = 0.001 = three decimal places
C = 0.0001 = four decimal places
D = 0.00001 = five decimal places
E = 0.000001 = six decimal places
F = 0.0000001 = seven decimal places
* = unchanged = transmitted by ddfplus with size only data type: string nullable: true example: 'D' unitCode: description: The corresponding unit code type: integer nullable: true example: 5 pointValue: description: An indicator representing the value of one point in dollar terms. This applies to futures. type: number format: double nullable: true example: 100000 required: - guid - id - symbolRealtime - symbolHistorical - symbolDdf - symbol - symbolName - symbolExpiration - symbolCFI - exchange - exchangeName - exchangeCode - tickIncrement - baseCode - unitCode - pointValue '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesSpecifications.json: get: tags: - Metadata summary: getFuturesSpecifications operationId: get-getFuturesSpecifications description: Barchart OnDemand's getFuturesSpecifications API provides contract information such as trading hours, contract size and tick size for futures contracts. 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. required: false schema: type: string example: 'GC,CL' - in: query name: exchanges description: The code for the exchange a group of financial instruments are listed on. required: false schema: type: string example: 'COMEX,NYMEX' - in: query name: futuresCategory description: | Futures categories include: Energies, Financials, Grains, Indices, Meats, Metals, Softs and Currencies. required: false schema: type: string example: 'energies,metals' 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. Multiple symbols separated by a comma may be used. type: string nullable: true example: 'GCJ21' root: description: The Future's root. type: string nullable: true example: 'GC' exchange: description: The code for the exchange a group of financial instruments are listed on. type: string nullable: true example: 'COMEX' futuresCategory: description: | Futures categories include: Energies, Financials, Grains, Indices, Meats, Metals, Softs and Currencies. type: string nullable: true example: 'Metals' contractName: description: The name of the futures contract. type: string nullable: true example: 'Gold 100-oz (GC)' tradingHours: description: The futures contract's trading hours. type: string nullable: true example: '5:00p.m. - 4:00p.m. (Sun-Fri) (RTH 7:20a.m. - 12:30p.m.) (Settles 12:30p.m.) CST' ContractSize: description: The futures contract's size. type: string nullable: true example: '100 fine troy ounces' monthsTraded: description: The contract months listed for trading. type: string nullable: true example: 'February, April, June, August, October, December (G, J, M, Q, V, Z)' tickValue: description: The size and value of the minimum tick size. type: string nullable: true example: '0.10 (10 cents) per troy ounce ($10.00 per contract)' pointValue: description: The value of one full point. type: string nullable: true example: '$100' optionsUnitValue: description: The price value of option point. type: string nullable: true example: '$100' exchangeMargin: description: The margin maintenance required for the future. type: string nullable: true example: '$12,100/11,000' exchangeSymbol: description: The actual exchange symbol for the corresponding future. type: string nullable: true example: 'GC' dailyLimit: description: The daily limit for the commodity. type: string nullable: true example: '10% above or below previous settlement' required: - symbol - root - exchange - futuresCategory - contractName - tradingHours - ContractSize - monthsTraded - tickValue - pointValue - optionsUnitValue - exchangeMargin - exchangeSymbol - dailyLimit '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesExpirations.json: get: tags: - Metadata summary: getFuturesExpirations operationId: get-getFuturesExpirations description: The getFuturesExpiration API from Barchart OnDemand provides first notice and last trade dates for futures contracts. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: roots description: A symbol or code that identifies a futures root. required: false schema: type: string example: 'ZC,ZS' - in: query name: contracts description: A symbol or code that identifies a futures contract. required: false schema: type: string example: 'ZCN26,ZCU26' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'lastTradingDay' 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 the futures contract. type: string nullable: true example: 'ZCH21' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'CBOT' contract: description: The expiration month and year of the futures contract. type: string nullable: true example: 'Mar 21' firstNoticeDate: description: The first notice date of the futures contract. type: string format: date nullable: true example: '2021-02-26' expirationDate: description: The expiration date. type: string format: date nullable: true example: '2021-03-12' lastTradingDay: description: The last trade day of the futures contract. type: string nullable: true example: 'The business day prior to the 15th calendar day of the contract month' required: - symbol - exchange - contract - firstNoticeDate - expirationDate '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuturesOptionsExpirations.json: get: tags: - Metadata summary: getFuturesOptionsExpirations operationId: get-getFuturesOptionsExpirations description: The getFuturesOptionsExpirations API provides last trade dates for options on futures contracts. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: roots description: A symbol or code that identifies a futures root. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'ZS' - in: query name: contracts description: A symbol or code that identifies a futures contract. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'ZCN14,ZCU14' - in: query name: symbols description: A symbol or code that identifies a futures option. Multiple symbols separated by a comma may be used. required: false schema: type: string example: 'ZCK260C,ZCK260P' 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 the futures symbol. type: string nullable: true example: 'BC1H21' exchange: description: The name of the exchange the instrument belongs to. type: string nullable: true example: 'CBOT' underlyingContract: description: The contract the option belongs to. type: string nullable: true example: 'ZCK21' expirationDate: description: The expiration date. type: string format: date nullable: true example: '2021-04-23' required: - symbol - exchange - underlyingContract - expirationDate '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSpecialOptionsClassification.json: get: tags: - Metadata summary: getSpecialOptionsClassification operationId: get-getSpecialOptionsClassification description: The getSpecialOptionsClassifications API from Barchart OnDemand provides the classification for weekly and special options by commodity. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: root description: Commodity root code for which the classification is requested. Multiple roots can be passed, separated by a comma. required: false schema: type: string example: 'ZC' - in: query name: category description: The category classification of the special option required: false schema: type: string 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: root: description: The code that identifies a commodity. type: string example: ZC nullable: true category: description: The category classification of the special option type: array items: anyOf: - type: object example: categoryName: Short Dated New Crop Options data: symbol: BCD name: Corn Short Dated New Crop Options nullable: true required: - root - category '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getForexForwardCurves.json: get: tags: - Metadata summary: getForexForwardCurves operationId: get-getForexForwardCurves description: The getForexForwardCurves API from Barchart OnDemand provides the bid, ask, and mid price data for all available forward curves (forward rates) for a given forex symbol. 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 valid forex symbol. required: true schema: type: string example: '^EURUSD' 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: The forex symbol. type: string nullable: true example: '^EURUSD' name: description: Name of the forex. type: string nullable: true example: 'Euro Fx/U.S. Dollar' bid: description: The current bid price. type: number format: double nullable: true example: 1.2142 ask: description: The current ask price. type: number format: double nullable: true example: 1.2145 mid: description: The current mid price. type: number format: double nullable: true example: 1.2145 lastUpdate: description: The exchange timestamp for the last traded price. type: string nullable: true example: '2021-02-23T15:23:07-06:00' forwardCurves: description: A multi-dimensional array with symbol, name, bid, ask, mid and last update timestamp for all available forward curves for the requested forex symbol. type: array items: anyOf: - type: object example: symbol: EURUSD.O name: EUR/USD Overnight Forward bid: 0.22 ask: 0.23 mid: 0.225 open: 0.5 high: 0.5 low: 0.455 previous: 0.455 lastUpdate: 2026-07-13T10:15:23-05:00 nullable: true required: - symbol - name - bid - ask - mid - lastUpdate - forwardCurves '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getSymbolChange.json: get: tags: - Metadata summary: getSymbolChange operationId: get-getSymbolChange description: The getSymbolChange API from Barchart OnDemand provides the list of symbols that have gone through a change. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: startDate description: The start date for which the symbol change records should be returned. required: false schema: type: string format: date example: '2026-06-22' - in: query name: endDate description: The end date for which the symbol change records should be returned. required: false schema: type: string format: date example: '2026-07-22' - in: query name: coverage description: The exchange/exchanges for which the symbol change records should be returned (Non-US coverage includes all available international markets). required: false schema: type: string enum: - 'ALL' - 'USA' - 'CAN' - 'EUR' - 'ASX' - 'LSE' - in: query name: fields description: Include the requested optional fields in the output. required: false schema: type: string example: 'availableOn' - in: query name: includeUpcomingChanges description: N/A required: false schema: type: string example: '1' 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: oldSymbol: description: The old name of the symbol. type: string nullable: true example: 'NSPX' newSymbol: description: The new name of the symbol. type: string nullable: true example: 'NSPXD' updatedOn: description: | The date of the update. Format: YYYY-MM-DD. type: string format: date nullable: true example: '2019-10-01' availableOn: description: | The date the update was available via the system. Format: YYYY-MM-DD type: string format: date nullable: true example: '2026-03-22' required: - oldSymbol - newSymbol - updatedOn '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getRelatedInstruments.json: get: tags: - Metadata summary: getRelatedInstruments operationId: get-getRelatedInstruments description: The getRelatedInstruments API from Barchart OnDemand provides the list of all symbols for a given company across different countries and exchanges. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A symbol or code that identifies a financial instrument. Multiple symbols separated by a comma may be used. required: true schema: type: string example: 'IBM' - 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 nullable: true example: 'IBM' symbolName: description: The name of the financial instrument. type: string nullable: true example: 'International Business Machines' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'NYSE' figi: description: This code is unique at exchange level, a pair of exchange and company is assigned a unique figi. type: string nullable: true example: 'BBG000BLNQ16 (unique code for IBM for NYSE.)' compositeFigi: description: This code is shared in all exchanges across a country for a given company. type: string nullable: true example: 'BBG000BLNNH6 (unique code for IBM for US exchanges.)' shareClassFigi: description: This code is shared in all exchanges across the world for a given company. type: string nullable: true example: 'BBG001S5S399' required: - symbol - symbolName - exchange - figi - compositeFigi - shareClassFigi '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getWeather.json: get: tags: - Other Data summary: getWeather operationId: get-getWeather description: Barchart OnDemand's getWeather API provides current conditions and forecasts based on zip code. As well as weather maps based on type or region. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: weatherType description: | The type of weather requested. Includes: Current Conditions ("CC") and Forecast ("F"). required: false schema: type: string enum: - 'CC' - 'F' - 'MAP' example: 'CC' - in: query name: zipCode description: The zip code of the location as a 5-digit numeric value. required: false schema: type: string example: '60606' - in: query name: fields description: The fields requested. required: false schema: type: string example: 'windDirection,windSpeed,humidity,dewpoint,forcastedDay,forcastedPrecipitation' - in: query name: mapType description: The type of map required. Only valid when using the "MAP" weatherType. required: false schema: type: string enum: - 'localRadarAnimation' - 'usRadarSatellite' - 'usRadarSatelliteAnimation' - 'todaysWeatherMap' - 'currentWindConditions' - 'todaysPrecipitationAccumulation' - 'dailyPrecipitation' - 'usSoilMoisture' - 'usCurrentTemperatures' - in: query name: mapRegion description: The region of map required. required: false schema: type: string enum: - 'centralPlains' - 'dakotas' - 'californiaArizona' - 'colorado' - 'deepSouth' - 'delta' - 'farWest' - 'florida' - 'greatBasin' - 'greatLakes' - 'midAtlantic' - 'montana' - 'northEast' - 'ohioValley' - 'pacificNorthwest' - 'rockyMountains' - 'southAtlantic' - 'southPlains' - 'southTexas' - 'southWest' - in: query name: mapWidth description: The width of the map. required: false schema: type: integer example: 255 - in: query name: mapHeight description: The height of the map. required: false schema: type: integer example: 220 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: weatherType: description: | The type of weather requested. Includes: Current Conditions ("CC") or Forecast ("F"). type: string nullable: true example: 'F' zipCode: description: The zip code of the location. type: string nullable: true example: '60606' location: description: The city or town related to the zip code. type: string nullable: true example: 'Chicago, Illinois' currentCondition: description: The descriptive of the current condition. type: string nullable: true example: 'Few Clouds' currentConditionIcon: description: The condition icon's URL. type: string nullable: true example: 'https://shared.websol.barchart.com/images/weather/pcldyicon.jpg' currentTemperature: description: The current temperature. type: string nullable: true example: '43\u0026deg;F' currentPressure: description: The current atmospheric pressure in Hg. type: string nullable: true example: '29.77 in. Hg' feelsLike: description: The current feels like temperature. type: string nullable: true example: '33.8\u0026deg;F' windDirection: description: The current wind direction. type: string nullable: true example: 'Northwest' windSpeed: description: The current wind speed. type: string nullable: true example: '9 mph' humidity: description: The current level of humidity. type: string nullable: true example: '81%' dewpoint: description: The current dew point. type: string nullable: true example: '31\u0026deg;F' forecastedDay: description: The name of the day of the week forecasted. type: string nullable: true example: 'Wednesday' forcastedPrecipitation: description: The amount of forecasted precipitation in inches. type: string nullable: true example: '0.01 in.' chancePrecipitationDay: description: The daytime chance of precipitation. type: string nullable: true example: '14%' chancePrecipitationNight: description: The nighttime chance of precipitation. type: string nullable: true example: '%' windchill: description: The forecasted windchill temperature. type: string nullable: true example: '33.8\u0026deg;F' dewFrostWeight: description: The dew/frost weight. type: string nullable: true example: 'Frost' hoursSun: description: The hours of sunlight for today. type: string nullable: true example: '3.9' soilMoisture: description: The current soil moisture. type: string nullable: true example: '2.05' evaporation: description: The current level of evaporation. type: string nullable: true example: '0.25' dryingIndex: description: The current drying index. type: string nullable: true example: 'Excellent' solarRadiation: description: The current level of solar radiation. type: string nullable: true example: '3960' livestockSafteyIndex: description: The current livestock safety index. type: string nullable: true example: 'Alert' cumulativeHDD: description: The cumulative heating degree days. type: string nullable: true example: '31' cumulativeGDD: description: The cumulative growing degree days. type: string nullable: true example: '173' forecastDayCondition: description: A descriptive of the weather forecasted for the day. type: string nullable: true example: 'Mostly Cloudy' forecastDayConditionIcon: description: The condition icon's URL. type: string nullable: true example: 'https://shared.websol.barchart.com/images/weather/mcldyicon.jpg' forecastNightCondition: description: A descriptive of the weather forecasted for the night. type: string nullable: true example: 'Cloudy' forecastNightConditionIcon: description: The condition icon's URL. type: string nullable: true example: 'https://shared.websol.barchart.com/images/weather/cldyicon.jpg' forecastHighTemperature: description: The forecasted high temperature for the day. type: string nullable: true example: '39\u0026deg;F' forecastLowTemperature: description: The forecasted low temperature for the day. type: string nullable: true example: '27\u0026deg;F' mapRegion: description: The map region. type: string nullable: true example: 'null' mapType: description: The map type. type: string nullable: true example: 'localRadarAnimation' mapUrl: description: The map image's URL. type: string nullable: true example: 'https://shared.websol.barchart.com/weather/weathermap.php/interrad?zipcode=60606\u0026width=560\u0026height=440' required: - weatherType - zipCode - location - currentCondition - currentConditionIcon - currentTemperature - currentPressure - feelsLike - mapRegion - mapType - mapUrl '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getGrainBids.json: get: tags: - Other Data summary: getGrainBids operationId: get-getGrainBids description: The getGrainBids API provides cashbid data for 30 closest locations in relation to the requested zip code. Learn more about Barchart's proprietary commodity data and grain cmdtyIndexes. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: requestType description: The type of request that is being requested in order to determine the type of data to be returned. required: false schema: type: string enum: - 'commodities' - 'locations' - 'bids' - in: query name: location description: | A location id or a code identifies a or multiple grain buying location(s) that cash bid will be returned for. A valid code consist of multiple location ids separated by a comma, and the code can contain up to 100 locations. A list of valid location ids can be retrieved by using this API with input: requestType = location. location and several other inputs -geographic coordinates, zipCode, maxDistance, county, totalLocations- are mutually exclusive. required: false schema: type: string - in: query name: latitude description: The latitude of a valid geographic coordinates to define the center of area that cashbid will be returned for. Geographic coordinates and Zipcode are mutually exclusive. required: false schema: type: number format: double nullable: true - in: query name: longitude description: The longitude of a valid geographic coordinates to define the center of area that cashbid will be returned for. Geographic coordinates and Zipcode are mutually exclusive. required: false schema: type: number format: double nullable: true - in: query name: zipCode description: A valid US or Canadian zip code to define the area that cash bids orginate from. required: false schema: type: string example: '60606' - in: query name: maxDistance description: The maximum distance from searched zipcode or the requested geo coordinates in miles. This input helps to define the area that cash bids will be returned from. Maximum value is 250. required: false schema: type: number format: double nullable: true - in: query name: county description: A valid string code which represents the concatenation of county name and state code seperated by a hyphen. required: false schema: type: string example: 'BOONE COUNTY-IA' - in: query name: fipsCode description: A concatenation of state FIPS code and county FIPS code without separator to define the county that cash bids will be returned for. Please click here to get a list of possible values. required: false schema: type: integer example: 17053 - in: query name: commodityName description: | A standard commodity name or a name list that separated by pipe (|) to filter cashbid. Note that the input need to be encoded in UTF-8. A list of valid commodity names can be retrieved by using this API with input: requestType = commodities. required: false schema: type: string example: 'Soybeans|Corn (#2 Yellow)' - in: query name: totalLocations description: The maximum number of locations to be returned based of the zip code provided by the user. Default value is 30. required: false schema: type: integer example: 1 - in: query name: getAllBids description: Return all cash bids for each location. required: false schema: type: string - in: query name: bidsPerCom description: The maximum number of cash bids to be returned for each commodity per location. This parameter should be set to the maximum number of cash bids the user wishes to be returned. required: false schema: type: integer example: 2 - in: query name: numOfDecimals description: The level of precision in decimal places of price and basis to be returned. required: false schema: type: integer example: 2 - in: query name: companyName description: Name of the applicable grain buying elevator. required: false schema: type: string - in: query name: getAllLocations description: Return all locations based of the searched zip code. required: false schema: type: integer - in: query name: rawDistance description: Remove the appended string, "mile away", from output:distance. required: false schema: type: string - in: query name: fields description: Additional as per-requested fields that the user can define. Requested fields should be separated by a comma. required: false schema: type: string - in: query name: deliveryStart description: The start date for the delivery period for qualified bids. required: false schema: type: string - in: query name: deliveryEnd description: The end date for the delivery period for qualified bids. required: false schema: type: string 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: bids: description: A list of cash bids from a grain buying location. Each cash bid contains the meta and price data applicable to that location. type: array items: anyOf: - type: object example: id: 43423878 commodity: CORN symbol: ZCH21 delivery_start: 2021-02-21 00:00:00 delivery_end: 2021-02-28 23:59:59 basis: 4.00 notes: active: true sym_root: ZC commodity_id: 121541 customer_commodity_id: 10269 commodity_display_name: Corn (#2 Yellow) unitvalue: 1 unitweight: 56 currency: USD deliveryMonth: Feb21 deliveryYear: 2021 basismonth: Mar 2021 timestamp: 1614186100 as_of: 11:01 price: 5.64 pricecwt: 10.071429 basiscwt: 7.14 pricetonne: 222.036729 basistonne: 157.47 change: +0.0625 rawchange: 0.0625 pctchange: +1.12 cashprice: 5.64 cashpricetonne: 222.036729 delivery_sort: 2021-02-21 00:00:00 delivery_start_raw: 2021-02-21 00:00:00 delivery_end_raw: 2021-02-28 23:59:59 basisSymbol: ZCBG21L-58118-10269.CM cashPriceSymbol: ZCPG21L-58118-10269.CM nullable: true distance: description: Distance of the elevator in miles from the input zip code. type: string nullable: true example: '13 miles away' company: description: Name of the applicable grain buying elevator. type: string nullable: true example: 'Elburn Coop' elevatorId: description: The elevator id. type: integer nullable: true example: 390 locationId: description: The location id. type: integer nullable: true example: 58118 location: description: Name of location that grain bid originated from. type: string nullable: true example: 'Ingredion' facility_type: description: The type of facility. type: string nullable: true example: 'Export Terminal' address: description: The street address of the location. type: string nullable: true example: '6400 S Archer Rd' city: description: City associated with the underlying grain bid. type: string nullable: true example: 'Bedford Park' state: description: 2-char abbreviation of the state that contains the applicable cash bid. type: string nullable: true example: 'IL' lng: description: The longitude of the location. type: number format: double nullable: true example: -87.826071 lat: description: The latitude of the location. type: number format: double nullable: true example: 41.775032 phone: description: The phone number for the location. type: string nullable: true example: '815-899-8964' url: description: The public website of the grain company. type: string nullable: true example: 'www.chselburn.com' zip: description: The zip code for the location. type: string nullable: true example: '60501' county: description: The name of the county containing the applicable cash bid. type: string nullable: true example: 'Cook County' county_code: description: Concatenation of stateFipsCode, countyFipsCode, and classFipsCode. type: string nullable: true example: 'IL-17-031-H1' fips_code: description: FIPS code for the county. Concatenation of stateFipsCode and countyFipsCode. type: number format: double nullable: true example: 17031 crop_district: description: District code of crop reporting district that is associated with the applicable cash bid. type: string nullable: true example: 'D20' basisTimestamp: description: Time when basis was last updated for given elevator. type: string nullable: true example: '2021-02-24T09:00:30-06:00' commodities: description: The commodity names. type: array items: anyOf: - type: string example: Barley - type: string example: Beans - type: string example: Beans (Garbonzo) - type: string example: Beans (Lentil) - type: string example: Beans (Pinto) nullable: true basisTimestampRaw: description: Unix timestamp when basis was last updated for the given elevator. type: integer nullable: true example: 1614178830 required: - bids - distance - company - locationId - location - facility_type - address - city - state - lng - lat - phone - url - zip - county - basisTimestamp - basisTimestampRaw '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getUSDAGrainPrices.json: get: tags: - Other Data summary: getUSDAGrainPrices operationId: get-getUSDAGrainPrices description: Barchart OnDemand's getUSDAGrainPrices API provides daily cash grain bids and prices for grain buying locations throughout the United States covering corn, wheat, oats and soybeans sourcing from USDA reports. This API refreshes on an hourly basis, so bids and prices from USDA reports would be available within an hour after the report is released. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: commodityTypes description: | The type of commodity. Includes: Corn ("C"), Corn Crude Oil ("CCO"), Crude Soybean Oil ("CSO"), DNS/NS Wheat 14% ("WDN"), HRW Wheat ("HRW"), HRW Wheat 11.5% ("HRW11"), Oats ("O"), Ord HRW Wheat ("HRWORD"), Soybean Meal 48% ("SM"), Soybeans ("S"), SRW Wheat ("SRW"), SWW Wheat ("SWW").
Available values (multiple values separated by a comma may be used): *C, CCO, CSO, WDN, HRW, HRW11, O, HRWORD, SM, S, SRW, SWW*. required: false schema: type: string example: 'C' - in: query name: bidTypes description: | The type of bid. Includes: Export ("E"), Processor ("P"), River ("R"), Terminal ("T") and Barge Loading ("B").
Available values (multiple values separated by a comma may be used): *E, P, R, T, B*. required: false schema: type: string example: 'E' 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: commodityType: description: | The type of commodity. Includes: Corn ("C"), Corn Crude Oil ("CCO"), Crude Soybean Oil ("CSO"), DNS/NS Wheat 14% ("WDN"), HRW Wheat ("HRW"), HRW Wheat 11.5% ("HRW11"), Oats ("O"), Ord HRW Wheat ("HRWORD"), Soybean Meal 48% ("SM"), Soybeans ("S"), SRW Wheat ("SRW"), SWW Wheat ("SWW"). type: string nullable: true example: 'Corn' grade: description: The grade level of commodity. type: string nullable: true example: 'US #1' protein: description: The protein level of commodity. type: string nullable: true example: 'Ordinary' locationState: description: The state where the handling facility is located in. type: string nullable: true example: 'IL' locationCity: description: The city where the handling facility is located in. type: string nullable: true example: 'Springfield' location: description: | The location of the handling facility. Includes: Atlantic ("A"), Central Illinois ("CIL"), Chicago ("CHGO"), Cincinnati Ohio River ("CIN"), Gulf ("GULF"), Kansas City ("KC"), Memphis Mississippi River ("MEM"), Minneapolis ("MIN"), Mt. Vernon Ohio River ("MTV"), N. Peoria Illinois River ("NPEO"), Omaha ("OMA"), Portland ("PORT"), S. Iowa Mississippi River ("SIOWA"), S. Peoria Illinois River ("SPEO"), St. Louis Mississippi River ("SLOU"), Toledo Non-River ("TLNON"), Toledo On-River ("TLON"). type: string nullable: true example: 'Chicago' bidType: description: | The type of bid. Includes: Export ("E"), Processor ("P"), River ("R"), Terminal ("T") and Barge Loading ("B"). type: string nullable: true example: 'Export' lowPrice: description: The low price for the day. type: number format: double nullable: true example: 3.0256 lowPriceChange: description: The change in low price compared to the previous day. type: number format: double nullable: true example: 5.0435 lowBasis: description: The low basis of the day. type: number format: double nullable: true example: -20 lowBasisChange: description: The change in low basis compared to the previous day. type: number format: double nullable: true example: 4 lowBasisMonth: description: The futures contract month associated with low basis. type: string nullable: true example: 'K' highPrice: description: The high price for the day. type: number format: double nullable: true example: 3.22 highPriceChange: description: The change in high price compared to the previous day. type: number format: double nullable: true example: 2.94 highBasis: description: The high basis for the day. type: number format: double nullable: true example: 24 highBasisChange: description: The change in high basis compared to the previous day. type: number format: double nullable: true example: 4.5 highBasisMonth: description: The futures contract month associated with high basis. type: string nullable: true example: 'Z' freight: description: The shipment agreements of the transportation of goods between buyers and sellers, i.e. CIF. type: string nullable: true example: 'Delivered' transMode: description: The transportation mode of the trade, i.e. Truck, Barge, etc. type: string nullable: true example: 'Truck' current: description: The indicator of delivery window whether spot or not. type: string nullable: true example: 'Yes' deliveryStart: description: The date delivery starts. type: string format: date nullable: true example: '2026-07-01' deliveryStartHalf: description: The delivery starts for half month window. type: string nullable: true example: 'Last Half' deliveryEnd: description: The date delivery ends. type: string format: date nullable: true example: '2026-07-01' deliveryEndHalf: description: The delivery ends for half month window. type: string nullable: true example: 'Last Half' report: description: The name of sourcing report. type: string nullable: true example: 'Illinois Grain Bids' reportDate: description: The release date of sourcing report. type: string format: date nullable: true example: '2026-07-22' priceChange: description: The price change in cents compared to the previous day. type: number format: double nullable: true example: -4 basis: description: The basis range in cents. type: string nullable: true example: '-25.0000 U to -5.0000 U' bidChange: description: The change in bid price compared to the previous day. type: number format: double nullable: true required: - commodityType - grade - protein - locationState - locationCity - location - bidType - lowPrice - lowPriceChange - lowBasis - lowBasisChange - lowBasisMonth - highPrice - highPriceChange - highBasis - highBasisChange - highBasisMonth - freight - transMode - current - deliveryStart - deliveryStartHalf - deliveryEnd - deliveryEndHalf - report - reportDate - priceChange - basis - bidChange '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCmdtyStatsId.json: get: tags: - Other Data summary: getCmdtyStatsId operationId: get-getCmdtyStatsId description: The getCmdtyStatsId API is used identify instrument identifiers that can be passed to getCmdtyStats in order to request data on the applicable series. Users can search for data series based on search parameters covering content, source, area, frequency, and more. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: commodity description: The primary subject of item of a data series. User can pass values such as "soy" and expect data series infomation for "soybean" and "soybeans" to be returned required: false schema: type: string example: 'Corn' - in: query name: measurement description: The measured aspect of a item required: false schema: type: string example: 'Production' - in: query name: area description: The geographic location of data series. Passing less specific queires - such as "america" in lieu of "united states" may be preferable to return meta for all possibly applicable data series required: false schema: type: string example: 'United States of America' - in: query name: source description: The originating sources of a data series. May include organization, associated report, data table, down to sourcing figure required: false schema: type: string example: 'USDA' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. required: false schema: type: string enum: - '50' - '100' - '150' - '200' - '250' - '300' - '350' - '400' - '450' - '500' example: '50' - in: query name: page description: The page value to use in order to determine the offset while returning results. required: false schema: type: integer example: 1 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: shortSymbol: description: A shorter alernate symbol for the data series. type: string nullable: true example: 'UD04006K.CS' seriesDescription: description: | A short description of the data series, that is created via concatenation of the following 4 data elements delimited by semicolons: "item";"measurement,frequency,unitDescription";"area";"sourcing figure" type: string nullable: true example: 'Corn;Production,Annual,Bushel;Arkansas;Corn for Grain Area Harvested, Yield, and Production' required: - shortSymbol - seriesDescription '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCmdtyStats.json: get: tags: - Other Data summary: getCmdtyStats operationId: get-getCmdtyStats description: The getCmdtyStats API is used to request information on various fundamentals, commodity statistics, and economic data. Users can request information by data series with historical information available through to inception for most series. cmdtyStats™ is the premier source of aggregated commodity statistics – all made available in one easy to use API. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: symbol description: A unique symbol that identifies a data series. required: true schema: type: string example: 'USDA-SOYB-PROD-MS-96.CS' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the 1 year back from current data. Note that if the date range requested by the user is more extensive than the user's permissions allow for, the output range will be determined based on an offset from the startDate. required: false schema: type: string example: '20250722' - in: query name: endDate description: The end date of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the last day of current year. Note that if the date range requested by the user is more extensive than the user's permissions allow for, the output range will be determined based on an offset from the startDate. required: false schema: type: string example: '20260722' - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' - in: query name: fields description: Additional fields that the API should return. required: false schema: type: string example: 'measurements,contents' 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 unique symbol that identifies a data series. type: string nullable: true example: 'USDA-SOYB-PROD-MS-96.CS' shortSymbol: description: A shorter alernate symbol for the data series. type: string nullable: true example: 'UD09002O.CS' shortName: description: The short name for the data series. type: string nullable: true example: 'MS Soybeans PROD' mediumName: description: The medium name for the data series. type: string nullable: true example: 'MS Soybeans PROD' longName: description: The long name for the data series. type: string nullable: true example: 'MS Soybeans Production' seriesDescription: description: | A short description of the data series, that is created via concatenation of the following 4 data elements delimited by semicolons: "item";"measurement,frequency,unitDescription";"area";"sourcing figure" type: string nullable: true example: 'Soybeans;Production,Annual,Bushel;Mississippi;Soybeans for Beans Area Harvested, Yield, and Production' item: description: The primary subject of data series type: string nullable: true example: 'Soybeans' measurement: description: The measured aspect of a item type: string nullable: true example: 'Production' measurements: description: The class hierarchy of measurement type: array items: anyOf: - type: string example: Flows - type: string example: Production nullable: true frequency: description: Periodicity with which the underlying data series is released, updated, or recorded type: string nullable: true example: 'Annual' unit: description: The unit associated with data series type: string nullable: true example: 'Bushel' multiplier: description: The multiplier of unit type: integer nullable: true example: 1 area: description: Geographic location that defines the data series type: string nullable: true example: 'Mississippi' areaType: description: Geographic granularity or aggregation level of the data type: string nullable: true example: 'State' sources: description: The originating sources of a data series. May include organization, associated report, data table, down to sourcing figure type: array items: anyOf: - type: string example: USDA - type: string example: NASS - type: string example: Crop Production - type: string example: Soybeans for Beans Area Harvested, Yield, and Production - type: string example: NASS Crops nullable: true contents: description: The class hierarchy of commodity type: array items: anyOf: - type: string example: cmdty - type: string example: Ag - type: string example: Grains - type: string example: Soy - type: string example: Soybeans nullable: true unitDescription: description: Plain text description of unit associated with data series type: string nullable: true example: 'Bushel' lastRefresh: description: Time of last update type: string format: date nullable: true example: '2020-11-10' stats: description: A time series array consisting of date and value for each applicable record. Date represents the last day of a period covering the underlying data, which is indicated by frequency. Value will be the underlying data record or null if not available for any reason. type: array items: anyOf: - type: object example: date: '2020-12-31' value: '11124000' nullable: true required: - symbol - shortSymbol - shortName - mediumName - longName - seriesDescription - item - measurement - frequency - unit - multiplier - area - areaType - sources - unitDescription - lastRefresh - stats '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getGrainInstruments.json: get: tags: - Other Data summary: getGrainInstruments operationId: get-getGrainInstruments description: The getGrainInstruments API is used to request symbol and metadata information regarding physical grain instruments across Barchart's cash bids and grain indexes. Users can request information based on crop type / root symbol, geo-location, or areas that are codified by FIPS standards. Returned instruments and their corresponding symbols can be passed to getQuote or getHistory to retrieve the associated price data - as requested by the end user. Find our more about our commodity data offerings here. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: instrumentType description: The type of grain instruments. This parameter should be set to the desired instrument type for the query. required: true schema: type: string enum: - 'bidBasis' - 'bidCash' - 'indexBasis' - 'indexCash' example: 'indexBasis' - in: query name: instrumentRoot description: | A 2-char indicator for commodities. This parameter should be set to the root that represents the desired commodity for the query. Roots that are denoted as "all" are valid for both bid and index data - if "bids" then there is no index associated with that root.

ZC: All kinds of Corn and Milo/Sorghum (all), ZS: All kinds of Soybeans (all), ZW: All kinds of Soft Red Winter Wheat (all), MW: All kinds of Spring Wheat (all), KE: All kinds of Hard Red Winter Wheat (all), FW: All kinds of Feed Wheat (bids), DW: All kinds of Durum Wheat (bids), CW: Wheat (Club) (bids), ZM: Soybean Meal (bids), HS: Soybeans (Hulls) (bids), ZO: Oats (bids), BB: Barley (bids), ZR: Rice (bids), ZK: Ethanol (E85) (bids), GP: Peas (Green) (bids), YP: Peas (Yellow) (bids), SF: Birdseed or Sunflowers (bids), RY: Rye (bids), RS: Canola (bids), PC: Pulse Crops (Peas, Dry Beans, Lentils & Chickpeas) (bids), PB: Beans (Pinto) (bids), LB: Beans (Lentil) (bids), GB: Beans (Garbonzo) (bids), MI: Millet (bids), MD: Distiller Grains (MWDGS) (bids), DG: Distiller Grains (DDGS) (bids), FL: Flax (bids), CS: Cottonseed (bids) required: true schema: type: string example: 'ZC' - in: query name: zipCode description: A valid zip code to refine the area that cash bids orgin from. This parameter is required if stateFipsCode has not been set. This is the only way to query Canada grain bids. required: false schema: type: string - in: query name: stateFipsCode description: A valid 2-digit state code used to define the area that the underlying grain data (bids or indexes) will be returned from. This parameter is required if zipCode and indexGroup have not been set. Note that calls using this field will return instruments for counties and districts that are associated with the requested stateFipsCode - in addition any instruments with an area equal to the user specified stateFipsCode.

Please click here to get a list of possible values. required: false schema: type: string - in: query name: districtCode description: A valid 2-digit district code used to define the area that the underlying grain data (bids or indexes) will be returned from. Note that calls using this field will return instruments for counties that are associated with the requested districtCode - in addition any instruments with an area equal to the user specified districtCode.

Please click here to get a list of possible values. required: false schema: type: string - in: query name: countyFipsCode description: A valid 3-digit county code use to define the the area that the underlying grain data (bids or indexes) will be returned from.

Please click here to get a list of possible values. required: false schema: type: string - in: query name: deliveryMonth description: | The last month in the delivery window for cash bids or indexes using the following format: "YYYYMM"(i.e. 202607). For example, a bid with a delivery window of 202612 through 202703 can only be retrieved by input of 202703.

For instrumentType = 'IndexBasis' or 'IndexCash', this parameter accepts rolling month codes: 'A' - 'L', which represent the forward delivery month from front month (A) to the 11th (L) forward month required: false schema: type: string example: '202607' - in: query name: indexGroup description: | A valid index aggregate level that returns all index instruments belonging to a specific indexGroup.Combining indexGroup and country or region are the only way to query national indexes and regional indexes.

This parameter may required if stateFipsCode has not been set.
Available values (multiple values separated by a comma may be used): *nation, region, state, district, county*. required: false schema: type: string example: 'nation' - in: query name: country description: The short country name to further refine the index instruments. required: false schema: type: string example: 'US' - in: query name: region description: A short region name to further refine the index instruments. required: false schema: type: string enum: - 'Delta' - 'Eastern' - 'Western' - 'Others' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. Default value is 200 required: false schema: type: string enum: - '25' - '50' - '100' - '150' - '200' - '250' - '300' - '350' - '400' - '450' - '500' example: '25' - in: query name: page description: The value to set for pagination. required: true schema: type: integer example: 1 - in: query name: locationId description: The locationId for which all cash bid symbol should be returned. required: false schema: type: integer example: 4435 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 unique symbol that identifies a grain bid or a grain index. type: string nullable: true example: 'ZCBG21US.CM' symbolDescription: description: A short description of a grain bid or a grain index. type: string nullable: true example: 'cmdty National Corn Basis Idx Feb 2021' elevator: description: Name of the applicable grain buying elevator.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: 'Elburn Coop' commodity: description: Standardized commodity name. type: string nullable: true example: 'Corn (#2 Yellow)' underlyingFuture: description: Futures symbol of tied futures contract. type: string nullable: true example: 'ZCH21' deliveryStart: description: Delivery start date of grain bid.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '2021-01-23T06:59:59-06:00' deliveryEnd: description: Delivery end date of the associated grain instrument. type: string nullable: true example: '2021-02-28T17:59:59-06:00' location: description: Name of location that grain bid originated from.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: 'Ingredion' facilityType: description: The type of facility.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: 'Export Terminal' phone: description: Phone number of location.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '815-899-8964' website: description: Website associated with elevator.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: 'www.chselburn.com' address: description: The street address of the location.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '6400 S Archer Rd' city: description: City associated with the underlying grain bid.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '6400 S Archer Rd' state: description: 2-char abbreviation of the state that contains the applicable cash bid or index. type: string nullable: true example: 'IL' zipCode: description: Zip code associated with the underlying grain bid. type: string nullable: true example: '60501' longitude: description: The longitude of the location.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '-87.826071' latitude: description: The latitude of the location.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '41.775032' county: description: The name of the county containing the applicable cash bid or index. type: string nullable: true example: 'Cook County' indexGroup: description: A index aggregate level (National, Regional, State, Crop Reporting District, County).
(ONLY returned for instrument type indexBasis or indexCash.) type: string nullable: true example: 'region' country: description: The country associated with the indexing area.
(ONLY returned for instrument type indexBasis or indexCash.) type: string nullable: true example: 'US' region: description: The region associated with the applicable indexing area.
(ONLY returned for instrument type indexBasis or indexCash.) type: string nullable: true example: 'Eastern' countyCode: description: Concatenation of stateFipsCode, countyFipsCode, and classFipsCode.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: 'IL-17-031-H1' fipsCode: description: FIPS code for the county. Concatenation of stateFipsCode and countyFipsCode.
(ONLY returned for instrument type bidBasis or bidCash.) type: string nullable: true example: '17031' countyFipsCode: description: 3-digit FIPS code of the county is associated with the applicable cash bid or index. type: string nullable: true example: '069' districtCode: description: 2-digit district code of crop reporting district that is associated with the applicable cash bid or index. type: string nullable: true example: 'D20' stateFipsCode: description: 2-digit FIPS code of state that is associated with the applicable cash bid or index. type: string nullable: true example: '39' required: - symbol - symbolDescription - commodity - underlyingFuture - deliveryEnd - state - county - countyFipsCode - districtCode - stateFipsCode '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getBLSIndexes.json: get: tags: - Other Data summary: getBLSIndexes operationId: get-getBLSIndexes description: The getBLSIndexes API provides historical price data for our cmdty BLS Commodity Price Index Family. The cmdty BLS Commodity Price Indexes measure price movements of 22 basic commodities whose markets are among the first to be influenced by changes in economic conditions. Sub-indices for six major asset classes are calculated. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: type description: The type of historical data to return, including tick data, minute data, and end-of-day data. required: true schema: type: string enum: - 'ticks' - 'minutes' - 'nearbyMinutes' - 'formTMinutes' - 'daily' - 'dailyNearest' - 'dailyContinue' - 'weekly' - 'weeklyNearest' - 'weeklyContinue' - 'monthly' - 'monthlyNearest' - 'monthlyContinue' - 'quarterly' - 'quarterlyNearest' - 'quarterlyContinue' - 'yearly' - 'yearlyNearest' - 'yearlyContinue' example: 'minutes' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the date 6 months back from present day. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20100101' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, but not including, this value). If not set, the value will default to the end of the current day. The value should conform to the format yyyymmdd[hhmm[ss]], where fields in brackets are optional (Do not include the brackets themselves). Any optional fields that are not explicitly set will default to 0 (i.e. 20090203 will default to 20090203000000 or February 3, 2009 at 00:00:00). required: false schema: type: string example: '20130101' - in: query name: maxRecords description: The maximum amount of records returned. This parameter should be set to the maximum number of records desired. If not specified, there number of records returned will be determined by the date/time parameters specified as well as any defaults that apply to the query. required: false schema: type: integer example: 10 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 nullable: true example: 'BZY00' name: description: The name/description for the instrument. type: string nullable: true example: 'cmdty BLS Commodity Price Index' history: description: An object with the date and close price for the provided date range. type: array items: anyOf: - type: object example: tradingDay: '2020-08-23' close: 387.45 - type: object example: tradingDay: '2020-08-25' close: 389.97 nullable: true required: - symbol - name - history '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCmdtyCalendar.json: get: tags: - Other Data summary: getCmdtyCalendar operationId: get-getCmdtyCalendar description: The getCmdtyCalendar API provides user the latest updates of US economic activity and commodity trading events, including previous, revised, and actual values, updated 3 times a day. Users can request calendar events for desired period, and filter the output via various methods - category, importance, event country, and event symbol. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the beginning of this data series. Note that if the date range requested by the user is more extensive than the user's permissions allow for, the output range will be determined based on an offset from the startDate. required: true schema: type: string example: '20250722' - in: query name: endDate description: The end date of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to the last day of current year. required: true schema: type: string example: '20261231' - in: query name: category description: | Filter returned result by category. Accept string concat category code by comma.
Available values (multiple values separated by a comma may be used): *All, Ag, Energy, Econ*. required: false schema: type: string example: 'Ag,Energy' - in: query name: country description: Filter returned result by country/countries. Accept string concat iso-3 country code by comma. required: false schema: type: string example: 'USA,CHN' - in: query name: importance description: | Filter returned result by importance level/levels. Accept string concat integer by comma.
1 = low, 2 = medium, 3 = high
Available values (multiple values separated by a comma may be used): *1, 2, 3*. required: false schema: type: string example: '2,1' - in: query name: symbol description: Filter returned result by symbol. Accept valid symbol, which is a unique identifier of a time series, and multiple symbols separated by a comma. required: false schema: type: string example: 'USCB-WHSLETRADE-SALES-CHG-SA-USA-13652.CM,USCB-WHSLETRADE-INV-CHG-SA-USA-13610.CM' - in: query name: order description: An arrangement of fields within a particular record (ascending or descending). This parameter can be set to one of two values ("asc" and "desc") in order to specify the chronological order of the result set returned. required: false schema: type: string enum: - 'asc' - 'desc' example: 'asc' - in: query name: fields description: | Return extra columns if requested, invalid input is a string concats optional output fields by comma.
Available values (multiple values separated by a comma may be used): *reference_ending, prior_reference_ending, status*. required: false schema: type: string example: 'reference_ending,prior_reference_ending' 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: date: description: Release time and date in UTC. type: string nullable: true example: '2020-03-26T12:30:00+00:00' country: description: Country Name. type: string nullable: true example: 'USA' event: description: Specific event name in the calendar. type: string nullable: true example: 'Retail Inventories' report: description: Report that event data released from. type: string nullable: true example: 'Advance Economic Indicators' source: description: Source of data. type: string nullable: true example: 'US Census' category: description: Category of event. type: string nullable: true example: 'Econ' reference: description: Reference period for latest released value. type: string nullable: true example: 'Feb' reference_ending: description: Ending date of the reference period in "YYYY-MM-DD" format. type: string format: date nullable: true example: '2020-02-29' actual: description: Latest released value. type: number format: double nullable: true example: 657502 prior_reference_ending: description: Ending date of the prior reference period in "YYYY-MM-DD" format. type: string format: date nullable: true example: '2020-01-31' prior: description: Value for the previous period before the revision (if revision is applicable). type: number format: double nullable: true example: 660227 revised: description: Value for the previous period after the revision (if revision is applicable). type: number format: double nullable: true example: 659246 unit: description: Unit of the value. type: string nullable: true example: 'Million U.S. Dollar' status: description: Event updating status. type: string nullable: true example: 'updated' refreshed: description: Last refresh timestamp. type: string format: date nullable: true example: '2020-04-16' symbol: description: A unique identifier for event's time series stored in cmdtyStats. type: string nullable: true example: 'USCB-RETTRADE-INV-SA-USA-15511.CS' importance: description: The priority level of the event. type: integer nullable: true example: 1 required: - date - country - event - report - source - category - reference - actual - prior - revised - unit - refreshed - symbol - importance '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getFuelPrices.json: get: tags: - Other Data summary: getFuelPrices operationId: get-getFuelPrices description: The getFuelPrices API provides refined fuel price data and reference data. Refined fuel data can be requested for fuel selling locations, for geographic coordinates and radius, for zip code and radius, and for a specified county. Refined fuel data can be filtered by product name(s), and by number of locations will be returned. Reference data contains fuel selling locations and product names, providing valid values in use for requesting refined fuel data. Reference data can be requested for geographic coordinates and radius. If no geographic coordinates are given, reference data will return all valid values by default. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: requestType description: A type of reference data to define what reference data will be returned. required: false schema: type: string enum: - 'products' - 'locations' - 'prices' - in: query name: location description: | A location id or a code identifies a or multiple fuel selling location(s) that fuel prices will be returned for. A valid code consist of multiple location ids separated by a comma, and the code can contain up to 100 locations. A list of valid location ids can be retrieved by using this API with input: requestType = location. location and several other inputs -geographic coordinates, zipCode, maxDistance, county, totalLocations- are mutually exclusive. required: false schema: type: string - in: query name: latitude description: The latitude of a valid geographic coordinates to define the center of area that fuel prices will be returned for. Geographic coordinates and Zipcode are mutually exclusive. required: false schema: type: number format: double nullable: true - in: query name: longitude description: The longitude of a valid geographic coordinates to define the center of area that fuel prices will be returned for. Geographic coordinates and Zipcode are mutually exclusive. required: false schema: type: number format: double nullable: true - in: query name: zipCode description: A valid US or Canadian zip code to define the center of area that fuel prices will be returned for. Default value is 60606. Geographic coordinates and Zipcode are mutually exclusive. required: false schema: type: string example: '60606' - in: query name: maxDistance description: A maximum distance from geographic coordinates input or from the center of zip code input in miles to help user define the area that fuel prices will be returned for. Maximum value is 250 required: false schema: type: number format: double nullable: true example: 100 - in: query name: county description: A valid string code which represents the concatenation of county name and state code seperated by a hyphen. required: false schema: type: string example: 'BOONE COUNTY-IA' - in: query name: state description: A valid 2-char state code. required: false schema: type: string example: 'IL' - in: query name: fipsCode description: A string concatenation of state FIPS code and county FIPS code without separator to define the county that fuel prices will be returned for. Please click here to get a list of possible values. required: false schema: type: integer example: 17053 - in: query name: productName description: | A standard product name or a name list that's separated by pipe (|) to filter prices. Note that the input needs to be encoded in UTF-8. A list of valid product names can be retrieved by using this API with input: requestType = products. required: false schema: type: string example: 'USLD' - in: query name: totalLocations description: The maximum amount of fuel selling locations that fuel prices will be returned for. If zip code is set, then API will provide cashbid for given amount closet locations in relation to the requested zip code. Maximum value is 100. required: false schema: type: integer example: 1 - in: query name: page description: The page number. required: false schema: type: integer example: 1 - in: query name: fields description: Additional as per-requested fields that the user can define. Requested fields should be separated by a comma. Valid per-requested fields are companyId, locationType, mailingAddress, fax, defLanes, dieselLanes, bioBlend, businessHours, productId, productShort, productFull required: false schema: type: string 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: prices: description: A list of fuel prices from a fuel selling location. Each fuel price contains the meta and price data applicable to that location. type: array items: anyOf: - type: object example: symbol: HOPA-1070-16.CM seriesName: Road Ranger Chicago, IL Auto Diesel Price productId: 16 product: Auto Diesel price: 2.859 date: '2021-01-11' - type: object example: symbol: HOPA-1070-1.CM seriesName: Road Ranger Chicago, IL Diesel Price productId: 1 product: Diesel price: 2.859 date: '2021-01-11' - type: object example: symbol: RBPA-1070-4.CM seriesName: Road Ranger Chicago, IL Regular Gas Price productId: 4 product: Regular Gas price: 2.599 date: '2021-01-11' nullable: true distance: description: Distance of the fuel selling location in miles from the input zip code/geographic coordinates. type: string nullable: true example: '5 miles away' locationId: description: A internal identifier of fuel selling location. type: integer nullable: true example: 1070 location: description: Name of fuel selling location that fuel price originated from. type: string nullable: true example: '3401 S California Ave' companyId: description: A internal identifier of fuel selling company. type: integer nullable: true example: 3 company: description: A full-length name for companies. type: string nullable: true example: 'Road Ranger' locationType: description: The type of fuel selling location. type: string nullable: true example: 'Fuel Stop' address: description: The street address of the location. type: string nullable: true example: '3401 S California Ave' mailingAddress: description: The mailing address of the location. type: string nullable: true example: '3401 S California Ave, Chicago, IL 60608, USA' highway: description: The nearby highway exit(s). type: string nullable: true example: 'I-57 Exit 353 I-294 Exit 12A' zipCode: description: The zip code for the location. type: string nullable: true example: '60608' city: description: City that contains the applicable fuel price. type: string nullable: true example: 'Chicago' county: description: The name of the county containing the applicable fuel price. type: string nullable: true example: 'Cook' fipsCode: description: A string concatenation of state FIPS code and county FIPS code to identify a county. type: number format: double nullable: true example: 17031 state: description: 2-char abbreviation of the state that contains the applicable fuel price. type: string nullable: true example: 'IL' country: description: ISO-3 country code of the location. type: string nullable: true example: 'USA' longitude: description: The longitude of the location. type: number format: double nullable: true example: -87.6945368 latitude: description: The latitude of the location. type: number format: double nullable: true example: 41.83145 phone: description: The phone number for the location. type: string nullable: true example: '815-977-7020' fax: description: The fax number for the location. type: string nullable: true example: '815-977-7020' showers: description: The total number or availability of showers. type: string nullable: true example: 'No' truckSpaces: description: The total number or availability of truck parking spaces. type: string nullable: true example: 'No' defLanes: description: The total number or availability of DEF lanes. type: string nullable: true example: 'No' dieselLanes: description: The total number or availability of diesel lanes. type: string nullable: true example: '7' weighScales: description: The brand or availability of weight scale. type: string nullable: true example: 'CAT' bioBlend: description: The type or availability of bio-blend fuel. type: string nullable: true example: 'B12' businessHours: description: The operating hours for the location. type: string nullable: true example: '24/7/365' currency: description: The currency used for the location. type: string nullable: true example: 'USD' metric: description: The units system a location used for quoting. type: string nullable: true example: 'U.S. Customary Units' locationUpdateDate: description: Date when the meta data was last updated for a location in Central Time Zone. type: string format: date nullable: true example: '2019-02-12' lastUpdateTimestamp: description: Date that prices were last updated for a location in Central Time Zone. type: string nullable: true example: '2021-01-11T00:00:00-06:00' productShort: description: A short-length name for products. type: string nullable: true example: null product: description: A medium-length name for products. type: string nullable: true example: null productFull: description: A full-length name for products. type: string nullable: true example: null productDescription: description: A short description for the product. type: string nullable: true example: null required: - prices - distance - locationId - location - company - address - highway - zipCode - city - county - fipsCode - state - country - longitude - latitude - phone - showers - truckSpaces - weighScales - currency - metric - locationUpdateDate - lastUpdateTimestamp '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getCropFactors.json: get: tags: - Other Data summary: getCropFactors operationId: get-getCropFactors description: The getCropFactors API provides weather data/factors specific to Ag Industry. With this API, you can retrieve satellite imagery derived weather factors, like Normalized Difference Vegetation Index (NDVI), Normalized Difference Water Index (NDWI), and Land Surface Temperature(LSTD & LSTN), and station collected weather data, like air temperature(TMAX & TMIN), and accumulated precipitation(PRCP).
Data can be requested for a combination of counties and observation windows. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: countyCode description: A county FIPS code or a code that identifies multiple counties. A valid code consists of multiple county FIPS codes separated by a comma, and the code can contain up to 100 counties. Mutually exclusive with stateCode.
Please click here to get a list of possible values. required: true schema: type: string example: '17031,17111' - in: query name: stateCode description: A state FIPS code or a code that identifies multiple states. A valid code consists of multiple state FIPS codes separated by a comma, and the code can contain up to 20 states.
Please click here to get a list of possible values. required: false schema: type: string example: '19,17' - in: query name: startDate description: The start date of the historical data query. This parameter should be set to the desired start date/time for the query (the result set will include records back to, and including, this value). If not set, the value will default to 20260101 required: true schema: type: string example: '20260601' - in: query name: endDate description: The end data of the historical data query. This parameter should be set to the desired end date/time for the query (the result set will include records up to, and including, this value). If not set, the value will default to the day specified in the start parameter. required: false schema: type: string example: '20260722' - in: query name: fields description: | Additional as per-requested fields that the user can define. Requested fields should be separated by a comma.
Available values (multiple values separated by a comma may be used): *ndviCount, ndwiCount, lstdCount, lstnCount, tmaxCount, tminCount, prcpCount*. required: false schema: type: string example: 'ndviCount,ndwiCount' 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: countyCode: description: FIPS code for the county. Concatenation of stateFipsCode and countyFipsCode. type: string nullable: true example: '19041' county: description: The name of the county corresponds to the weather data. type: string nullable: true example: 'Clay County' state: description: 2-char abbreviation of the state. type: string nullable: true example: 'IA' startDate: description: Start date of 8-days composite window. type: string format: date nullable: true example: '2021-01-01' endDate: description: End date of 8-days composite window. type: string format: date nullable: true example: '2021-01-08' ndvi: description: Average Normalized Difference Vegetation Index (NDVI) for croplands within a county calculated based on MODIS with daily updating. type: number format: double nullable: true example: -0.00899 ndviCount: description: Count of cropland grids(250m * 250m) that contributed to calculating NDVI type: integer nullable: true example: 12548 ndwi: description: Average Normalized Difference Water Index (NDWI) for croplands within a county calculated based on MODIS with daily updating. type: number format: double nullable: true example: 0.75143 ndwiCount: description: Count of cropland grids(250m * 250m) that contributed to calculating NDWI type: integer nullable: true example: 12548 lstd: description: Average Land Surface Temperature Daytime (LSTD) in Celsius degrees for croplands within a county calculated based on MODIS with daily updating. Unit in celsius degrees. type: number format: double nullable: true example: -0.87 lstdCount: description: Count of cropland grids(250m * 250m) that contributed to calculating LSTD type: integer nullable: true example: 12548 lstn: description: Average Land Surface Temperature Nighttime (LSTN) in Celsius degrees for croplands within a county calculated based on MODIS with daily updating. Unit in celsius degrees. type: number format: double nullable: true example: -14.31 lstnCount: description: Count of cropland grids(250m * 250m) that contributed to calculating LSTN. type: integer nullable: true example: 12548 tmax: description: Average Maximum Air Temperature in Celsius degrees for a county calculated based on land surface stations with daily updating. type: number format: double nullable: true example: 0.31 tmaxCount: description: Count of land surface stations that contributed to calculating TMAX. type: integer nullable: true example: 2 tmin: description: Average Minimum Air Temperature in Celsius degrees for a county calculated based on land surface stations with daily updating. type: number format: double nullable: true example: -10.06 tminCount: description: Count of land surface stations that contributed to calculating TMIN. type: integer nullable: true example: 2 prcp: description: Average accumulated precipitation in millimeter for a county in the 8-days window. type: number format: double nullable: true prcpCount: description: Count of land surface stations that contributed to calculating PRCP. type: integer nullable: true example: 2 updatedAt: description: Date that factors were last updated for a county. type: string nullable: true example: '2021-01-17T00:00:00-06:00' required: - countyCode - county - state - startDate - endDate - ndvi - ndwi - lstd - lstn - tmax - tmin - prcp - updatedAt '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getUniqueIdentifier.json: get: tags: - Other Data summary: getUniqueIdentifier operationId: get-getUniqueIdentifier description: The getUniqueIdentifier provides the Financial Instrument Global Identifier (FIGI) information for all available instruments. For more information on FIGI, please click here. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: identifierType description: | The code/value for the global identifier protocol.
Available values (multiple values separated by a comma may be used): *openFIGI*. required: false schema: type: string example: 'openFIGI' - in: query name: barchartSymbols description: The unique barchart identifier. Multiple symbols can be requested separated by a comma. required: false schema: type: string example: 'IBM,GOOGL' - in: query name: exchange description: A valid exchange identifer code. required: false schema: type: string example: 'NYSE' - in: query name: openFIGIGlobal description: The unique global OpenFIGI id. Multiple IDs can be requested separated by a comma. required: false schema: type: string example: 'BBG0015VZ6S1' - in: query name: openFIGIComposite description: The unique composite OpenFIGI id. Multiple IDs can be requested separated by a comma. required: false schema: type: string 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 nullable: true example: 'SLNLF' symbolName: description: The name of the financial instrument. type: string nullable: true example: 'Stella International Holdings Ltd.' exchange: description: Exchange code for the marketplace where the financial instruments are listed. type: string nullable: true example: 'HKEX' openFIGI: description: An object with OpenFIGI unique identifer information (global and composite) for each available symbol. type: object properties: global: type: string example: BBG000RPRDK4 composite: type: string example: BBG000RPRDK4 name: type: string example: STELLA INTERNATIONAL nullable: true required: - symbol - symbolName - exchange - openFIGI '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error /getYieldForecastPlanet.json: get: tags: - Other Data summary: getYieldForecastPlanet operationId: get-getYieldForecastPlanet description: The getYieldForecast API provides Barchart proprietary grain yield forecast data. Yield Index data can be filtered by commodity, by indexGroup, by state, by district, and by county. The unit is in Bushel per Acre. parameters: - in: query name: apikey description: Enter the secret API key. required: true schema: type: string example: YOUR_API_KEY - in: query name: country description: The ISO-2 country code to further refine the instruments. required: true schema: type: string enum: - 'US' example: 'US' - in: query name: state description: An ANSI-2 state abbreviation to define the state that yield forecast index will be returned for. required: false schema: type: string example: 'IL' - in: query name: stateFips description: A valid 2-digits state fips code used to define the state that yield forecast index will be returned for. Please click here to get a list of possible values. required: false schema: type: string example: '17' - in: query name: districtCode description: A valid 2-digit district code used to define the district that yield forecast index will be returned for. Please click here to get a list of possible values. required: false schema: type: string example: '50' - in: query name: county description: A county name to define the county that yield forecast index will be returned for. required: false schema: type: string example: 'Champaign County' - in: query name: countyFips description: A valid 3-digits county fips code to define the county that yield forecast index will be returne for. Please click here to get a list of possible values. required: false schema: type: string example: '019' - in: query name: crop description: A commodity name to filter yield forecast index. required: false schema: type: string enum: - 'corn' - 'soybean' example: 'corn' - in: query name: indexGroup description: A valid index aggregate level to filter yield forecast index. required: false schema: type: string enum: - 'national' - 'state' - 'district' - 'county' example: 'district' - in: query name: fields description: | Additional output fields requested. Requested fields should be separated by a comma.
Available values (multiple values separated by a comma may be used): *shortName*. required: false schema: type: string example: 'shortName' 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 unique symbol that identifies the data series. type: string nullable: true example: null name: description: The name of the data series. type: string nullable: true example: null shortName: description: The short name of the data series. type: string nullable: true example: null indexGroup: description: An index aggregate level (National, State, Crop Reporting District, County). type: string nullable: true example: null crop: description: The crop name. type: string nullable: true example: null country: description: The ISO-2 country code abbreviation associated with the indexing area. type: string nullable: true example: null state: description: The 2-char abbreviation of the state associated with the indexing area. type: string nullable: true example: null stateFipsCode: description: The -digit FIPS code of state associated with the indexing area. type: string nullable: true example: null district: description: 2-digit district code of crop reporting district that is associated with the indexing area. type: string nullable: true example: null county: description: The name of the county that is associated with the indexing area. type: string nullable: true example: null countyFipsCode: description: 3-digit FIPS code of the county is associated with the indexing area. type: string nullable: true example: null lastUpdated: description: The date of the index last updated. type: string format: date nullable: true example: null required: - symbol - name - indexGroup - crop - country - state - stateFipsCode - district - county - countyFipsCode - lastUpdated '204': description: No Content '400': description: Bad Request '500': description: Internal Server Error