KickUsersRequests

Inherits: KickRequestBase < RefCounted < Object

Handles Kick API requests related to users.

Description

KickUsersRequests provides methods for retrieving user information from the Kick API.

Access this handler through KickAPI.get_users().

func _ready():
    KickAPI.configure("your_token")
    KickAPI.request_completed.connect(_on_request_completed)

    # Get authenticated user
    KickAPI.get_users().get_users()

    # Get user by username
    KickAPI.get_users().get_users({"username": ["streamer123", "gamer456"]})

    # Get users by ID
    KickAPI.get_users().get_users({"user_id": [12345, 67890]})

func _on_request_completed(signal_name: String, response_code: int, data: Dictionary):
    if signal_name == "users_received":
        # Output:
        # {
        #   "data": [
        #     {
        #       "user_id": 12345,
        #       "name": "streamer123",
        #       "email": "[email protected]",
        #       "profile_picture": "https://..."
        #     },
        #     {
        #       "user_id": 67890,
        #       "name": "gamer456",
        #       "email": "[email protected]",
        #       "profile_picture": "https://..."
        #     }
        #   ],
        #   "message": "success"
        # }
        for user in data["data"]:
            print("User: ", user["name"])
            print("  ID: ", user["user_id"])
            print("  Email: ", user["email"])
            print("  Profile: ", user["profile_picture"])

Tutorials

KickAPI Developer Examples

Methods

void	get_users(params: Dictionary = {})

Method Descriptions

void get_users(params: Dictionary = {}) 🔗

Retrieves user information. The params dictionary can include:

user_id: Array of user IDs (up to 50)
username: Array of usernames (up to 50, max 25 chars each)

If no parameters are provided, returns information for the authenticated user.

You cannot mix user_id and username parameters.

Results are returned via the KickAPI.request_completed signal with signal_name "users_received".

KickAPI.get_users().get_users({"username": ["streamer123"]})