# @hebcal/rest-api

> Jewish holidays and Hebrew calendar as plain JSON objects and CSV export

Latest version **7.3.3** (published 2026-11-11) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install @hebcal/rest-api
pnpm add @hebcal/rest-api
yarn add @hebcal/rest-api
bun add @hebcal/rest-api
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.3.3 |
| Published | 2026-11-11 |
| First published | 2020-07-07 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >= 18.0.0 |
| Dependencies | 3 |
| Unpacked size | 148.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 19 |
| Author | Michael J. Radwin |
| Maintainers | mjradwin |
| Keywords | hebcal |

## Links

- npm: https://www.npmjs.com/package/@hebcal/rest-api
- Repository: https://github.com/hebcal/hebcal-rest-api
- Homepage: https://hebcal.github.io/api/rest-api/
- Issues: https://github.com/hebcal/hebcal-rest-api/issues
- npm.io page: https://npm.io/package/@hebcal/rest-api

## Dependencies (3)

- [@hebcal/core](https://npm.io/package/@hebcal/core.md) ^6.16.0
- [@hebcal/hdate](https://npm.io/package/@hebcal/hdate.md) ^0.23.1
- [@hebcal/leyning](https://npm.io/package/@hebcal/leyning.md) ^10.1.0

## Recent versions

- 7.3.3 (latest) — 2026-11-11
- 7.3.2 — 2026-11-06
- 7.3.1 — 2026-10-05
- 7.3.0 — 2026-10-05
- 7.2.1 — 2026-09-28
- 7.1.3 — 2026-07-30
- 7.1.2 — 2026-07-30
- 7.1.1 — 2026-07-29
- 7.1.0 — 2026-07-29
- 7.0.1 — 2026-07-28
- 7.0.0 — 2026-07-27
- 6.5.1 — 2026-07-08
- 6.5.0 — 2026-07-08
- 6.4.9 — 2026-05-26
- 6.4.8 — 2026-05-14
- … 138 more at https://npm.io/package/@hebcal/rest-api/versions

## README

# @hebcal/rest-api
Jewish holidays and Hebrew calendar as plain JSON objects and CSV export

[![Build Status](https://github.com/hebcal/hebcal-rest-api/actions/workflows/node.js.yml/badge.svg)](https://github.com/hebcal/hebcal-rest-api/actions/workflows/node.js.yml)

## Installation
```bash
$ npm install @hebcal/rest-api
```

## Synopsis
```javascript
import {HebrewCalendar, Location} from '@hebcal/core';
import {eventsToClassicApi, eventsToCsv} from '@hebcal/rest-api';

const options = {
  year: 2020,
  month: 2,
  sedrot: true,
  candlelighting: true,
  location: Location.lookup('Hawaii'),
};
const events = HebrewCalendar.calendar(options);
const apiResult = eventsToClassicApi(events, options);

console.log(JSON.stringify(apiResult));

const csv = eventsToCsv(events, options);
console.log(JSON.stringify(csv));
```

## [API Documentation](https://hebcal.github.io/api/rest-api/index.html)

---
_Source: https://npm.io/package/@hebcal/rest-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
