Each account on TheAltening has an API Key which can be found on the account page.
Each api call has to include the token as a parameter:
?key=api-1234-1234-1234.
The base url for all api calls is api.thealtening.com/v2/. Combined with the endpoint /generate it looks like api.thealtening.com/v2/generate.
A complete api call to the endpoint /generate looks like api.thealtening.com/v2/generate?key=api-1234-1234-1234.
api.thealtening.com/v2/generate?key=<api-key>[&info=true]
Parameters in [ ] are optional.
A call to the generate endpoint will generate a token, that can be used to login to an account. This call only works for plans that include API Access (starter does not include this).
While this call is not rate limited, it does have a daily use limit, which depends on the user's plan. Once the daily limit is reached the response will loop from the beginning of the day's history. This is also indicated by the limit variable in the 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": { // Sent only if 'info' is set as a parameter (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)
}
* The api has a limit of 150/250 alts per day.
api.thealtening.com/v2/license?key=<api-key>
A call to the license endpoint will return information about the license that is attached to the API Key. This should be used by clients to check whether an API Key is valid and can be used to generate accounts.
{
"username": "OnlyQubes", // Username of api key owner.
"hasLicense": true, // Does the user have an active license.
"licenseType": "premium", // License name if hasLicense is true (e.g.: "premium", "basic", "starter").
"expires": "2020-08-05T00:00:00" // JSON Encoded date time indicating when the license will expire.
}
api.thealtening.com/v2/info?key=<api-key>&token=<alt-token>
A call to the info endpoint will return information about the given alt token. This should be used by clients to check whether an alt token is valid and whether it hasn't expired yet.
{
"expires": "2020-08-05T00:00:00" // JSON Encoded date time indicating when the token will expire.
"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
"username": "Examp**" // Alt username, but the two last characters are hidden.
}
api.thealtening.com/v2/favorite?key=<api-key>&token=<alt-token>
A call to the info endpoint will attempt to favorite the provided token. The token must belong to the user that is attempting to favorite it and the token should not be expired.
Only users that have a Premium license can call this endpoint, otherwise it will result in a 403 Forbidden response.
{
"success": true
}
api.thealtening.com/v2/favorites?key=<api-key>
A call to the favorites endpoint will return all favorited alts by the user. The response is an array of objects which follow the same format as Generate's response.
Only users that have a Premium license can call this endpoint, otherwise it will result in a 403 Forbidden response.
[
{
"token": "example@alt.com",
"password": "anything",
"username": "Examp**",
"limit": false,
"skin": "555cbe24c15f4793b70239935dde21f6",
"info": {
"hypixel.lvl": "10",
...
}
},
{
"token": "example2@alt.com",
"password": "anything",
"username": "Exampl**",
"limit": false,
"skin": "555cbe24c15f4793b70239935dde21f6",
"info": {
"mineplex.rank": "LEGEND"
...
}
},
...
]
api.thealtening.com/v2/private?key=<api-key>&token=<alt-token>
A call to the info endpoint will attempt to private the provided token. The token must belong to the user that is attempting to private it and the token should not be expired.
Only users that have a Premium license can call this endpoint, otherwise it will result in a 403 Forbidden response.
{
"success": true
}
api.thealtening.com/v2/privates?key=<api-key>
A call to the privates endpoint will return all favorited alts by the user. The response is an array of objects which follow the same format as Generate's response.
Only users that have a Premium license can call this endpoint, otherwise it will result in a 403 Forbidden response.
[
{
"token": "example@alt.com",
"password": "anything",
"username": "Examp**",
"limit": false,
"skin": "555...",
"info": {
"hypixel.lvl": "10",
...
}
},
{
"token": "example2@alt.com",
"password": "anything",
"username": "Exampl**",
"limit": false,
"skin": "666...",
"info": {
"mineplex.rank": "LEGEND"
...
}
},
...
]
Either the API Key was not provided or is invalid. To learn how to get and include your API Key in the request please refer to the Authorization section.
The API Key provided is not able to access the requested endpoint. E.g: free customer attempts to access /generate.
The requested endpoint does not exist. If you get this error make sure you didn't misspell the endpoint.
Our servers encountered and unexpected error, try again later.