Skip to content
faretek edited this page Oct 11, 2025 · 80 revisions

Scratch API wrapper with support for almost all site features. Created by TimMcCool.

This library can set cloud variables, follow Scratchers, post comments and do so much more! It has special features that make it easy to transmit data through cloud variables.

PyPI statusPyPI download monthPyPI version shields.ioGitHub licenseDocumentation Status

It is strongly advised to learn Python before using scratchattach.

Documentation

Helpful resources

Report bugs by opening an issue on this repository. If you need help or guideance, leave a comment in the official forum topic. Projects made using scratchattach can be added to this Scratch studio.

Helpful for contributors

Contribute code by opening a pull request on this repository.

️Example usage

Set a cloud variable:

importscratchattachassasession=sa.login("username", "password")
cloud=session.connect_cloud("project_id")
cloud.set_var("variable", value)

More examples

Getting started

Installation:

Run the following command in your command prompt / shell:

pip install -U scratchattach

If this doesn't work, try running:

python -m pip install -U scratchattach

Logging in with username / password:

importscratchattachassasession=sa.login("username", "password")

login() returns a Session object that saves your login and can be used to connect objects like users, projects, clouds etc.

Logging in with a sessionId:You can get your session id from your browser's cookies. More information

importscratchattachassasession=sa.login_by_id("sessionId", username="username") #The username field is case sensitive

Cloud variables:

cloud=session.connect_cloud("project_id") # connect to the cloudvalue=cloud.get_var("variable")
cloud.set_var("variable", "value") # the variable name is specified without the cloud emoji

Cloud events:

cloud=session.connect_cloud('project_id')
events=cloud.events()
@events.eventdefon_set(activity):
print("variable", activity.var, "was set to", activity.value)
events.start()

Follow users, love their projects and comment:

user=session.connect_user('username')
user.follow()
project=user.projects()[0]
project.love()
project.post_comment('Great project!')

All scratchattach features are documented in the documentation.

Clone this wiki locally