API Documentation

Method: GET

Endpoint: /api/home

Params: No parameters required for this endpoint.

This endpoint returns the user profile data, training information, and rating details.

{
    "user": {
        "id": 1,
        "name": "Agnieszka Shiklina",
        "avatar": "url_to_avatar"
    },
    "space_coins": 1449,
    "training_count": 124,
    "trainer": {
        "name": "Мария Ивановна",
        "contact": "+48746099769"
    },
    "rating": [
        { "name": "Anna Kowalska", "place": 1 },
        { "name": "Filip Zając", "place": 2 }
    ]
}
            

Method: GET

Endpoint: /api/olympiads

Params:

• category (optional) — Category of the olympiad (e.g., "математика").
• level (optional) — Difficulty level of the olympiad ("легкий", "средний", "сложный").
• price_min (optional) — Minimum participation price.
• price_max (optional) — Maximum participation price.
• date (optional) — Date of the olympiad (format: YYYY-MM-DD).

This endpoint returns a list of available olympiads with details such as category, level, and price.

[
    {
        "id": 1,
        "title": "Украинская Национальная Олимпиада",
        "category": "Математика",
        "level": "Средний",
        "date": "2025-04-26",
        "price": 500,
        "type": "Украинские",
        "currency": "₴"
    },
    {
        "id": 2,
        "title": "International Competition",
        "category": "Физика",
        "level": "Сложный",
        "date": "2025-07-17",
        "price": 1700,
        "type": "Международные",
        "currency": "₴"
    }
]
            

Method: POST

Endpoint: /api/auth/register

Params:

• name — First name of the user.
• surname — Last name of the user.
• age — Age of the user.
• school — Name of the school.
• country — Country of the user.
• city — City of the user.
• phone — User's phone number.
• email — User's email address.
• password — User's password.
• level — User's competition level (e.g., "Basic").
• competition_code — The competition code.

This endpoint registers a new user in the system.

**Success:**
{
    "message": "Регистрация успешна",
    "user_id": 5
}

**Errors:**
{
    "error": "Некорректный email",
    "code": 400
}
            

Method: GET

Endpoint: /api/ranking

Params: No parameters required for this endpoint.

This endpoint returns a list of users who are part of the ranking, including their rank, name, age group, and points.

[
    {
        "place": 1,
        "name": "Łukasz Dudek",
        "level": "Intermediate",
        "age": "13-15",
        "points": 9976
    },
    {
        "place": 2,
        "name": "Anna Kamińska",
        "level": "Intermediate",
        "age": "13-15",
        "points": 9950
    },
    {
        "place": 3,
        "name": "Tomasz Zieliński",
        "level": "Intermediate",
        "age": "13-15",
        "points": 9877
    }
]