roblox-api-raw

Retrieve the raw JSON Roblox API Dump.

Installation

Install roblox-api-raw through npm:

$ npm install roblox-api-raw

Usage

Retrieve the latest version of the Roblox API dump through getLatestVersion().

import * as RobloxApi from "roblox-api-raw";

const version = await RobloxApiDump.getLatestVersion();
console.log(version); // => version-7f176a3bbd5e424e

// Ensure we're a module for top-level await.
export {};

Retrieve the latest version of the Roblox API dump through getApiDump() or, similarly, retrieve the Roblox API dump for a certain version with getApiDump(version).

import * as RobloxApi from "roblox-api-raw";

const apiDump = await RobloxApiDump.getApiDump();
console.log(apiDump.Version); // => 1

// Ensure we're a module for top-level await.
export {};

roblox-api-raw retrieves the Roblox API dump as-is.

API

View the full documentation here.

License

This package is available as open source under the terms of the MIT License.