Dokumentacja API

RESTful API do dostępu do danych serwerów i statystyk

Wprowadzenie

To API pozwala na programowy dostęp do danych serwerów. Wszystkie endpointy zwracają odpowiedzi JSON i nie wymagają autoryzacji.

URL bazowy:
http://lista-minecraft.pl
Format odpowiedzi:
application/json
Autoryzacja:
Nie wymaga autoryzacji

Dostępne endpointy

Pobierz głosy serwera

GET /api/servers/{uuid}/votes

Pobiera listę głosów dla określonego serwera z ostatnich 7 dni. Zwraca zanonimizowane dane głosów zawierające nicki głosujących i czasy głosowania.

Parametry

Nazwa Typ Wymagany Opis
uuid string Wymagany Unikalny identyfikator (UUID) serwera

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/servers/your-server-uuid/votes' \
 -H 'Accept: application/json'

Przykład odpowiedzi

JSON
[
 {
 "nickname": "HeVer_",
 "createdAt": "2025-11-07T19:04:55+01:00"
 },
 {
 "nickname": "PlayerName",
 "createdAt": "2025-11-07T18:30:12+01:00"
 }
]

Pola odpowiedzi

Pole Typ Opis
nickname string Nick głosującego (z formularza głosowania)
createdAt string Znacznik czasu oddania głosu (format ISO 8601 ze strefą czasową)

Kody odpowiedzi

Kod Opis
200 Sukces - Zwraca tablicę głosów
404 Serwer nie znaleziony

Pobierz feed aktywności na żywo

GET /api/v1/live-ticker

Pobiera najnowszą publiczną aktywność — ostatnie głosy, recenzje i nowo dodane serwery — połączoną w kolejności od najnowszych. Są to te same dane, które pokazuje ticker aktywności na żywo na stronie.

Parametry

Nazwa Typ Wymagany Opis
limit integer Opcjonalny Maksymalna liczba zwracanych pozycji (1–50, domyślnie 15)

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/live-ticker?limit=15' \
 -H 'Accept: application/json'

Przykład odpowiedzi

JSON
[
 {
 "type": "vote",
 "username": "HeVer_",
 "serverHost": "play.example.com",
 "serverPath": "/servers/minecraft/1f2e...",
 "createdAt": "2026-08-03T19:04:55+00:00"
 }
]

Pola odpowiedzi

Pole Typ Opis
type string Typ aktywności: vote, review lub server
username string|null Nazwa użytkownika lub null dla aktywności anonimowej
serverHost string Host serwera, którego dotyczy aktywność
serverPath string Względna ścieżka do publicznej strony serwera
createdAt string Znacznik czasu aktywności (format ISO 8601 ze strefą czasową)

Kody odpowiedzi

Kod Opis
200 Sukces - Zwraca tablicę głosów

Lista głosów

GET /api/v1/votes

Pobiera filtrowalną i sortowalną kolekcję głosów ze wszystkich publicznie widocznych serwerów. Zwraca zanonimizowane dane głosów wraz z odniesieniem do serwera, na który oddano głos.

Parametry

Nazwa Typ Wymagany Opis
nickname string Opcjonalny Filtruj po nicku głosującego (dopasowanie częściowe, bez rozróżniania wielkości liter)
server.uuid string Opcjonalny Filtruj po dokładnym UUID serwera, na który oddano głos
server.game.slug string Opcjonalny Filtruj po slugu gry serwera (np. minecraft)
createdAt[after] date Opcjonalny Filtruj po dacie głosu; obsługuje before, after, strictly_before i strictly_after (np. createdAt[after]=2026-01-01)
order[createdAt] string Opcjonalny Sortuj po createdAt lub nickname, asc albo desc (np. order[createdAt]=asc)

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/votes?server.game.slug=minecraft&order[createdAt]=desc' \
 -H 'Accept: application/json'

Przykład odpowiedzi

JSON
[
 {
 "uuid": "9c1e...",
 "nickname": "HeVer_",
 "createdAt": "2026-08-03T19:04:55+00:00",
 "serverUuid": "1f2e...",
 "serverHost": "play.example.com"
 }
]

Pola odpowiedzi

Pole Typ Opis
nickname string Nick głosującego (z formularza głosowania)
createdAt string Znacznik czasu oddania głosu (format ISO 8601 ze strefą czasową)
serverUuid string UUID serwera, na który oddano głos
serverHost string Host serwera, na który oddano głos

Kody odpowiedzi

Kod Opis
200 Sukces - Zwraca tablicę głosów

Lista typów serwerów

GET /api/v1/server-types

Zwraca kolekcję typów serwerów (trybów gry) używanych do kategoryzowania serwerów. Każdy element udostępnia uuid, nazwę, slug, opisy oraz odnośnik do gry. Użyj zwróconego sluga w filtrze ?serverTypes.slug= na endpoincie serwerów.

Parametry

Nazwa Typ Wymagany Opis
game.slug string Opcjonalny Filtruj po slugu gry nadrzędnej (np. minecraft)
slug string Opcjonalny Filtruj po dokładnym slugu typu serwera

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/server-types?game.slug=minecraft' \
 -H 'Accept: application/json'

Lista wersji serwerów

GET /api/v1/server-versions

Zwraca kolekcję wersji serwerów obsługiwanych dla poszczególnych gier. Każdy element udostępnia uuid, wartość, slug, opisy oraz odnośnik do gry. Użyj zwróconego sluga w filtrze ?serverVersions.slug= na endpoincie serwerów.

Parametry

Nazwa Typ Wymagany Opis
game.slug string Opcjonalny Filtruj po slugu gry nadrzędnej (np. minecraft)
slug string Opcjonalny Filtruj po dokładnym slugu wersji serwera

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/server-versions?game.slug=minecraft' \
 -H 'Accept: application/json'

Lista map

GET /api/v1/maps

Zwraca kolekcję publicznie widocznych map. Każdy element udostępnia uuid, nazwę, slug oraz odnośnik do gry. Mapy nieopublikowane dla wszystkich nigdy nie są zwracane.

Parametry

Nazwa Typ Wymagany Opis
game.slug string Opcjonalny Filtruj po slugu gry nadrzędnej (np. minecraft)
slug string Opcjonalny Filtruj po dokładnym slugu mapy

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/maps?game.slug=minecraft' \
 -H 'Accept: application/json'

Lista wydarzeń

GET /api/v1/events

Zwraca filtrowalną i sortowalną kolekcję zatwierdzonych wydarzeń w grach. Każdy element udostępnia uuid, tytuł, opis, adres URL, daty rozpoczęcia/zakończenia oraz odnośnik do gry. Wydarzenia oczekujące na moderację nigdy nie są zwracane.

Parametry

Nazwa Typ Wymagany Opis
game.slug string Opcjonalny Filtruj po slugu powiązanej gry (np. minecraft)
startsAt[after] string Opcjonalny Filtruj po dacie rozpoczęcia; obsługuje before, after, strictly_before i strictly_after (np. startsAt[after]=2026-01-01)
order[startsAt] string Opcjonalny Sortuj wyniki po startsAt, asc lub desc (np. order[startsAt]=asc)

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/events?order[startsAt]=asc' \
 -H 'Accept: application/json'

Lista ogłoszeń

GET /api/v1/announcements

Zwraca kolekcję aktualnie opublikowanych ogłoszeń serwisu. Każdy element udostępnia uuid, treść w języku polskim i angielskim, typ, opcjonalną datę wygaśnięcia oraz znaczniki czasu. Zwracane są wyłącznie aktywne, niewygasłe ogłoszenia — wersje robocze i wygasłe są ukrywane.

Parametry

Nazwa Typ Wymagany Opis
type string Opcjonalny Filtruj po typie ogłoszenia: info, warning lub critical
order[createdAt] string Opcjonalny Sortuj wyniki po createdAt lub updatedAt, asc lub desc (np. order[createdAt]=desc)

Przykład zapytania

cURL
curl -X GET 'http://lista-minecraft.pl/api/v1/announcements?type=critical' \
 -H 'Accept: application/json'

Zarządzanie ogłoszeniami (tylko administrator)

Tworzenie, edycja i usuwanie ogłoszeń jest dostępne wyłącznie dla zalogowanych administratorów. Odczyt (endpointy powyżej) pozostaje publiczny.

Metoda Endpoint Opis
POST /api/v1/announcements Utwórz nowe ogłoszenie. Body: contentPl (wymagane), contentEn, type (info/warning/critical), isActive, expiresAt.
PUT /api/v1/announcements/{uuid} Zastąp istniejące ogłoszenie wskazane przez uuid.
DELETE /api/v1/announcements/{uuid} Usuń ogłoszenie wskazane przez uuid.

Limity zapytań

Obecnie nie są egzekwowane żadne limity zapytań do API. Prosimy jednak o odpowiedzialne korzystanie z API i unikanie nadmiernych zapytań, które mogłyby wpłynąć na wydajność serwera.

Wsparcie

Jeśli masz pytania dotyczące API lub potrzebujesz pomocy w integracji z Twoją aplikacją, skontaktuj się z nami przez nasze kanały wsparcia.