Real-Time Stock Prices

This endpoint lets you query real-time stock prices for US stocks.

Available Fields

• symbol: The symbol or ticker of the stock.
• exchange: The primary exchange in which the stock trades. Please note the price quote itself does not necessarily correspond to a trade on this exchange. As most stocks trade on multiple exchanges, we simply display the latest trade data we have on a stock regardless of which exchange the trade took place on.
• name: The name of the company corresponding to the stock.
• price: The last price the stock traded at during regular market hours.
• percentChange: The percent change in the price of the stock relative to the price it closed at during regular market hours of the previous trading session.
• priceExtended: The last price the stock traded at during regular or extended market hours.
• percentChangeExtended: The percent change in the price of the stock (including extended hours) relative to the price it closed at during regular market hours of the previous trading session.
• open: The opening price of the stock during the active or most recent trading session.
• high: The highest price the stock has traded at during the active or most recent trading session during regular market hours.
• low: The lowest price the stock has traded at during the active or most recent trading session during regular market hours.
• volume: The amount of shares of the stock that traded during the active or most recent trading session during regular market hours.
• relVolume: The stock's relative volume, which is the stock's current volume divided by the stock's average volume (found via the stock profile endpoint).
• smartRelVolume: Smart relative volume is an adjusted measure of relative volume that takes into account how much of the trading day has passed. Example: If only half of the trading day has passed (it's 12:45pm) then we would multiply relative volume by 2.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To query a single stock just identify the stock by its symbol (i.e. "&symbol=AAPL"). To query multiple stocks, identify the stocks with a comma separated list of the relavent symbols (i.e. "&symbol=AAPL,AMZN,NFLX,TSLA"). To identify all US stocks, set the parameter to allsymbols (i.e. "&symbols=allsymbols"). To identify all stocks within a specific US exchange (options are NYSE, NASDAQ or BATS) use the following syntax when setting the parameter: "&symbols=exchangenyse".
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Historic Stock Prices

This endpoint lets you query daily historic stock prices for US stocks.

*Note: All historic data is adjusted for stock splits.

Available Fields

• symbol: The symbol or ticker of the stock.
• date: The date corresponding to the trading data.
• open: The opening price of the stock on that date.
• high: The highest price the stock traded at on that date.
• low: The lowest price the stock traded at on that date.
• close: The closing price of the stock on that date.
• openAdj: The opening price (adjusted for dividends) of the stock on that date.
• highAdj: The highest price (adjusted for dividends) the stock traded at on that date.
• lowAdj: The lowest price (adjusted for dividends) the stock traded at on that date.
• closeAdj: The closing price (adjusted for dividends) of the stock on that date.
• volume: The amount of shares of the stock that traded on that date.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the stock you want to query (i.e. "&symbol=AAPL").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• from: The inclusive starting date of the stock price history you want to query in the format YYYY-MM-DD (i.e. "&from=2020-01-01"). The defualt value is 1 year ago from today.
• to: The inclusive ending date of the stock price history you want to query in the format YYYY-MM-DD (i.e. "&to=2021-01-01"). The defualt value is today.

Real-Time Crypto Prices

This endpoint lets you query 24/7 real-time crypto prices. Please note, although crypto trading sessions never actually close, the "open" is considered at 8PM UTC.

Available Fields

• symbol: The symbol or ticker of the crypto. All symbols start with "$" to identify its a crypto.
• name: The name of the crypto.
• price: The last price the crypto traded at.
• percentChange: The percent change in the price of the crypto relative to its price at the open of the current trading session.
• open: The price of the crypto at the open of the current trading session.
• high: The highest price the crypto has traded at during the current trading session.
• low: The lowest price the crypto has traded at during the current trading session.
• volume: The USD dollar value of the crypto traded during the current trading session.
• avgVolume: The average daily USD dollar volume of the crypto traded.
• relVolume: The crypto's relative volume, which is the crypto's current volume divided by the crypto's average volume (avgVolume field).
• smartRelVolume: Smart relative volume is an adjusted measure of relative volume that takes into account how much of the trading day has passed. Example: If only half of the day has passed then we would multiply relative volume by 2.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single crypto, multiple cryptos, or all covered cryptos. To query a single crypto just identify the crypto by its symbol (i.e. "&symbol=$BTC"). To query multiple cryptos, identify the cryptos with a comma separated list of the relavent symbols (i.e. "&symbol=$BTC,$ETH,$SOL"). To identify all covered cryptos, set the parameter to allsymbols (i.e. "&symbols=allsymbols").
  
  *Note: There is no direct limit to how many individual cryptos can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Historic Crypto Prices

This endpoint lets you query daily historic crypto prices for covered cryptos. Note the open/close for dates is at 8PM UTC.

Available Fields

• symbol: The symbol or ticker of the crypto. All symbols start with "$" to identify its a crypto.
• date: The date corresponding to the trading data.
• open: The opening price of the crypto on that date.
• high: The highest price the crypto traded at on that date.
• low: The lowest price the crypto traded at on that date.
• close: The closing price of the crypto on that date.
• volume: The USD dollar value of the crypto traded on that date.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the crypto you want to query (i.e. "&symbol=$BTC").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• from: The inclusive starting date of the crypto price history you want to query in the format YYYY-MM-DD (i.e. "&from=2020-01-01"). The defualt value is 1 year ago from today.
• to: The inclusive ending date of the crypto price history you want to query in the format YYYY-MM-DD (i.e. "&to=2021-01-01"). The defualt value is today.

Technical Stock Data

This endpoint lets you query advanced metrics computed off of the real-time stock price for all US stocks. As an example, with this endpoint you can query to see which stock is trading the furthest below its 1 week high or how far AAPL is off of its 20 day SMA.

Available Fields

*Note: For all the fields below whenever week, month or year is referenced, it is in relationship to today, and not the current calendar week, month, or year. As an example, the weekOpen field is the opening price from 7 days ago, monthOpen is the opening price from 30 days ago and yearOpen is the opening price from 365 days ago.

• symbol: The symbol or ticker of the stock.
• price: The real-time price of the stock which is used to compute several of the other available fields.
• weekOpen, monthOpen, yearOpen, allTimeOpen: These are 4 separate fields which tell you the opening price of the stock for the past week, month, year, and all time (going back up to 2010) respectively.
• weekHigh, monthHigh, yearHigh, allTimeHigh: These are 4 separate fields which tell you the highest price the stock traded at during the past week, month, year and all time (going back up to 2010) respectively.
• weekLow, monthLow, yearLow, allTimeLow: These are 4 separate fields which tell you the lowest price the stock traded at during the past week, month, year and all time (going back up to 2010) respectively.
• sma20, sma50, sma200: These are 3 separate fields which tell you a stock's 20 day SMA (Simple-Moving-Average), 50 day SMA, and 200 day SMA respectively.
• weekPerChange, monthPerChange, yearPerChange, allTimePerChange: These are 4 separate fields which tell you the percentage change in the price of a stock over the past week, month, year and all time (going back up to 2010) respectively.
• perBelowWeekHigh, perBelowMonthHigh, perBelowYearHigh, perBelowAllTimeHigh: These are 4 separate fields which tell you how far below (in percentage terms) a stock's current price is from its highest price traded at during the past week, month, year and all time (going back up to 2010) respectively.
• perAboveWeekLow, perAboveMonthLow, perAboveYearLow, perAboveAllTimeLow: These are 4 separate fields which tell you the how far above (in percentage terms) a stock's current price is from its lowest price traded at during the past week, month, year and all time (going back up to 2010) respectively.
• perOffSma20, perOffSma50, perOffSma200: These are 3 separate fields which tell you how far off (in percentage terms) a stock is from its 20 day SMA (Simple-Moving-Average), 50 day SMA, and 200 day SMA respectively. A positive number here indicates the stock is currently trading above its SMA while a negative number means the stock is trading below its SMA.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To query a single stock just identify the stock by its symbol (i.e. "&symbol=AAPL"). To query multiple stocks, identify the stocks with a comma separated list of the relavent symbols (i.e. "&symbol=AAPL,AMZN,NFLX,TSLA"). To identify all US stocks, set the parameter to allsymbols (i.e. "&symbols=allsymbols").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• extendedHours: If set to true (ex. "&extendedHours=true") then the latest price a stock traded at including extended trading hours will be used as the "price" of the stock. If set to false (ex. "&extendedHours=false"), only regular trading hours will be used to determine the "price" of the stock. The default value is false.

Technical Crypto Data

This endpoint lets you query advanced metrics computed off of the real-time crypto price for all cryptos. As an example, with this endpoint you can query to see which crypto is trading the furthest below its 1 week high or how far $BTC is off of its 20 day SMA.

Available Fields

*Note: For all the fields below whenever week, month or year is referenced, it is in relationship to today, and not the current calendar week, month, or year. As an example, the weekOpen field is the opening price from 7 days ago, monthOpen is the opening price from 30 days ago and yearOpen is the opening price from 365 days ago.

• symbol: The symbol or ticker of the crypto. All symbols start with "$" to identify its a crypto.
• price: The real-time price of the crypto which is used to compute several of the other available fields.
• weekOpen, monthOpen, yearOpen, allTimeOpen: These are 4 separate fields which tell you the opening price of the crypto for the past week, month, year, and all time (going back up to 2010) respectively.
• weekHigh, monthHigh, yearHigh, allTimeHigh: These are 4 separate fields which tell you the highest price the crypto traded at during the past week, month, year and all time (going back up to 2010) respectively.
• weekLow, monthLow, yearLow, allTimeLow: These are 4 separate fields which tell you the lowest price the crypto traded at during the past week, month, year and all time (going back up to 2010) respectively.
• sma20, sma50, sma200: These are 3 separate fields which tell you a crypto's 20 day SMA (Simple-Moving-Average), 50 day SMA, and 200 day SMA respectively.
• weekPerChange, monthPerChange, yearPerChange, allTimePerChange: These are 4 separate fields which tell you the percentage change in the price of a crypto over the past week, month, year and all time (going back up to 2010) respectively.
• perBelowWeekHigh, perBelowMonthHigh, perBelowYearHigh, perBelowAllTimeHigh: These are 4 separate fields which tell you how far below (in percentage terms) a crypto's current price is from its highest price traded at during the past week, month, year and all time (going back up to 2010) respectively.
• perAboveWeekLow, perAboveMonthLow, perAboveYearLow, perAboveAllTimeLow: These are 4 separate fields which tell you the how far above (in percentage terms) a crypto's current price is from its lowest price traded at during the past week, month, year and all time (going back up to 2010) respectively.
• perOffSma20, perOffSma50, perOffSma200: These are 3 separate fields which tell you how far off (in percentage terms) a crypto is from its 20 day SMA (Simple-Moving-Average), 50 day SMA, and 200 day SMA respectively. A positive number here indicates the crypto is currently trading above its SMA while a negative number means the crypto is trading below its SMA.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single crypto, multiple cryptos, or all covered cryptos. To query a single crypto just identify the crypto by its symbol (i.e. "&symbol=$BTC"). To query multiple cryptos, identify the cryptos with a comma separated list of the relavent symbols (i.e. "&symbol=$BTC,$ETH,$SOL"). To identify all covered cryptos, set the parameter to allsymbols (i.e. "&symbols=allsymbols").
  
  *Note: There is no direct limit to how many individual cryptos can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Intraday Moves

This endpoint lets you query intraday price moves for stocks and cryptos.

Available Fields

• symbol: The symbol or ticker of the stock/crypto. If it's a crypto the ticker will start with a "$".
• 2MinMove: The percent change in the price of the stock/crypto during the past 2 minutes. Please note outside of regular trading hours and extended trading hours, this field will display as null for stocks.
• 3MinMove: The percent change in the price of the stock/crypto during the past 3 minutes. Please note outside of regular trading hours and extended trading hours, this field will display as null for stocks.
• 5MinMove: The percent change in the price of the stock/crypto during the past 5 minutes. Please note outside of regular trading hours and extended trading hours, this field will display as null for stocks.
• 10MinMove: The percent change in the price of the stock/crypto during the past 10 minutes. Please note outside of regular trading hours and extended trading hours, this field will display as null for stocks.
• 15MinMove: The percent change in the price of the stock/crypto during the past 15 minutes. Please note outside of regular trading hours and extended trading hours, this field will display as null for stocks.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To identify a crypto please add a "$" in front of the ticker (i.e. "&symbol=$BTC"). To query multiple assets, identify the stocks and cryptos with a comma separated list of the relavent symbols (i.e. "&symbols=AAPL,$BTC,AMZN"). To identify all assets (stocks and cryptos), set the parameter to allsymbols (i.e. "&symbols=allsymbols"). To identify all stocks, set the parameter to allstocks (i.e. "&symbols=allstocks"). To identify all cryptos, set the parameter to allcryptos (i.e. "&symbols=allcryptos").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Live Odds

For a full explanation of live odds data click here. The following is a concise explanation. For each asset, the live odds tells you the historical (going back up to 2010) trading results that would have been realized if you had bought the asset every time it moved an equivalent amount to its current day's percentage move and sold it at: the same day's close for same day odds, the next trading day's market close for one day odds, and the market close 5 trading days away for one week odds. Based on this, the following metrics can be calculated: "Up Odds" which tells you the percent of those trades that would have been profitable, "Average Return" which tells you the avg return from those trades, "Min Return" which tells you the lowest return from those trades, "Max Return" which tells you the highest return from those trades, and "# Of Past Occurances" which tells you the amount of historical observations/trades that these statistics are based on.

Available Fields

• symbol: The symbol or ticker of the stock/crypto. If it's a crypto the ticker will start with a "$".
• price: For stocks - the last price the stock traded at during regular market hours. For cryptos - the last price the crypto traded at.
• percentChange: For stocks - the percent change in the price of the stock relative to the price it closed at during regular market hours of the previous trading session. For cryptos - the percent change in the price of the crypto relative to its closing price from the previous session (crypto sessions end/start at 8pm UTC). These are the percent change which all the odds are based on.
• sameDayUpOdds: For each asset, this is the "Same Day Up Odds", which tells you the historical (going back up to 2010) percent of trades that would have yielded a positive return if you had bought the asset every time it moved an equivalent amount to its current day's percentage move and sold it at the same day's close. Example: If AAPL was up 5% at this moment, and the Same Day Up Odds were 65%, it means that historically if you had bought AAPL every other time it was up 5% in the past, at the moment it was up 5%, and then sold it at the close of those same trading days, 65% of the time you would have realized a profit on those trades. For stocks, this value will be null during none market hours.
• sameDayAvg: For each asset, this is the "Same Day Average Return", which tells you the historical (going back up to 2010) average return you would have made if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the same day's close. For stocks, this value will be null during none market hours.
• sameDayMax: For each asset, this is the "Same Day Max Return", which tells you the highest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the same day's close. For stocks, this value will be null during none market hours.
• sameDayMin: For each asset, this is the "Same Day Min Return", which tells you the lowest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the same day's close. For stocks, this value will be null during none market hours.
• sameDayObs: For each asset, this is the number of observations or "Same Day # Of Past Occurances". This tells you the number of days since 2010 where at some point the asset was up/down an equivalent amount to the asset's current day's move. This can be seen as the "population size" that all of the asset's same day statistics are based on.
• oneDayUpOdds: For each asset, the "One Day Up Odds" tells you the historical (going back up to 2010) percent of trades that would have yielded a positive return if you had bought the asset every time it moved an equivalent amount to its current day's percentage move and sold it at the following trading day's close. If AAPL was up 5% at this moment, and the One Day Up Odds were 65%, it means that historically if you had bought AAPL every other time it was up 5% in the past, at the moment it was up 5%, and then sold it at the close of the following trading day, 65% of the time you would have realized a profit on those trades.
• oneDayAvg: For each asset, this is the "One Day Average Return", which tells you the historical (going back up to 2010) average return you would have made if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the following trading day's close.
• oneDayMax: For each asset, this is the "One Day Max Return", which tells you the highest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the following trading day's close.
• oneDayMin: For each asset, this is the "One Day Min Return", which tells you the lowest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the following trading day's close.
• oneDayObs: For each asset, this is the number of observations or "One Day # Of Past Occurances". This tells you the number of days since 2010 where at some point the asset was up/down an equivalent amount to the asset's current day's move. This can be seen as the "population size" that all of the asset's one day statistics are based on.
• oneWeekUpOdds: For each asset, the "One Week Up Odds" tells you the historical (going back up to 2010) percent of trades that would have yielded a positive return if you had bought the asset every time it moved an equivalent amount to its current day's percentage move and sold it at the market close 5 trading days later (7 days later for cryptos). Example: If AAPL was up 5% at this moment, and the One Week Up Odds were 65%, it means that historically if you had bought AAPL every other time it was up 5% in the past, at the moment it was up 5%, and then sold it at the close 5 trading days later, 65% of the time you would have realized a profit on those trades.
• onWeekyAvg: For each asset, this is the "One Week Average Return", which tells you the historical (going back up to 2010) average return you would have made if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the close 5 trading days later (7 days later for cryptos).
• oneWeekMax: For each asset, this is the "One Week Max Return", which tells you the highest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the close 5 trading days later (7 days later for cryptos).
• oneWeekMin: For each asset, this is the "One Week Min Return", which tells you the lowest return you would have obtained historically (going back up to 2010) if each time the asset moved an equivalent amount to what it has moved today, you bought it at that moment and sold it at the close 5 trading days later (7 days later for cryptos).
• oneWeekObs: For each asset, this is the number of observations or "One Week # Of Past Occurances". This tells you the number of days since 2010 where at some point the asset was up/down an equivalent amount to the asset's current day's move. This can be seen as the "population size" that all of the asset's one week statistics are based on.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To identify a crypto please add a "$" in front of the ticker (i.e. "&symbol=$BTC"). To query multiple assets, identify the stocks and cryptos with a comma separated list of the relavent symbols (i.e. "&symbols=AAPL,$BTC,AMZN"). To identify all assets (stocks and cryptos), set the parameter to allsymbols (i.e. "&symbols=allsymbols"). To identify all stocks, set the parameter to allstocks (i.e. "&symbols=allstocks"). To identify all cryptos, set the parameter to allcryptos (i.e. "&symbols=allcryptos").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

This endpoint lets you query StockTwits stats for stocks and cryptos. StockTwits is the top social media platform for stocks and cryptos and is very useful for tracking social momentum for assets.

Available Fields

• symbol: The symbol or ticker of the stock/crypto. If it's a crypto the ticker will start with a "$".
• watchers: The number of users following the stock/crypto on StockTwits.
• hourChange: The change in the asset's StockTwits watchers over the last hour.
• dayChange: The change in the asset's StockTwits watchers over the last day.
• weekChange: The change in the asset's StockTwits watchers over the last week (7 days).
• hourChangePer: The percent change in the asset's StockTwits watchers over the last hour.
• dayChangePer: The percent change in the asset's StockTwits watchers over the last day.
• weekChangePer: The percent change in the asset's StockTwits watchers over the last week (7 days).
• sentiment: The change in the asset's sentiment on StockTwits.
• msgvol: The change in the asset's message volume on StockTwits.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To identify a crypto please add a "$" in front of the ticker (i.e. "&symbol=$BTC"). To query multiple assets, identify the stocks and cryptos with a comma separated list of the relavent symbols (i.e. "&symbols=AAPL,$BTC,AMZN"). To identify all assets (stocks and cryptos), set the parameter to allsymbols (i.e. "&symbols=allsymbols"). To identify all stocks, set the parameter to allstocks (i.e. "&symbols=allstocks"). To identify all cryptos, set the parameter to allcryptos (i.e. "&symbols=allcryptos").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Ratings Feed

This endpoint lets you query a list of all the latest analyst ratings released across all US stocks during the past 30 days.

Available Fields

• symbol: The symbol or ticker of the stock.
• firm: The firm issuing the stock rating.
• analyst: The analyst issuing the stock rating.
• date: The date the stock rating was issued.
• rating: The stock rating issued by the firm.
• ratingStandardized: The stock rating issued by the firm in a standardized version which categorizes all ratings as either a buy, hold, or sell. For instance, an "overweight" or "long" rating would both be considered a buy standardized rating.
• priceTarget: The price target for the stock issued by the firm.
• action: This is based on comparing the current standardized rating (ratingStandardized field) issued by the firm for the stock, versus the previous standardized rating (prevRatingStandardized field). If this is the first rating issued, the action is considered "initiation". If both standardized ratings are the same, the action is considered "maintain". If the new standardized rating is superior, it is considered an "upgrade". If the new standardized rating is inferior, it is considered a "downgrade".
• priceTargetChange: The percentage change in the current price target (priceTarget field) issued by the firm versus the previous price target (prevPriceTarget field).
• priceAtRating: The approximate price of the stock at the time the rating was issued.
• postRatingWeekReturn: The approximate percentage change in the price of the stock during the week (5 trading days) immediately following the rating release (based off of the priceAtRating field). This field helps to see if the rating potentially helped drive a change in the short term price of the stock.
• prevRating: The previous stock rating issued by the firm.
• prevRatingStandardized: The previous stock rating issued by the firm in a standardized version which categorizes all ratings as either a buy, hold, or sell. For instance, an "overweight" or "long" rating would both be considered a buy standardized rating.
• prevPriceTarget: The previous price target for the stock issued by the firm.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. There are no other mandatory parameters for this endpoint.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To query a single stock just identify the stock by its symbol (i.e. "&symbol=AAPL"). To query multiple stocks, identify the stocks with a comma separated list of the relavent symbols (i.e. "&symbol=AAPL,AMZN,NFLX,TSLA"). To identify all US stocks, set the parameter to allsymbols (i.e. "&symbols=allsymbols"). The default value is "allsymbols".
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.
• limit: This parameter identifies the maximum number of ratings to return. Please only add an integer (ex. "&limit=25"). Note the maximum value here is 10,000 and the minimum value is 1. The default value is 1,000.

Stock Ratings Stats

This endpoint lets you query advanced stats on the analyst ratings for all US stocks.

Available Fields

• symbol: The symbol or ticker of the stock.
• totalRatings: The number of unique Analyst Ratings issued in the last year. If the same analyst has released multiple ratings on a stock within the last year, only the last rating is counted in as a unique rating.
• buys: The number of the total ratings for a stock that are BUY ratings.
• holds: The number of the total ratings for a stock that are HOLD ratings.
• sells: The number of the total ratings for a stock that are SELL ratings.
• buysPer: The percent of the total ratings for a stock that are BUY ratings.
• holdsPer: The percent of the total ratings for a stock that are HOLD ratings.
• sellsPer: The percent of the total ratings for a stock that are SELL ratings.
• avgTarget: The average price target for a stock.
• medianTarget: The median price target for a stock.
• maxTarget: The highest price target for a stock.
• minTarget: The lowest price target for a stock.
• avgTargetDayChange: The one day percent change in the average price target for a stock.
• avgTargetWeekChange: The one week (7 days) percent change in the average price target for a stock.
• avgTargetMonthChange: The one month (30 days) percent change in the average price target for a stock.
• avgTargetYearChange: The one year (365 days) percent change in the average price target for a stock.
• dayCoverageChange: The one day change in the number of analysts covering a stock.
• weekCoverageChange: The one week (7 days) change in the number of analysts covering a stock.
• monthCoverageChange: The one month (30 days) change in the number of analysts covering a stock.
• yearCoverageChange: The one year (365 days) change in the number of analysts covering a stock.
• dayUpgrades: The number of ratings upgrades the stock has recieved in the last day.
• weekUpgrades: The number of ratings upgrades the stock has recieved in the last week (7 days).
• monthUpgrades: The number of ratings upgrades the stock has recieved in the last month (30 days).
• yearUpgrades: The number of ratings upgrades the stock has recieved in the last year (365 days).
• dayDowngrades: The number of ratings downgrades the stock has recieved in the last day.
• weekDowngrades: The number of ratings downgrades the stock has recieved in the last week (7 days).
• monthDowngrades: The number of ratings downgrades the stock has recieved in the last month (30 days).
• yearDowngrades: The number of ratings downgrades the stock has recieved in the last year (365 days).
• coverageQuality: Our proprietary "Coverage Quality Score" is the average Quality Score of the analysts that have covered a stock in the last year. The Quality score assigned to each analyst is based on 2 factors. 1) The analyst's success rate: The percentage of rating releases that are profitable, assuming a position had been opened when the analyst issued the ratings. 2) The analyst's average return: The average return of the analyst's rating releases, assuming a position had been opened when the analyst issued the ratings.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To query a single stock just identify the stock by its symbol (i.e. "&symbol=AAPL"). To query multiple stocks, identify the stocks with a comma separated list of the relavent symbols (i.e. "&symbol=AAPL,AMZN,NFLX,TSLA"). To identify all US stocks, set the parameter to allsymbols (i.e. "&symbols=allsymbols").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Stock Ratings List

This endpoint lets you query a list of all the active ratings for a stock. The most recent rating from each rating firm is considered an active rating, as long as the rating was released within the last year.

Available Fields

• symbol: The symbol or ticker of the stock.
• firm: The firm issuing the stock rating.
• analyst: The analyst issuing the stock rating.
• date: The date the stock rating was issued.
• rating: The stock rating issued by the firm.
• ratingStandardized: The stock rating issued by the firm in a standardized version which categorizes all ratings as either a buy, hold, or sell. For instance, an "overweight" or "long" rating would both be considered a buy standardized rating.
• priceTarget: The price target for the stock issued by the firm.
• action: This is based on comparing the current standardized rating (ratingStandardized field) issued by the firm for the stock, versus the previous standardized rating (prevRatingStandardized field). If this is the first rating issued, the action is considered "initiation". If both standardized ratings are the same, the action is considered "maintain". If the new standardized rating is superior, it is considered an "upgrade". If the new standardized rating is inferior, it is considered a "downgrade".
• priceTargetChange: The percentage change in the current price target (priceTarget field) issued by the firm versus the previous price target (prevPriceTarget field).
• priceAtRating: The approximate price of the stock at the time the rating was issued.
• postRatingWeekReturn: The approximate percentage change in the price of the stock during the week (5 trading days) immediately following the rating release (based off of the priceAtRating field). This field helps to see if the rating potentially helped drive a change in the short term price of the stock.
• prevRating: The previous stock rating issued by the firm.
• prevRatingStandardized: The previous stock rating issued by the firm in a standardized version which categorizes all ratings as either a buy, hold, or sell. For instance, an "overweight" or "long" rating would both be considered a buy standardized rating.
• prevPriceTarget: The previous price target for the stock issued by the firm.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the stock you want to query (i.e. "&symbol=AAPL").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters available for this endpoint.

Seasonality

This endpoint lets you query the historic (going back up to 2010) monthly and weekday seasonality for any US stock or crypto. For instance, you can utilize this endpoint to see what month has historically been the best performing for AAPL or what weekday has historically been the worst for $BTC.

Available Fields

• symbol: The symbol or ticker of the stock/crypto queried.
• Logic For 190 Other Fields: All other 190 possible seasonality fields are structured as monthWeekday-lookbackPeriod-metric. monthWeekday: This is the 3 letter abbreviation of the month (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec) or weekday (mon, tue, wed, thu, fri, sat, sun) you are interested in. lookbackPeriod: This can be set to "12m" if you would like the metric to be based on the last 12 months of trading data or to "alltime" if you would like the metric to be based on data going back up to 2010. metric: This is the statistic you are interested in which can be "avg" for average historic return for the month or weekday, "max" for highest historic return for the month or weekday, "min" for lowest historic return for the month or weekday, "upodds" for the percentage of historic months or weekdays that yielded a positive return, or "obs" for the historic number of months or weekdays that the metric is based on.
  
  Example: dec-alltime-avg would tell you the average historic return for the asset during the month of December going back up to 2010.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the stock or crypto you want to query. To identify a crypto please add a "$" in front of the ticker (i.e. "&symbol=$BTC").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.

Stock Profile

This endpoint lets you query general informative and financial data for any US stocks.

Available Fields

• symbol: The symbol or ticker of the stock.
• companyName: The company name of the stock.
• description: A description of the company.
• exchange: The primary exchange in which the stock trades. Please note the price quote itself does not necessarily correspond to a trade on this exchange. As most stocks trade on multiple exchanges, we simply display the latest trade data we have on a stock regardless of which exchange the trade took place on.
• industry: The industry of the stock.
• sector: The sector of the stock.
• avgVolume: The average volume of the stock's shares traded per trading day.
• sharesOutstanding: The number of shares outstanding for the stock.
• optionableStatus: "true" if the stock has options, "false" otherwise.
• ceo: The CEO of the company.
• website: The website of the company.
• country: The country where the company is headquartered.
• city: The city where the company is headquartered.
• address: The address of the company's headquarters.
• fullTimeEmployees: The number of full time employees for the company.
• ipoDate: The IPO date of the stock.
• adrStatus: "true" if the stock is an ADR, "false" otherwise.
• beta: The beta of the stock.
• cash: The cash & cash equivalents on the company's balance sheet.
• totalDebt: The total debt on the company's balance sheet.
• totalStockholdersEquity: The total shareholder's equity on the company's balance sheet.
• minorityInterest: The minority interest on the company's balance sheet.
• totalEquity: The total equity on the company's balance sheet.
• revenue: The trailing twelve month revenue on the company's income statement. If less than 4 quarters of financials history are available, the available quarters will be pro-rated.
• ebitda: The trailing twelve month ebitda (earnings before interest, taxes, depreciation and amortization) on the company's income statement. If less than 4 quarters of financials history are available, the available quarters will be pro-rated.
• netIncome: The trailing twelve month net income on the company's income statement. If less than 4 quarters of financials history are available, the available quarters will be pro-rated.
• depreciation: The trailing twelve month depreciation and amortization on the company's income statement. If less than 4 quarters of financials history are available, the available quarters will be pro-rated.
• interest: The trailing twelve month interest on the company's income statement. If less than 4 quarters of financials history are available, the available quarters will be pro-rated.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the stock you want to query (i.e. "&symbol=AAPL").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters available for this endpoint.

News

This endpoint lets you query news items (articles and videos) for any US stock or crypto.

Available Fields

• symbol: The symbol or ticker of the stock/crypto queried.
• time: The date and time the news item was released at in EST.
• source: The publisher of the news item (i.e. New York Post).
• title: The title of the news item.
• url: The url that leads to the news item.
• sentiment: The sentiment of the news item: "ps" stands for positive, "nt" stands for neutral, "ng" stands for negative.
• mediatype: The style of the media item: "a" stands for article, "v" stands for video.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbol: This parameter identifies the stock or crypto you want to query. To identify a crypto please add a "$" in front of the ticker (i.e. "&symbol=$BTC").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• limit: This parameter identifies the maximum number of news items to return. Please only add an integer (ex. "&limit=25"). Note the maximum value here is 100 and the minimum value is 1. The default value is 100.

All News

This endpoint lets you query the latest news items (articles and videos) across all US stocks or across all cryptos.

Available Fields

• symbols: The symbols or tickers the news item pertains to. For cryptos, the tickers will start with a "$".
• time: The date and time the news item was released at in EST.
• source: The publisher of the news item (i.e. New York Post).
• title: The title of the news item.
• url: The url that leads to the news item.
• sentiment: The sentiment of the news item: "ps" stands for positive, "nt" stands for neutral, "ng" stands for negative.
• mediatype: The style of the media item: "a" stands for article, "v" stands for video.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• assetclass: Set to stocks if you would like to query the latest news for all us stocks (i.e. "&assetclass=stocks") or set to cryptos if you would like to query the latest news across all cryptos (i.e. "&assetclass=cryptos").

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. Any other optional parameters are listed below.

• limit: This parameter identifies the maximum number of news items to return. Please only add an integer (ex. "&limit=25"). Note the maximum value here is 1,000 and the minimum value is 1. The default value is 100.

Stock Float

This endpoint lets you query the share float for all US stocks.

Available Fields

• symbol: The symbol or ticker of the stock.
• float: The stock's share float.

Required Parameters

As with all requests the apikey parameter, format parameter and fields parameter must be passed. The available fields for the fields parameter are listed above. Any additional required parameters are listed below.

• symbols: With this parameter you can query a single stock, multiple stocks, or all US stocks. To query a single stock just identify the stock by its symbol (i.e. "&symbol=AAPL"). To query multiple stocks, identify the stocks with a comma separated list of the relavent symbols (i.e. "&symbol=AAPL,AMZN,NFLX,TSLA"). To identify all US stocks, set the parameter to allsymbols (i.e. "&symbols=allsymbols").
  
  *Note: There is no direct limit to how many individual stocks can be queried at once, however, the length of the request URL should remain under 2000 characters.

Optional Parameters

As with all requests the sortBy parameter, sortDir parameter and apiCreditsUsed parameter are optional. There are no other optional parameters for this endpoint.