ShareSphere API Documentation

The ShareSphere API is the most important part of ShareSphere, it’s essential to not only the official in-game ui, but also numerous other in-game utilities and even web-based apps. This documentation should help you get used to how our API works and how to use it in your own project.

Getting started guide

To start using most endpoints, you need to -

  • You must use a valid API Key to send requests to the API endpoints. You can learn more about Authentication here.
  • The API has rate and usage limits.

Authentication

For most API endpoints, ShareSphere requires an authentication key. This helps us combat spam and malicious users.

A key can be generated here, and is connected to your roblox account.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

Each API endpoint has it’s own rate limit. Some endpoint’s rate limit are not publicly stated.

Here you can see the public endpoint rate limits.

Endpoint Rate Limit
createPost For unverified games and applications, users can post once every two minutes.
For verified games and applications, users can post once every minute.

The total rate limit for specific authorization keys are not public.

Need some help?

Contact our support team at support@sharesphere.xyz

Public Endpoints 5

Endpoints which are generally accessable to the public, API keys can be generated, etc.

Description

This API allows you to create a post in ShareSphere. To use this API, you need to send an HTTP POST request with the required parameters. Make sure to include the necessary headers for authorization.

Headers
Key Value Description
UserSession {{UserSession}}

A user session identifier is required for user authentication.

Authorization {{Authorization}}

A valid API key.

Body
{ "parentPost": 0, //Optional, if not present or empty, the post will not have a parent. If it is present and not empty, but the parent post is not found, an error will return. "userId": 0, //Required, API will return an error if not present, empty, or 0. "gamePosted": 0, //Required, API will return an error if not present, empty, or 0. "text": "", //Required, API will return an error if not present or empty. "contentType": 0, //Optional, if 0 or empty, there will be no additional content. "contentData": {} //Optional, if not present or empty, there will be no additional content. }

Description

Gets up-to-date ShareSphere settings such as global message, current version, etc.


Description

Gets info about a user. Includes their settings, onboarding status, liked posts, and posts, last online time.

Headers
Key Value Description
Authorization {{Authorization}}

A valid API key.

Query
Key Value Description
userId 0

The UserId of the user to get info about.


Description

Likes or unlikes a post or list of posts.

Headers
Key Value Description
Authorization {{Authorization}}

A valid API key

UserSession {{UserSession}}

A user session identifier is required for user authentication.

Query
Key Value Description
userId 0

The UserId of the user who is liking post(s).

Body
{ "postIds": [ "commentPostTest", "-NfNuB0hzAHFBSkzGBkt", "-ShareSpherePostV2", "-Nfn1yZBAXz4mfjTPtkB" ] }

Description

This API endpoint allows you to retrieve posts based on various loading types. You can specify the type of posts you want to retrieve, such as global feed, game-specific feed, user-specific posts, parent post-related posts, or specific posts. The API also allows you to set the number of posts to retrieve.

Loading Types

  • 0: Request the global feed.

  • 1: Request the game-specific feed (requires gamePosted).

  • 2: Request both the global feed and game-specific feed (requires gamePosted). This results in two sets of posts.

  • 3: Request posts from specific user IDs (requires userId).

  • 4: Request posts related to a parent post (requires parentPost).

  • 5: Request specific posts by post ID(s) (requires postId).



Headers
Key Value Description
Authorization {{Authorization}}

A valid API key.

Query
Key Value Description
loadingType 0

Specifies the type of posts to load (values 0 to 5).

numberOfPosts 10

(required for loading types 0 to 4): Specifies the number of posts to retrieve.


Private Endpoints 6

Endpoints which are not accessable to the public. This includes internal tools such as moderation and testing tools.

Description

Deletes a specified post.

Query
Key Value Description
postId 0

The ID of the post to delete

Description

Gets the user’s moderation status, internal ids, and other information.

Query
Key Value Description
userId 0

The userId of the user to get the status of.

Description

Deletes a user’s account. Complies with GDPR, deletes all user data.

Query
Key Value Description
userId 0

The userId of the user who’s profile should be deleted.

Description

Moderates a specified user. Used for post-banning and account-banning.

Query
Key Value Description
userId 0

The userId of the user being moderated.

moderationAction 0

What action should be taken to moderate the user

Body
{ "description":"" //The reason for moderating, will be shown to the user. }
Body
{ "code": "" //A valid roblox OAuth Token }

Query
Key Value Description
apiKey

The api key to validate.