# prismarine-realms

> Library to manage and interact with Minecraft Realms for Java/Bedrock edition

Latest version **1.6.0** (published 2026-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install prismarine-realms
pnpm add prismarine-realms
yarn add prismarine-realms
bun add prismarine-realms
```

## Health

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

Positive: has types; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 1.6.0 |
| Published | 2026-04-14 |
| First published | 2022-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 79.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 23 |
| Author | Romain Beaumont |
| Maintainers | rom1504 |
| Keywords | prismarine, realms |

## Links

- npm: https://www.npmjs.com/package/prismarine-realms
- Repository: https://github.com/PrismarineJS/prismarine-realms
- Homepage: https://github.com/PrismarineJS/prismarine-realms#readme
- Issues: https://github.com/PrismarineJS/prismarine-realms/issues
- npm.io page: https://npm.io/package/prismarine-realms

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^4.3.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.6.0 (latest) — 2026-04-14
- 1.5.0 — 2026-03-30
- 1.4.1 — 2025-12-21
- 1.4.0 — 2025-12-04
- 1.3.2 — 2023-05-04
- 1.3.1 — 2023-04-08
- 1.3.0 — 2023-01-16
- 1.2.0 — 2022-05-21
- 1.1.1 — 2022-05-04
- 1.1.0 — 2022-04-03
- 1.0.0 — 2022-04-02
- 0.0.1 — 2022-04-02

## README

# prismarine-realms
[![NPM version](https://img.shields.io/npm/v/prismarine-realms.svg)](http://npmjs.com/package/prismarine-realms)
[![Build Status](https://github.com/PrismarineJS/prismarine-realms/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-realms/actions?query=workflow%3A%22CI%22)
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-realms)

Minecraft Realm interface for Minecraft Java and Bedrock editions, providing a stable API to start/stop Realms, and obtain Realm information such as connection addresses.

Minecraft Realms is a subscription based service provided by Mojang where users can host, create and manage their own private Minecraft servers.

## Installation
```shell
npm install prismarine-realms
```

## Usage

### RealmAPI

#### .from(authflow: Authflow, platform: 'bedrock' | 'java', options: Options)

Takes an **Authflow** instance from [prismarine-auth](https://github.com/PrismarineJS/prismarine-auth), you can see the documentation for this [here.](https://github.com/PrismarineJS/prismarine-auth#authflow)

### Example

```js
const { Authflow } = require('prismarine-auth') 
const { RealmAPI } = require('prismarine-realms')

const authflow = new Authflow()

const api = RealmAPI.from(authflow, 'bedrock') // or 'java'

// Returns a list of Realms the authenticating account has joined or owns.
await api.getRealms().then(console.log)
```

## Documentation

See [API Documentation](./docs/API.md#realmsapi)

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