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

Replying to:the_squat1115
Lol, that is a mature theme
He looked at the meme I posted in a reply

Replying to:the_squat1115
Lol, that is a mature theme
Oh lol

How do I transfer binary and GRP files back to my 3DS via PetitModem? Is the file structure different, or is it the same as sending a DAT/GRP file to PC via PetitModem?

Replying to:HTV04
For anyone using the SiteJS, if you want to use MB (megabytes) and KB (kilobytes) instead, change the 1024 values to 1000, and rename the MiB value to MB.
Eh, I personally left it the same because Iā€™m used to having it uppercase (other devices use capital K). But a lowercase K is the correct way.

I love it. Without it, I wouldn't be able to transfer my programs to my tablet because I don't have any PC any time soon.
SpoilerOkay, I could write out each byte one at a time and on GRPs one pixel at a time but typing it in using no actual keyboard is horrible if not, it would take years to even get my projects on my device, when it doesn't fail...

Bug: Seems like some of the metadata disappeared. This is only when I use the zip option. When I download keys that only contain one file (not even a folder) the metadata is intact.

Replying to:TheV360
Bug: Seems like some of the metadata disappeared. This is only when I use the zip option. When I download keys that only contain one file (not even a folder) the metadata is intact.
It's because SB removes file metadata when it makes a project. I'll have this fixed ASAP

Just want to note that we're still looking for people with SmileBASIC 4 and a hacked Switch to help with adding support for SB Switch keys on SBAPI. If you have what's needed and you're interested, please DM on Discord (@MasterR3C0RD#7695), send me a Site PM, or message me in the SBS Chat.

Suggestion: Add decompression support for .PKD format compressed files.

Replying to:HTV04
Suggestion: Add decompression support for .PKD format compressed files.
That's outside of the scope of what SBAPI should do. SBAPI is only meant to get files and convert them to file types that make sense, not to become a be-all end-all of SmileBASIC PC tools. That would be nice, but it would take forever and no one would really use it.

Replying to:HTV04
Suggestion: Add decompression support for .PKD format compressed files.
Okay, thanks for the response. Is there any documentation on how .PKD files are packed and how its compression methods could be ported to PC?

Replying to:HTV04
Suggestion: Add decompression support for .PKD format compressed files.
I have absolutely no idea, you'd have to look at the unpacker and figure it out yourself.

A question: How do I download a full game (with all the code and grps) to a computer?

Replying to:Tarudahat
A question: How do I download a full game (with all the code and grps) to a computer?

Can you add an encoding that allows projects to be downloaded with txts that have no metadata and GRPs that are converted to png? The reason why I'm asking is because I would like to use this with otyasmilebasic.

Replying to:HTV04
Can you add an encoding that allows projects to be downloaded with txts that have no metadata and GRPs that are converted to png? The reason why I'm asking is because I would like to use this with otyasmilebasic.
GRPs can be converted to PNG already.
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:
Also, TXT/PRG files can be opened in Wordpad and you can convert the program by simply saving it as a TXT file.

Replying to:HTV04
Can you add an encoding that allows projects to be downloaded with txts that have no metadata and GRPs that are converted to png? The reason why I'm asking is because I would like to use this with otyasmilebasic.
I know, but you have to convert each one individually, which is annoying when downloading large projects.

Replying to:HTV04
Can you add an encoding that allows projects to be downloaded with txts that have no metadata and GRPs that are converted to png? The reason why I'm asking is because I would like to use this with otyasmilebasic.
I'll work at adding this when I get the chance.

Replying to:HTV04
Can you add an encoding that allows projects to be downloaded with txts that have no metadata and GRPs that are converted to png? The reason why I'm asking is because I would like to use this with otyasmilebasic.
Added. You can add ?nice=1 to the end of the zip encoding URL, and it'll download it as a nicer ZIP file. Note that certain files (DAT files with > 2 dimensions) will stay raw.

that's like... amazing tbh