Skip to main content

A Module to fetch scratch things from ScratchGetData

Project description

ScratchAPIClient Documentation

Note: This is not update often please check the github for more up-to-date info

Introduction

The ScratchAPIClient class provides a convenient interface for accessing data from the Scratch API using the "https://scratch-get-data.kokoiscool.repl.co" base URL. Github: https://github.com/kokofixcomputers/Scratch-getdata

Install: pip install scratch-getdata Import: from scratch_getdata import ScratchAPIClient

Api Key

You will need to signup at the api: https://scratch-get-data.kokoiscool.repl.co and get the api key first before using this.

Usage

  1. Instantiating the ScratchAPIClient class: client = ScratchAPIClient()

  2. Retrieving the follower count of a user: follower_count = client.get_follower_count(username, api_key)

  3. Checking if a user is a Scratcher: is_scratcher = client.is_scratcher(username, api_key)

  4. Retrieving the following count of a user: following_count = client.get_following_count(username, api_key)

  5. Retrieving the "What I'm Working On" (WIWO) status of a user: wiwo_status = client.get_wiwo(username, api_key)

  6. Retrieving the "About Me" information of a user: about_me = client.get_about_me(username, api_key)

  7. Retrieving the messages of a user: messages = client.get_messages(username, api_key)

  8. Retrieving the creator of a project: project_creator = client.get_project_creator(project_id, api_key)

  9. Retrieving the name of a project: project_name = client.get_project_name(project_id), api_key

  10. Retrieving the description of a project: project_description = client.get_project_description(project_id, api_key)

  11. Retrieving the instructions of a project: project_instructions = client.get_project_instructions(project_id, api_key)

  12. Retrieving the blocks of a project: project_blocks = client.get_project_blocks(project_id, api_key)

  13. Retrieving the title of a forum post: forum_title = client.get_forum_title(post_id, api_key)

  14. Retrieving the category of a forum post: forum_category = client.get_forum_category(post_id, api_key)

  15. Retrieving the country of a Scratch user: user_country = client.get_scratch_user_country(username, api_key)

Note: Replace username with the desired Scratch username and project_id with the desired project ID.

API website: https://scratch-get-data.kokoiscool.repl.co

Credits

If you use GetData, please credit @kokofixcomputers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scratch-getdata-1.0.8.tar.gz (3.2 kB view hashes)

Uploaded Source

Built Distribution

scratch_getdata-1.0.8-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page