OpenAPI

Windows · macOS · Android · home

The whole API is described in OpenAPI 3.1, generated from the same route table that builds /api/v1, so it cannot list a route the server does not answer.

https://rbxoffsets.com/api/v1/openapi.json

Import it

  • Postman — Import, then paste the URL above.
  • Insomnia — Create, then Import from URL.
  • Bruno — Import Collection, then OpenAPI V3.
  • Swagger UI — open any hosted Swagger UI and give it the URL.

Generate a client

# TypeScript types
npx openapi-typescript https://rbxoffsets.com/api/v1/openapi.json -o rbxoffsets.d.ts

# a Python client
npx @openapitools/openapi-generator-cli generate -g python -i https://rbxoffsets.com/api/v1/openapi.json -o rbxoffsets-py

# a C# client
npx @openapitools/openapi-generator-cli generate -g csharp -i https://rbxoffsets.com/api/v1/openapi.json -o RbxOffsets
Generated clients rarely follow the 302 redirects the file routes use in a way you want. For downloads and offsets files, fetch the redirect target yourself — see Downloading files.

The JSON index

https://rbxoffsets.com/api/v1 is the short form: every route with one line each, the offsets tiers and files, and links to these pages.