# robloxcloudapi

> Node.JS module made to use the Roblox Cloud API externally

Latest version **1.2.4** (published 2023-07-12) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install robloxcloudapi
pnpm add robloxcloudapi
yarn add robloxcloudapi
bun add robloxcloudapi
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2023-07-12 |
| First published | 2023-05-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | load_lua |
| Maintainers | load_lua |
| Keywords | Roblox, API, Cloud, DataStoreService, MessagingService |

## Links

- npm: https://www.npmjs.com/package/robloxcloudapi
- npm.io page: https://npm.io/package/robloxcloudapi

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) latest

## Recent versions

- 1.2.4 (latest) — 2023-07-12
- 1.2.3 — 2023-07-12
- 1.2.2 — 2023-05-31
- 1.2.1 — 2023-05-31
- 1.2.0 — 2023-05-31
- 1.1.11 — 2023-05-30
- 1.1.10 — 2023-05-30
- 1.1.9 — 2023-05-30
- 1.1.8 — 2023-05-30
- 1.1.7 — 2023-05-30
- 1.1.6 — 2023-05-30
- 1.1.5 — 2023-05-30
- 1.1.4 — 2023-05-30
- 1.1.3 — 2023-05-30
- 1.1.2 — 2023-05-30
- … 3 more at https://npm.io/package/robloxcloudapi/versions

## README

# Roblox Node JS Open Cloud API
There are ***two*** APIs in this module right now.
### Note
Please setup your cloud API key before beginning.

Link: https://create.roblox.com/dashboard/credentials

**Having trouble?** View this article: https://create.roblox.com/docs/cloud/open-cloud/managing-api-keys

## Introduction to the MessageService API <a name="ms"></a>
Before starting this identify your API key and the universe ID you want to access.
```js
const API_KEY = "api key here"
const UniverseID = "universe id here"
```
Require the module as seen below.
```js
const rbxcloudAPI = require("robloxcloudapi")
```
Now lets setup our MessageService communicator.
```js
const MessageService = new rbxcloudAPI.MessageService(API_KEY, UniverseID)
```
From here you can now comunicate with all servers of the game
```js
.sendMessage(Message) // sends Message to all servers of universe
.sendObject(Object) // sends Object to all servers of universe
```
## Introduction to the DataStoreService API <a name="ds"></a>
Before starting this identify your API key and the universe ID you want to access.
```js
const API_KEY = "api key here"
const UniverseID = "universe id here"
```
Require the module as seen below.
```js
const rbxcloudAPI = require("robloxcloudapi")
```
Now lets setup our DataStore communicator.
```js
const DataStores = new rbxcloudAPI.DataStoreService(API_KEY, UniverseID)
```
From here you can view and edit your DataStores' entries inside this game by using functions shown below.
```js
.getEntries(datastore_name) // returns a JSON table of all Entries
.getEntry(datastore_name,entryKey) // returns the value of entryKey
.setEntry(datastore_name,entryKey,value) // Sets entry to the value given
```

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