This class offers a user-level interface for pulling data from SplatNet 3. It is built upon the QueryHandler class and provides a top-level API that orchestrates multiple queries together to reduce the amount of work needed to pull data that users are likely to want.

Constructors¶

SplatNet_Scraper(query_handler)

Initializes a SplatNet_Scraper.

Methods¶

static from_config_file(config_path=None)

Creates a SplatNet_Scraper instance using the given config file.

static from_env(prefix='')

Creates a SplatNet_Scraper instance using the environment variables.

static from_s3s_config(config_path)

Creates a SplatNet_Scraper instance using the config file from s3s.

static from_session_token(session_token)

Creates a SplatNet_Scraper instance using the given session token.

static from_tokens(session_token, gtoken=None, bullet_token=None)

Creates a SplatNet_Scraper instance using the given tokens. This is useful if you already have the tokens and don’t want to have to retrieve them again. This does not guarantee that the tokens are valid, that will be checked when the first query is run.

get_matches(mode: str, detail: False, ...) → QueryResponse

get_matches(...) → tuple[splatnet3_scraper.query.responses.QueryResponse, list[splatnet3_scraper.query.responses.QueryResponse]]

get_matches(...) → QueryResponse | tuple[splatnet3_scraper.query.responses.QueryResponse, list[splatnet3_scraper.query.responses.QueryResponse]]

Gets matches for the given mode.

Properties¶

property query_handler : QueryHandler

The query handler used by the scraper.