API Dokumentation
Poszukaj.se is a web service providing data about game and voice servers.
Server data
-
/api/server/{server:id}/detailsParameters
- • server:id int
Authorization
Use the bearer token generated from the user panel. You must be the owner of the server!
- • server:read permission
Responses
// 200 - success { "data": { "id": 1208, "address": "prokoxy.pl", "country": "pl", "game": "minecraft", "version": "1.8 - 1.17", "owner": 0, // 0 if guest "motd": "PROKOXY.pl Zagraj juz teraz razem z nami!", "map": null, "status": 1, "players_online": 1, "players": 200, "description": null, "port": null, "query": null, "website": "https:\/\/www.prokoxy.pl\/", "discord": null, "votes": 5, "promoted": "2021-07-22 13:26:49", "created_at": "2020-10-25T20:20:37.000000Z", "updated_at": "2021-06-29T07:41:29.000000Z" } } // 401 - unauthorized { "status": 401, "error": "You are not authorized." } // 404 - server not found { "status": 404, "message": "Record not found." } -
/api/server/{server:id}/chart/onlineParameters
- • server:id int
Responses
// 200 - success { "data": [ { "d": "2022-02-16 10:33:49", "o": 2 }, { "d": "2022-02-16 10:41:48", "o": 2 }, { "d": "2022-02-16 11:12:23", "o": 2 } ] } // 404 - no data { "status": 404, "error": "No data available." } // 404 - server not found { "status": 404, "message": "Record not found." } -
/api/server/{server:id}/chart/day?start_at={days:before}Parameters
- • server:id int
- • days:before int
Responses
// 200 - success { "data": [ { "d": "2021-04-22", "o": 9 }, { "d": "2021-04-23", "o": 7 } ] } // 404 - no data { "status": 404, "error": "No data available." } // 404 - server not found { "status": 404, "message": "Record not found." } -
/api/server/{server:id}/chart/vote?start_at={days:before}Parameters
- • server:id int
- • days:before int
Responses
// 200 - success { "data": [ { "d": "2021-04-22", "o": 9 }, { "d": "2021-04-23", "o": 7 } ] } // 404 - no data { "status": 404, "error": "No data available." } // 404 - server not found { "status": 404, "message": "Record not found." }
Server votes
-
/api/vote/{server:id}/{user:ip}Parameters
- • server:id int
- • user:ip string
Responses
// 200 - success [ { "id": 1234, "server": 123 "user": 123, // or 0 if guest "game": "minecraft", "name": "CoolUser", "ip": "12.345.67.89", "date": "2021-06-01 12:00:00", "received": 0 // 1 if received } ] // 409 - vote not found { "status": 409, "error": "The vote was not found." } // 404 - server not found { "status": 404, "error": "Record not found." } -
/api/vote/{server:id}/lastParameters
- • server:id int
Responses
// 200 - success { "server": 123, "data": [ { "id": 7162, "user": 10, // or 0 if guest "name": "RikoDEV", "game": "minecraft", "date": "2022-03-05 14:45:19" }, { "id": 7161, "user": 0, // or 0 if guest "name": "TheMagpie777", "game": "minecraft", "date": "2022-03-05 13:48:08" }, { "id": 7160, "user": 0, // or 0 if guest "name": "TheMagpie777", "game": "minecraft", "date": "2022-03-04 10:35:53" }, { "id": 7159, "user": 0, // or 0 if guest "name": "RageElixir1377", "game": "minecraft", "date": "2022-02-18 18:42:02" } ] } // 409 - server has no votes { "status": 409, "error": "No data available." } // 404 - server not found { "status": 404, "error": "Record not found." } -
/api/vote/{server:id}/{user:ip}/redeemParameters
- • server:id int
- • user:ip string
Responses
// 200 - success { "status": 1, "response": "Successfully received." } // 409 - already received { "status": 0, "error": "Already received." } // 409 - vote not found { "status": 409, "error": "The vote was not found." }