Skip to content

Cloudsinger API Documentation

  • Public Endpoints
    Throttled: 60 requests per 1 minute or 1 request per second

    These endpoints can be accessed publicly.

    User Info $_GET /api/v1/core/user/:steamid

    Returns non-sensitive data on the given user

    Parameters
    Name Type Example Description
    :steamid mixed 76561198026398801 SteamID, SteamID3, or SteamID64
    Try it!
  • Wrappers
    Throttled: 30 requests per 1 minute or 0.5 requests per second

    These endpoints are our own wrappers for existing API endpoints from other services.

    Steam User Info $_GET /api/v1/steam/user/:id

    Returns detailed info on a Steam user based on the provided SteamID with no key required.

    Parameters
    Name Type Example Description
    :id string 76561198026398801 SteamID64
    Try it!

    YouTube@getVideoInfo $_GET /api/v1/youtube/getVideoInfo/:id

    Returns video data based on the provided ID.

    Parameters
    Name Type Example Description
    :id string 3R3cvbLsbAk YouTube video ID
    Try it!

    YouTube@getChannelByName $_GET /api/v1/youtube/getChannelByName/:id

    Returns channel data based on the provided name.

    Parameters
    Name Type Example Description
    :id string CrowbCat YouTube channel name
    Try it!

    YouTube@getChannelById $_GET /api/v1/youtube/getChannelById/:id

    Returns channel data based on the provided ID.

    Parameters
    Name Type Example Description
    :id string UCYZtp0YIxYOipX15v_h_jnA YouTube channel ID
    Try it!
  • Internal Endpoints

    Internal endpoints are used by the site itself and cannot be used by the public. Most endpoints require the user's authenticity token to be sent with the request.

    Set Language $_POST /internal/setLang/

    Sets a cookie that determines what language to view the application in.

    Parameters
    Name Type Example Description
    language string en ISO 639-1 representation of the desired language.
  • Retired Endpoints

    Endpoints that are no longer used or deprecated in favor of a differet implementation.

    Login User $_POST /internal/login_user/

    This attempts to log a user in.

    Parameters
    Name Type Example Description
    username string user_124 User handle
    password string hunter12 User password

    Logout User $_POST /internal/logout_user/

    This attempts to log the currently-logged in user out. Logouts are handled via POST as to prevent possible exploiting with logout URLs.

    Parameters
    Name Type Example Description
    logout string logout Only accepts the string 'logout' for simple validation.

    Ban User $_POST /internal/ban_user/

    This attempts to ban a user.

    Parameters
    Name Type Example Description
    uid integer 1 User ID
    ban_reason string Misbehaving Reason to attach to the user's ban