screeps-api
    Preparing search index...

    Interface SeasonsCurrentResponse

    GET /api/seasons/current response

    ScreepsHttpClient.seasonsCurrent

    interface SeasonsCurrentResponse {
        _id: string;
        createdAt: string;
        endDate: string;
        index: number;
        ok: 1;
        players: number;
        rank: number;
        startDate: string;
        title: string;
        updatedAt: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id createdAt endDate index ok players rank startDate title updatedAt

    Properties

    _id

    _id: string
    createdAt: string

    Date/time at which this season was published (ISO 8601 UTC)

    endDate: string

    Season end date/time (ISO 8601 UTC)

    index: number

    The season ordinal (ex: 5 for season 5, 8 for season 8, etc)

    ok: 1

    An API success response always contains { ok: 1 }

    players: number

    Ostensibly reports the number of participants in the season, but instead, this is almost always 0

    The only known exception is Season 1, which reports 2121 players.

    ScoreboardListResponse.meta.length for an actual player count

    rank: number

    The authenticated user's current ranking on the seasonal leaderboard

    startDate: string

    Season start date/time (ISO 8601 UTC)

    title: string

    Name of the season (ex: "Season 8")

    updatedAt: string

    Date/time at which this season was last updated (ISO 8601 UTC)

    Settings

    Member Visibility

    On This Page

    Properties