Seraph API Client

This repository contains the client library for interacting with the Seraph API. It provides a convenient way to access various Seraph services, including player data, authentication, and linking functionalities.

Installation

To add the lib, use Bun:

bun add @seraphmc/node-seraph-api

Usage

Initialising the API Client

To use the Seraph API, you need to instantiate SeraphAPI with your client refresh token. This token is crucial for authentication with the Seraph services.

import { SeraphAPI } from "./seraph-api.ts";

const clientRefreshToken = process.env.SERAPH_CLIENT_REFRESH_TOKEN;
const seraphApiKey = process.env.SERAPH_API_KEY;

if (!clientRefreshToken) {
    throw new Error("Seraph refresh token is required.");
}

const seraph = new SeraphAPI('DEVELOPER', clientRefreshToken, seraphApiKey);

Available Services

The SeraphAPI instance provides access to several services, each handling specific functionalities:

getPlayerMojangService

Handles fetching Mojang player data (UUID and username).

const mojangService = seraph.getPlayerMojangService;
const player = await mojangService.fetchMojang("Notch");
console.log(player); // { id: "069a79f4-44e9-4726-a5be-fca90e38aaf5", name: "Notch" }

getAuthService

Manages authentication with the Seraph API, including fetching and refreshing access tokens.

const authService = seraph.getAuthService;
const token = await authService.getSeraphToken(true); // Get token with "Bearer" prefix
console.log(token); // Bearer <your_access_token>

getPlayerClientService

Provides methods to fetch player client information (e.g., Lunar Client, Badlion Client) and cosmetics.

const clientService = seraph.getPlayerClientService;
const clients = await clientService.fetchClient('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
console.log(clients);

const cosmetics = await clientService.fetchClientCosmetics('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
console.log(cosmetics);

getPlayerCacheService

Allows fetching historical player data and changes from the player cache.

const cacheService = seraph.getPlayerCacheService;

const playerHistory = await cacheService.fetchPlayerHistory('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
console.log(playerHistory);

const playerChanges = await cacheService.fetchPlayerChanges('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
console.log(playerChanges);

getPlayerStashService

Provides access to player stash functionalities, including search and ping data.

const stashService = seraph.getPlayerStashService;

const searchResults = await stashService.fetchSeraphSearch("Notch");
console.log(searchResults);

const seraphPing = await stashService.fetchSeraphPing('6ba7b810-9dad-11d1-80b4-00c04fd430c8');
console.log(seraphPing);

Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests.