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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file scratch-getdata-1.0.8.tar.gz.

File metadata

  • Download URL: scratch-getdata-1.0.8.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for scratch-getdata-1.0.8.tar.gz
Algorithm Hash digest
SHA256 527dd45486c963068968c8ec96bcfe77bec046b4eccf1db74b90d3283e1ec26a
MD5 95ad3db2a899f173808a956e8013cd9b
BLAKE2b-256 c8ab3fd1b9d689ac803b8511ab4d2d58f5d974b09d8dec414d3a2e24220f3cbc

See more details on using hashes here.

File details

Details for the file scratch_getdata-1.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for scratch_getdata-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0f092ef3cdb4bf762a125863189ad522ee507130755828d45c40ee179593a1d6
MD5 440188964b915570d83c4b21802fa34b
BLAKE2b-256 17a08ad01646d72cd6ef7cad5ac4a6f47d99256bfbda3c6914c62de2c9620874

See more details on using hashes here.

Supported by

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