All documented Roblox HTTP APIs can now be found either by domain (e.g. groups.roblox.com) or by use-case (e.g. Users, Groups). Both the feature and domain-based references include the full-set of documented Roblox HTTP APIs, whether they were considered “Cloud V1/V2” or “Legacy.”
We now format all endpoint information in the same way. The stability level, supported authentication types, and recommended alternative endpoints (if any) are now documented clearly, and provide suggestions on how each endpoint should be used.
All content on these pages comes from a single open-sourced OpenAPI JSON document. This file will be updated roughly weekly with content improvements.
You can use this file yourself for testing API calls, generating client SDKs, or even building your own documentation viewers. Read more about this OpenAPI document here.
How to browse?
Navigate to a feature or domain-based page based on the endpoint(s) of your interest.
Use the filter to split longer reference pages up. You can share that filtered view deeplink with other creators.
Click into and view an endpoint’s specific details. You can also share the endpoint deeplink with other creators.
This might be just down to preference, but when an API is deprecated and has a preferred alternative, I would like it to not open that alternative in a new tab by default.
Prior to this update you could clearly see that there were 4 main endpoints for dev products, and a bunch for internationalization and then even further down there was a section for legacy endpoints. Now with them all clumped together, it is much harder to read and distinguish.
Endpoints are tagged with multiple features, which does allow us add headers programmatically based on the shared categorizations. I’ve drafted up a preview below. Would this be an effective replacement for you?
Hey VastMajorPie, do you think you’d rather see this list with a dropdown to minimize the list and/or have the .roblox.com suffix of the domain title removed?
I vote to keep the full domain names in the sidebar. Yes, it’s clunky but it lets me know that api-service.roblox.com is definitely the domain I’ll be using. If we just have Games V1, the subdomain might not match the human-readable name.
As an example, take the Localization Tables subdomain. If it was like that on your own, you wouldn’t know if it’s hyphenated or one word.
This update is phenomenal. I have been making use of nearly all the Open Cloud endpoints that are available and this makes my life so much easier. Essentially gives me everything I have been asking for.
Not exactly relevant to this thread, but on the topic of improving the docs, want to bump this documentation issue
Additionally, is there a changelog for the docs or endpoints anywhere? Earlier this week I was trying to create a feature for my app that allows users to edit creator store products but put this on hold since the docs showed that all the fields were immutable so the endpoint wasn’t actually usable. I happened to have checked again now and it seems the fields can be edited now. If I hadn’t randomly check the docs, I never would have known that there was a change to the endpoint.
We don’t have an official changelog anywhere, but the history of the openapi.json document can be used for reference.
This looks like a bug with the old reference documentation. Within the OpenAPI document, only the product type fields are marked as immutable with the x-immutable field, which the new documentation now respects. Given that we’ve released the new documentation reference and depending on further feedback, we’ll likely prioritize improving the new reference rather than patching this.
I honestly liked when I could see deprecated functions and properties.
The new documentation may be better, but I liked the old one because it had all the old, depreciated things too.
I honestly liked when I could see deprecated functions and properties.
Endpoints that are deprecated but still functional haven’t yet been removed from the documentation - they can be found in a “Not Recommended” section on each page. Is this what you’re looking for?
