Resources

Resource classes wrap individual LPDB v3 endpoints. Each resource is accessible as an attribute on LiquipediaClient.

Base class

class liquipydia.Resource

Bases: object

Base resource wrapping a single LPDB v3 endpoint.

Provides list and paginate methods that delegate HTTP calls to the parent client. Subclasses set _endpoint to the API path segment (e.g. "player") and _model to the corresponding Pydantic model class for filter key validation.

Parameters:

client (LiquipediaClient) – The parent LiquipediaClient instance.

__init__(client)
list(wiki, *, conditions=None, query=None, limit=50, offset=0, order=None, groupby=None, rawstreams=False, streamurls=False, **filters)

Query this endpoint and return results.

Parameters:

  • wiki (str) – Wiki(s) to query (pipe-separate for multi-wiki, e.g. "dota2|counterstrike").

  • conditions (str | None (default: None)) – Filter expression using LPDB condition syntax.

  • query (str | None (default: None)) – Comma-separated list of fields to return.

  • limit (int (default: 50)) – Maximum number of results (1–1000).

  • offset (int (default: 0)) – Number of results to skip.

  • order (str | None (default: None)) – SQL-style ordering (e.g. "id ASC").

  • groupby (str | None (default: None)) – SQL-style grouping (e.g. "id ASC").

  • rawstreams (bool (default: False)) – Return raw stream data (/match endpoint only).

  • streamurls (bool (default: False)) – Return stream URLs (/match endpoint only).

  • **filters (str) – Keyword filters converted to conditions (e.g. name="Zen" becomes [[name::Zen]]). Prefix values with >, <, or ! for operators.

Return type:

ApiResponse

Returns:

Parsed API response.

paginate(wiki, *, conditions=None, query=None, order=None, groupby=None, rawstreams=False, streamurls=False, page_size=50, max_results=None, **filters)

Iterate through paginated results from this endpoint.

Yields individual record dicts, automatically requesting successive pages.

Parameters:

  • wiki (str) – Wiki(s) to query.

  • conditions (str | None (default: None)) – Filter expression using LPDB condition syntax.

  • query (str | None (default: None)) – Comma-separated list of fields to return.

  • order (str | None (default: None)) – SQL-style ordering.

  • groupby (str | None (default: None)) – SQL-style grouping.

  • rawstreams (bool (default: False)) – Return raw stream data (/match endpoint only).

  • streamurls (bool (default: False)) – Return stream URLs (/match endpoint only).

  • page_size (int (default: 50)) – Number of records per page (max 1000).

  • max_results (int | None (default: None)) – Stop after yielding this many records. None for unlimited.

  • **filters (str) – Keyword filters converted to conditions (e.g. name="Zen" becomes [[name::Zen]]). Prefix values with >, <, or ! for operators.

Yields:

Individual record dicts from the API.

Standard resources

These resources inherit list() and paginate() from Resource without modifications.

class liquipydia.BroadcastersResource

Bases: Resource

Resource for the /broadcasters endpoint.

class liquipydia.CompaniesResource

Bases: Resource

Resource for the /company endpoint.

class liquipydia.DatapointsResource

Bases: Resource

Resource for the /datapoint endpoint.

class liquipydia.ExternalMediaLinksResource

Bases: Resource

Resource for the /externalmedialink endpoint.

class liquipydia.PlacementsResource

Bases: Resource

Resource for the /placement endpoint.

class liquipydia.PlayersResource

Bases: Resource

Resource for the /player endpoint.

class liquipydia.SeriesResource

Bases: Resource

Resource for the /series endpoint.

class liquipydia.SquadPlayersResource

Bases: Resource

Resource for the /squadplayer endpoint.

class liquipydia.StandingsEntriesResource

Bases: Resource

Resource for the /standingsentry endpoint.

class liquipydia.StandingsTablesResource

Bases: Resource

Resource for the /standingstable endpoint.

class liquipydia.TeamsResource

Bases: Resource

Resource for the /team endpoint.

class liquipydia.TournamentsResource

Bases: Resource

Resource for the /tournament endpoint.

class liquipydia.TransfersResource

Bases: Resource

Resource for the /transfer endpoint.

Specialized resources

MatchResource

Inherits list() and paginate() from Resource. The rawstreams and streamurls parameters are only meaningful on this endpoint.

class liquipydia.MatchResource

Bases: Resource

Resource for the /match endpoint.

Supports rawstreams and streamurls parameters via the base list() and paginate() methods.

TeamTemplateResource

Different API signature — uses get() instead of list().

class liquipydia.TeamTemplateResource

Bases: object

Resource for the /teamtemplate endpoint (single template lookup).

This endpoint has a different parameter signature from standard resources and does not support conditions, limit, offset, or order.

Parameters:

client (LiquipediaClient) – The parent LiquipediaClient instance.

__init__(client)
get(wiki, template, *, date=None)

Get a single team template.

Parameters:

  • wiki (str) – Single wiki identifier (no multi-wiki).

  • template (str) – Template name of the team template (e.g. "teamliquid").

  • date (str | None (default: None)) – Date for historical logos (format: YYYY-MM-DD).

Return type:

ApiResponse

Returns:

Parsed API response.

TeamTemplateListResource

Different API signature — uses pagination parameter instead of limit/offset.

class liquipydia.TeamTemplateListResource

Bases: object

Resource for the /teamtemplatelist endpoint.

This endpoint has a different parameter signature from standard resources and does not support conditions, limit, offset, or order.

Parameters:

client (LiquipediaClient) – The parent LiquipediaClient instance.

__init__(client)
list(wiki, *, pagination=None)

Get a list of team templates.

Parameters:

  • wiki (str) – Single wiki identifier (no multi-wiki).

  • pagination (int | None (default: None)) – Page number.

Return type:

ApiResponse

Returns:

Parsed API response.