v1

latestOpenAPI 3.0.32026-08-0615081.4 KB
v1

Get historical price candles for a stock.

get/v1/stocks/candles/{resolution}/{symbol}/

Path parameters

resolutionstring required

The duration of each candle. Minutely Resolutions: (1, 3, 5, 15, 30, 45, ...) Hourly Resolutions: (H, 1H, 2H, ...) Daily Resolutions: (D, 1D, 2D, ...) Weekly Resolutions: (W, 1W, 2W, ...) Monthly Resolutions: (M, 1M, 2M, ...) Yearly Resolutions:(Y, 1Y, 2Y, ...)')

symbolstring required

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. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)

Query parameters

format'csv' | 'json'

The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.

datestring date

Use to lookup historical candles from a specific trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.

fromstring date

The leftmost candle on a chart (inclusive). If you use countback, to is not required. Accepted timestamp inputs: ISO 8601, unix, spreadsheet.

tostring date

The rightmost candle on a chart (not inclusive). Accepted timestamp inputs: ISO 8601, unix, spreadsheet.

countbackinteger

Countback will fetch a number of candles before (to the left of) to If you use from, countback is not required.

exchangestring

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.

extendedboolean

Include extended hours trading sessions when returning intraday candles. Daily resolutions never return extended hours candles. The default is false

countrystring

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.

adjustsplitsboolean

Adjust historical data for for historical splits and reverse splits. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default: false. Only three price views are supported (raw, split-only, fully adjusted). See adjustdividends for the rejected combinations.

adjustdividendsboolean

Adjust candles for dividends. Market Data uses the CRSP methodology for adjustment. Daily candles default: true. Intraday candles default: false. 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.

dateformat'spreadsheet' | 'timestamp' | 'unix'

The dateformat parameter allows you specify the format you wish to receive date and time information in.

limitinteger

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.

offsetinteger

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.

headersboolean

The headers parameter is used to turn off headers when using CSV output.

columnsstring

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.

humanboolean

Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.

Response

object required