Skip to content

Endpoints

Standard Endpoints

These endpoints support all common parameters (wiki, conditions, query, limit, offset, order, groupby):

EndpointDescription
/playerPlayer information
/teamTeam information
/matchMatch data (has extra params)
/tournamentTournament information
/transferPlayer transfers
/placementTournament placements
/seriesSeries/leagues
/squadplayerTeam rosters
/broadcastersStream broadcasters
/companyOrganizations/companies
/datapointCustom data points
/externalmedialinkExternal media links
/standingsentryStanding entries
/standingstableStanding tables

Special Endpoints

/match

The match endpoint has additional parameters for stream data:

typescript
const matches = await client
  .endpoint('/match')
  .wiki('counterstrike')
  .rawstreams('true') // Get raw stream data
  .streamurls('true') // Get stream URLs
  .limit(10)
  .execute()
ParameterTypeDescription
rawstreams'true' | 'false'Include raw stream data
streamurls'true' | 'false'Include stream URLs

/teamtemplate

Get a single team template:

typescript
const template = await client
  .endpoint('/teamtemplate')
  .wiki('dota2')
  .template('teamliquid') // Required: template name
  .date('2020-01-01') // Optional: for historical logos
  .execute()
ParameterTypeRequiredDescription
wikistringYesWiki name
templatestringYesTeam template name
datestringNoDate for historical logos (YYYY-MM-DD)

/teamtemplatelist

Get a paginated list of team templates:

typescript
const templates = await client
  .endpoint('/teamtemplatelist')
  .wiki('leagueoflegends')
  .pagination(1) // Page number (200 per page)
  .execute()
ParameterTypeRequiredDescription
wikistringYesWiki name
paginationnumberNoPage number

Type Safety

The client is fully typed. Parameters that don't exist on an endpoint will cause TypeScript errors:

typescript
// This will cause a TypeScript error
client.endpoint('/player').rawstreams('true')
//                         ^^^^^^^^^^
// Property 'rawstreams' does not exist on QueryBuilder<'/player'>

// This works correctly
client.endpoint('/match').rawstreams('true')

Available Wikis

The Wiki type includes all supported wikis:

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

const wiki: Wiki = 'dota2' // Type-safe wiki names

Some popular wikis:

  • dota2
  • counterstrike
  • leagueoflegends
  • valorant
  • overwatch
  • starcraft2
  • rocketleague
  • fortnite

See the full list in the Types reference.

Released under the MIT License.