openapi: 3.2.0 info: title: Market Data V1 API version: 0.0.0 termsOfService: https://www.marketdata.app/terms/ contact: email: support@marketdata.app tags: - name: v1 paths: /v1/markets/status/: get: operationId: v1_markets_status_retrieve description: Get market status ("open" or "closed") for a date or range of dates. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: query name: date schema: type: string format: date description: 'Use to lookup status from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'Limit the status to dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'Limit the status to dates before to (inclusive). Should be combined with from to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a number of dates before (to the left of) to. If you use from, countback is not required. - in: query name: country schema: type: string description: Use to specify the country of the exchange. Use the two digit ISO 3166 country code. If no country is specified, US exchanges will be assumed. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: MarketStatus: value: s: ok date: - 1706745600 - 1706832000 - 1706918400 status: - open - open - closed summary: Market Status text/csv: schema: type: object additionalProperties: {} description: '' /v1/options/chain/{underlying}/: get: operationId: v1_options_chain_retrieve description: 'Get a current or historical end of day options chain for an underlying ticker symbol. Optional parameters allow for extensive filtering of the chain. Use the optionSymbol returned from this endpoint to get quotes, greeks, or other information using the other endpoints.' parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: underlying schema: type: string description: "The underlying ticker symbol for the options chain you wish to lookup.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Use to lookup a historical end of day options chain from a specific trading day. If no date is specified the chain will be the most current chain available during market hours. When the market is closed the chain will be from the last trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: expiration schema: type: string format: date description: 'Limit the option chain to a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.' - in: query name: from schema: type: string format: date description: 'Limit the option chain to expiration dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.' - in: query name: to schema: type: string format: date description: 'Limit the option chain to expiration dates before to (not inclusive). Should be combined with from to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.' - in: query name: month schema: type: integer description: Limit the option chain to options that expire in a specific month (1-12). - in: query name: year schema: type: integer description: Limit the option chain to options that expire in a specific year. - in: query name: weekly schema: type: boolean description: Limit the option chain to weekly expirations by setting weekly to true and omitting the monthly and quarterly parameters. If set to false, no weekly expirations will be returned. - in: query name: monthly schema: type: boolean description: Limit the option chain to standard monthly expirations by setting monthly to true and omitting the weekly and quarterly parameters. If set to false, no monthly expirations will be returned. - in: query name: quarterly schema: type: boolean description: Limit the option chain to quarterly expirations by setting quarterly to true and omitting the weekly and monthly parameters. If set to false, no quarterly expirations will be returned. - in: query name: dte schema: type: integer description: Days to expiry. Limit the option chain to a single expiration date closest to the dte provided. Should not be used together with from and to. Take care before combining with weekly, monthly, quarterly, since that will limit the expirations dte can return. If you are using the date parameter, dte is relative to the date provided. - in: query name: side schema: type: string enum: - call - put description: Limit the option chain to either call or put. If omitted, both sides will be returned. - in: query name: range schema: type: string enum: - all - itm - otm description: 'Limit the option chain to strikes that are in the money, out of the money, or include all. If omitted all options will be returned. Valid inputs: itm, otm, all.' - in: query name: strike schema: type: string description: Limit the option chain to options with the specific strike specified. - in: query name: minOpenInterest schema: type: number format: float description: Limit the option chain to options with an open interest greater than or equal to the number provided. Can be combined with minVolume and minLiquidity to further filter. - in: query name: minVolume schema: type: integer description: Limit the option chain to options with an volume transacted greater than or equal to the number provided. - in: query name: maxBidAskSpread schema: type: number format: float description: Limit the option chain to options with a bid-ask spread less than or equal to the number provided. - in: query name: maxBidAskSpreadPct schema: type: number format: float description: Limit the option chain to options with a bid-ask spread less than or equal to the percent provided (relative to the underlying). For example, a value of 0.5% would exclude all options trading with a bid-ask spread greater than $1.00 in an underlying that trades at $200. - in: query name: nonstandard schema: type: boolean description: Include non-standard contracts by setting nonstandard to true. If set to false, no non-standard options will be returned. If omitted, defaults to false. - in: query name: delta schema: type: string description: Limit the option chain to options with a delta value close to the specified value. - in: query name: strikeLimit schema: type: integer description: Limit the number of strikes returned to the N closest strikes to the at-the-money strike. - in: query name: minBid schema: type: number format: float description: Limit the option chain to options with a bid price greater than or equal to the number provided. - in: query name: maxBid schema: type: number format: float description: Limit the option chain to options with a bid price less than or equal to the number provided. - in: query name: minAsk schema: type: number format: float description: Limit the option chain to options with an ask price greater than or equal to the number provided. - in: query name: maxAsk schema: type: number format: float description: Limit the option chain to options with an ask price less than or equal to the number provided. - in: query name: am schema: type: boolean description: Limit the option chain to AM-settled options by setting am to true. If set to false, no AM-settled options will be returned. - in: query name: pm schema: type: boolean description: Limit the option chain to PM-settled options by setting pm to true. If set to false, no PM-settled options will be returned. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: OptionChain: value: s: ok optionSymbol: - AAPL250117C00150000 - AAPL250117P00150000 underlying: - AAPL - AAPL expiration: - 1737136800 - 1737136800 side: - call - put strike: - 150 - 150 firstTraded: - 1663118400 - 1663118400 dte: - 45 - 45 updated: - 1705449600 - 1705449600 bid: - 52.1 - 0.02 bidSize: - 10 - 50 mid: - 52.35 - 0.03 ask: - 52.6 - 0.04 askSize: - 15 - 100 last: - 52.3 - 0.03 openInterest: - 5000 - 12000 volume: - 1500 - 800 inTheMoney: - true - false intrinsicValue: - 50.22 - 0 extrinsicValue: - 2.13 - 0.03 underlyingPrice: - 200.22 - 200.22 iv: - 0.3012 - 0.4521 delta: - 0.89 - -0.01 gamma: - 0.012 - 0.005 theta: - -0.05 - -0.01 vega: - 0.15 - 0.02 summary: Option Chain text/csv: schema: type: object additionalProperties: {} description: '' /v1/options/expirations/{underlying}/: get: operationId: v1_options_expirations_retrieve description: 'Get a list of current or historical option expiration dates for an underlying symbol. If no optional parameters are used, the endpoint returns the expirations for strike in the chain.' parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: underlying schema: type: string description: "The underlying ticker symbol for the options chain you wish to lookup.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: strike schema: type: string description: Limit the lookup of expiration dates to the strike provide. This will cause the endpoint to only return expiration dates that include this strike. - in: query name: date schema: type: string format: date description: 'Use to lookup a historical list of expiration dates from a specific previous trading day. If date is omitted the expiration dates will be from the current trading day during market hours or from the last trading day when the market is closed. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: OptionExpirations: value: s: ok expirations: - '2025-01-17' - '2025-02-21' - '2025-03-21' updated: 1705449600 summary: Option Expirations text/csv: schema: type: object additionalProperties: {} description: '' /v1/options/lookup/{userInput}/: get: operationId: v1_options_lookup_retrieve description: 'Generate a properly formatted OCC option symbol based on the user''s human-readable description of an option. This endpoint converts text such as "AAPL 7/26/23 $200 Call" to OCC option symbol format: AAPL230726C00200000. The user input must be URL-encoded.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: userInput schema: type: string description: The human-readable string input that contains (1) stock symbol (2) strike (3) expiration date (4) option side (i.e. put or call). This endpoint will translate the user's input into a valid OCC option symbol. required: true tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: OptionLookup: value: s: ok optionSymbol: AAPL250117C00150000 summary: Option Lookup text/csv: schema: type: object additionalProperties: {} description: '' /v1/options/quotes/{optionSymbol}/: get: operationId: v1_options_quotes_retrieve description: 'Get a current or historical end of day quote for a single or multiple options contracts. Separate multiple options symbols with a comma.' parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: optionSymbol schema: type: string description: The option symbol (as defined by the OCC) for the option you wish to lookup. Use the current OCC option symbol format, even for historic options that quoted before the format change in 2010. required: true - in: query name: date schema: type: string format: date description: 'Use to lookup a historical end of day quote from a specific trading day. If no date is specified the quote will be the most current price available during market hours. When the market is closed the quote will be from the last trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'Use to lookup a series of end of day quotes. From is the oldest (leftmost) date to return (inclusive). If from/to is not specified the quote will be the most current price available during market hours. When the market is closed the quote will be from the last trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'Use to lookup a series of end of day quotes. To is the newest (rightmost) date to return (exclusive). If from/to is not specified the quote will be the most current price available during market hours. When the market is closed the quote will be from the last trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a number of quotes before (to the left of) to. If you use from, countback is not required. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: OptionQuote: value: s: ok optionSymbol: - AAPL250117C00150000 underlying: - AAPL expiration: - 1737136800 side: - call strike: - 150 firstTraded: - 1663118400 dte: - 45 updated: - 1705449600 bid: - 52.1 bidSize: - 10 mid: - 52.35 ask: - 52.6 askSize: - 15 last: - 52.3 openInterest: - 5000 volume: - 1500 inTheMoney: - true intrinsicValue: - 50.22 extrinsicValue: - 2.13 underlyingPrice: - 200.22 iv: - 0.3012 delta: - 0.89 gamma: - 0.012 theta: - -0.05 vega: - 0.15 summary: Option Quote text/csv: schema: type: object additionalProperties: {} description: '' /v1/options/strikes/{underlying}/: get: operationId: v1_options_strikes_retrieve description: 'Get a list of current or historical options strikes for an underlying symbol. If no optional parameters are used, the endpoint returns the strikes for every expiration in the chain.' parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: underlying schema: type: string description: "The underlying ticker symbol for the options chain you wish to lookup.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Use to lookup a historical list of strikes from a specific previous trading day. If date is omitted the strikes will be from the current trading day during market hours or from the last trading day when the market is closed. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: expiration schema: type: string format: date description: 'imit the lookup of strikes to options that expire on a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: OptionStrikes: value: s: ok updated: 1705449600 '2025-01-17': - 140 - 145 - 150 - 155 - 160 '2025-02-21': - 135 - 140 - 145 - 150 - 155 - 160 - 165 summary: Option Strikes text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/bulkcandles/{resolution}/: get: operationId: v1_stocks_bulkcandles_retrieve description: Get bulk candles for stocks. This endpoint returns daily candle data for multiple stocks. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: resolution schema: type: string description: "The duration of each candle.\n Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...)\n Hourly Resolutions: (H, 1H, 2H, ...)\n Daily Resolutions: (D, 1D, 2D, ...)\n Weekly Resolutions: (W, 1W, 2W, ...)\n Monthly Resolutions: (M, 1M, 2M, ...)\n Yearly Resolutions:(Y, 1Y, 2Y, ...)')" required: true - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required. - in: query name: exchange schema: type: string description: Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same symbol. You may specify the exchange using the EXCHANGE ACRONYM, MIC CODE, or two digit YAHOO FINANCE EXCHANGE CODE. If no exchange is specified symbols will be matched to US exchanges first. - in: query name: extended schema: type: boolean description: Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The default is false - in: query name: country schema: type: string description: Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is useful when you know the ticker symbol and the country of the exchange, but not the exchange code. Use the two digit ISO 3166 country code. If no country is specified, US exchanges will be assumed. - in: query name: adjustsplits schema: type: boolean description: "Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment.\n Daily candles default: true.\n Intraday candles default: false.\n Only three price views are supported (raw, split-only, fully adjusted). See adjustdividends for the rejected combinations." - in: query name: adjustdividends schema: type: boolean description: "Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment.\n Daily candles default: true.\n Intraday candles default: false.\n Requires adjustsplits=true: dividend-only adjustment is not supported. On daily candles, adjustsplits=false with adjustdividends=true (including the default-resolved case where adjustsplits=false is passed alone) returns HTTP 400. On intraday candles, adjustdividends=true is not supported and returns HTTP 400." - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: BulkStockCandles: value: s: ok symbol: - AAPL - MSFT - GOOG o: - 220.1 - 413.5 - 174.8 h: - 222.3 - 416.0 - 176.2 l: - 219.5 - 412.0 - 173.9 c: - 221.5 - 415.1 - 175.2 v: - 58240000 - 22150000 - 18430000 t: - 1705449600 - 1705449600 - 1705449600 summary: Bulk Stock Candles description: Returns daily candle data for multiple symbols. Each symbol has one candle for the same date. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/bulkquotes/: get: operationId: v1_stocks_bulkquotes_retrieve description: 'Get bulk quote data for stocks. This endpoint returns bulk real time quote data for multiple stocks.' parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: query name: symbols schema: type: string description: "The ticker symbols separated by commas. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: extended schema: type: boolean description: Whether to include extended session prices, defaults to True. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: BulkStockQuotes: value: s: ok symbol: - AAPL - MSFT - GOOG ask: - 221.55 - 415.2 - 175.3 askSize: - 200 - 100 - 150 bid: - 221.5 - 415.05 - 175.15 bidSize: - 300 - 150 - 200 mid: - 221.525 - 415.125 - 175.225 last: - 221.52 - 415.1 - 175.2 change: - 1.38 - -2.4 - 0.95 changepct: - 0.0063 - -0.0057 - 0.0055 volume: - 58240000 - 22150000 - 18430000 updated: - 1705449600 - 1705449600 - 1705449600 summary: Bulk Stock Quotes description: Returns real-time quotes for multiple symbols in a single request. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/candles/{resolution}/{symbol}/: get: operationId: v1_stocks_candles_retrieve description: Get historical price candles for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: resolution schema: type: string description: "The duration of each candle.\n Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...)\n Hourly Resolutions: (H, 1H, 2H, ...)\n Daily Resolutions: (D, 1D, 2D, ...)\n Weekly Resolutions: (W, 1W, 2W, ...)\n Monthly Resolutions: (M, 1M, 2M, ...)\n Yearly Resolutions:(Y, 1Y, 2Y, ...)')" required: true - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required. - in: query name: exchange schema: type: string description: Use to specify the exchange of the ticker. This is useful when you need to specify stock that quotes on several exchanges with the same symbol. You may specify the exchange using the EXCHANGE ACRONYM, MIC CODE, or two digit YAHOO FINANCE EXCHANGE CODE. If no exchange is specified symbols will be matched to US exchanges first. - in: query name: extended schema: type: boolean description: Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The default is false - in: query name: country schema: type: string description: Use to specify the country of the exchange (not the country of the company) in conjunction with the symbol argument. This argument is useful when you know the ticker symbol and the country of the exchange, but not the exchange code. Use the two digit ISO 3166 country code. If no country is specified, US exchanges will be assumed. - in: query name: adjustsplits schema: type: boolean description: "Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment.\n Daily candles default: true.\n Intraday candles default: false.\n Only three price views are supported (raw, split-only, fully adjusted). See adjustdividends for the rejected combinations." - in: query name: adjustdividends schema: type: boolean description: "Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment.\n Daily candles default: true.\n Intraday candles default: false.\n Requires adjustsplits=true: dividend-only adjustment is not supported. On daily candles, adjustsplits=false with adjustdividends=true (including the default-resolved case where adjustsplits=false is passed alone) returns HTTP 400. On intraday candles, adjustdividends=true is not supported and returns HTTP 400." - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockCandles: value: s: ok c: - 217.83 - 219.68 - 218.24 - 220.91 - 222.5 h: - 218.55 - 220.12 - 219.85 - 221.34 - 223.08 l: - 215.78 - 217.32 - 216.09 - 218.45 - 220.15 o: - 216.5 - 218.0 - 219.4 - 218.7 - 221.0 t: - 1705276800 - 1705363200 - 1705449600 - 1705536000 - 1705622400 v: - 62130000 - 58240000 - 53890000 - 61450000 - 55780000 summary: Stock Candles description: Returns OHLCV time-series candles for a single symbol. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/earnings/{symbol}/: get: operationId: v1_stocks_earnings_retrieve description: Get historical earnings per share data or a future earnings calendar for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Retrieve a specific earnings report by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'The earliest earnings report to include in the output. If you use countback, from is not required. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'The latest earnings report to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a specific number of earnings reports before to. If you use from, countback is not required. - in: query name: report schema: type: string description: 'Retrieve a specific earnings report by date and quarter. Example: 2023-Q4. This allows you to retrieve a 4th qurater value without knowing the company''s specific fiscal year.' - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockEarnings: value: s: ok symbol: - AAPL - AAPL - AAPL fiscalYear: - 2024 - 2024 - 2024 fiscalQuarter: - 3 - 2 - 1 date: - 1706659200 - 1698883200 - 1690848000 reportDate: - 1706832000 - 1699056000 - 1691020800 reportTime: - after close - after close - after close currency: - USD - USD - USD reportedEPS: - 2.18 - 1.46 - 1.52 estimatedEPS: - 2.1 - 1.39 - 1.43 surpriseEPS: - 0.08 - 0.07 - 0.09 surpriseEPSpct: - 3.81 - 5.04 - 6.29 updated: - 1706832000 - 1699056000 - 1691020800 summary: Stock Earnings text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/news/{symbol}/: get: operationId: v1_stocks_news_retrieve description: Get news for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: date schema: type: string format: date description: 'Retrieve news by date. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: from schema: type: string format: date description: 'The earliest news to include in the output. If you use countback, from is not required. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: to schema: type: string format: date description: 'The latest news to include in the output. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.' - in: query name: countback schema: type: integer description: Countback will fetch a specific number of news before to. If you use from, countback is not required. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockNews: value: s: ok symbol: - AAPL - AAPL headline: - Apple Reports Record Q4 Revenue - Apple Announces New Product Line content: - Apple Inc. reported record revenue for the fourth quarter... - Apple unveiled its latest product offerings today... source: - https://www.bloomberg.com/news/articles/2024-01-15/apple-record-q4 - https://www.reuters.com/technology/apple-new-product-line-2024-01-14 publicationDate: - 1705449600 - 1705363200 updated: 1705449600 summary: Stock News text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/prices/: get: operationId: stocks_prices description: Get last price for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: query name: symbols schema: type: string description: "The ticker symbols separated by commas. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockPrices: value: s: ok symbol: - AAPL - MSFT - GOOG mid: - 221.525 - 415.125 - 175.225 change: - 1.38 - -2.4 - 0.95 changepct: - 0.0063 - -0.0057 - 0.0055 updated: - 1705449600 - 1705449600 - 1705449600 summary: Stock Prices description: Returns last prices for multiple symbols. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/prices/{symbol}/: get: operationId: stocks_price_by_symbol description: Get last price for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockPrice: value: s: ok symbol: - AAPL mid: - 221.525 change: - 1.38 changepct: - 0.0063 updated: - 1705449600 summary: Stock Price description: Returns the last price for a single symbol. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/quotes/: get: operationId: stocks_quotes description: Get last quote for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: query name: symbols schema: type: string description: "The ticker symbols separated by commas. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: extended schema: type: boolean description: Whether to include extended session prices, defaults to True. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockQuotes: value: s: ok symbol: - AAPL - MSFT - GOOG ask: - 221.55 - 415.2 - 175.3 askSize: - 200 - 100 - 150 bid: - 221.5 - 415.05 - 175.15 bidSize: - 300 - 150 - 200 mid: - 221.525 - 415.125 - 175.225 last: - 221.52 - 415.1 - 175.2 change: - 1.38 - -2.4 - 0.95 changepct: - 0.0063 - -0.0057 - 0.0055 volume: - 58240000 - 22150000 - 18430000 updated: - 1705449600 - 1705449600 - 1705449600 summary: Stock Quotes description: Returns real-time quotes for multiple symbols. text/csv: schema: type: object additionalProperties: {} description: '' /v1/stocks/quotes/{symbol}/: get: operationId: stocks_quote_by_symbol description: Get last quote for a stock. parameters: - in: query name: format schema: type: string enum: - csv - json description: The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON. - in: path name: symbol schema: type: string description: "The company's ticker symbol. If no exchange is specified, by default a US exchange will be assumed. You may embed the exchange in the ticker symbol using the Yahoo Finance or TradingView formats.\n Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)\n " required: true - in: query name: extended schema: type: boolean description: Whether to include extended session prices, defaults to True. - in: query name: dateformat schema: type: string enum: - spreadsheet - timestamp - unix description: The dateformat parameter allows you specify the format you wish to receive date and time information in. - in: query name: limit schema: type: integer description: The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data. - in: query name: offset schema: type: integer description: The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value. - in: query name: headers schema: type: boolean description: The headers parameter is used to turn off headers when using CSV output. - in: query name: columns schema: type: string description: The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell. - in: query name: human schema: type: boolean description: Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names. tags: - v1 security: - Api Authentication: [] - {} responses: '200': content: application/json: schema: type: object additionalProperties: {} examples: StockQuote: value: s: ok symbol: - AAPL ask: - 221.55 askSize: - 200 bid: - 221.5 bidSize: - 300 mid: - 221.525 last: - 221.52 change: - 1.38 changepct: - 0.0063 volume: - 58240000 updated: - 1705449600 summary: Stock Quote description: Returns a real-time quote for a single symbol. text/csv: schema: type: object additionalProperties: {} description: '' components: securitySchemes: Api_Authentication: type: apiKey in: query name: token