# @waline/api

> Client API for Waline comment system

Latest version **1.1.2** (published 2026-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @waline/api
pnpm add @waline/api
yarn add @waline/api
bun add @waline/api
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2026-06-04 |
| First published | 2023-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 0 |
| Unpacked size | 33.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 3125 |
| Author | Mr.Hope |
| Maintainers | lizheming, mister-hope |
| Keywords | api, waline |

## Links

- npm: https://www.npmjs.com/package/@waline/api
- Repository: https://github.com/walinejs/waline
- npm.io page: https://npm.io/package/@waline/api

## Recent versions

- 1.1.2 (latest) — 2026-06-04
- 1.1.1 — 2026-06-03
- 1.1.0 — 2026-02-25
- 1.0.0 — 2025-01-17
- 1.0.0-alpha.8 — 2024-05-29
- 1.0.0-alpha.7 — 2024-02-20
- 1.0.0-alpha.6 — 2024-02-20
- 1.0.0-alpha.5 — 2024-01-26
- 1.0.0-alpha.4 — 2023-12-14
- 1.0.0-alpha.3 — 2023-11-21
- 1.0.0-alpha.2 — 2023-11-21
- 1.0.0-alpha.1 — 2023-05-18
- 1.0.0-alpha.0 — 2023-05-17

## README

<!-- markdownlint-disable MD033 MD041 -->

<img src="./assets/logo.png" width="200" align="right" alt="Waline logo" />

# Waline

![Author](https://img.shields.io/badge/author-lizheming,%20Mr.Hope-blue?style=for-the-badge) ![License](https://img.shields.io/github/license/walinejs/waline?style=for-the-badge) [![qq](https://img.shields.io/badge/qq-waline交流群-f75137?logo=TencentQQ&style=for-the-badge)](https://jq.qq.com/?_wv=1027&k=bKoVBppG) [![telegram](https://img.shields.io/badge/telegram-walinejs-2ca5e0?logo=telegram&style=for-the-badge)](https://t.me/walinejs)

![npm version](https://img.shields.io/npm/v/@waline/client?color=critical&logo=npm&style=flat-square&label=@waline/client) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@waline/client?style=flat-square&label=@waline/client%20size) ![downloads](https://img.shields.io/npm/dm/@waline/vercel?style=flat-square&label=@waline/client%20downloads) [![jsDelivr hits](https://data.jsdelivr.com/v1/package/npm/@waline/client/badge)](https://www.jsdelivr.com/package/npm/@waline/client)

![npm version](https://img.shields.io/npm/v/@waline/vercel?color=critical&logo=npm&style=flat-square&label=@waline/vercel)

A simple comment system with backend support.

---

> [中文 README](https://github.com/walinejs/waline/blob/main/README_CN.md)

## Documentation

### [English](https://waline.js.org/en/) | [简体中文](https://waline.js.org/)

## Feature

- Fast
- **Really** Safe
- Support full markdown syntax
- Simple and lightweight
- Deploy free!
- Multiple deployment and storage service support, at least 243 deployment choice!

- |                                                 | Waline                                                              |                                   |
  | ----------------------------------------------- | ------------------------------------------------------------------- | --------------------------------- |
  | **Client**                                      | **Server**                                                          | **Storage**                       |
  | [@waline/client](https://waline.js.org)         | [Vercel](https://vercel.com)                                        | PostgreSQL                        |
  | [MiniValine](https://minivaline.js.org/)        | [CloudBase](https://cloudbase.net/)                                 | MySQL                             |
  | [sodesu](https://github.com/BeiyanYunyi/sodesu) | [Railway](https://railway.app)                                      | SQLite                            |
  |                                                 | [Render](https://render.com)                                        | [TiDB](https://tidbcloud.com/)    |
  |                                                 | [Zeabur](https://zeabur.com)                                        | [MongoDB](https://mongodb.com)    |
  |                                                 | [Netlify](https://netlify.com)                                      | [CloudBase](https://clodbase.net) |
  |                                                 | [Alibaba Cloud ComputeNest](https://computenest.console.aliyun.com) | [GitHub](https://github.com)      |
  |                                                 | Docker                                                              |                                   |
  |                                                 | self host                                                           |                                   |

## Todo

- [x] Email notification
- [x] Wechat notification
- [x] QQ notification
- [x] Telegram notification
- [x] Akismet
- [x] Article counter
- [x] i18n
- [x] Custom language
- [x] Login support
- [x] Comment management
- [x] Support delete comment
- [x] More database support
- [x] Limit the frequency of comments posted by IP
- [x] Comment keyword restrictions
- [x] IP disallow list
- [x] Duplicate content check
- [x] CloudBase deploy support
- [x] Social account login
- [x] Sticky Comment
- [x] Comment Like
- [ ] AWS, GCP, Azure deploy support

We **really** welcome you to contribute to waline!

## Contact

You can contact me through [discussions](https://github.com/walinejs/waline/discussions). Join our [telegram](https://t.me/walinejs) group or scan [QQ group](https://qm.qq.com/cgi-bin/qm/qr?k=rPZvq_EBfwQa6QZX7sToVlhH49c6ed0R&jump_from=webapi) qrcode to communicate about waline!

<a href="https://qm.qq.com/cgi-bin/qm/qr?k=rPZvq_EBfwQa6QZX7sToVlhH49c6ed0R&jump_from=webapi" target="_blank">
  <img src="./assets/qqgroup.jpg" width="300" alt="qq group qrcode" />
</a>

## Contributors

Your contributions enrich the open-source community, fostering learning, inspiration, and innovation. We deeply value your involvement. Thank you for being a vital part of our community! 🥰

[![Contributors](https://contrib.rocks/image?repo=walinejs/waline)](https://github.com/walinejs/waline/graphs/contributors)

## License

[GPL-2.0](https://github.com/lizheming/Waline/blob/main/LICENSE)

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