Important: This API is currently in BETA. Some features may change, please report any issues you encounter.

API Documentation

Learn how to interact with our API and get started with the integration process.

Base URL

All API requests are made to the following base URL:

https://topserver.live/api/

Add Server

This endpoint allows you to create a new server and will create a user as well. You need to provide the server details such as its name, description, URL, language, and version. The user will receive the details via email.

Important: It is very important to use a valid email address because when the user is created, the details are sent to that email and are required to log in.
Available Game Versions
World of Warcraft
The Burning Crusade
Wrath of the Lich King
Cataclysm
Mists of Pandaria
Warlords of Draenor
Legion
Battle for Azeroth
Shadowlands
Dragonflight

POST /add-server


POST https://topserver.live/api/add-server

{
    "name": "Top Server Live",
    "description": "Best World of Warcraft Servers Ranking",
    "url": "https://topserver.live/",
    "owner_email": "support@topserver.live"
    "language": "en",
    "version_name": "Wrath of the Lich King",
    "realmlist": "topserver.live",
    "realmlist_port": 8085,
    "socials": [
        {"social": "facebook", "url": "https://facebook.com/example"},
        {"social": "twitter", "url": "https://twitter.com/example"}
    ],
    "banner_url": "https://topserver.live/images/banner.png"
}

Example Response:

Response


{
    "message": "Server added successfully!",
    "server": {
        "name": "Top Server Live",
        "description": "Best World of Warcraft Servers Ranking",
        "url": "https://topserver.live/",
        "language": "en",
        "version_name": "Wrath of the Lich King",
        "realmlist": "topserver.live",
        "realmlist_port": 8085,
        "socials": [
            {"social": "facebook", "url": "http://facebook.com/example"},
            {"social": "twitter", "url": "http://twitter.com/example"}
        ],
        "banner_url": "http://example.com/banner.jpg"
    }
}

Update Server

This endpoint allows you to update an existing server. You need to provide the server ID and the fields you want to update.

Important: The server ID is mandatory to perform the update. You can find the server ID in the administration panel, under the server information section.
Important: An API token is required to use this endpoint. You can generate the token in the user profile section of the administration panel.
Important: You must use the Bearer Token for authentication. Include the token in the Authorization header.
Important: You must include the Accept: application/json header in your request.

PUT /update-server/{serverId}


                PUT https://topserver.live/api/update-server/{serverId}
                Accept: application/json
                Authorization: Bearer YOUR_API_TOKEN

                {
                    "enable": true,
                    "tags": "PvP, No Custom, Active Staff"
                }

Example Response:

Response


                {
                    "message": "Server updated successfully!",
                    "server": {
                        "name": "Top Server Live",
                        "description": "Best World of Warcraft Servers Ranking",
                        "url": "https://topserver.live/",
                        "language": "en",
                        "version_name": "Wrath of the Lich King",
                        "realmlist": "topserver.live",
                        "realmlist_port": 8085,
                        "socials": [
                            {"social": "facebook", "url": "https://facebook.com/example"},
                            {"social": "twitter", "url": "https://twitter.com/example"}
                        ],
                        "banner_url": "https://topserver.live/images/banner.png",
                        "enable": true,
                        "tags": ["PvP", "No Custom", "Active Staff"]
                    }
                }

Delete Server

This endpoint allows you to delete an existing server. You need to provide the server ID.

Important: The server ID is mandatory to perform the deletion. You can find the server ID in the administration panel, under the server information section.
Important: An API token is required to use this endpoint. You can generate the token in the user profile section of the administration panel.
Important: You must use the Bearer Token for authentication. Include the token in the Authorization header.
Important: You must include the Accept: application/json header in your request.

DELETE /delete-server/{serverId}


DELETE https://topserver.live/api/delete-server/{serverId}
Accept: application/json
Authorization: Bearer YOUR_API_TOKEN

Example Response:

Response


{
    "message": "Server deleted successfully!"
}

Check

This endpoint allows you to check if a server name, URL, or email is already registered. You will receive a response if there is a conflict.

Important: This endpoint is useful for verifying if a server or email address is already in use before creating a new one.

GET /check


GET https://topserver.live/api/check?url=https://topserver.live/&email=owner@example.com&name=Top%20Server%20Live

Example Response:

Response


{
    "message": "No conflicts found."
}

Example Error Response:

Error Response


{
    "errors": {
        "url": "The URL is already in use.",
        "email": "The email is already in use.",
        "name": "The server name is already in use."
    }
}