1.1.0 • Published 3 years ago

thealtening-js v1.1.0

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

npm.io\ Unofficial API Wrapper made for The Altening

Example Usage

const Client = require('thealtening-js');
const TheAltening = new Client('1234 /* your token */');

(async () => {
    const res = await TheAltening.generate();
    console.log(res);
    /* Response:
    {
        "token": "example@alt.com",       // Alt token.
        "password": "anything",           // Any password works, this is provided for convenience.
        "username": "Examp**",           // Alt username, but the two last characters are hidden.
        "limit": false,                    // Has the daily limit been reached (*100 alts/24 hours).
        "skin": "555...",                  // Skin token, can be used with the cdn to retrieve skin information of the account.
                                           // E.g.: https://cdn.thealtening.com/skins/body/555....png
        "info": {                         // This object may not have any properties set.
            "hypixel.lvl": "10",            // Level of this account on hypixel.
            "hypixel.rank": "MVP",        // Rank of this account on hypixel.
            "mineplex.lvl": "10",          // Level of this account on mineplex.
            "mineplex.rank": "LEGEND",  // Rank of this account on mineplex.
            "labymod.cape": "true",     // Signifies that this account has a cape from the mod LabyMod.
            "5zig.cape": "true"          // Signifies that this account has a cape from the mod 5Zig.
        } // (Properties are only set when they have a value, e.g.: if an account doesn't have a labymod cape then 'labymod.cape' property is not present)
    }
    */
})();

Methods

.generate()

Generates an alt token.

{
  token: string,
  password: string,
  username: string,
  limit: boolean,
  skin: string,
  info: {},
  valid: boolean
}

.license()

Information about your license.

{
  username: string,
  hasLicense: boolean,
  licenseType: string,
  expires: date
}

.altInfo(alt)

Information about an alt.

{
  expires: date,
  username: string,
  skin: string,
  cape: string,
  password: string
}

.favorite(alt)

Favorite an alt. (Requires Premium))

{
  success: boolean
}

.favorites()

View your favorited alts. (Requires Premium))

[
    {
        altInfo()
    },
    {
        altInfo()
    }
]

.private(alt)

Private an alt. (Requires Premium))

{
  success: boolean
}

.privates()

View your privated alts. (Requires Premium))

[
    {
        altInfo()
    },
    {
        altInfo()
    }
]
1.1.0

3 years ago

1.0.0

3 years ago