Class DeFiLlama

DeFi Llama API client Provides methods to interact with DeFi Llama's API endpoints

Hierarchy (View Summary)

DefiLlamaAPI
- DeFiLlama

Index

Constructors

Methods

getChains getCurrentProtocolTVL getHistoricalChainTVL getProtocols getProtocolTVL

Constructors

constructor

new DeFiLlama(customBaseUrl?: string): DeFiLlama
Creates a new DeFi Llama API client
Parameters
- OptionalcustomBaseUrl: string
  Optional custom base URL for the API
Returns DeFiLlama
Inherited from DefiLlamaAPI.constructor
- Defined in core/api.ts:20

Methods

getChains

getChains(): Promise<Chain[]>
Get all chains tracked by DeFi Llama

Returns Promise<Chain[]>
Promise with array of chains
- Defined in core/defillama.ts:58

getCurrentProtocolTVL

getCurrentProtocolTVL(protocol: string): Promise<number>
Get current TVL for a specific protocol
Parameters
- protocol: string
  Protocol identifier
Returns Promise<number>
Promise with current TVL value
- Defined in core/defillama.ts:49

getHistoricalChainTVL

getHistoricalChainTVL(
chain?: string,
formatted?: boolean,
): Promise<FormattedChainTVLAnalysis | ChainTVLDataPoint[]>
Get historical TVL data for a specific chain
Parameters
- Optionalchain: string
  Chain name (optional)
- formatted: boolean = false
  Whether to return formatted analysis
Returns Promise<FormattedChainTVLAnalysis | ChainTVLDataPoint[]>
Promise with chain TVL data or formatted analysis
- Defined in core/defillama.ts:69

getProtocols

getProtocols(): Promise<Protocol[]>
Get all protocols listed on DeFi Llama

Returns Promise<Protocol[]>
Promise with array of protocols
- Defined in core/defillama.ts:19

getProtocolTVL

getProtocolTVL(
protocol: string,
formatted?: boolean,
): Promise<ProtocolTVLResponse | FormattedProtocolAnalysis>
Get TVL data for a specific protocol
Parameters
- protocol: string
  Protocol identifier
- formatted: boolean = false
  Whether to return formatted analysis
Returns Promise<ProtocolTVLResponse | FormattedProtocolAnalysis>
Promise with protocol TVL data or formatted analysis
- Defined in core/defillama.ts:30