---

📌 What am I?

Pterom is a open source API wrapper for Pterodactyl that is built with TypeScript. It will support the Application & Client side of the API. Currenty it is a work in progress but client side seems stable.

---

❓ How do I work?

This library works by querying the Pterodactyl API V1 (REST requests) using a library called AXIOS.

---

💻 Getting started with installation

First install pterom with your package manager.

npm i pterom
OR
yarn add pterom

Then import it into your file.

// ESM
import Pterom from 'pterom';

// CJS
const Pterom = require('pterom');

Create a new instance of pterom with options.

The host option is required.

The clientKey & appKey are optinal but one must be used.

const pt = new Pterom({
    host: 'HOST',
    clientKey: 'CLIENT_API_KEY',
    appKey: 'APP_API_KEY',
});

Choose what class you want to use.

// For client
pt.client;
// For application
pt.app;

You can then use the functions after choosing the class.

All functions are promised based so they must have a .then after like below.

pt.client.listServers().then((res) => console.log(res));

pt.app.listServers().then((res) => console.log(res));

---

📖 Documentation (coming soon)

The full documentation has been started but is not yet done. But JSDocs will be included within the code.

---

🧾 License

This project is licensed under the terms of the GPL-3.0 License.

You can check out the full license HERE

---

✨ Contributors

Thanks goes to these wonderful people:

cainthebest 💻 📖

mister 💻 📖

GHOST 💻 📖

Rejxcted 📖

Lynx White 📖 💻

---

Emoji/Type	Represents	Comments
🐛 bug	Bug reports	Links to issues reported by the user on this project
💻 code	Code	Links to commits by the user on this project
📖 doc	Documentation	Links to commits by the user on this project, Wiki, or other source of documentation
💡 example	Examples	People that have created examples to help others
💵 financial	Financial Support	People or orgs who provide financial support
🤔 ideas	Ideas & Planning
🚧 maintenance	Maintenance	People who help in maintaining the repo
🧑‍🏫 mentoring	Mentoring	People who mentor new contributors
📆 projectManagement	Project Management
💬 question	Answering Questions	Answering Questions in Issues etc.
👀 review	Reviewed Pull Requests
🛡️ security	Security	Identify and/or reduce security threats, Privacy, etc
⚠️ test	Tests	People that have created tests
✅ tutorial	Tutorials	content creators that have made tutorials on this wrapper
📓 userTesting	User Testing	People that have found an issue via testing