Examples

This section contains practical examples and use cases for Legend.

Basic Example

Here’s a simple example of using Legend to query data:

import { createLegend } from '@legend/core'

const legend = createLegend({
  apiKey: process.env.LEGEND_API_KEY,
})

async function getActiveUsers() {
  const users = await legend.query('users', {
    where: { status: 'active' },
    select: ['id', 'name', 'email'],
    limit: 100,
  })

  return users
}

getActiveUsers().then(console.log)

Advanced Example

Using Legend with TypeScript:

import { createLegend, type QueryOptions } from '@legend/core'

interface User {
  id: string
  name: string
  email: string
  status: 'active' | 'inactive'
}

const legend = createLegend({
  apiKey: process.env.LEGEND_API_KEY,
})

async function getActiveUsers(): Promise<User[]> {
  const options: QueryOptions<User> = {
    where: { status: 'active' },
    select: ['id', 'name', 'email'],
    limit: 100,
  }

  return legend.query<User>('users', options)
}

More examples coming soon!