Marketstack SDK

A simple JavaScript SDK for interacting with the Marketstack API to get access to real-time, intraday, historical market data along with Bonds and ETFs information.

Features

• Fetch End-of-Day and Intraday market data
• Retrieve splits, dividends, and ticker information
• Access market indices, exchanges, bonds, and ETF holdings
• Easily manage API calls with minimal setup

Installation

Install the SDK via npm:

npm install apilayer-marketstack

or via yarn:

yarn add apilayer-marketstack

Usage

First, you need to create an account on Marketstack and obtain your API key.

Initialization

This SDK supports both CommonJS (require) and ES Modules (import).

CommonJS (require)

const Marketstack = require("apilayer-marketstack");

// Initialize with your API key
const marketstack = new Marketstack("YOUR_API_KEY");

ES Modules (import)

import Marketstack from "apilayer-marketstack";

// Initialize with your API key
const marketstakc = new Marketstack("YOUR_API_KEY");

Example Usage

Fetch historical market data for a specific date range.

marketstack
    .endOfDay({ symbols: "AAPL", date_from: "2024-12-09", date_to: "2024-12-19" })
    .then((data) => console.log(data))
    .catch((err) => console.error(err));

You can use this format to make an API call to any available endpoints.

API Methods

Below are the available methods provided by the SDK:

General Market Data

| Method | Description | | ------------------ | ----------------------------- | | endOfDay(params) | Fetch end-of-day market data. | | intraday(params) | Fetch intraday market data. |

Splits and Dividends Data

| Method | Description | | ------------------- | ------------------------------------------------ | | splits(params) | Fetch stock splits factor for different symbols. | | dividends(params) | Fetch stock dividend for different symbols. |

Ticker Data

| Method | Description | | -------------------------------------- | ----------------------------------------- | | ticker(symbol, params) | Fetch general information about a ticker. | | tickerEod(symbol, params) | Fetch end-of-day data for a ticker. | | tickerEodDate(symbol, date, params) | Fetch EOD data for a specific date. | | tickerEodLatest(symbol, params) | Fetch the latest EOD data for a ticker. | | tickerIntraday(symbol, params) | Fetch intraday data for a ticker. | | tickerIntradayLatest(symbol, params) | Fetch the latest intraday data. | | tickerSplits(symbol, params) | Fetch splits data for a ticker. | | tickerDividends(symbol, params) | Fetch dividend data for a ticker. |

Lists and Information

| Method | Description | | -------------------- | ---------------------------------------- | | tickerList(params) | Fetch a list of tickers. | | tickerInfo(params) | Fetch general ticker information. | | indexList(params) | Fetch a list of market indices. | | indexInfo(params) | Fetch detailed market index information. |

Exchanges, Currencies, and Timezones Data

| Method | Description | | -------------------- | ------------------------------------- | | exchanges(params) | Fetch a list of market exchanges. | | currencies(params) | Fetch a list of supported currencies. | | timezones(params) | Fetch a list of supported time zones. |

Bonds and ETFs

| Method | Description | | ------------------------- | ----------------------------------------- | | bondList(params) | Fetch a list of bonds. | | bondInfo(params) | Fetch bond details by country. | | etfHoldingsList(params) | Fetch a list of ETF holdings. | | etfHoldings(params) | Fetch details for a specific ETF holding. |

Note

For more detailed information about Marketstack API, make sure to check out our Developer Documentation.

License

This package is licensed under the MIT License.