API Tutorial: Using Yahoo Finance API

Yahoo Finance is a media property that provides various financial news and data including stock details, quotes, press releases, financial reports.

In this tutorial, we will cover how to consume the Yahoo Finance API powered by Rakuten RapidAPI, how to get market summary, quotes and get a stock details using node.js.

Setup

To get started you’ll need:

1. Javascript editor and npm unirest package that will speed up code writing.
2. Subscribe to the Yahoo Finance API.

Getting the Javascript Code

Rakuten RapidApi got you covered and packaged all the javascript code you need to work with the API in an easy unirest SDK, which is a library to simplify HTTP REST requests and save you time writing code.

Get started by installing the unirest package with the following command:

npm install unirest --save

As soon as that’s done, you can start exploring the API. It’s safe to ignore the npm warn messages at this point if you see any.

 

Start with Signing Up to the Yahoo Finance API

Access is free through Rakuten RapidAPI — the world’s largest API marketplace. With 8,000+ third-party APIs and used by over 500,000 active developers, we enable developers to build transformative apps through the power of APIs. Find, test and connect to all the APIs you need in one place!

On top of that, you can try it without leaving the browser. You’ll need to sign up to get the API keys and make requests. With these keys, you’ll be able to make and authenticate the requests, so we will know they come from you.

As soon as you sign-in with your account, the view above will be replaced with another view, where you can see your API keys (X-RapidAPI-Key) in the Request Headers section and a ready to copy snippet of code at the right side.

 

Yahoo Finance API Overview

The Yahoo Finance API provides, through Rakuten RapidAPI, 8 endpoints, each of which covers a specific feature that you can use:

• market/get-summary: Get live summary information at the request time
• market/get-movers: The live day gainers / losers / actives in specific region
• market/get-quotes: Retrieve the quotes by symbols
• market/get-charts: Get data to draw charts for a specific symbol and its comparisons
• market/auto-complete: Get auto complete suggestion for stocks
• stock/get-detail: Get detail information of each stock
• stock/get-histories: Get stock histories to draw charts
• stock/get-news: Get latest news related to a symbol, the result may be empty if there are no news in that region

 

Get Market summary

1. Start by clicking on the market/get-summary function on the left menu.
2. The header parameters will be prefilled automatically
3. Enter the region and language code you wish to get summary information from
4. Click on the Test Endpoint button to make a request and see the result
5. Your code is ready to be copied on the right side of the screen

Understanding the code:

To get the market summary you need just a few lines of codes and a few pieces of data:

• The X-RapidAPI-Key displayed on the page
• The region and language code you wish to get summary information from

const unirest = require('unirest');

const API_KEY = "YOUR_API_KEY_HERE";
const region = "US", lang = "en";

unirest.get(`https://apidojo-yahoo-finance-v1.p.rapidapi.com/market/get-summary?region=${region}&lang=${lang}`)
.header("X-RapidAPI-Host", "apidojo-yahoo-finance-v1.p.rapidapi.com")
.header("X-RapidAPI-Key", API_KEY)
.end(function (result) {
 console.log(result.status, result.headers, result.body);
});

API Response:

The response is pretty easy to interpret, comments were added to explain the fields:

{
 "marketSummaryResponse": {
   "result": [
     {
       "fullExchangeName":"SNP", // Name of the exchange
       "exchangeTimezoneName":"America/New_York", // Timezone
       "symbol":"^GSPC", // Exchange symbol
       "regularMarketChange":{}, // Information about the market change
       "gmtOffSetMilliseconds": -14400000,
       "exchangeDataDelayedBy":0,
       "language":"en-US", // Language
       "regularMarketTime":{},
       "regularMarketChangePercent":{},
       "exchangeTimezoneShortName":"EDT",
       "quoteType":"INDEX", // Type of the quote
       "regularMarketPrice":{},
       "marketState":"REGULAR",
       "market":"us_market",
       "quoteSourceName":"Free Realtime Quote",
       "priceHint":2,
       "tradeable":false, // Whether this can be traded
       "sourceInterval":15,
       "exchange":"SNP",
       "shortName":"S&P 500",
       "region":"US",
       "regularMarketPreviousClose":{}
     },
     ...
   ],
   "error": null
 }
}

 

Get Market Quotes:

1. Start by clicking on the market/quotes function on the left menu.
2. The header parameters will be prefilled automatically
3. Enter the region, language, and symbols you wish to get quotes for
4. Click on the Test Endpoint button to make a request and see the result
5. Your code is ready to be copied on the right side of the screen

Understanding the code:

To get the market quotes you need just a few lines of codes and a few pieces of data:

• The X-RapidAPI-Key displayed on the page
• The region, language, and symbols you wish to get quotes for, note that symbols is URL encoded because it’s passed as a query string parameter

const unirest = require('unirest');

const API_KEY = "YOUR_API_KEY_HERE";
const region = "US", lang = "en";
const symbols = "BAC%2CKC%3DF%2C002210.KS%2CIWM%2CAMECX";

unirest.get(`https://apidojo-yahoo-finance-v1.p.rapidapi.com/market/get-quotes?region=${region}&lang=${lang}&symbols=${symbols}`)
.header("X-RapidAPI-Host", "apidojo-yahoo-finance-v1.p.rapidapi.com")
.header("X-RapidAPI-Key", API_KEY)
.end(function (result) {
 console.log(result.status, result.headers, result.body);
});

API Response:

The response is pretty easy to interpret, comments were added to explain the fields:

{
 "quoteResponse":{
   "result": [
       {
         "language":"en-US",
         "region":"US",
         "quoteType":"EQUITY", // Type of the quote
         "quoteSourceName":"Nasdaq Real Time Price", // Source name of the quote
         "exchangeDataDelayedBy":0, // Delay for the data returned
         "preMarketChange":-0.21000099,
         "preMarketChangePercent":-0.7261445,
         "preMarketTime":1548340100,
         "preMarketPrice":28.71,
         "regularMarketChangePercent":0.2939111,
         "regularMarketPreviousClose":28.92,
         "fullExchangeName":"NYSE", // Full name of the exchange
         "longName":"Bank of America Corporation",
         "marketState":"REGULAR",
         "exchange":"NYQ",
         "sourceInterval":15,
         "exchangeTimezoneName":"America/New_York",
         "exchangeTimezoneShortName":"EST",
         "pageViews":{},
         "gmtOffSetMilliseconds":-18000000,
         "esgPopulated":false,
         "tradeable":true,
         "priceHint":3,
         "shortName":"Bank of America Corporation",
         "market":"us_market",
         "regularMarketPrice":29.005,
         "regularMarketTime":1548351167,
         "regularMarketChange":0.084999084,
         "regularMarketVolume":28284717,
         "symbol":"BAC"
       },
       ...
   ],
   "error": null
 }
}

 

Get Stock details:

1. Start by clicking on the stock/get-detail function on the left menu.
2. The header parameters will be prefilled automatically
3. Enter the region, language, and symbol you wish to get quotes for
4. Click on the Test Endpoint button to make a request and see the result
5. Your code is ready to be copied on the right side of the screen

Understanding the code:

To get the stock details you need just a few lines of codes and a few pieces of data:

• The X-RapidAPI-Key displayed on the page
• The region, language, and symbol representing the stock you wish to get details for

const unirest = require('unirest');

const API_KEY = "YOUR_API_KEY_HERE";
const region = "US", lang = "en";
const symbol = "NBEV";

unirest.get(`https://apidojo-yahoo-finance-v1.p.rapidapi.com/market/get-quotes?region=${region}&lang=${lang}&symbol=${symbol}`)
.header("X-RapidAPI-Host", "apidojo-yahoo-finance-v1.p.rapidapi.com")
.header("X-RapidAPI-Key", API_KEY)
.end(function (result) {
 console.log(result.status, result.headers, result.body);
});

API Response:

The response is pretty easy to interpret, each field is an object containing pertinent information about the stock:

{
 "defaultKeyStatistics":{},
 "details":{},
 "summaryProfile":{},
 "recommendationTrend":{},
 "majorDirectHolders":{},
 "earnings":{},
 "price":{},
 "fundOwnership":{},
 "insiderTransactions":{},
 "insiderHolders":{},
 "netSharePurchaseActivity":{},
 "majorHoldersBreakdown":{},
 "financialData":{},
 "quoteType":{},
 "institutionOwnership":{},
 "calendarEvents":{},
 "summaryDetail":{},
 "symbol":"NBEV",
 "esgScores":{},
 "upgradeDowngradeHistory":{},
 "pageViews":{}
 }

 

That’s it!

You are ready to go. Feel free to use any or all of the above snippets as you like. Check out the thousands more building blocks that are equally simple to access at Rakuten RapidAPI.

About Rakuten RapidAPI

Rakuten RapidAPI is the world’s largest API marketplace with 8,000+ third-party APIs and used by over 500,000 active developers. We enable developers to build transformative apps through the power of APIs. Find, test and connect to all the APIs you need in one place!

Check out some of the world’s best APIs including Microsoft, Sendgrid, Crunchbase, and Skyscanner.

Facebook | LinkedIn | Twitter