Roblox-api-types - A collection of Luau type definitions for the Roblox web apis

I’ve made a collection of type definitions for the roblox web apis using the OpenAPI definitions of each of them. This is useful because it lets you use the roblox api with intellisense without having to painfully type out the types yourself.

Simply find the type definition file inside of the types directory and copy-and-paste the source inside of your codebase.

Example:

local users = require(...)

local raw = HttpService:GetAsync("https://users.roblox.com/v1/users/1")
local user: users.GetUserResponse = HttpService:JSONDecode(raw)

print(user.id)
print(user.foo) -- luau gets angry

Enjoy!

9 Likes

I am now offering a single-file solution for the bravest which you can download at Releases · synpixel/roblox-api-types · GitHub (~5000 lines).