Status

Retrieve market status information (open/closed) for dates and countries.

Making Requests

Use the status() method on the markets resource to fetch market status information.

Output Format	Result Payload	Description
internal (default)	MarketStatus[] or MarketStatusHuman[]	Array of decoded market-status records.
json	Raw JSON object	The compressed, array-keyed response object.
csv	Blob	CSV payload. Use .save(filename) to write it.

status

status<P>(
  params?: P,
): MarketDataPromise<MarketStatus[] | MarketStatusHuman[]>

Fetches market status information. All parameters are optional.

Parameters

• country (string, optional)

  Filter by country code (e.g. "US", "CA", "GB").

• date (string | Date, optional)

  Specific date to fetch status for.

• from (string | Date, optional)

  Start of the date range.

• to (string | Date, optional)

  End of the date range.

• countback (number, optional)

  Number of days to return, counting backwards from to (or the current date if to is not provided).

• outputFormat (optional): The format of the returned data. Alias: format.

• dateFormat (optional): Date format. Alias: dateformat.

• columns (optional): Columns to include.

• addHeaders (optional): Whether to include headers in CSV output. Alias: headers.

• useHumanReadable (optional): Use human-readable field names. Alias: human.

• mode (optional): The data mode to use.

Returns

• MarketDataPromise<MarketStatus[] | MarketStatusHuman[] | Blob>

Today

import { MarketDataClient } from "@marketdata/sdk";

const client = new MarketDataClient();

try {
  const days = await client.markets.status();
  for (const d of days) {
    console.log(`date=${d.date} status=${d.status}`);
  }
} catch (error) {
  console.error(error);
}

Date Range

import { MarketDataClient } from "@marketdata/sdk";

const client = new MarketDataClient();

try {
  const days = await client.markets.status({
    from: "2024-01-01",
    to: "2024-01-31",
    country: "US",
  });
  console.log(days);
} catch (error) {
  console.error(error);
}

Countback

import { MarketDataClient } from "@marketdata/sdk";

const client = new MarketDataClient();

try {
  // Last 7 trading-status days
  const days = await client.markets.status({ countback: 7 });
  console.log(days);
} catch (error) {
  console.error(error);
}

Human Readable

import { MarketDataClient } from "@marketdata/sdk";

const client = new MarketDataClient();

try {
  const days = await client.markets.status({ countback: 7, human: true });
  for (const d of days) {
    console.log(`Date=${d.Date} Status=${d.Status}`);
  }
} catch (error) {
  console.error(error);
}

MarketStatus

interface MarketStatus {
  s?: string;
  date: number;
  status: string;
}

Properties

• s (string, optional): Status indicator.
• date (number): Unix timestamp of the trading day.
• status (string): Market status (e.g. "open", "closed").

MarketStatusHuman

interface MarketStatusHuman {
  s?: string;
  Date: number;
  Status: string;
}

MarketStatusHuman is returned when human: true is set.