Skip to content

Commit 4aca2d8

Browse files
committed
feat: libs
1 parent 93c9d8e commit 4aca2d8

File tree

2 files changed

+39
-3
lines changed

2 files changed

+39
-3
lines changed

docs/API/existing-libraries.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
There exist a number of pre-existing libraries for interacting with the scratch API
2+
3+
!!! warning
4+
5+
This is not a complete list
6+
7+
=== "Python"
8+
- ## [ScratchAttach](https://github.com/TimMcCool/scratchattach)
9+
A sync (developing async) python library for the scratch API and other site features.
10+
- ## [Scapi](https://github.com/kakeruzoku/scapi)
11+
An async python library for the scratch web API, using aiohttp. Docs in Japanese.
12+
13+
??? Warning "Deprecated libraries:"
14+
15+
- [scratchcloud](https://github.com/yuwex/scratchcloud)
16+
- [scratchclient](https://github.com/CubeyTheCube/scratchclient)
17+
- [node-scratch-client](https://www.npmjs.com/package/node-scratch-client)
18+
- [scratch-api (js)](https://github.com/trumank/scratch-api)
19+
20+
=== "TypeScript"
21+
22+
- ## [ScratchAttach.ts](https://github.com/scratch-api/scratchattach.ts)
23+
An async TypeScript library for the scratch API (missing features)

docs/API/index.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# Scratch Web API
1+
# API
2+
3+
API stands for application-programmer-interface. Essentially what this means is a way to integrate your code
4+
with scratch.
5+
6+
Scratch itself provides a number of urls which can be used for interaction via web requests, shown [below](#web-api).
7+
8+
!!! info
9+
10+
It is recommended to use an [existing library](existing-libraries) to interact with scratch instead of making your own
11+
12+
## Web API
213

314
In order to make requests to scratch, there are a multitude of different urls where you can make
415
`GET`, `POST`, `PUT`, `DELETE` and other types of request.
@@ -9,6 +20,8 @@ These urls can be generally categorized by their subdomain and/or path.
920

1021
This is not a complete list.
1122

23+
### Scratch
24+
1225
| URL | Purpose |
1326
|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
1427
| https://scratch.mit.edu/ | The main website |
@@ -23,14 +36,14 @@ These urls can be generally categorized by their subdomain and/or path.
2336
| https://cdn.scratch.mit.edu | Content delivery network - hosts images, css, js, emojis, etc. |
2437
| https://synthesis-service.scratch.mit.edu | Text2Speech requests - which the Text2Speech extension uses |
2538

26-
## Ocular
39+
### Ocular
2740

2841
| URL | Purpose |
2942
|------------------------------------|-----------------------------------------------|
3043
| https://jeffalo.net/api/ | Jeffalo's API |
3144
| https://my-ocular.jeffalo.net/api/ | API for [ocular](https://ocular.jeffalo.net/) |
3245

33-
## TurboWarp
46+
### TurboWarp
3447

3548
| URL | Purpose |
3649
|-----|---------|

0 commit comments

Comments
 (0)