Python3 Code Example

import urllib.parse
import requests


def freePlayPriceAction(
    host: str,
    seed: int,
    price_actions: list[int],
) -> dict:
    """Free Play mode.

    Post price decisions of a round and get the round status.

    Args:
        host (str): the server address
        seed (int): unique identifier of a round, nonnegative integer
        price_actions (list[int]): list of price levels (0, 1, 2, 3) in the past
        and current weeks. Prices: 0 -- $60, 1 -- $54, 2 -- $48, 3 -- $36.

    Returns:
        dict: round status in the form of a dict
    """

    api = "/api/freeplayRoundPriceAction"
    url = urllib.parse.urljoin(host, api)
    payload = {"seed": seed, "priceActions": price_actions}
    res = requests.post(url=url, json=payload)

    return res.json()


def getCompetitionList(
    host: str,
    is_robot: bool = True,
) -> dict:
    """To get the list of available competitions.

    Args:
        host (str): the server address
        is_robot (bool, optional): whether to list robot competitions or
        student competitions. Defaults to True.

    Returns:
        dict: dict of competition list
    """
    if is_robot:
        # for robot only competitions
        api = "/api/competition/robotlist"
    else:
        # can also play a standard competition using the APIs
        api = "/api/competition/studentlist"

    url = urllib.parse.urljoin(host, api)
    res = requests.post(url=url)

    return res.json()


def getCompetitionData(
    host: str,
    access_token: str,
    competition_id: str,
) -> dict:
    """To get data about a particular competition

    Args:
        host (str): the server address
        access_token (str): the player's access token
        competition_id (str): id of the competition of interest

    Returns:
        dict: competition data as a dict
    """
    api = "/api/clientCompetitionData"
    url = urllib.parse.urljoin(host, api)
    headers = {"Authorization": "Bearer " + access_token}
    payload = {"competition_id": competition_id}
    res = requests.post(url=url, json=payload, headers=headers)

    return res.json()


def getRoundData(
    host: str,
    access_token: str,
    competition_id: str,
    round: int | None = None,
) -> dict:
    """To get data about a particular round of a competition

    Args:
        host (str): the server address
        access_token (str): the player's access token
        competition_id (str): id of the competition of interest
        round (int | None, optional): round number, take the current round if
        None. Defaults to None.

    Returns:
        dict: round data as a dict
    """
    api = "/api/clientRoundData"
    url = urllib.parse.urljoin(host, api)
    headers = {"Authorization": "Bearer " + access_token}
    payload = {"competition_id": competition_id}
    if round is not None:
        payload["round"] = round
    res = requests.post(url=url, json=payload, headers=headers)

    return res.json()


def postPriceAction(
    host: str,
    access_token: str,
    competition_id: str,
    price_action: int,
) -> dict:
    """To post a price decision to the current round of a competition

    Args:
        host (str): the server address
        access_token (str): the player's access token
        competition_id (str): id of the competition of interest
        price_action (int): price decision, one of the four possible values
        0, 1, 2, 3 (0 -- $60, 1 -- $54, 2 -- $48, 3 -- $36).

    Returns:
        dict: round data as a dict
    """
    api = "/api/competitionRoundPriceAction"
    url = urllib.parse.urljoin(host, api)
    headers = {"Authorization": "Bearer " + access_token}
    payload = {"competition_id": competition_id, "priceAction": price_action}
    res = requests.post(url=url, json=payload, headers=headers)

    return res.json()


if __name__ == "__main__":

    ### Parameters ###
    HOST = "http://localhost:3001"  # "https://retailer.casepp.com"
    # NOTE: replace the following with your own access token!!!
    ACCESS_TOKEN = "WmJjSSGiOVd_n5uVcv9LMb2jqhCQTNweta4uB-W0kYK"

    ### Free Play ###

    # start a new round of free play of seed=12345
    res = freePlayPriceAction(host=HOST, seed=12345, price_actions=[0])
    print(f"response: {res}")

    # move on one week with prices 1
    # NOTE: price_actions is the list of all previous and current prices
    res = freePlayPriceAction(host=HOST, seed=12345, price_actions=[0, 1])
    print(f"response: {res}")

    # move on another week with price 1
    # NOTE: price_actions is the list of all previous and current prices
    res = freePlayPriceAction(host=HOST, seed=12345, price_actions=[0, 1, 1])
    print(f"response: {res}")

    ### Competition ###

    # get the list of competitions for robots
    competition_list = getCompetitionList(host=HOST, is_robot=True)
    print(f"Competitions for robots: {competition_list}")

    # get competition data (for a new competition)
    competition_data = getCompetitionData(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
    )
    print(f"Competition_data: {competition_data}")

    # get round data (for a new competition)
    round_data = getRoundData(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
    )
    print(f"round_data: {round_data}")

    # post the 1st price action (Week 1 price is fixed at 0, the input has no effect)
    round_data = postPriceAction(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
        price_action=2,
    )
    print(f"round_data: {round_data}")

    # post the 2nd price action
    round_data = postPriceAction(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
        price_action=2,
    )
    print(f"round_data: {round_data}")

    # get the competition data (for an ongoing competition)
    competition_data = getCompetitionData(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
    )
    print(f"Competition_data: {competition_data}")

    # fix price_action at 2 and run all the way to the end
    price_action = 2
    while not round_data["data"]["isCompleted"]:
        round_data = postPriceAction(
            host=HOST,
            access_token=ACCESS_TOKEN,
            competition_id="TEST_ROBOT",
            price_action=price_action,
        )
        print(round_data)
        # you may set your own pricing strategy here
        price_action = 2

    # get the competition data (for a completed competition)
    competition_data = getCompetitionData(
        host=HOST,
        access_token=ACCESS_TOKEN,
        competition_id="TEST_ROBOT",
    )
    print(f"Competition_data: {competition_data}")