Realms Specification (1.13.3) - version 1

Realms 1.13.3

PRODUCTION:     https://pc.realms.minecraft.net
STAGE:          https://pc-stage.realms.minecraft.net
LOCAL:          http://localhost:8080

PATHS
    PATH_ACCEPT_INVITE              /accept/$INVITATION_ID
    PATH_AVAILABLE                  /available
    PATH_CLIENT_COMPATIBLE          /client/compatible
    PATH_DELETE_WORLD               /$WORLD_ID
    PATH_GET_ACTIVTIES              /$WORLD_ID
    PATH_GET_LIVESTATS              /liveplayerlist
    PATH_GET_SUBSCRIPTION           /$WORLD_ID
    PATH_INITIALIZE                 /$WORLD_ID/initialize
    PATH_NEWS                       /v1/news
    PATH_OP                         /$WORLD_ID/$PROFILE_UUID
    PATH_PENDING_INVITES            /pending
    PATH_PENDING_INVITES_COUNT      /count/pending
    PATH_PUT_INTO_MINIGAMES_MODE    /minigames/$MINIGAME_ID/$WORLD_ID
    PATH_REJECT_INVITE              /reject/$INVITATION_ID
    PATH_SLOT                       /$WORLD_ID/slot/$SLOT_ID
    PATH_STAGE_AVAILABLE            /stageAvailable
    PATH_TEMPLATES                  /templates/$WORLD_TYPE
    PATH_TOS_AGREED                 /tos/agreed
    PATH_UNINVITE_MYSELF            /$WORLD_ID
    PATH_WORLD_BACKUPS              /$WORLD_ID/backups
    PATH_WORLD_CLOSE                /$WORLD_ID/close
    PATH_WORLD_DOWNLOAD             /$WORLD_ID/slot/$SLOT_ID/download
    PATH_WORLD_GET                  /$ID
    PATH_WORLD_INVITES              /$WORLD_ID
    PATH_WORLD_JOIN                 /v1/$ID/join/pc
    PATH_WORLD_OPEN                 /$WORLD_ID/open
    PATH_WORLD_RESET                /$WORLD_ID/reset
    PATH_WORLD_UNINVITE             /$WORLD_ID/invite/$UUID
    PATH_WORLD_UPDATE               /$WORLD_ID
    PATH_WORLD_UPLOAD               /$WORLD_ID/backups/upload

    REGIONS_RESOURCE                regions/ping/stat  <!-- is it a path? -->

    SUBSCRIPTION_RESOURCE           subscriptions
    TRIALS_RESOURCE                 trial
    WORLDS_RESOURCE_PATH            worlds


    # paths found, but not static vars are defined for them
    getLiveStats()                  activities/liveplayerlist
    mcoEnabled()                    mco/available
    stageAvailable()                mco/stageAvailable
    clientCompatible()              mco/client/compatible
    pendingInvitesCount()           invites/count/pending
    pendingInvites()                invites/pending
    agreeToTos()                    mco/tos/agreed
    getNews()                       mco/v1/news

REQUEST
    COOKIES
        sid                 sessionId
        user                username
        version             1.13
        realms_version      <!-- present in version.txt
                                 not set if not found -->

    RESPONSE CODES
        503                 retrying after Retry-After header
        200-299             read text normally
        401                 RealmsServiceException
                            "Could not authorize you against Realms server"
                            Also reads WWW-Authenticate header
        empty response      RealmsServiceException
        different header    RealmsServiceException
        no response         RealmsServiceException("Could not connect to Realms")