QueryBuilder

A fluent builder for constructing API queries. The available methods depend on the endpoint type.

Creating a QueryBuilder

Query builders are created via LPDBClient.endpoint():

const builder = client.endpoint('/player')

Common Methods

These methods are available on all endpoints:

wiki

Set a single wiki to query.

wiki(value: Wiki): this

client.endpoint('/player').wiki('dota2')

wikis

Set multiple wikis to query (pipe-separated).

wikis(value: Wiki[]): this

client.endpoint('/player').wikis(['dota2', 'counterstrike'])

execute

Execute the query and return results.

execute(): Promise<ApiResponse>

const response = await client.endpoint('/player').wiki('dota2').execute()

build

Return the query parameters without executing.

build(): { path: T; params: Record<string, string | number | undefined> }

const query = client.endpoint('/player').wiki('dota2').limit(10).build()

// { path: '/player', params: { wiki: 'dota2', limit: 10 } }

Standard Query Methods

Available on most endpoints (not /teamtemplate or /teamtemplatelist):

conditions

conditions(value: string): this

Filter results using Liquipedia's condition syntax.

.conditions('[[nationality::France]] AND [[team::!]]')

query

query(value: string): this

Select specific fields to return.

.query('id, name, nationality')

limit

limit(value: number): this

Maximum number of results.

.limit(50)

offset

offset(value: number): this

Number of results to skip (for pagination).

.offset(100)

order

order(value: string): this

Sort order for results.

.order('name ASC')

groupby

groupby(value: string): this

Group results by field.

.groupby('nationality')

Match-Specific Methods

Only available on /match endpoint:

rawstreams

rawstreams(value: 'true' | 'false'): this

Include raw stream data.

streamurls

streamurls(value: 'true' | 'false'): this

Include stream URLs.

TeamTemplate-Specific Methods

Only available on /teamtemplate endpoint:

template

template(value: string): this

The team template name (required).

date

date(value: string): this

Date for historical logos (YYYY-MM-DD format).

TeamTemplateList-Specific Methods

Only available on /teamtemplatelist endpoint:

pagination

pagination(value: number): this

Page number (200 results per page).