About Pteroly

Pteroly

With pteroly you can easily control your Pterodactyl panel quick and easy with a flawless experience and good support. Pteroly is always up-to-date and supports the latest versions of the Pterodactyl panel.

Pteroly Documentation | NpmJS Package | Pteroly PayPal | Pteroly Discord

Benefits of Pteroly:

• Supports latest Pterodactyl panel
• Supports nearily every api feature of pterodactyl
• Easy client panel login, which is only required once
• Up-to-Date
• Easy-to-Use
• Typescript
• Fast

Quick Start Guide

First install the package to your Node.JS app/project:

npm install pteroly@latest

Then you require the package and login into the Pterodactyl API:

const pteroly = require('pteroly');
const admin = pteroly.Admin;
const client = pteroly.Client;

// You only need to login once in your entire app/project
admin.login('HOST_PANEL_URL', 'YOUR_ADMIN_API_KEY', (loggedIn, errorMsg) => {
    console.log('Login status Admin: ' + loggedIn);
    if (!loggedIn) console.error(errorMsg);
});

client.login('HOST_PANEL_URL', 'YOUR_CLIENT_API_KEY', (loggedIn, errorMsg) => {
    console.log('Login status Client: ' + loggedIn);
    if (!loggedIn) console.error(errorMsg);
});

And then you can call any function you want like this, to find all the functions of the panel consider visiting our documentation.

// As a .then function
admin.functionName(<ARGUMENTS>).then((response) => {
    // TODO: Insert your code here.
}).catch((err) => console.error(err));

client.functionName(<ARGUMENTS>).then((response) => {
    // TODO: Insert your code here.
}).catch((err) => console.error(err));

// With await
const resultAdmin = await admin.functionName(<ARGUMENTS>).catch((err) => console.error(err));
const resultClient = await client.functionName(<ARGUMENTS>).catch((err) => console.error(err));

Changelog

Version 1.8.5:

• Added mocha tests
• Added build tests
• Added linters

ToDo list

• Class support and support of new instances (with v2.0.0).
• More features (please suggest features on GitHub)