BloxVault
DocsUpload ScriptObfSign UpLog in

Documentation

Public API

Only public and official APIs are listed here.

  • GET
    /api/scripts
    List scripts (query: search, author, game, limit)
  • GET
    /api/scripts/[slug]
    Get script details by slug (includes content)
  • GET
    /api/raw/[slug]
    Raw script content (text/plain)
  • GET
    /api/download/[slug]
    Download script file (attachment)
  • GET
    /api/users/[username]
    Public user profile and stats
  • GET
    /api/favorites?username=
    List a user's favorited scripts
How to use

Base URL is your site (e.g. /api/*). All endpoints return JSON unless noted otherwise.

Authentication
- Most write endpoints require an auth token in Authorization: Bearer <token> header or the sb_token cookie.
Common fields
  • title — human readable title
  • content — script source
  • language — e.g. lua
  • game — optional game name or id
  • tags — array of strings
  • exposure — public or private
Examples
Quick Node.js example
// Node.js (fetch)
const res = await fetch('https://bloxvault.org/api/scripts?limit=5')
const scripts = await res.json()
console.log(scripts)
Reference: GET /api/scripts
Query parameters: limit (number, max 100), offset (number), search (string), author (string), game (string).
Behavior: Returns an array of scripts (most recent first). Authenticated requests may have higher rate limits.
Sample response:
[
  {
    "slug": "abc123",
    "title": "Auto Farm",
    "createdAt": "2026-01-23T12:34:56.000Z",
    "language": "lua",
    "views": 42,
    "game": "123456789",
    "tags": "admin,fun",
    "thumbnail": "/thumbnails/123.png",
    "description": "Auto farm for game",
    "author": "javen"
  }
]
Notes
- Some endpoints may require CAPTCHA (Turnstile) for POSTs when configured. Private APIs return structured JSON responses describing missing keys or captcha requirements.
- Custom thumbnails are currently disabled in the Upload tab and the script Settings modal; provide a Roblox game to auto‑fetch a thumbnail for now.
- If you want more examples or a full OpenAPI spec, open an issue or send a PR — contributions welcome!