Documentation

Before we begin:

  • Please register to obtain an API key.
  • All endpoints are prefixed with: https://stocknewsapi.com
  • Parameter values must be comma-delimited when requesting multiple tickers.
  • For example: ?tickers=AMZN,fb is correct.
  • Casing does not matter when passing values to a parameter.
  • For example: ?tickers=fb and ?tickers=FB will work.
  • If you would like to download the data as a .csv file, add the following parameter after your token: &datatype=csv.

  • Get ticker news

    /api/v1?tickers=FB&items=5&fallback=true&token=API_KEY

  • ?tickers=FB
  • Obtain news about a specific company. In this example FB is the symbol for Facebook. This parameter is required.

  • ?tickers=TSLA,AMZN,FB
  • Seperate the symbols by a comma to retrieve news from multiple companies.

  • &items=20
  • Number of news items returned. Items value must be between 1 and 50. This parameter is required. If you would like more than 50 results please use our &page=2 parameter.

  • &date=03152019-03252019 or &date=03152019-today
  • Use the date parameter to retrieve news on specific dates. Format: DDMMYYYY and today.

  • &type=video or &type=article
  • Use these parameters if you want to filter on news type.

  • &source=CNBC or &sourceexclude=benzinga
  • Use these parameters if you want to filter on news sources. Use a comma to seperate multiple sources. To view the list of all news sources: Click here

  • &sentiment=positive
  • Use the sentiment parameter to filter on positive, neutral or negative news.

  • &tag=CEO or &tagexclude=CEO
  • Use the tag parameter to include or exclude specific topics. Seperate tags by a comma to use multiple tags.
    To view the available tags/topics:
    Click here

  • &fallback=true
  • Fallback returns general stock news in the case that a specific company doesn't have any news associated with it.

  • &page=2
  • Use the page parameter: &page=2, &page=3, &page=4 etc... to obtain more than 50 results.

  • &sortby=trending
  • Use this parameter if you would like to have trending & more important news higher in the results page. If you don't include this parameter the default sort will be latest news first.

  • &token=API_KEY
  • Change "API_KEY" for your 40 charachter key. This parameter is required.

    "title":"Facebook changes board",
    "news_url":"https://www.youtube.com/watch?v=E-OnobmoWuE",
    "image_url":"https://stocknewsapi.com/images/v1/m/q-2/facebook-changes-board.jpg",
    "text":"CNBC's Seema Mody reports on changes to Facebook's board of directors.",
    "sentiment":"Neutral",
    "type":"Video",
    "source_name":"CNBC Television",
    "date":"Fri, 12 Apr 2019 16:53:57 -0400",
    "tickers":["FB"]
    "tags":[""]

    Get All Ticker News

    This endpoint retrieves all news posted on all tickers:

    /api/v1/category?section=alltickers&items=50&token=API_KEY

  • ?section=alltickers
  • This parameter shows all news that is posted under all tickers. This parameter is required. If you would like more than 50 results please use our &page=2 parameter.

  • &items=50
  • Number of news items returned. Items value must be between 1 and 50. This parameter is required.

  • &date=03152019-03252019 or &date=03152019-today
  • Use the date parameter to retrieve news on specific dates. Format: DDMMYYYY and today

  • &type=video or &type=article
  • Use these parameters if you want to filter on news type.

  • &source=CNBC or &sourceexclude=benzinga
  • Use these parameters if you want to filter on news sources. Use a comma to seperate multiple sources. To view the list of all news sources: Click here

  • &sentiment=positive
  • Use the sentiment parameter to filter on positive, neutral or negative news.

  • &tag=CEO or &tagexclude=CEO
  • Use the tag parameter to include or exclude specific topics. Seperate tags by a comma to use multiple tags. To view the available tags/topics: Click here

  • &sector=technology
  • Filter by sector. To view all sectors: Click here

  • &ipodate=01012018-12312018 or &ipodate=01012019-today
  • Use the date parameter to retrieve news on companies that went public on a specific date. Format: DDMMYYYY and today.

  • &page=2
  • Use the page parameter: &page=2, &page=3, &page=4 etc... to obtain more than 50 results.

  • &sortby=trending
  • Use this parameter if you would like to have trending & more important news higher in the results page. If you don't include this parameter the default sort will be latest news first.

  • &token=API_KEY
  • Change "API_KEY" for your 40 charachter key. This parameter is required.

    "title":"Google announces new game streaming service called Stadia",
    "news_url":"https://www.youtube.com/watch?v=RusqvPjL2Po",
    "image_url":"https://stocknewsapi.com/images/v1/g/o/googl-stadia.png",
    "text":"Google announced its new video game streaming service Stadia on Tuesday...",
    "sentiment":"Positive",
    "type":"Video",
    "source_name":"CNBC Television",
    "date":"Tue, 19 Mar 2019 16:36:22 -0400",
    "tickers":["GOOG", "GOOGL"]
    "tags":["product"]

    Get General Market News

    This endpoint retrieves general market news:

    /api/v1/category?section=general&items=50&token=API_KEY

  • ?section=general
  • General news about the market - not company specific. Section parameter is required.

  • &items=50
  • Number of news items returned. Items value must be bewteen 1 and 50. This parameter is required. If you would like more than 50 results please use our &page=2 parameter.

  • &type=video or &type=article
  • Use these parameters if you want to filter on news type.

  • &source=CNBC or &sourceexclude=benzinga
  • Use these parameters if you want to filter on news sources. Use a comma to seperate multiple sources. To view the list of all news sources: Click here

  • &sentiment=positive
  • Use the sentiment parameter to filter on positive, neutral or negative news.

  • &token=API_KEY
  • Change "API_KEY" for your 40 charachter key. This parameter is required.

    "title":"Two analysts agree market could end year higher",
    "news_url":"https://www.youtube.com/watch?v=G5Fp3L5A-6M",
    "image_url":"https://stocknewsapi.com/images/v1/m/q-2/two-analysts.jpg",
    "text":"Mark Luschini, Janney Montgomery Scott chief investment strategist, and Randy...",
    "sentiment":"Positive",
    "type":"Video",
    "source_name":"CNBC Television",
    "date":"Fri, 12 Apr 2019 18:37:01 +0000",
    "tags":[]

    Support

    If you have any feedback or questions, don't hesitate to contact us.