Skip to main content

A Python helper library for interacting with the Roblox API.

Project description

roblox-api-helper

A Python helper library for interacting with the Roblox API.

Installation

pip install roblox-api-helper

Usage

from roblox_api_helper import RobloxAPI

api = RobloxAPI()

# Get user info
user_id = 12345678 # Replace with a valid Roblox User ID
try:
    user_info = api.get_user_info(user_id)
    print(f"User Info: {user_info}")
except Exception as e:
    print(f"Error getting user info: {e}")

# Get group info
group_id = 12345 # Replace with a valid Roblox Group ID
try:
    group_info = api.get_group_info(group_id)
    print(f"Group Info: {group_info}")
except Exception as e:
    print(f"Error getting group info: {e}")

# More examples will be added soon...

Available Functions

Users API

  • get_user_info(user_id): Get basic information about a user.
  • get_user_by_username(username): Search for a user by username (Note: This is a simplified placeholder).
  • get_user_usernames_history(user_id): Get a user's username history (Note: This is a simplified placeholder).

Groups API

  • get_group_info(group_id): Get information about a group.
  • get_group_members(group_id, limit=10, cursor=None): Get a list of group members.
  • get_group_roles(group_id): Get roles in a group.

Games API

  • get_universe_info(universe_id): Get information about a game (universe).
  • get_place_info(place_id): Get information about a specific place.
  • get_game_servers(place_id, server_type=\'Public\', limit=10, cursor=None): Get a list of game servers (Note: This is a simplified placeholder).

Assets & Inventory API

  • get_user_inventory(user_id, asset_type_id, limit=10, cursor=None): Get a user's inventory for a specific asset type.
  • get_asset_info(asset_id): Get information about an item in the catalog.

Presence API

  • get_user_presence(user_ids): Get user presence status (online/offline/in-game) (Note: This is a simplified placeholder).

Thumbnails API

  • get_user_thumbnail(user_id, size=\'420x420\', format=\'Png\', is_circular=False): Get a user's avatar thumbnail.
  • get_group_thumbnail(group_id, size=\'420x420\', format=\'Png\'): Get a group's icon thumbnail.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details (LICENSE file will be added later).

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

roblox_api_helper-0.1.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

roblox_api_helper-0.1.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file roblox_api_helper-0.1.0.tar.gz.

File metadata

  • Download URL: roblox_api_helper-0.1.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0rc1

File hashes

Hashes for roblox_api_helper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e581b710f9a10677d88d886deba25ede4b7cab53b23f66609280ae8be3f7b14d
MD5 4cb27cfa0adc711d498f44f012537b6e
BLAKE2b-256 b64e2d32e8c93f732f49e186b12c2106daabb32cf67339f2c6272bf3f2a75565

See more details on using hashes here.

File details

Details for the file roblox_api_helper-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for roblox_api_helper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 26951eba107c4fda16dce19f9fc2017faf936883df6083fa8b199778c44cf570
MD5 49e6d82dc590b4056b56b63cbc6503c7
BLAKE2b-256 51e2f2c239fc14214b77144f018001642111cdd654fa6bbd5a2d767aabd83b19

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