# @absolit/simple-wildduck

> Documented TypeScript wrapper for the WildDuck API

Latest version **1.2.2** (published 2026-09-13) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @absolit/simple-wildduck
pnpm add @absolit/simple-wildduck
yarn add @absolit/simple-wildduck
bun add @absolit/simple-wildduck
```

## Health

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

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2026-09-13 |
| First published | 2023-03-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 313 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Absolit |
| Maintainers | absolit |
| Keywords | wildduck, absolit |

## Links

- npm: https://www.npmjs.com/package/@absolit/simple-wildduck
- Repository: https://github.com/Absolit-FOSS/simple-wildduck
- Homepage: https://github.com/Absolit-FOSS/simple-wildduck#readme
- Issues: https://github.com/Absolit-FOSS/simple-wildduck/issues
- npm.io page: https://npm.io/package/@absolit/simple-wildduck

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.20.0
- [@netsu/js-utils](https://npm.io/package/@netsu/js-utils.md) ^2.1.0

## Recent versions

- 1.2.2 (latest) — 2026-09-13
- 1.2.1 — 2026-09-13
- 1.2.0 — 2026-09-13
- 1.1.10 — 2026-07-22
- 1.1.9 — 2026-05-27
- 1.1.6 — 2026-03-04
- 1.1.5 — 2026-03-04
- 1.1.4 — 2026-03-04
- 1.1.3 — 2026-03-04
- 1.1.2 — 2026-03-04
- 1.1.1 — 2026-03-04
- 1.1.0 — 2025-09-26
- 1.0.8 — 2024-07-24
- 1.0.7 — 2024-04-05
- 1.0.6 — 2024-04-05
- … 32 more at https://npm.io/package/@absolit/simple-wildduck/versions

## README

# Simple WildDuck

Simple WildDuck is a free and open-source wrapper for the WildDuck API. It simplifies API requests by providing well-documented TypeScript functions, making it easy to integrate WildDuck into any project.

Based completely on the existing API: https://docs.wildduck.email/docs/category/wildduck-api

- [Setup and Usage](#setup-and-usage)
- [Contributing](#contributing)
  - [Project Structure](#project-structure)
- [Useful Resources](#useful-resources)

## Setup and Usage

```typescript
import wd from "@absolit/simple-wildduck";

// initial setup, only have to do once
wd.wdInit({
	baseUrl: "https://www.your-wildduck-server.com",
	accessToken: "my-access-token",
	xAccessToken: "HeaderXAccessToken",
});

// simply make a request as such - note you will receive headers as well as data
const users = await wd.getUsers({ limit: 10 });

// reap the data rewards
if (users.data.success && users.data.results.length > 0) {
	console.log(users.data.results[0].address);
}
```

## Contributing

### Project Structure

- `src/` -> All source code goes here
- `src/models` -> Models that can be used everywhere goes here
- `src/requests` -> All WildDuck request endpoints
  - `src/requests/.../index.ts` -> Exports all request functions
  - `src/requests/.../config.ts` -> Config to be applied to all requests
  - `src/requests/.../models.ts` -> All models used in related requests
  - `src/requests/.../get.ts` -> All GET request functions
  - `src/requests/.../delete.ts` -> All DELETE request functions
  - `src/requests/.../post.ts` -> All POST request functions
  - `src/requests/.../put.ts` -> All PUT request functions
- `src/setup` -> Module setup, required functions when imported into your project

## Useful Resources

- [WildDuck](https://docs.wildduck.email)
- [WildDuck API](https://docs.wildduck.email/docs/category/wildduck-api)
- [WildDuck Docs](https://docs.wildduck.email/docs/intro)

---

## MeetingPal - Simplify Voting in Meetings

[MeetingPal](https://meetingpal.co.za) is a user-friendly app that allows for transparent voting during online, hybrid, or in-person meetings. This revolutionary software can be used for community schemes, professional bodies, associations, or trusts as it enables attendees to vote securely from anywhere in the world using only a mobile device. Enhance your meeting experience with MeetingPal.

---

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