🎮 Exaroton Server API

A Node.js API for monitoring and retrieving information from Exaroton Minecraft servers

✨ What is it?

This is a lightweight Node.js API that integrates with the Exaroton service to provide real-time information about Minecraft servers and players. Built for easy deployment on Vercel with serverless functions.

Key Features:

• 🎮 Player List - Get real-time list of online players
• 👤 Player Info - Detailed player statistics and information
• 🚀 Serverless - Ready for Vercel deployment
• 🌐 CORS Enabled - Ready for web integration
• ⚡ Fast & Reliable - Optimized for performance

🚀 Quick Deploy

1-Click Deploy on Vercel

Manual Setup

# Clone the repository
git clone https://github.com/CachorroninjaBot/Minecraft-API.git
cd exaroton-server-api

# Install dependencies
npm install

# Set up environment variables (see below)
cp .env.example .env

# Start development server
npm start

🔑 Environment Variables

Create a .env file in the root directory:

EXAROTON_TOKEN=your_exaroton_api_token_here

How to get your Exaroton token:

1. Go to Exaroton Account Settings
2. Navigate to API section
3. Generate a new API token
4. Copy and paste it into your .env file

📖 API Endpoints

🎮 Get Online Players

GET /c

Returns a list of currently online players.

Response:

{
  "default": false,
  "mensagem": "Selecione um jogador",
  "players": {
    "name1": "PlayerName1",
    "name2": "PlayerName2",
    "enable1": false,
    "enable2": false,
    // ... up to 25 players
  }
}

👤 Get Player Information

GET /player/{playerName}

Get detailed information about a specific player.

Parameters:

• playerName - The Minecraft username

Response:

{
  "success": true,
  "data": {
    "name": "PlayerName",
    "online": true,
    "nickname": "DisplayName",
    "balance": "1000.0",
    "rank": "Member",
    "world": "world",
    "clan": "ClanName",
    "time_played": "120h 30m",
    "auraskills_level": "50"
  },
  "mensagem": "Player information retrieved successfully"
}

Error Response:

{
  "success": false,
  "error": "Jogador PlayerName não registrado"
}

🏗️ Project Structure

exaroton-server-api/
├── api/
│   ├── list/
│   │   └── index.js          # Player list endpoint
│   └── player/
│       └── index.js          # Player info endpoint
├── index.js                  # Main application
├── package.json              # Dependencies
├── vercel.json              # Vercel configuration
├── .env.example             # Environment template
├── .gitignore               # Git ignore rules
├── LICENSE                  # MIT License
└── README.md                # This file

🎯 Usage Examples

JavaScript/Fetch

// Get online players
const players = await fetch('https://your-api.vercel.app/c')
  .then(res => res.json());

// Get specific player info
const playerInfo = await fetch('https://your-api.vercel.app/player/Steve')
  .then(res => res.json());

Python

import requests

# Get online players
response = requests.get('https://your-api.vercel.app/c')
players = response.json()

# Get player info
response = requests.get('https://your-api.vercel.app/player/Steve')
player_info = response.json()

cURL

# Get online players
curl https://your-api.vercel.app/c

# Get player information
curl https://your-api.vercel.app/player/Steve

🔧 Configuration

Server ID Configuration

The API is currently configured to work with a specific server. To use it with your server:

1. Find your server ID from the Exaroton dashboard
2. Replace b84AUtz8FZXVQ6Xq in the API endpoints with your server ID
3. Update both /api/list/index.js and /api/player/index.js

Custom Player Command

The API uses a custom playerinfo command. Make sure your Minecraft server has this command available, or modify the code to use standard commands.

⚠️ Error Handling

The API includes comprehensive error handling for:

• Invalid player names - Returns appropriate error messages
• Server offline - Waits for server to come online
• API rate limits - Implements retry logic
• Network issues - Graceful error responses

🛡️ Security Features

• ✅ Environment variables for sensitive data
• ✅ Input validation for player names
• ✅ Error sanitization to prevent information leakage
• ✅ CORS configuration for web security

📊 Rate Limits

Exaroton API has rate limits. This API implements:

• Automatic retry logic
• Intelligent waiting between requests
• Error handling for rate limit exceeded

🚀 Performance

• Serverless deployment - Zero cold start optimization
• Efficient API calls - Minimized requests to Exaroton
• Proper error handling - Fast failure responses
• Optimized JSON responses - Minimal payload size

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. 🍴 Fork the repository
2. 🌟 Create a feature branch (git checkout -b feature/amazing-feature)
3. ✅ Make your changes
4. 📝 Commit your changes (git commit -m 'Add amazing feature')
5. 🚀 Push to the branch (git push origin feature/amazing-feature)
6. 📬 Open a Pull Request

Development Guidelines

• Keep code clean and well-commented
• Add error handling for new features
• Test all endpoints before submitting
• Update documentation as needed

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Links

• Exaroton Official Website
• Exaroton API Documentation
• Vercel Documentation

💡 Support

If you encounter any issues:

1. Check the Issues section
2. Create a new issue with detailed information
3. Include error messages and steps to reproduce

---

Made with ❤️ for the Minecraft community

⭐ Star this repo • 🐛 Report Bug • 💡 Request Feature

# Minecraft-API