Fetching/searching is great to look through the ScriptBlox script catalogue and see what there is, but what about top scripts at the moment?
For this exact purpose, we have the trending endpoint, that returns a targetted list of the scripts that received the most interactions from the community.
The API path for this endpoint is /api/script/trending
The trending endpoint can only accept a single query parameter max, to limit the amount of results returned.
| Parameter | Description | Required | Type | Default |
|---|---|---|---|---|
| max | The amount of results to return | ❌ | Any positive number up to 20 | 20 |
The response, unless errored, would be of the following structure:
{
"result": {
"max": number,
"scripts": [
{
"_id": "string",
"title": "string",
"game": {
"_id": "string",
"name": "string",
"imageUrl": "string"
},
"slug": "string",
"verified": boolean,
"key": boolean,
"views": number,
"scriptType": "string",
"isPatched": boolean,
"isUniversal": boolean,
"createdAt": "string",
"image": "string",
},
...
]
}
}
If an error occurs, the response will contain a single message field:
{
"message": "string"
}