LPDBClient

The main client class for interacting with the Liquipedia API.

Constructor

new LPDBClient(options: LPDBClientOptions)

Parameters

interface LPDBClientOptions {
  apiKey: string
  baseUrl?: string
}

Option	Type	Required	Default	Description
apiKey	string	Yes	-	Your Liquipedia API key
baseUrl	string	No	https://api.liquipedia.net/api/v3	API base URL

Example

import { LPDBClient } from '@npldev/lpdb-ts-client'

const client = new LPDBClient({
  apiKey: 'your-api-key',
})

Methods

endpoint

Creates a new query builder for the specified endpoint.

endpoint<T extends EndpointPath>(path: T): QueryBuilder<T>

Parameters

Parameter	Type	Description
path	EndpointPath	The API endpoint path

Returns

A QueryBuilder instance typed for the specific endpoint.

Example

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

executeQuery

Internal method to execute a query. Usually you should use QueryBuilder.execute() instead.

executeQuery(
  path: EndpointPath,
  params: Record<string, string | number | undefined>
): Promise<ApiResponse>

Type Exports

import type { LPDBClientOptions } from '@npldev/lpdb-ts-client'