Unofficial library for programmatic access to zacks ranking page. Any feature requests in Issues tab are more than welcome! :)

Install the package

yarn add zacks-api-2

or

npm install zacks-api-2

Once it has been installed, it can easily be imported in your project, depending on the import method you need.

// Common js module
const { getQuote } = require("zacks-api-2");
// ESM module
import { getQuote } from "zacks-api-2";

Used to retrieve zacks rank on a symbol. Can be extended to include information about each rank. Throws an error when the symbol is not found.

const quote = await getQuote("AAPL");
console.log(quote.rank)
// 3

const quoteExtended = await getQuote("AAPL", { extended: true });
console.log(quote.zrankRows)
// [
//     { rank: 1, definition: 'Strong Buy', annualizedReturn: 0.2415 },
//     { rank: 2, definition: 'Buy', annualizedReturn: 0.18 },
//     { rank: 3, definition: 'Hold', annualizedReturn: 0.0944 },
//     { rank: 4, definition: 'Sell', annualizedReturn: 0.051 },
//     { rank: 5, definition: 'Strong Sell', annualizedReturn: 0.0253 }
// ]

If you want to improve the package or you are just curious on how it works, follow this section.

• node.js 18.x (but earlier will prob work too.)
• npm (or similar package manager)

• typescript to make programming decent
• jest.js for unit tests

Install the dependencies with

yarn

Make sure everything is clean by running

yarn clean

then all the versions of the package can be built with the command

yarn build

After having installed the dependencies, run

yarn test