# krist

> Krist API library for Node.js and the browser

Latest version **3.1.0** (published 2024-06-28) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install krist
pnpm add krist
yarn add krist
bun add krist
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2024-06-28 |
| First published | 2021-03-29 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20 |
| Dependencies | 7 |
| Unpacked size | 493 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Lemmmy |
| Keywords | krist |

## Links

- npm: https://www.npmjs.com/package/krist
- Repository: https://github.com/tmpim/Krist.js
- Homepage: https://github.com/tmpim/Krist.js#readme
- npm.io page: https://npm.io/package/krist

## Dependencies (7)

- [ws](https://npm.io/package/ws.md) ^8.16.0
- [axios](https://npm.io/package/axios.md) ^1.6.7
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [wspromisify](https://npm.io/package/wspromisify.md) ^2.4.4
- [tiny-typed-emitter](https://npm.io/package/tiny-typed-emitter.md) ^2.1.0
- [@aws-crypto/sha256-js](https://npm.io/package/@aws-crypto/sha256-js.md) ^5.2.0
- [rate-limiter-flexible](https://npm.io/package/rate-limiter-flexible.md) ^4.0.1

## Recent versions

- 3.1.0 (latest) — 2024-06-28
- 3.0.2 — 2024-02-12
- 3.0.1 — 2024-02-11
- 3.0.0 — 2024-02-11
- 2.0.4 — 2023-05-15
- 2.0.3 — 2023-05-15
- 2.0.2 — 2023-03-28
- 2.0.1 — 2022-07-23
- 2.0.0 — 2021-03-29

## README

# krist.js

JavaScript and TypeScript wrapper for the [Krist API](https://krist.dev/docs).
Supports Node.js and the browser.

- [Guides and examples](https://docs.krist.dev/docs/libraries/krist-js.html)
- [Full API reference](https://docs.krist.dev/library/krist.js/modules/)

## Features
- Works on the server with Node.js, and in browsers
- ES Modules support
- Modern, Promise-based API with TypeScript support designed with async/wait in mind
- Type-safe functions for all HTTP endpoints
- Fully-featured WebSocket client with events and automatic reconnection
- Useful Promise exceptions for all API errors
- V2 Address generation with support for common wallet formats (KristWallet, Krist API, etc.)
- CommonMeta parser for transaction metadata
- Pagination helper for working with multiple pages of results
- Utilities for common tasks such as validating addresses and names

### Not yet supported
- Lookup API
- Search API
- Idempotent requests

## Quick Start

1. Install `krist` from npm or yarn:

```sh
npm install krist
yarn add krist
```

2. Import `krist` and create an instance of `KristApi`:

```ts
import { KristApi } from "krist";
const api = new KristApi();
```

More examples can be found at [docs.krist.dev](https://docs.krist.dev/docs/libraries/krist-js.html).
View the [full API reference here](https://docs.krist.dev/library/krist.js/modules/).

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