{"id":19784341,"url":"https://github.com/pteropackages/pterojs","last_synced_at":"2025-07-29T14:10:27.399Z","repository":{"id":37295221,"uuid":"395104274","full_name":"PteroPackages/PteroJS","owner":"PteroPackages","description":"A verbose API library for Pterodactyl","archived":false,"fork":false,"pushed_at":"2024-06-30T13:59:32.000Z","size":1430,"stargazers_count":44,"open_issues_count":9,"forks_count":11,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-18T11:51:14.428Z","etag":null,"topics":["javascript","library","nodejs","pterodactyl","pterodactyl-api","pterodactyl-panel-api","typescript","wrapper"],"latest_commit_sha":null,"homepage":"https://pteropackages.github.io/PteroJS/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PteroPackages.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-08-11T20:05:39.000Z","updated_at":"2025-06-10T07:56:16.000Z","dependencies_parsed_at":"2024-01-24T23:41:23.999Z","dependency_job_id":"b9f866e1-ef9a-4eb1-8ac9-80e01b02b0a0","html_url":"https://github.com/PteroPackages/PteroJS","commit_stats":{"total_commits":593,"total_committers":8,"mean_commits":74.125,"dds":0.5143338954468804,"last_synced_commit":"0823869d7064ca4f15a2611e4aa977950fa204b9"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/PteroPackages/PteroJS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PteroPackages","download_url":"https://codeload.github.com/PteroPackages/PteroJS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PteroPackages%2FPteroJS/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267701287,"owners_count":24130447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","library","nodejs","pterodactyl","pterodactyl-api","pterodactyl-panel-api","typescript","wrapper"],"created_at":"2024-11-12T06:11:13.425Z","updated_at":"2025-07-29T14:10:27.371Z","avatar_url":"https://github.com/PteroPackages.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003ePteroJS\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003e\u003cstrong\u003eA verbose API library for Pterodactyl\u003c/strong\u003e\u003c/h3\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://discord.com/invite/dwcfTjgn7S\" type=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-invite-5865f2?style=for-the-badge\u0026logo=discord\u0026logoColor=white\"\u003e\u003c/a\u003e \u003cimg src=\"https://img.shields.io/badge/version-2.2.2-3572A5?style=for-the-badge\"\u003e \u003cimg src=\"https://img.shields.io/github/issues/PteroPackages/PteroJS.svg?style=for-the-badge\"\u003e \u003ca href=\"https://pteropackages.github.io/PteroJS/\" type=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-typedoc-e67e22?style=for-the-badge\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n## About\n\nPteroJS is a verbose API library for the [Pterodactyl Game Panel](https://pterodactyl.io) designed to give developers full access and control over the API without having to compromise on code quality or efficiency.\n\n## Installing\n\nIf you are using Node.js (v14.x and above):\n\n```\nnpm install @devnote-dev/pterojs\nyarn add @devnote-dev/pterojs\n```\n\nor if you are using Deno:\n```js\nimport pterojs from 'https://cdn.skypack.dev/@devnote-dev/pterojs';\n```\n\nPlease join the [support server](https://discord.com/invite/dwcfTjgn7S) if you experience any issues with installing the package.\n\n## Compatibility\n\nNote that you can use older versions of PteroJS with newer versions of Pterodactyl and Wings, but they will not be up-to-date with the latest features and fixes.\n\n| PteroJS | Panel            | Wings    |\n| ------- | ---------------- | -------- |\n| ❌      | `\u003c= 0.7`         | `\u003c= 1.5` |\n| `1.3.0` | `1.6.5 \u003e= 1.7.0` | `~1.6.0` |\n| `1.4.2` | `1.7.0 \u003e= 1.8.1` | `~1.6.0` |\n| `2.0.1` | `^1.9.0`         | `^1.7.0` |\n| `2.1.0` | `^1.10.0`        | `^1.7.0` |\n\n## Setting Up\n\nPteroJS uses separate classes for the client and application sides of the Pterodactyl API.\n\n### Using the application API\n\n```js\nconst { PteroApp } = require('@devnote-dev/pterojs');\n\n// Initialising the application\nconst app = new PteroApp('your.domain.name', 'pterodactyl_api_key');\n\n// Accessing information\napp.servers.fetch(4).then(console.log);\n```\n\n### Using the client API\n\n```js\nconst { PteroClient } = require('@devnote-dev/pterojs');\n\n// Initialising the client\nconst client = new PteroClient('your.domain.name', 'pterodactyl_api_key');\n\n// Adding the server to listen for\nconst shard = client.addSocketServer('f7eca02e');\n\n// Listening to events\nshard.on('statusUpdate', (status) =\u003e {\n    console.log(`server ${shard.id} status: ${status}`);\n});\n\n// Connecting to the server\nshard.connect();\n```\n\n## Migrations\n\nCheckout the new [migrations guide](./migrations/v2-0-1.md) to PteroJS v2!\n\n## Contributing\n\nPlease see the [issues](https://github.com/PteroPackages/PteroJS/issues) section for contributing ideas. New ideas/features are also welcome.\n\n1. [Fork this repo](https://github.com/PteroPackages/PteroJS/fork)!\n2. Make a branch from `main` (`git branch -b \u003cnew-feature\u003e`)\n3. Commit your changes (`git commit -am \"...\"`)\n4. Open a PR here (`git push origin \u003cnew-feature\u003e`)\n\n## Contributors\n\n- [Devonte](https://github.com/devnote-dev) - Owner, maintainer\n- [Chelog](https://github.com/chelog) - Code contributor\n- [Cain](https://github.com/cainthebest) - Code contributor\n\nThis repository is managed under the MIT license.\n\n© 2021-present PteroPackages\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpteropackages%2Fpterojs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpteropackages%2Fpterojs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpteropackages%2Fpterojs/lists"}