LoginLogin

SmileBASIC API

Root / Submissions / [.]

MasterR3C0RDCreated:

Announcement (10/06/2020):

I just wanted to let anyone who wanted to use this API know that this is pretty safe to use. All downloaded files are cached, and as such it avoids sending more than the required amount of requests to SmileBASIC servers. If you're doing a large amount of automated queries at one time, please check out the WebSocket Query API, as it provides less overhead on the server and adds additional features like queueing requests. Also, there might be a new feature soon :) Quick jump: News Introduction Usage Examples SiteJS plugin Credits WebSocket Query API

NEWS:
  • 03/26/2020: Fixed a bug that was causing long load times. I don't know if anyone noticed this, but it was taking like 3 seconds per request. Not any more!
  • 03/16/2020: Added English tag support! When using the `info` endpoint, add ?en=1 for the official English tags. They haven't been updated but should give a better idea of what each tag is. This also works with ?json=1 and the WebSocket Query API!
  • 02/29/2020: Added tags to the info page! Only Japanese tags for now because official tag data for English is not very good right now, but will be updated in the future!
  • 02/04/2020: WebSocket query API implemented! Read more details below.
  • 01/31/2020: SBAPI 4 has launched! If you're using the SBAPI SiteJS, please update it to support SB4 keys.
Introduction SmileBASIC API (SBAPI) is a service created by me (MasterR3C0RD) and triangle, with help from Yttria, 12Me21, and snail_, that allows you to get info for and download programs directly from SmileBASIC 3 servers. Not only is this useful for moderators to check if a key is still available, it also allows users to post GRPs to the forums as a PNG. Usage: Everything in SBAPI is simply a URL. The basic URL format for keys is http://sbapi.me/get/(key)[/(filename)]/(encoding), where anything in [] is optional and anything in () is required. key should be replaced with the public key, and filename allows you to choose a specific file if the key is a project. The encoding is required and can be one of the following:
  • info - all files, shows information about the file provided (use ?json=1 if you're writing a program to get information as JSON, add en=1 for English tags)
  • list - only projects, lists all files (use ?json=1 if you're writing a program to get information as JSON)
  • zip - only projects, download all files from the project as a ZIP file. If you want to convert files to their preferred format (ex, GRP -> PNG, TXT -> Text), add ?nice=1
  • raw - all files, downloads the raw file.
  • text - only TXTs, returns the text content of the file
  • code - only TXTs, highlights code using 12Me21's SBHighlight library (use ?wrap=1 to enable word-wrapping)
  • png - only GRPs, converts the GRP to a PNG
  • json - only DATs, returns the DAT information as a JSON array of arrays.
  • csv - only 2D DATs, converts the data to a CSV (comma-separated values) file
  • icon - only META files, returns the icon as a PNG file.
  • downloads - all files, returns a PNG with the download count (download count is only updated every 24 hours). You can also control the PNG using query parameters: ?color=#BADA55&stroke=#A55A55&strokewidth=3&padding=3&bgcolor=rgba(0,0,0,0.5)
  • encodings - all files, returns JSON array with all possible encodings for the file given
Other encodings may be added in the future. Examples: Disclaimer: Authors of projects or assets displayed on this page are not associated with and have not contributed to the SmileBASIC API project. This can be used when asking people to debug code on the forums. Posting a public key and a link to the code could make debugging much easier. Example: http://sbapi.me/get/CKANY53Y/TN_SHARP/code (Phil's N# compiler) Output: Wanting to show off your sprites is another possible use. Simply use the PNG endpoint. Example: http://sbapi.me/get/4DH5P4K3/BBG_TIKI/png (sprites from cujo1992's Tiki Descent) Output: You can also back up your project as a ZIP file if you need to be sure you'll always have it. Example: http://sbapi.me/get/P3T43E3V/zip (kantackistan's Virtual Buffalo) Output: Don't forget a download counter to gauge how popular your programs are! Note that the download count is not real time, and only updates every 24 hours. Example: http://sbapi.me/get/QK4N3PZF/downloads (calc84maniac's Spooky Maze Raycaster demo) Output: Optional SiteJS: If you think it's too much of a hassle to have to go through the API to check out information about programs, you have a similar mindset to I. That's why me and 12Me21 wrote a SiteJS, available at http://sbapi.me/sbapi-sbs.js that adds an extra section to pages that looks something like this: Simply copy and paste the contents into your SiteJS and load up a program page. After a few seconds, the information will load and be shown on the page. WebSocket Query API If you're doing multiple requests, the best way to accomplish this is using the WebSocket Query API. Simply connect to ws[s]://sbapi.me/get and send a request, and you'll get something back. You can either do: Request: (key[/version[/filename]]) info [prop1,prop2.subprop2] - Gets information about a program. Response: (key[/version[/filename]]) (value) - Value will either be the entire JSON-encoded info object (if no properties are provided), a single JSON-encoded value (if one property is provided), or a JSON-encoded object of all properties requested and their values (if multiple properties are provided). This info object uses a different format than the `info` encoding, test it first by not providing any property arguments. OR Request: (key[/version[/filename]]) download [encoding[?options]] - Gets the file as a specified encoding (or the raw file if none is specified). Any encodings that allow options work exactly the same as if options were provided Response: (key[/version[/filename]]) (filename) (datalength) (data) - Datalength will be the ASCII representation of the size of the data returned, and data will be the response of the encoding. If a request fails, you will get a response similar to such: (key[/version[/filename]]) FAIL If you get this and you're sure you're not doing anything wrong, send me a DM and I'll take a look. NOTE: Send multiple requests separated by \n, eg, `KEY1 info\nKEY2 info` or otherwise you will end up never getting a response in the end. Some requests async are fine, but not all. Credits
  • triangle - file format guru, wrote the file parser used for SB files and other parts of code, and most of reverse engineering of SmileBASIC's servers, donated 3DS information for the server
  • MasterR3C0RD - hosting, wrote the server communication libraries and helped with reverse engineering of SmileBASIC's servers
  • 12Me21 - wrote sbhighlight and rewrote the SiteJS plugin to work with more browsers
  • snail_ - working on proper documentation for API
  • Yttria - word of reason, helped with multiple things internally
  • Jaku - helped with SB4 support
ResourcesAdditional Content
Simeon#81
Omg
Simeon#82
Replying to:Simeon
Omg
So, if a SmileBASIC interpreter were created, it can have all functionality of the original application
TheV360#83
Feature suggestion: add an option to zip downloads that adds a text file to the project containing metadata such as the key, author, size, date downloaded, downloads, etc. It could also use a character that isn't on the SmileBASIC filename keyboard, to decrease the likelihood of a file name clash. This would help make the preservation process easier. Speaking of that, has anyone built a key scraper yet, for sites like SBS, the Japanese wiki, the official key repository, and the Twitter hashtag?
HTV04#84
Replying to:TheV360
Feature suggestion: add an option to zip downloads that adds a text file to the project containing metadata such as the key, author, size, date downloaded, downloads, etc. It could also use a character that isn't on the SmileBASIC filename keyboard, to decrease the likelihood of a file name clash. This would help make the preservation process easier. Speaking of that, has anyone built a key scraper yet, for sites like SBS, the Japanese wiki, the official key repository, and the Twitter hashtag?
Pretty sure 12 already made one for an experiment he did Not sure about the wiki or Twitter Now that I think about it, what will we do when eventually we hear about SB3's servers closing? With the 3DS basically dying, it's bound to happen soon in favor of SB4, which may attract a much larger user base due to being on the Switch. I kind of thought of something, but I don't know if it will work. I could create an account for archive.org specifically for archiving SmileBASIC's servers. Using SBAPI, we can scrape keys and get the raw data from them (we should also release tools convert files like SBAPI does). These projects/files can then be put into a new entry in the archive.org database, with a lot of folders that are named after projects/files' public keys. If a key only contains a single file, it should be put into a new folder named after its key, with the name of the file intact. The project names should be changed to the public key, but the files inside the project (folder) should have their names intact. Sorry if any of my wording above is wrong, I'm really tired rn and I need to get some sleep :P I don't even know if the sentence above is worded right.
rando#85
TEST Ok it failed To put a code image from this, do I need to screenshot? How do I put the image?
kitesinpowerlines#86
I don’t think it is documented here but there seems to be a required letter to preface the file name depending on the output. Examples: ...BBG_TIKI/png ...TN_SHARP/code
chicken#87
Replying to:rando
TEST Ok it failed To put a code image from this, do I need to screenshot? How do I put the image?
the website returns a SB-like code preview, so yes, you have to screenshot it.
CyberYoshi64#88
Replying to:kitesinpowerlines
I don’t think it is documented here but there seems to be a required letter to preface the file name depending on the output. Examples: ...BBG_TIKI/png ...TN_SHARP/code
The prefix? Explained here. (see post below) And the code is comparable with the ［CODE］ bbcode here but without the rest of the page.
rando#89
Replying to:rando
TEST Ok it failed To put a code image from this, do I need to screenshot? How do I put the image?
Ok. I find that kinda dumb, because honestly it's easier to just screenshot the code directly on SB.
chicken#90
Replying to:rando
TEST Ok it failed To put a code image from this, do I need to screenshot? How do I put the image?
it's so you can copy-paste and use a mouse and stuff on pc
rando#91
Replying to:rando
TEST Ok it failed To put a code image from this, do I need to screenshot? How do I put the image?
Yeah. The problem with that for me is that almost always, I'm using a 3ds to post here.
rando#92
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
MasterR3C0RD#93
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
Never been reported to me, if you could give some examples I could do some looking around
TheV360#94
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
Here's one example: this page keeps reporting that the key doesn't exist, even though the developer has confirmed it is downloadable.
HTV04#95
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
A fix by CY64 was also provided, but it trips up the check for keys that were actually removed.
rando#96
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
Yeah basically virtual buffalo There was another one I saw, but I don't remember what it was.
CyberYoshi64#97
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
A fix by CY64 was also provided, but it trips up the check for keys that were actually removed.
Yeah, removed keys will just stuck saying that their info is loading though there aren't any infos to load...
MasterR3C0RD#98
Replying to:rando
Thx you for the site js It's probably in SBAPI itself, but sometimes it says that the key doesn't work, when it does. (This has been mentioned before)
I'm thinking what happened is someone tried to check the key while SB servers were down for maintenance and it returned unavailable. I'll fix it when I get home. I've been really busy with school and work so...
snail_#99
Updated the sitejs to include a sb4 mincompat check, now displays a helpful unsupported message instead of silently giving up
hakke#100
Replying to:HTV04
How are the Switch servers set up (how are they different from the SB3 servers)?
I guess SBAPI for SB4 could use a generously donated modded Switch to access the servers, but that would be prone to bans... I don't know it's just a proof of concept.
123456789101112