aimardcr/README.md

## README.md

      
    Raw
  

              README.md
            
          
    API Documentation

Base URL

https://mlbb-api.aimar.id/v1
Authentication

All endpoints except /health-check require API key authentication. Include the API key in the Authorization header of your request.
API Keys

There are two types of API keys available:

Free: No IP restrictions
Specific User: IP-restricted

Error Handling


401 Unauthorized: Returned when the API key is missing, invalid, or the request is from an unauthorized IP (for IP-restricted keys).
404 Not Found: Returned when the requested resource is not found.

Endpoints

1. Health Check

Check the health status of the API.

URL: /health-check
Method: GET
Auth required: No

Success Response


Code: 200 OK
Content:
{
  "success": true,
  "message": "Healthy!"
}


2. Get Player Data

Retrieve player information based on game ID and server ID.

URL: /get-player-data
Method: GET
Auth required: Yes

Parameters


Name
Type
Required
Description


game_id
string
Yes
Player's game ID


server_id
string
Yes
Player's server ID


Success Response


Code: 200 OK
Content:
{
  "success": true,
  "message": "Player data fetched!",
  "data": {
    // Player data object
  }
}


Error Response


Code: 400 Bad Request
Content:
{
  "success": false,
  "message": "game_id is required!"
}
OR
{
  "success": false,
  "message": "server_id is required!"
}

Code: 404 Not Found
Content:
{
  "success": false,
  "message": "Player not found!"
}


3. Get Battle IDs

Retrieve recent battle IDs for a player.

URL: /get-battle-ids
Method: GET
Auth required: Yes

Parameters


Name
Type
Required
Description


game_id
string
Yes
Player's game ID


server_id
string
Yes
Player's server ID


Success Response


Code: 200 OK
Content:
{
  "success": true,
  "message": "Battle Info fetched!",
  "data": {
    // Battle IDs data
  }
}


Error Response


Code: 400 Bad Request
Content:
{
  "success": false,
  "message": "game_id is required!"
}
OR
{
  "success": false,
  "message": "server_id is required!"
}

Code: 404 Not Found
Content:
{
  "success": false,
  "message": "Player not found!"
}


4. Get Squad Data

Retrieve data for a specific squad.

URL: /get-squad-data
Method: GET
Auth required: Yes

Parameters


Name
Type
Required
Description


squad_id
string
Yes
Squad ID


Success Response


Code: 200 OK
Content:
{
  "success": true,
  "message": "Squad data fetched!",
  "data": {
    // Squad data object
  }
}


Error Response


Code: 400 Bad Request
Content:
{
  "success": false,
  "message": "squad_id is required!"
}

Code: 404 Not Found
Content:
{
  "success": false,
  "message": "Squad not found!"
}
Name	Type	Required	Description
game_id	string	Yes	Player's game ID
server_id	string	Yes	Player's server ID
No results found