# snoway-api

> Snoway API is a simple api that lets you find out a user's old name(s) into Snoway's database.

Latest version **2.0.1** (published 2026-01-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install snoway-api
pnpm add snoway-api
yarn add snoway-api
bun add snoway-api
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2026-01-04 |
| First published | 2024-05-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Sown |
| Maintainers | sown145 |
| Keywords | api, display, name, namehistory, discord, discordbot, prevnames, prevname, oldnames, oldname |

## Links

- npm: https://www.npmjs.com/package/snoway-api
- Repository: https://github.com/sownay/snoway-api
- Homepage: https://github.com/sownay/snoway-api#readme
- Issues: https://github.com/sownay/snoway-api/issues
- npm.io page: https://npm.io/package/snoway-api

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2026-01-04
- 2.0.0 — 2025-11-23
- 1.5.1 — 2024-06-06
- 1.5.0 — 2024-06-06
- 1.4.0 — 2024-06-06
- 1.3.0 — 2024-05-04
- 1.2.0 — 2024-05-04
- 1.1.0 — 2024-05-04
- 1.0.0 — 2024-05-04

## README

# Snoway API Wrapper

![npm version](https://img.shields.io/npm/v/snoway-api)
![npm size](https://img.shields.io/bundlephobia/min/snoway-api)
![license](https://img.shields.io/npm/l/snoway-api)

**Snoway API** is a simple and lightweight Node.js wrapper that allows you to easily access Snoway's database to find a Discord user's old usernames and display names.

## 💾 Installing

You can install this package using your favorite package manager:

```bash
# npm
npm i snoway-api

# Yarn
yarn add snoway-api

# Bun
bun i snoway-api
```

## 🎈 __Example Usage__
Here is a complete example of how to use the wrapper.

```js
const SnowayAPI = require('snoway-api');
const api = new SnowayAPI("Your API key");

async function main() {
    const userId = 'USER_ID_HERE';
    try {
        // 1. Get all previous names (Global history)
        const allHistory = await api.allPrevnames(userId);
        console.log('All History:', allHistory);

        // 2. Get specific usernames history
        const names = await api.getNames(userId);
        console.log('Usernames:', names);

        // 3. Get specific display names history
        const displayNames = await api.getDisplay(userId);
        console.log('Display Names:', displayNames);

        // 4. Get API Stats
        const stats = await api.stats();
        console.log('API Stats:', stats);

    } catch (error) {
        console.error('An error occurred:', error);
    }
}

main();
```

## 💖 Contributors

*  [**Sown**](https://github.com/sownay)
*  [**Inside**](https://github.com/insidou)

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