GET /api/v2/scripts

This API endpoint retrieves a list of scripts based on various filters and sorting options.

Parameters

The following parameters can be included in the query string:

Name	Type	Description
page	number	The page number to retrieve (default: 1).
noKeySystem	boolean	Whether to filter for scripts without a key system (default: null).
mobileOnly	boolean	Whether to filter for mobile-ready scripts only (default: null).
notPaid	boolean	Whether to filter for free scripts only (default: null).
unpatched	boolean	Whether to filter for unpatched scripts only (default: null).
verifiedOnly	boolean	Whether to filter for scripts by verified users only (default: null).
orderBy	string	The field to order the results by (e.g., "date", "id", "views", "likes", "dislikes"...).
sort	string	The sort order ("asc" for ascending, "desc" for descending).
q	string	The search term to filter scripts by title and description.

Headers

The following header can be included in the request in case you want to find scripts by username:

Name	Type	Description
Username	string	The username of the authenticated user.

Response

The response is a JSON object with the following structure:

{
  "info": {
    "currentPage": 1,
    "maxPages": 177
  },
  "scripts": [
    {
      "_id": "66f29a0dc7543f330a528ee3",
      "title": "New 💪Crash Out Simulator hack script | Decent ngl | Its alright",
      "views": 256,
      "private": false,
      "likes": 0,
      "dislikes": 0,
      "keySystem": true,
      "mobileReady": true,
      "lastUpdated": "2024-09-24T10:53:01.559Z",
      "createdAt": "2024-09-24T10:53:01.559Z",
      "paid": false,
      "description": "This games kinda dog and easy to dog on. Its kinda dog booty. Want more s word scripts? just recommend them!",
      "image": "https://tr.rbxcdn.com/e7c6d4197a2723384ce8d2642e92eead/480/270/Image/Jpeg",
      "rawScript": "https://rscripts.net/raw/new-crash-out-simulator-hack-script-or-decent-ngl-or-its-alright_1727175181561_8xIEfxo9mG.txt",
      "testedExecutors": [
        {
          "_id": "66a6704b796b8cf770481380",
          "title": "Cryptic",
          "image": "https://rscripts.net/assets/executors/CrypticLogo200x200.png",
          "creator": "reaperscripts",
          "discord_url": "https://discord.gg/qM3WZhQShn",
          "downloads": 1080,
          "platforms": [
            "android"
          ],
          "download_url": "https://getcryptic.net/"
        },
        {
          "_id": "66a6ad1a796b8cf770481386",
          "title": "Codex",
          "image": "https://rscripts.net/assets/executors/CodexLogo.jpg",
          "creator": "Furky",
          "discord_url": "https://discord.gg/robloxexploits",
          "downloads": 1211,
          "platforms": [
            "android"
          ],
          "download_url": "https://codex.lol"
        },
        {
          "_id": "66ed6cbe744db12a4a161fe4",
          "title": "Synapse Z",
          "image": "https://rscripts.net/assets/executors/SynapsezLogo.webp",
          "creator": "grhofficial",
          "discord_url": "https://synapsez.net/discord",
          "downloads": 253,
          "platforms": [
            "windows"
          ],
          "download_url": "https://synapsez.net/"
        }
      ],
      "user": {
        "_id": "65cb7efca9aa5d9a728faf67",
        "username": "pcallskeleton",
        "image": "https://rscripts.net/assets/avatars/65cb7efca9aa5d9a728faf67_1707835997436_mZ8v0oseq7.webp",
        "discord": {
          "id": "897365281696018462",
          "username": "pcallskeleton"
        },
        "verified": true,
        "displayEmail": false,
        "socials": {
          "discordServer": "https://discord.gg/simplest"
        },
        "bio": "i will be better than Toon very soon...\nhttps://discord.gg/simplest",
        "admin": true,
        "lastActive": "2024-09-24T11:13:55.465Z"
      },
      "game": {
        "_id": "66e7b27889a085209163676e",
        "title": "💪Crash Out Simulator",
        "placeId": "15839834917",
        "imgurl": "https://tr.rbxcdn.com/e7c6d4197a2723384ce8d2642e92eead/480/270/Image/Jpeg",
        "last_updated": "2024-09-16T04:22:16.277Z",
        "__v": 0,
        "gameLink": "https://www.roblox.com/games/15839834917/Crash-Out-Simulator"
      }
    },
 ]
}

⚠️

Please read about possible API Response Edge cases and handle them accordingly.

Description

The GET /api/v2/scripts endpoint retrieves a list of scripts based on various filters and sorting options. The Username header can be included in the request if you only want to receive scripts created by a specific user.

The response includes an info object with the current page number and the maximum number of pages based on the applied filters. Additionally, it includes an array of scripts objects containing the script details, including the associated user information (excluding sensitive fields like password and email).

The scripts are sorted by pinned status first, followed by the specified orderBy field and sort order. If a search term (q) is provided, the scripts are also filtered by the search term.

Example Usage

// retrieve the latest scripts for the game "arsenal" created by user 3itx
fetch('https://rscripts.net/api/v2/scripts?page=1&orderBy=date&sort=desc&q=blade-ball', {
    headers: {
      'Username': '3itx' // optional to filter by specific user
    }
  })
    .then(response => response.json())
    .then(data => {
      console.log('Current Page:', data.info.currentPage);
      console.log('Max Pages:', data.info.maxPages);
      console.log('Scripts:', data.scripts);
    })
    .catch(error => {
      console.error('Error fetching scripts:', error);
    });

Scripts Introduction Retrieve a specific script