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.
To start using most endpoints, you need to -
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.
If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
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. |
Contact our support team at support@sharesphere.xyz
Endpoints which are generally accessable to the public, API keys can be generated, etc.
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.
Key | Value | Description |
---|---|---|
UserSession | {{UserSession}} |
A user session identifier is required for user authentication. |
Authorization | {{Authorization}} |
A valid API key. |
Gets up-to-date ShareSphere settings such as global message,
current
version, etc.
Gets info about a user. Includes their settings, onboarding
status,
liked posts, and posts, last online time.
Key | Value | Description |
---|---|---|
Authorization | {{Authorization}} |
A valid API key. |
Key | Value | Description |
---|---|---|
userId | 0 |
The UserId of the user to get info about. |
Likes or unlikes a post or list of posts.
Key | Value | Description |
---|---|---|
Authorization | {{Authorization}} |
A valid API key |
UserSession | {{UserSession}} |
A user session identifier is required for user authentication. |
Key | Value | Description |
---|---|---|
userId | 0 |
The UserId of the user who is liking post(s). |
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.
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
).
Key | Value | Description |
---|---|---|
Authorization | {{Authorization}} |
A valid API key. |
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. |
Endpoints which are not accessable to the public. This includes internal tools such as moderation and testing tools.
Deletes a specified post.
Key | Value | Description |
---|---|---|
postId | 0 |
The ID of the post to delete |
Gets the user’s moderation status, internal ids, and other
information.
Key | Value | Description |
---|---|---|
userId | 0 |
The userId of the user to get the status of. |
Deletes a user’s account. Complies with GDPR, deletes all
user
data.
Key | Value | Description |
---|---|---|
userId | 0 |
The userId of the user who’s profile should be deleted. |
Moderates a specified user. Used for post-banning and
account-banning.
Key | Value | Description |
---|---|---|
userId | 0 |
The userId of the user being moderated. |
moderationAction | 0 |
What action should be taken to moderate the user |
Key | Value | Description |
---|---|---|
apiKey |
The api key to validate. |