Ctrl K
| Parameter | Type |
|---|---|
slug | STRING |
[
{
"description": "Get descriptive information and current stats of a protocol.",
"name": "getProtocol",
"parameters": {
"properties": {
"slug": {
"type": "string",
"example": "lido"
}
},
"required": [
"slug"
],
"type": "object"
}
},
{
"description": "Get the current TVL of a protocol.",
"name": "getProtocolTvl",
"parameters": {
"properties": {
"slug": {
"type": "string",
"example": "uniswap"
}
},
"required": [
"slug"
],
"type": "object"
}
},
{
"description": "Get the protocols that gained the most TVL.",
"name": "getTopGainers",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer",
"example": 10
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
},
"chain": {
"type": "string",
"example": "ethereum"
}
},
"required": [
"num_protocols"
],
"type": "object"
}
},
{
"description": "Get the protocols that had the highest percentage growth in TVL.",
"name": "getTopGrowers",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer",
"example": 10
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
},
"chain": {
"type": "string",
"example": "ethereum"
}
},
"required": [
"num_protocols"
],
"type": "object"
}
},
{
"description": "Get the protocols that lost the most TVl.",
"name": "getTopLosers",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer",
"example": 10
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
},
"chain": {
"type": "string",
"example": "ethereum"
}
},
"required": [
"num_protocols"
],
"type": "object"
}
},
{
"description": "Get the protocols that had the highest percentage loss in terms of TVl.",
"name": "getTopShrinkers",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer",
"example": 10
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
},
"chain": {
"type": "string",
"example": "ethereum"
}
},
"required": [
"num_protocols"
],
"type": "object"
}
},
{
"description": "Get historical TVL data of a protocl.",
"name": "getHistoricalProtocolTVL",
"parameters": {
"properties": {
"slug": {
"type": "string",
"example": "lido"
}
},
"required": [
"slug"
],
"type": "object"
}
},
{
"description": "Get the slug most similar to the given text.",
"name": "getSlug",
"parameters": {
"properties": {
"text": {
"type": "string",
"example": "uniswap"
}
},
"required": [
"text"
],
"type": "object"
}
},
{
"description": "Get the fees earned by a protocol",
"name": "getProtocolFees",
"parameters": {
"properties": {
"defillamaId": {
"type": "string"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
"required": [
"defillamaId"
],
"type": "object"
}
},
{
"description": "Get the protocols that have earned the most fees.",
"name": "getTopProtocolFees",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"chain": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
}
},
"type": "object"
}
},
{
"description": "Get the DefiLlamaID of a protocol",
"name": "getDefiLlamaID",
"parameters": {
"properties": {
"text": {
"type": "string",
"example": "uniswap"
}
},
"required": [
"text"
],
"type": "object"
}
},
{
"description": "Get the revenue earned by a protocol",
"name": "getProtocolRevenue",
"parameters": {
"properties": {
"defillamaId": {
"type": "string"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
"required": [
"defillamaId"
],
"type": "object"
}
},
{
"description": "Get the protocols that have earned the most revenue.",
"name": "getTopProtocolRevenue",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"chain": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"liquid staking",
"dexes",
"lending",
"bridge",
"CDP",
"yield",
"services",
"derivatives",
"yield aggregator",
"cross chain",
"launchpad",
"indexes",
"synthetics",
"RWA",
"liquidity manager",
"nft lending",
"insurance",
"algo-stables",
"privacy",
"payments",
"leveraged farming",
"nft marketplace",
"options",
"options vault",
"staking pool",
"prediction market",
"farm",
"uncollateralized lending",
"reserve currency",
"RWA lending",
"gaming",
"oracle"
],
"example": "liquid staking"
}
},
"type": "object"
}
},
{
"description": "Get the TVL for a specific chain or L2.",
"name": "getChainTVL",
"parameters": {
"properties": {
"chain": {
"type": "string",
"example": "ethereum"
}
},
"type": "object"
}
},
{
"description": "Get the change in TVL for a specific chain or L2 over a given time period.",
"name": "getChainTVLChange",
"parameters": {
"properties": {
"chain": {
"type": "string",
"example": "ethereum"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
},
"required": [
"chain"
],
"type": "object"
}
},
{
"description": "Get the net bridge flow for a specific chain or L2 over a given time period.",
"name": "getNetBridgeFlow",
"parameters": {
"properties": {
"chain": {
"type": "string",
"example": "ethereum"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
},
"required": [
"chain"
],
"type": "object"
}
},
{
"description": "Get the net bridge flow for all chains and L2s over a given time period.",
"name": "getAllNetBridgeFlows",
"parameters": {
"properties": {
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
},
"type": "object"
}
},
{
"description": "Get the top yielding pools.",
"name": "getTopYields",
"parameters": {
"properties": {
"num_pools": {
"type": "integer",
"minimum": 1,
"default": 10
},
"chain": {
"type": "string",
"example": "ethereum"
},
"stablecoin": {
"type": "boolean"
},
"token": {
"type": "string",
"examples": [
"BTC",
"RADAR-WBNB",
"ETH/XVS"
]
},
"single_sided": {
"type": "boolean"
},
"outlook": {
"type": "string",
"enum": [
"stable",
"up",
"down"
],
"example": "up"
}
},
"type": "object"
}
},
{
"description": "Get information about what this plugin can do.",
"name": "getFeatures",
"parameters": {
"properties": {},
"type": "object"
}
},
{
"description": "Get link to a form where you can give feedback on the plugin.",
"name": "getFeedbackForm",
"parameters": {
"properties": {},
"type": "object"
}
},
{
"description": "Get the chains that have gained the most TVL.",
"name": "getTopChainGainers",
"parameters": {
"properties": {
"num_chains": {
"type": "integer",
"example": 5
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
}
},
"type": "object"
}
},
{
"description": "Get the chains that have the highest percentage growth in TVL",
"name": "getTopChainGrowers",
"parameters": {
"properties": {
"num_chains": {
"type": "integer",
"example": 5
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
}
},
"type": "object"
}
},
{
"description": "Get the chains that have lost the most TVL.",
"name": "getTopChainLosers",
"parameters": {
"properties": {
"num_chains": {
"type": "integer",
"example": 5
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
}
},
"type": "object"
}
},
{
"description": "Get the chains that the highest percentage loss in TVL.",
"name": "getTopChainShrinkers",
"parameters": {
"properties": {
"num_chains": {
"type": "integer",
"example": 5
},
"min_tvl": {
"type": "number",
"format": "float",
"example": 1000000
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
}
},
"type": "object"
}
},
{
"description": "Returns interesting/important data on what is happening on-chain re protocols, chains and yields.",
"name": "getInteresting",
"parameters": {
"properties": {
"time_period": {
"type": "string",
"enum": [
"day",
"week"
],
"default": "week"
}
},
"type": "object"
}
},
{
"description": "Get the trading volume of a dex",
"name": "getDexVolume",
"parameters": {
"properties": {
"defillamaId": {
"type": "string"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
"required": [
"defillamaId"
],
"type": "object"
}
},
{
"description": "Get the dexes with the highest trading volume.",
"name": "getTopDexVolume",
"parameters": {
"properties": {
"num_protocols": {
"type": "integer"
},
"time_period": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
},
"chain": {
"type": "string"
}
},
"type": "object"
}
}
]
