openblox

KO | EN

gitlite — search

#javascript #python #react #ai #llm #go #golang #linux #docker #kubernetes #vue #mcp #openai #open-source

(★ 40)

An API wrapper for Roblox, written in Typescript. Fully typesafe, optional caching, use any http client.

openblox Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div>

</div>

A strictly typed Roblox API wrapper which supports both classic and OpenCloud endpoints.

- - -
  
</div>

Openblox allows your typescript (and javascript) codebase to communicate with the Roblox API extemely easily.

It wraps over 100+ Roblox API endpoints, each with its own strictly typed response data. Typings were written manually as opposed to programatically generating them to ensure the strictest possible type-safety.

- Automatically handles csrf tokens.

- Prettifies / formats responses from the Roblox API to be developer friendly as possible, and to maintain a consistant (see Prettification).
- All results from Openblox methods return the underlying http response with it.

- Easily iterate over paginated endpoints (see Pagination).

- Each Openblox method utilises only one Roblox API endpoint to ensure clarity and efficiency in your codebase.

- Scarcely utilise classes to allow for treeshaking.

- - -

<h3>Example Usage</h3>

```ts
import "dotenv/config";
import { setDefaultOpenbloxConfig, createOpenbloxConfig } from "openblox/config";
import { UsersApi } from "openblox/cloud";
import { ClassicUsersApi } from "openblox/classic"; // Classic (BEDEV & BEDEV2) APIs will always be prefixed with `Classic`.

/*
Naming your Roblox Cookie environment variable `ROBLOX_COOKIE` will automatically
import it into your Openblox config, therefore voiding the need to set it in the config
manually. Similarly, naming your OpenCloud API Key environment variable `ROBLOX_CLOUD_KEY`
will also automatically import it into your Openblox config.
*/
setDefaultOpenbloxConfig(
    createOpenbloxConfig({
        cookie: process.env.ROBLOX_COOKIE as any,
        cloudKey: process.env.CLOUD_KEY as any
    })
)

(async () => {

const { data:userInfo_classic } = await ClassicUsersApi.userInfo({ userId: 45348281 })

const { data:userInfo_cloud } = await UsersApi.userInfo({ userId: 45348281 })

})
```

See more examples [here](https://github.com/MightyPart/openblox/tree/main/examples)!

- - -

<h3>Openblox Methods</h3>

Openblox methods all return an object containing the following
```ts
const {
  data: unknown, // The prettified / formatted data from the Roblox api endpoint (As an optimisation, prettification / formatting only happens once accessed / destructured).

response: HttpResponse, // The http response from the Roblox api endpoint. The raw unprettified data can be accessed via `response.body`.

cursors: { next: string, previous: string }, // Only exists on paginated endpoints. Contains the previous and next cursor.
} = OpenbloxApi.method(...)
```

- - -

openblox

openblox Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

openblox

openblox Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README