Getting Started

Installation

bun

bun add @npldev/lpdb-ts-client

pnpm

pnpm add @npldev/lpdb-ts-client

npm

npm install @npldev/lpdb-ts-client

yarn

yarn add @npldev/lpdb-ts-client

Prerequisites

You need a Liquipedia API key to use this client. You can request one at Liquipedia API Portal.

Quick Start

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

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

// Query players from Dota 2
const response = await client.endpoint('/player').wiki('dota2').limit(10).execute()

console.log(response.result)

Basic Example

Here's a more complete example showing various features:

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

const client = new LPDBClient({
  apiKey: process.env.LIQUIPEDIA_API_KEY!,
})

async function main() {
  try {
    // Get French Valorant players
    const players = await client
      .endpoint('/player')
      .wiki('valorant')
      .conditions('[[nationality::France]]')
      .query('id, name, team')
      .limit(20)
      .order('name ASC')
      .execute()

    console.log('Players:', players.result)

    // Get upcoming CS2 matches with stream URLs
    const matches = await client
      .endpoint('/match')
      .wiki('counterstrike')
      .conditions('[[finished::0]]')
      .streamurls('true')
      .limit(5)
      .execute()

    console.log('Matches:', matches.result)
  } catch (error) {
    if (error instanceof LPDBError) {
      console.error(`API Error (${error.status}):`, error.message)
    }
  }
}

main()

Next Steps

• Learn about Configuration options
• Explore Basic Queries in depth
• See all available Endpoints