# @eclipse-utilities/blox.js

> ROBLOX API wrapping, simplified.

Latest version **1.2.2** (published 2026-06-07) · 0 weekly downloads

## Install

```sh
npm install @eclipse-utilities/blox.js
pnpm add @eclipse-utilities/blox.js
yarn add @eclipse-utilities/blox.js
bun add @eclipse-utilities/blox.js
```

## Health

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

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2026-06-07 |
| First published | 2022-10-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | qalue |

## Links

- npm: https://www.npmjs.com/package/@eclipse-utilities/blox.js
- Repository: https://github.com/qalue/blox.js
- Homepage: https://github.com/qalue/blox.js#readme
- Issues: https://github.com/qalue/blox.js/issues
- npm.io page: https://npm.io/package/@eclipse-utilities/blox.js

## Dependencies (1)

- [@aero/http](https://npm.io/package/@aero/http.md) ^1.2.0

## Recent versions

- 1.2.2 (latest) — 2026-06-07
- 1.2.1 — 2026-06-06
- 1.2.0 — 2026-06-06
- 1.1.9 — 2023-07-17
- 1.1.8 — 2023-07-17
- 1.1.7 — 2023-07-16
- 1.1.6 — 2023-07-16
- 1.1.5 — 2022-10-11
- 1.1.4 — 2022-10-11
- 1.1.3 — 2022-10-08
- 1.1.2 — 2022-10-08
- 1.1.1 — 2022-10-02
- 1.1.0 — 2022-10-02
- 1.0.0 — 2022-10-01

## README

<p align="center">
    <img src="https://i.ibb.co/5XXpsm60/blox.png" alt="blox.js" width=300/>
    <br><br>
    <strong>ROBLOX API wrapping, simplified.</strong>
</p>

---

### Get a list of users by a keyword
```js
const { getUsersByKeyword } = require('@eclipse-utilities/blox.js')
await getUsersByKeyword(keyword)
```
Returns an array or `null`

### Get avatar by ID
```js
const { getAvatar } = require('@eclipse-utilities/blox.js')
await getAvatar(userId, type, size)
```
`type` - `'avatar'` (default), `'headshot'`, `'bust'`  
`size` - defaults to `'720x720'`  
Returns a string or `null`

### Get users by username(s)
```js
const { getUsersByUsernames } = require('@eclipse-utilities/blox.js')
await getUsersByUsernames(usernames, excludeDeletedUsers)
```
Returns an array or `null`

### Get user by username
```js
const { getUserByUsername } = require('@eclipse-utilities/blox.js')
await getUserByUsername(username)
```
Returns a JSON object or `null`

### Get previous usernames by ID
```js
const { getPastUsernames } = require('@eclipse-utilities/blox.js')
await getPastUsernames(userId)
```
Returns an array or `null`

### Get user by ID
```js
const { getUserByID } = require('@eclipse-utilities/blox.js')
await getUserByID(userId)
```
Returns a JSON object or `null`

### Get user presence
```js
const { getUserPresence } = require('@eclipse-utilities/blox.js')
await getUserPresence(userId)
await getUserPresence([userId1, userId2])
```
Returns a presence object or array or `null`

### Get user groups
```js
const { getUserGroups } = require('@eclipse-utilities/blox.js')
await getUserGroups(userId)
```
Returns an array or `null`

### Get user friend count
```js
const { getUserFriendCount } = require('@eclipse-utilities/blox.js')
await getUserFriendCount(userId)
```
Returns a number or `null`

### Get user follower count
```js
const { getUserFollowerCount } = require('@eclipse-utilities/blox.js')
await getUserFollowerCount(userId)
```
Returns a number or `null`

### Check if inventory is visible
```js
const { canViewInventory } = require('@eclipse-utilities/blox.js')
await canViewInventory(userId, apiKey)
```
Requires a [Roblox Open Cloud API key](https://create.roblox.com/dashboard/credentials) with **Inventory Read** access.  
Returns `true`, `false`, or `null`

### Get user badges
```js
const { getUserBadges } = require('@eclipse-utilities/blox.js')
await getUserBadges(userId, apiKey)
```
Requires a [Roblox Open Cloud API key](https://create.roblox.com/dashboard/credentials) with **Inventory Read** access.  
Returns `null` if the user's inventory is private.  
Returns an array of badge objects.

---
_Source: https://npm.io/package/@eclipse-utilities/blox.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._