splatnet3_scraper.scraper.SplatNet_Scraper.get_matches(mode: str, detail: False, limit: int | None = None, existing_ids: list[str] | str | None = None, progress_callback: Callable[[int, int], None] | None = None) → QueryResponse
splatnet3_scraper.scraper.SplatNet_Scraper.get_matches(mode: str, detail: True, limit: int | None = None, existing_ids: list[str] | str | None = None, progress_callback: Callable[[int, int], None] | None = None) → tuple[splatnet3_scraper.query.responses.QueryResponse, list[splatnet3_scraper.query.responses.QueryResponse]]
splatnet3_scraper.scraper.SplatNet_Scraper.get_matches(mode: str, detail: bool = False, limit: int | None = None, existing_ids: list[str] | str | None = None, progress_callback: Callable[[int, int], None] | None = None) → QueryResponse | tuple[splatnet3_scraper.query.responses.QueryResponse, list[splatnet3_scraper.query.responses.QueryResponse]]

Gets matches for the given mode.

Parameters:
mode : str

The mode to get the battles for. Valid values are: “turf”, “anarchy”, “xbattle”, “private”, “challenge”, and “salmon”.

detail : bool

Whether to get the detailed results or not. Defaults to False.

limit : int | None

The maximum number of battles to get. If None, it will get all battles. Defaults to None.

existing_ids : list[str] | str | None

The existing IDs to check against. If a string is passed, it will return the results upon finding the first match. If a list is passed, it will return the results of all matches not in the list. If None, it will return all results. Defaults to None.

progress_callback : Callable[[int, int], None] | None

A callback function that will be called with the current index and the total number of battles. Defaults to None.

Raises:

ValueError – If the mode is not valid.

Returns:

  • QueryResponse – The summary query response, returned regardless of the value of detail.

  • (list[QueryResponse]) – The list of detailed query responses associated with each battle until the limit is reached. Only returned if detail is True, along with the summary query response.