Skip to content

Introduction

Discord Server DevForum Post Downloads

rblx-open-cloud is a Python API wrapper for Roblox's Open Cloud. It supports all experience and creator APIs, OAuth2, and incoming webhooks, and OAuth2.

Getting Started

Instalation

py -3 -m pip install rblx-open-cloud --upgrade

python3 -m pip install rblx-open-cloud --upgrade

Basic Usage

Here are examples of creating classes for experiences, and groups.

This example will create an experience object, with 0000000 as the experience/universe ID, and apikey is the API key (see below).

from rblxopencloud import Experience

experience = Experience(0000000, "apikey")

Check out the experience guide and reference to learn more.

This example will create an experience object, with 0000000 as the group ID, and apikey is the API key (see below).

from rblxopencloud import Group

group = Group(0000000, "apikey")

Check out the group guide and reference to learn more.

API Keys

To use Open Cloud APIs you need to create an API key. An API key is a string which is provided to Roblox is prove who you are, and that you have permission to use these APIs. Here's how to create an API key:

  1. Go to the Creator Dashboard, and navigate to the Open Cloud API Keys section.
  2. Press 'CREATE API KEY'.
  3. Give your API key a name to identify it.
  4. Under 'Access Permissions', select the API system from the drop down you'd like to use
  5. Configure the permissions to allow the required experiences and/or scopes.

Each guide gives more detailed information about how to create API keys for that guide. Most APIs are also able to be authentiated with OAuth2.

Getting Help

You can ask for help in the Discord server or the DevForum Post, and you can report bugs on the GitHub repository.

Thank you for using rblx-open-cloud!