Economy api docs don't work

When you go to the docs page of that site, it redirects you to the URL below.
https://economy.roblox.com/docs/index.html
image

If i try this URL it takes me to the docs:
https://economy.roblox.com//docs
It should have redirected to
https://economy.roblox.com/docs

Expected behavior

I expect it to show the normal swagger page.

Page URL: https://economy.roblox.com/docs

add an extra ‘/’ before ‘docs’ so it is
https://economy.roblox.com//docs/index.html
instead of https://economy.roblox.com/docs/index.html

I know, that is why i said it should have redirected to the correct canonical destination.

oh sorry i didnt read the full post :skull::skull:

This has already been reported and fully addressed here:

Aforementioned, a workaround is adding an additional slash to the URL.

As stated above this is intentional, see my reply here.

Please avoid this when possible and work with the new documentation at: Documentation - Roblox Creator Hub

We do not guarantee that the old URLs will work or continue to work in the future. The “double slash” or any other alteration may stop working without warning in the future.

Sadly the new docs are messy.
The old swagger was more user-friendly.
I’ve almost given up on the new docs site, i can’t find any API and they don’t show example URLs on usage.
There’s no test option like on the swagger either.
Deprecating/legacy APIs before any new API for it is created isn’t a good solution either.

Thanks for the feedback, we’re aware of those issues and looking to address already.

What do you mean with “messy” and less “user-friendly” precisely other than what you already wrote?

Due to emergent reasons we had to disable the routes and it’s possible we need to disable the alterations in the future as well. Ideally we would have ported all functionality to the docs site first but this was not possible due to external factors. Thanks for your patience here.

I do understand that external factors can play a role in getting things done.
But then we need to get a heads-up before such big things change.
We did get an update in 2023, about some apis being sunset.

What I mean by “messy” is that users are now required to navigate to separate websites to find information about the APIs for specific subdomains. Previously, we had a centralized and straightforward resource at https://api.roblox.com/docs, where we could easily look up the available services for a given subdomain.

It would be ideal if Roblox provided something similar, such as https://apis.roblox.com/docs, which would list all available subdomains and their APIs in a consolidated and user-friendly manner. The old wiki also maintained a list like this, and while it wasn’t perfect, it served as a valuable reference. However, after the wiki was deprecated and we moved to the Developer Forum, this type of centralized documentation was lost.

The current Legacy API page only includes a partial list of APIs that were previously accessible via Swagger. Unfortunately, it doesn’t reflect the full scope of what was available. I settled with the expectation that “we might get that later,” but progress on comprehensive API documentation has been slow.

I strongly suggest Roblox use an automated system, such as AI, to scan for and list all the active Roblox APIs. This could then be published on the documentation site, providing a single source of truth. However, until this is fully implemented, it would be beneficial to restore the old Swagger interface as a temporary solution.

Additionally, there has been little transparency regarding which APIs are being designated as “Legacy.” Beyond the few listed on the Legacy page, we don’t know what else has been or might be deprecated. This lack of clarity makes it harder for developers to plan and adapt their projects.

Furthermore, Roblox has not provided much detail regarding the scope or reasoning behind moving away from the Swagger interface. Back in 2023, Roblox shared this post: Action Needed: Sunsetting api.roblox.com, but there have been no significant updates or follow-ups since then. This lack of communication makes it difficult for developers to understand the long-term goals or adapt effectively to the ongoing changes.

To illustrate the lack of documentation, here’s a list of APIs that are currently in use but lack proper centralized documentation:

Found API list
API Name Description Documentation URL Example Usage URL
AbTesting API Manages A/B testing frameworks. abtesting.roblox.com//docs https://abtesting.roblox.com/v1/experiments
AccountInformation API Accesses and modifies account information. accountinformation.roblox.com//docs https://accountinformation.roblox.com/v1/users/12345678
AccountSettings API Handles user account settings. accountsettings.roblox.com//docs https://accountsettings.roblox.com/v1/email
AdConfiguration API Configures Roblox advertisements. adconfiguration.roblox.com//docs https://adconfiguration.roblox.com/v1/ad-formats
Ads API Manages advertisement endpoints. ads.roblox.com//docs https://ads.roblox.com/v1/ads/12345678
AssetDelivery API Delivers asset content. assetdelivery.roblox.com//docs https://assetdelivery.roblox.com/v1/asset?id=12345678
Authentication API Manages authentication sessions. auth.roblox.com//docs https://auth.roblox.com/v2/login
Avatar API Customizes player avatars. avatar.roblox.com//docs https://avatar.roblox.com/v1/users/12345678/avatar
Badges API Manages badges and badge awards. badges.roblox.com//docs https://badges.roblox.com/v1/users/12345678/badges
Billing API Handles real-money transactions. billing.roblox.com//docs https://billing.roblox.com/v1/transactions
Catalog API Browses and searches catalog items. catalog.roblox.com//docs https://catalog.roblox.com/v1/search/items?category=All
Chat API Manages chat and party functionalities. chat.roblox.com//docs https://chat.roblox.com/v2/get-user-conversations
ClientSettings API Retrieves client configuration information. clientsettings.roblox.com//docs https://clientsettings.roblox.com/v1/client-version/WindowsPlayer
ContentStore API Manages temporary storage for files before uploading. contentstore.roblox.com//docs https://contentstore.roblox.com/v1/assets/12345678
Contacts API Manages contacts and user tags. contacts.roblox.com//docs https://contacts.roblox.com/v1/users/12345678/contacts
Develop API Configures game development settings. develop.roblox.com//docs https://develop.roblox.com/v1/universes/12345678
Economy API Manages transactions and currency. economy.roblox.com//docs https://economy.roblox.com/v1/users/12345678/currency
EconomyCreatorStats API Provides creator economy statistics. economycreatorstats.roblox.com//docs https://economycreatorstats.roblox.com/v1/creators/12345678/stats
EngagementPayouts API Handles engagement-based payouts. engagementpayouts.roblox.com//docs https://engagementpayouts.roblox.com/v1/payouts
Followings API Manages follow relationships between entities. followings.roblox.com//docs https://followings.roblox.com/v1/users/12345678/followings
Friends API Manages friends, followers, and contacts. friends.roblox.com//docs https://friends.roblox.com/v1/users/12345678/friends
GameInternationalization API Manages game localization and translations. gameinternationalization.roblox.com//docs https://gameinternationalization.roblox.com/v1/localization-tables
GameJoin API Handles game launching processes. gamejoin.roblox.com//docs https://gamejoin.roblox.com/v1/join-game-instance
GamePersistence API Manages in-game data storage. gamepersistence.roblox.com//docs https://gamepersistence.roblox.com/v1/persistence/places/12345678
Games API Provides game discovery and details. games.roblox.com//docs https://games.roblox.com/v1/games?universeIds=12345678
Groups API Manages group functionalities. groups.roblox.com//docs https://groups.roblox.com/v1/groups/12345678
GroupsModeration API Handles group moderation tasks. groupsmoderation.roblox.com//docs https://groupsmoderation.roblox.com/v1/groups/12345678/moderation
Inventory API Views item ownership. inventory.roblox.com//docs https://inventory.roblox.com/v1/users/12345678/inventory
ItemConfiguration API Configures avatar and bundle items. itemconfiguration.roblox.com//docs https://itemconfigura

Finally, I want to emphasize the value of the testing panel that Swagger provided. It allowed us to interact directly with the APIs and test their functionality in real-time. Bringing back a similar feature on the new documentation site would be a major improvement for developers.

1 Like

This had to happen fast without warning due to external factors, we had no control over it this time unfortunately. Totally understand we need to give you heads-up for changes we can anticipate. Thank you for your understanding on this.

Yes, the new legacy docs page will be exactly that. We’re likely going to add apis.roblox.com documentation there in the future. Currently it covers API sites (<product>.roblox.com/... APIs, like economy.roblox.com/...).

My understanding is that it should cover everything that was available via swagger before. We never exposed documentation for apis.roblox.com yet, only for <product>.roblox.com sites. Can you let me know which you think are missing?

Yes, we are planning to automate documentation for more APIs (doesn’t need AI :smile:).

Please note: it’s not likely we will document all endpoints. There is no creator use case for e.g. changing a user’s password or completing a captcha programmatically. We’ll document everything where we expect there is valid, benign use cases for the APIs, with the widest definition possible. Many/most of the ones you have in your list are already documented on the legacy page. (please review the sidebar on the documentation page)

We’re aware we need it, we are going to look into that and also having a JSON export for the swagger document so you can import it into tools such as Postman.


Thanks for your feedback so far, appreciate all this!

2 Likes

Found API list

Just to be extra sure, my hunch is you missed the sidebar, can you confirm you browsed through this? Most of the ones mentioned in this list are there already:

1 Like

I saw the sidebar, but sometimes the pages wouldn’t load, it only loaded the “Overview” when i clicked the sub-pages, but I’ll have another look.
Thanks for the follow-up on my reply :slight_smile:

1 Like

On the topic of economy.roblox.com, only 1 endpoint is documented in the new documentation (and swagger page) and the entirety of v2 has its documentation hidden

This is expected behavior, only the endpoints shown on Economy Api v1 | Documentation - Roblox Creator Hub are intended to be exposed in the documentation.

I’m going to close out this report since as discussed earlier in thread this is intended (we have a new location for the docs on the Creator Hub documentation). We’re aware of all the improvements we should look into porting over from the old swagger documentation to the new page.