Home / API Reference

API Reference

Read-only access to the public script library. Base URL: https://rscripts.info/wp-json/rscripts/v1

Overview

The API exposes the public library: scripts, games, and trending lists. Everything is read-only — scripts can only be published through the website after review. Responses are JSON.

Authentication

Send your API key as a Bearer token. Find your key on the API tab of your dashboard after signing in. Keep it private — anyone with the key can read the library as you.

Authorization: Bearer rsc_live_YOUR_API_KEY

Use the Bearer header above. Some HTTP clients also let you set a custom X-Api-Key header with the same key value, but the live API validates the Authorization header.

X-Api-Key: rsc_live_YOUR_API_KEY
  • Keys are per-account. If a key leaks, regenerate it from the dashboard.
  • The Health endpoint is public and needs no key.
  • Every other endpoint returns 401 without a valid key.

Trust & safety

Do not fetch or execute script code without showing it to the user first. Scripts are community-submitted and reviewed, but you should still show the code before running anything.

  • Never ask users for their Roblox password or cookies.
  • Cache responses where you can instead of polling every second.
  • Keys may be revoked at any time if they are abused.

Responses

Successful responses return 200 with a JSON body. Lists are wrapped with data, total, page, and per_page.

{
  "data": [ ... ],
  "total": 42,
  "page": 1,
  "per_page": 20
}

Rate limits

Fair use: up to 60 requests per minute per key. Exceeding the limit returns 429. Cache responses where you can.

  • One request per user action is plenty for most tools.
  • Back off and retry after a short wait when you hit 429.

Shared parameters

List endpoints accept the same paging, search, and filter parameters.

ParameterTypeDescription
pageintegerPage number, starting at 1.
per_pageintegerResults per page, max 100. Default 20.
searchstringFull-text search across script titles and descriptions.
gamestringGame slug, e.g. blox-fruits.
filterstringOne of: all, keyless, verified, opensource.
sortstringOne of: recommended, newest, oldest, views, likes.

In-game analytics

In-game analytics — executions counted inside Roblox — are not part of the current API. The endpoints below cover the website library only. When an in-game endpoint ships, it will be documented here first.

Health

GET /health — Check that the API is up

Public status check. No key needed. Use it to confirm the API is reachable before calling anything else.

curl https://rscripts.info/wp-json/rscripts/v1/health

Search is a parameter on the List scripts endpoint, not a separate route. Pass a search term and you get matching scripts back.

curl -H "Authorization: Bearer rsc_live_YOUR_API_KEY" \
  "https://rscripts.info/wp-json/rscripts/v1/scripts?search=blox%20fruits"

List scripts

GET /scripts — List published scripts

Returns published scripts, newest first by default. Combine the shared parameters to page, search, filter by game, or sort by views and likes.

ParameterTypeDescription
pageintegerPage number, starting at 1.
per_pageintegerResults per page, max 100.
searchstringSearch term.
gamestringGame slug filter.
filterstringall, keyless, verified, or opensource.
sortstringrecommended, newest, oldest, views, or likes.
curl -H "Authorization: Bearer rsc_live_YOUR_API_KEY" \
  "https://rscripts.info/wp-json/rscripts/v1/scripts?game=blox-fruits&filter=keyless&sort=views"

Script detail

GET /scripts/{slug} — Get one script by slug

Returns a single published script. The slug is the last part of the script page URL.

ParameterTypeDescription
slugstringURL slug of the script, in the path.
curl -H "Authorization: Bearer rsc_live_YOUR_API_KEY" \
  "https://rscripts.info/wp-json/rscripts/v1/scripts/blox-fruits-auto-farm"

GET /trending — Most-viewed scripts from the last 48 hours

Returns up to 20 scripts with the most views in the last 48 hours, most-viewed first.

curl -H "Authorization: Bearer rsc_live_YOUR_API_KEY" \
  "https://rscripts.info/wp-json/rscripts/v1/trending"

Community projects

Built something with the API? Show us your tool, bot, or site. Good projects get listed here for the community to find. Submit your project

Error codes

400 — Bad request: check your parameters. 401 — Missing or invalid API key. 404 — Resource not found. 429 — Rate limit exceeded: slow down and retry.

Objects

A script object, as returned by the list and detail endpoints.

{
  "slug": "blox-fruits-auto-farm",
  "title": "Blox Fruits Auto Farm",
  "game": "blox-fruits",
  "creator": "ExampleCreator",
  "views": 12345,
  "likes": 678,
  "keyless": true,
  "verified": true,
  "open_source": false,
  "url": "https://example.com/script/blox-fruits-auto-farm/"
}

Note: the example URL above is illustrative — your site returns its own domain.