Hi developers,
In order to increase the reliability of our platform and improve scalability, we are migrating endpoints away from the monolithic api.roblox.com
web API.
Beginning on July 15, 2022, we will start removing individual API endpoints from api.roblox.com
. All endpoints are scheduled to be removed by the end of the year.
We recommend switching to newer endpoints on the apis.roblox.com
or individual APIs (avatar.roblox.com, games.roblox.com, etc).
Please update any tools, browser plugins, or third-party sites that rely on api.roblox.com
over to the newer endpoints listed below.
If you are having any issues with the new endpoints, reply to this post and we will be happy to provide answers.
FAQs
What is the exact date each API endpoint will be removed?
- Individual endpoints will be removed one-by-one at some point between now and the end of the year. We don’t have an exact date for each one.
I am not a web developer, how can I tell if this impacts me?
- This change only impacts developers who are making requests from third-party servers, browser plugins, or tools to
api.roblox.com
. - If you only develop inside of the Roblox game engine, you don’t need to make any changes.
- Currently HttpService does not allow direct requests to *.roblox.com. Some developers use proxy web servers to get around this limitation. If you use one of these proxy servers, you may be affected.
The new recommended endpoint doesn’t solve my use case, what can I do?
- Please reply to this post and we will do our best to assist you.
The new recommended endpoint is rate limiting me with a 429 Status Code (Too Many Requests)
- Different endpoints may have different rate limits applied. Reply with information about your use case and how frequently you are hitting the endpoint, and we will try to help you.
Is there a better way to notify people who are still using API endpoints?
- As part of the Open Cloud initiative, we are allowing consumers to identify themselves using API keys. In the future, this will allow us to notify impacted developers before we sunset any API endpoints.
What is apis.roblox.com
and how is it different from api.roblox.com
?
-
apis.roblox.com
is Roblox’s API Gateway and is responsible for routing traffic to services containing our API endpoints. Long-term we plan to move most of our endpoints toapis.roblox.com
. -
api.roblox.com
is a single monolithic site that handles traffic directly. The lack of routing has lead to an increasing number of scalability and reliability issues over time.
How can I view the documentation for endpoints on apis.roblox.com
?
- As part of the Open Cloud initiative, we plan to create a unified documentation system for our web API endpoints. For now, you can visit Open Cloud to view some of the endpoints.
Endpoints
This section is a list of all the public api.roblox.com
endpoints, and the replacement endpoints that we recommend switching over to. The new endpoints have different request and response formats, so we recommend reading the documentation.
Users
GET /users/account-info
→ Users Api for user info
→ AccountSettings Api for email info
→ https://economy.roblox.com/docs#!/Currency/get_v1_user_currency for Robux balance
→ Locale Api for locale info
GET /users/{userId}
→ Users Api for user info
→ https://thumbnails.roblox.com/docs#!/Avatar/get_v1_users_avatar for thumbnail
GET /users/get-by-username
→ Users Api
Blocking
GET /userblock/getblockedusers
POST /userblock/block
POST /userblock/unblock
Marketplace
GET /marketplace/productinfo
→ A new endpoint is not ready at the time of this announcement. Please stay tuned.
GET /marketplace/game-pass-product-info
→ A new endpoint is not ready at the time of this announcement. Please stay tuned.
GET /marketplace/productdetails
→ A new endpoint is not ready at the time of this announcement. Please stay tuned.
GET /developerproducts/list
→ Develop Api
GET /currency/balance
→ https://economy.roblox.com/docs#!/Currency/get_v1_user_currency
GET /my/balance
→ https://economy.roblox.com/docs#!/Currency/get_v1_user_currency
Universes
GET /universes/get-info
→ Games Api
GET /universes/get-universe-containing-place
→ Games Api
POST /universes/create
→ A new endpoint is not ready at the time of this announcement. Please stay tuned.
GET /universes/{universeId}/listcloudeditors
→ https://develop.roblox.com/docs#!/TeamCreate/get_v1_universes_universeId_teamcreate_memberships
GET /universes/get-universe-places
→ Develop Api
Assets
GET /ownership/hasasset
→ Inventory Api
GET /users/{userId}/canmanage/{assetId}
→ Develop Api
GET /assets/{id}/versions
→ Develop Api
GET /v2/assets/{id}/versions
→ Develop Api
Miscellaneous
GET /users/{userId}/onlinestatus
→ https://presence.roblox.com/docs#!/Presence/post_v1_presence_users
GET /users/{userId}/friends
→ Friends Api
GET /groups/{groupId}
→ Groups Api
GET /incoming-items/counts
→ Friends Api for friend request count
→ PrivateMessages Api for unread message count
GET /user/get-vote-count
→ https://api.roblox.com/user/get-vote-count?targetType=Place