{"id":28500713,"url":"https://github.com/gglvxd/minecraftserverstatus","last_synced_at":"2025-07-04T12:31:11.943Z","repository":{"id":297784120,"uuid":"997880598","full_name":"GGLVXD/MinecraftServerStatus","owner":"GGLVXD","description":"nodejs package to fetch minecraft server status","archived":false,"fork":false,"pushed_at":"2025-06-19T11:38:26.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-19T12:36:34.798Z","etag":null,"topics":["bedrock","bedrock-server","bedrock-status","java","java-http-server","java-server","java-status","minecraft","minecraft-bedrock-server","minecraft-server","minecraft-status"],"latest_commit_sha":null,"homepage":"https://api.fryde.id.lv/#/Minecraft","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GGLVXD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-06-07T11:47:47.000Z","updated_at":"2025-06-19T11:38:29.000Z","dependencies_parsed_at":"2025-06-07T13:37:12.988Z","dependency_job_id":null,"html_url":"https://github.com/GGLVXD/MinecraftServerStatus","commit_stats":null,"previous_names":["gglvxd/minecraftserverstatus"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GGLVXD/MinecraftServerStatus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GGLVXD%2FMinecraftServerStatus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GGLVXD%2FMinecraftServerStatus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GGLVXD%2FMinecraftServerStatus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GGLVXD%2FMinecraftServerStatus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GGLVXD","download_url":"https://codeload.github.com/GGLVXD/MinecraftServerStatus/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GGLVXD%2FMinecraftServerStatus/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263539460,"owners_count":23477454,"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","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":["bedrock","bedrock-server","bedrock-status","java","java-http-server","java-server","java-status","minecraft","minecraft-bedrock-server","minecraft-server","minecraft-status"],"created_at":"2025-06-08T15:07:36.278Z","updated_at":"2025-07-04T12:31:11.937Z","avatar_url":"https://github.com/GGLVXD.png","language":"JavaScript","readme":"# Minecraft Server Status Checker\n\nnodejs package to fetch minecraft server status/info.\n\n## Features\n\n- **Pure Node.js** - No external dependencies\n- **Dual Edition Support** - Check both Java and Bedrock servers\n- **Simple API** - Promise-based interface\n- **Error Handling** - Proper error propagation\n- **Configurable** - Optional API key support\n\n## Ratelimit\n- With API key: 100 requests/minute\n- Without API key: 50 requests/minute\n\n## Installation\n\n```bash\nnpm install @gglvxd/minecraftserverstatus\n```\n\n## Usage\n\n### Basic Usage\n\n```javascript\nconst MinecraftServerStatus = require('@gglvxd/minecraftserverstatus');\n\n// Create instance (API key optional)\nconst statusChecker = new MinecraftServerStatus(); \n\n// Check Java server\nstatusChecker.checkJava('mc.hypixel.net')\n    .then(status =\u003e console.log('Java Server Status:', status))\n    .catch(error =\u003e console.error('Error:', error));\n\n// Check Bedrock server\nstatusChecker.checkBedrock('hivebedrock.network')\n    .then(status =\u003e console.log('Bedrock Server Status:', status))\n    .catch(error =\u003e console.error('Error:', error));\n```\n\n### With API Key\n\nGet your api key at https://fryde.id.lv/dashboard/apikey\n\n```javascript\nconst statusChecker = new MinecraftServerStatus('your_api_key_here');\n```\n\n### With Async/Await\n\n```javascript\nasync function checkServers() {\n    try {\n        const javaStatus = await statusChecker.checkJava('mc.hypixel.net');\n        console.log('Java Server Online:', javaStatus.online);\n        \n        const bedrockStatus = await statusChecker.checkBedrock('hivebedrock.network');\n        console.log('Bedrock Players Online:', bedrockStatus.players.online);\n    } catch (error) {\n        console.error('Error checking servers:', error);\n    }\n}\n\ncheckServers();\n```\n\n## API Reference\n\n### `new MinecraftServerStatus([apiKey])`\n\nCreates a new instance of the status checker.\n\n- `apiKey` (String, optional): Your API key if you have one\n\n### Methods\n\n#### `checkJava(ip, [port], [premium])`\n\nChecks the status of a Java edition server.\n\n- `ip` (String, required): Server IP address\n- `port` (Number, optional, default=25565): Server port\n- `premium` (Boolean, optional, default=false): Use premium points\n- Returns: Promise that resolves with server status object\n\n#### `checkBedrock(ip, [port], [premium])`\n\nChecks the status of a Bedrock edition server.\n\n- `ip` (String, required): Server IP address\n- `port` (Number, optional, default=19132): Server port\n- `premium` (Boolean, optional, default=false): Use premium points\n- Returns: Promise that resolves with server status object\n\n## Response Format\n\n### Java Edition Example\n\n```json\n{\n  \"online\": true,\n  \"ip\": \"mc.hypixel.net\",\n  \"port\": 25565,\n  \"version\": \"Requires MC 1.8 / 1.21\",\n  \"protocol\": 47,\n  \"players\": {\n    \"online\": 41844,\n    \"max\": 200000\n  },\n  \"motd\": {\n    \"raw\": \"§f                §aHypixel Network §c[1.8-1.21]§f\\n        §d§lSKYWARS UPDATE §7- §b§lDISASTERS v0.3\",\n    \"clean\": \"                Hypixel Network [1.8-1.21]\\n        SKYWARS UPDATE - DISASTERS v0.3\"\n  },\n  \"favicon\": \"data:image/png;base64,...\"\n}\n```\n\n### Bedrock Edition Example\n\n```json\n{\n  \"online\": true,\n  \"ip\": \"hivebedrock.network\",\n  \"port\": 19132,\n  \"version\": {\n    \"name\": \"1.0\",\n    \"protocol\": 121\n  },\n  \"players\": {\n    \"online\": 23065,\n    \"max\": 100001\n  },\n  \"edition\": \"MCPE\",\n  \"motd\": {\n    \"raw\": \"§fBEDWARS + BUILD BATTLE§f\\nHive Games\",\n    \"clean\": \"BEDWARS + BUILD BATTLE\\nHive Games\"\n  },\n  \"gameMode\": \"Survival\",\n  \"serverGUID\": \"1747355109132437\"\n}\n```\n\n## Error Handling\n\nThe API may return errors with the following status codes:\n\n- `400`: Missing required parameters\n- `429`: Rate limit exceeded\n- `500`: Server error\n- `503`: Server offline/unreachable\n\nThese errors will be rejected as promises with the error object from the API.\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgglvxd%2Fminecraftserverstatus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgglvxd%2Fminecraftserverstatus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgglvxd%2Fminecraftserverstatus/lists"}