Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Getting Started

Installation

pnpm
pnpm add @whisk/steakhouse

Quick Start

import { SteakhouseClient, getVaults, getVault, getStats } from "@whisk/steakhouse"
 
const client = new SteakhouseClient({
  apiKey: process.env.STEAKHOUSE_API_KEY!,
})
 
// List Steakhouse-curated vaults
const vaults = await getVaults(client)
 
// Get vault details
const vault = await getVault(client, {
  chainId: 1,
  vaultAddress: "0x...",
})
 
// Get stats & TVL
const stats = await getStats(client)

Next Steps

Requirements

RequirementVersion
Node.js>= 18
TypeScript>= 5.0

@whisk/steakhouse is an ESM-only package.