@codiium/bloxlink-api


npm version npm downloads Tests status

An unofficial Bloxlink API wrapper for Node.js

Installation

Note

npm install @codiium/bloxlink-api
yarn add @codiium/bloxlink-api
pnpm add @codiium/bloxlink-api

Getting your API Key

Visit the Bloxlink Developer page to get your API key.

Setup/Usage

Global API

You can import the global library by adding /global to the package import path

import global from "@codiium/bloxlink-api/global";

global.setGlobalApiKey("YOUR-API-KEY-HERE");

const response = await global.DiscordToRoblox("756614666066591836");

console.log(response);

Guild API

You can import the guild library by adding /guild to the package import path

import guild from "@codiium/bloxlink-api/guild";

guild.setGuildApiKey("YOUR-API-KEY-HERE");

const response = await guild.DiscordToRoblox("756614666066591836");

console.log(response);

Typings

This package comes with some typings, such as certain data responses, and enums for the different error types. All respones include a statusCode property if you would like to know the status code. That is not included by default in the response body from Bloxlink's API.