加密资产指南
加密资产指南 · Actions GPT
Crypto market information Plugin
A comprehensive tool for cryptocurrency and NFT data and Defi protocol analytics. It offers a range of features including OHLCV data for spot, futures, and perpetual contracts, funding rate analysis, long/short ratio and Open Interest (OI) for futures and options, liquidation statistics, gas prices across blockchains, contract intelligence via address, NFT rankings and details, trending cryptocurrencies, and DeFi protocol data such as Total Value Locked (TVL).
GET /get_current_utc_datetimeReturns current UTC+0 time. Useful when 'now' or 'current' is mentioned by users. Helps ChatGPT provide exact time during conversations.GET /utc_datetime_to_timestamp/{datetime}Generates accurate timestamp needed by other APIs. Assists ChatGPT in providing precise timestamps for data fetching and manipulation in various contexts.GET /spot/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}This API returns OHLCV price data for a specified cryptocurrency spot over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.GET /future/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{expireDay}/{startTs}/{endTs}/{timeframe}This API returns OHLCV prcie data for a specified cryptocurrency future over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.GET /swap/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}This API returns OHLCV prcie data for a specified cryptocurrency PerpetualFutures/PerpetualSwaps/PerpetualContracts over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.GET /swap/funding_rate/{exchange}/{baseCurrency}/{quoteCurrency}Real-time funding rate of specific PerpetualFutures/PerpetualSwaps/PerpetualContracts.GET /swap/funding_rate_history/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}Funding rate history of specific PerpetualFutures/PerpetualSwaps/PerpetualContracts.GET /long_short_ratio/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}This API provides LongShortRatio data across three dimensions. 'GlobalAccount' (ratio of long to short account numbers across all exchanges), 'WhalesAccount' (ratio of long to short accounts among large holders), and 'WhalesPosition' (ratio of long to short position volume among large holders).GET /future/open_interest/{exchange}/{currency}Access open interest data for specific expiry date futuresGET /liquidation_topProvides 24-hour liquidation data for major cryptocurrencies, giving insights into market volatility.GET /liquidation_infoRetrieve recent total liquidation data from the cryptocurrency market with this API, a tool for understanding market turbulence.GET /gas_price/{network}Get current gas prices of different blockchains, providing key insights for transaction planning.GET /get_coin_info_from_contract_address/{id}/{contract_address}Provides detailed information about a blockchain contract, as well as associated cryptocurrency data, using the contract's address.GET /get_nft_list/{blockchain_name}/{ranking_type}Provides rankings of NFTs based on market value, floor price, and 24-hour trading volume, delivering a comprehensive overview of top-performing digital assets.GET /get_nft_details/{nft_name}Provides detailed information and market data for a specified NFT, enabling comprehensive understanding of the digital asset.GET /search/trendingTop-7 trending coins on CoinGecko as searched by users in the last 24 hours (Ordered by most popular first)GET /companies/public_treasury/{coin_id}Get public companies bitcoin or ethereum holdings (Ordered by total holdings descending)GET /get_tvl_listThis API returns comprehensive details of the top 100 DeFi protocols, including unique ID, name, contract address, URL, description, blockchain, logo, audits, category, chains used, TVL, price changes, and token breakdowns.GET /get_tvl_protocol/{protocol}Retrieve detailed information about any specified DeFi protocol. The information includes unique ID, name, contract address, URL, description, blockchain, logo, audits, category, chains used, TVL, price changes, and token breakdowns.GET /get_current_tvl_of_all_chainsProvides a list of the total value locked (TVL) for all known blockchains, giving insights into the assets secured across different blockchain networks.GET /option/detail/{exchange}/{baseCurrency}/{expireDay}/{strikePrice}/{type}This API endpoint provides detailed market information for a specific cryptocurrency option, including price, volume, option greeks, underlying index, and more.GET /volatility_index/{currency}/{startTs}/{endTs}/{timeframe}Retrieve the 10-day volatility index of a cryptocurrency across different platforms, including 'DVOL' from Deribit and 'VIV' from volmex, help users understand the volatility of the market.GET /get_deribit_call_put_open_interest_ratio/{currency}Provides the ratio of open interest for call and put options for a specific cryptocurrency. A ratio greater than 1 indicates bearish sentiment, while a ratio less than 1 indicates bullish sentiment.
Schéma original API
{
"openapi": "3.0.1",
"info": {
"title": "Crypto market information Plugin",
"description": "A comprehensive tool for cryptocurrency and NFT data and Defi protocol analytics. It offers a range of features including OHLCV data for spot, futures, and perpetual contracts, funding rate analysis, long/short ratio and Open Interest (OI) for futures and options, liquidation statistics, gas prices across blockchains, contract intelligence via address, NFT rankings and details, trending cryptocurrencies, and DeFi protocol data such as Total Value Locked (TVL).",
"version": "v1"
},
"servers": [
{
"url": "https://chatgptpi.signalplus.com"
}
],
"paths": {
"/get_current_utc_datetime": {
"get": {
"operationId": "getCurrentUTCTime",
"summary": "Returns current UTC+0 time. Useful when 'now' or 'current' is mentioned by users. Helps ChatGPT provide exact time during conversations.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getCurrentUTCTime"
}
}
}
}
}
}
},
"/utc_datetime_to_timestamp/{datetime}": {
"get": {
"operationId": "utcDatetimeToTimestamp",
"summary": "Generates accurate timestamp needed by other APIs. Assists ChatGPT in providing precise timestamps for data fetching and manipulation in various contexts.",
"parameters": [
{
"in": "path",
"name": "datetime",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a UTC+0 time string in the format \"YYYY-MM-DD HH:MM:SS\" (e.g. \"2023-06-13 13:23:17\") to be converted into a Unix timestamp."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/utcDatetimeToTimestamp"
}
}
}
}
}
}
},
"/spot/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}": {
"get": {
"operationId": "getSpotOHLCV",
"summary": "This API returns OHLCV price data for a specified cryptocurrency spot over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\"."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "timeframe",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter is for specifying the time interval for the historical BTC price data. Like '1m','30m','1h','1d','3d','1w','1M'."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getSpotOHLCV"
}
}
}
}
}
}
},
"/future/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{expireDay}/{startTs}/{endTs}/{timeframe}": {
"get": {
"operationId": "getFuturesOHLCV",
"summary": "This API returns OHLCV prcie data for a specified cryptocurrency future over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\"."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
},
{
"in": "path",
"name": "expireDay",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the expire date of the futures, use the format ‘YYMMDD’(e.g., 230630 stands for 30 Jun 2023)."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "timeframe",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter is for specifying the time interval for the historical BTC price data. Like '1m','30m','1h','1d','3d','1w','1M'."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getFuturesOHLCV"
}
}
}
}
}
}
},
"/swap/ohlcv/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}": {
"get": {
"operationId": "getPerpetualOHLCV",
"summary": "This API returns OHLCV prcie data for a specified cryptocurrency PerpetualFutures/PerpetualSwaps/PerpetualContracts over a given time period. Users can input a digital currency's identifier and desired date range for comprehensive price trends analysis.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\".."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical price data you want to retrieve."
},
{
"in": "path",
"name": "timeframe",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter is for specifying the time interval for the historical BTC price data. Like '1m','30m','1h','1d','3d','1w','1M'."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getSwapOHLCV"
}
}
}
}
}
}
},
"/swap/funding_rate/{exchange}/{baseCurrency}/{quoteCurrency}": {
"get": {
"operationId": "getPerpetualFundingRate",
"summary": "Real-time funding rate of specific PerpetualFutures/PerpetualSwaps/PerpetualContracts.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\".."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getPerpetualFundingRate"
}
}
}
}
}
}
},
"/swap/funding_rate_history/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}": {
"get": {
"operationId": "getPerpetualFundingRateHistory",
"summary": "Funding rate history of specific PerpetualFutures/PerpetualSwaps/PerpetualContracts.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\".."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical funding rate data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical funding rate data you want to retrieve."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getPerpetualFundingRateHistory"
}
}
}
}
}
}
},
"/long_short_ratio/{exchange}/{baseCurrency}/{quoteCurrency}/{startTs}/{endTs}/{timeframe}": {
"get": {
"operationId": "getLongShortRatio",
"summary": "This API provides LongShortRatio data across three dimensions. 'GlobalAccount' (ratio of long to short account numbers across all exchanges), 'WhalesAccount' (ratio of long to short accounts among large holders), and 'WhalesPosition' (ratio of long to short position volume among large holders).",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The base currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", all should return \"btc\"."
},
{
"in": "path",
"name": "quoteCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "The quote currency in a currency pair. For instance, in \"btc/usd\", it is \"usd\"; in \"eth/usdt\", it is \"usdt\"; in \"btc usd spot\", it is \"usd\"; in \"btc/eth\", it is \"eth\"."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical data you want to retrieve."
},
{
"in": "path",
"name": "timeframe",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter is for specifying the time interval for the historical data. Must in \"5m\",\"15m\",\"30m\",\"1h\",\"2h\",\"4h\",\"6h\",\"12h\",\"1d\"."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getLongShortRatio"
}
}
}
}
}
}
},
"/future/open_interest/{exchange}/{currency}": {
"get": {
"operationId": "getFuturesOpenInterest",
"summary": "Access open interest data for specific expiry date futures",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Binance' as default."
},
{
"in": "path",
"name": "currency",
"schema": {
"type": "string"
},
"required": true,
"description": "The currency in a currency pair. For instance, in \"btc/usd\", \"btc/usdt\", \"btc swap\", \"btc perp\", \"btc\", all should return \"btc\"."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getFuturesOpenInterest"
}
}
}
}
}
}
},
"/liquidation_top": {
"get": {
"operationId": "getLiquidationList",
"summary": "Provides 24-hour liquidation data for major cryptocurrencies, giving insights into market volatility.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getLiquidationList"
}
}
}
}
}
}
},
"/liquidation_info": {
"get": {
"operationId": "getTotalLiquidation",
"summary": "Retrieve recent total liquidation data from the cryptocurrency market with this API, a tool for understanding market turbulence.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getTotalLiquidation"
}
}
}
}
}
}
},
"/gas_price/{network}": {
"get": {
"operationId": "getGasPrice",
"summary": "Get current gas prices of different blockchains, providing key insights for transaction planning.",
"parameters": [
{
"in": "path",
"name": "network",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the blockchain, like'eth', 'ethereum','bsc','arbitrum','optimism','polygon','avalanche'."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getGasPrice"
}
}
}
}
}
}
},
"/get_coin_info_from_contract_address/{id}/{contract_address}": {
"get": {
"operationId": "getContractInfo",
"summary": "Provides detailed information about a blockchain contract, as well as associated cryptocurrency data, using the contract's address.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the id of the assect platform. If not specified, use '1' as default."
},
{
"in": "path",
"name": "contract_address",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the address of the contract you wish to query for detailed information."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getContractInfo"
}
}
}
}
}
}
},
"/get_nft_list/{blockchain_name}/{ranking_type}": {
"get": {
"operationId": "getTopNFT",
"summary": "Provides rankings of NFTs based on market value, floor price, and 24-hour trading volume, delivering a comprehensive overview of top-performing digital assets.",
"parameters": [
{
"in": "path",
"name": "blockchain_name",
"schema": {
"type": "string"
},
"required": true,
"description": "Specify the blockchain where the NFT resides. If unknown, input 'Ethereum' as a default.blockchain_name_list"
},
{
"in": "path",
"name": "ranking_type",
"schema": {
"type": "string"
},
"required": true,
"description": "Select the ranking criteria from 'market cap', 'floor price', or 'volume'.\""
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getTopNFT"
}
}
}
}
}
}
},
"/get_nft_details/{nft_name}": {
"get": {
"operationId": "getNFTinfo",
"summary": "Provides detailed information and market data for a specified NFT, enabling comprehensive understanding of the digital asset.",
"parameters": [
{
"in": "path",
"name": "nft_name",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name or ID of the NFT for which you wish to retrieve detailed information and market data."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getNFTinfo"
}
}
}
}
}
}
},
"/search/trending": {
"get": {
"operationId": "getCoinTrending",
"summary": "Top-7 trending coins on CoinGecko as searched by users in the last 24 hours (Ordered by most popular first)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getCoinTrending"
}
}
}
}
}
}
},
"/companies/public_treasury/{coin_id}": {
"get": {
"operationId": "GetPublicCompaniesHoldingForCrypto",
"summary": "Get public companies bitcoin or ethereum holdings (Ordered by total holdings descending)",
"parameters": [
{
"in": "path",
"name": "coin_id",
"schema": {
"type": "string"
},
"required": true,
"description": "Input 'bitcoin' or 'ethereum';"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPublicCompaniesHoldingForCrypto"
}
}
}
}
}
}
},
"/get_tvl_list": {
"get": {
"operationId": "getTopDefiProtocalList",
"summary": "This API returns comprehensive details of the top 100 DeFi protocols, including unique ID, name, contract address, URL, description, blockchain, logo, audits, category, chains used, TVL, price changes, and token breakdowns.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getTopDefiProtocalList"
}
}
}
}
}
}
},
"/get_tvl_protocol/{protocol}": {
"get": {
"operationId": "GetDefiProtocalDetail",
"summary": "Retrieve detailed information about any specified DeFi protocol. The information includes unique ID, name, contract address, URL, description, blockchain, logo, audits, category, chains used, TVL, price changes, and token breakdowns.",
"parameters": [
{
"in": "path",
"name": "protocol",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the DeFi protocol you wish to retrieve detailed information about."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetDefiProtocalDetail"
}
}
}
}
}
}
},
"/get_current_tvl_of_all_chains": {
"get": {
"operationId": "getBlockchainTVL",
"summary": "Provides a list of the total value locked (TVL) for all known blockchains, giving insights into the assets secured across different blockchain networks.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getBlockchainTVL"
}
}
}
}
}
}
},
"/option/detail/{exchange}/{baseCurrency}/{expireDay}/{strikePrice}/{type}": {
"get": {
"operationId": "getOptionMarketData",
"summary": "This API endpoint provides detailed market information for a specific cryptocurrency option, including price, volume, option greeks, underlying index, and more.",
"parameters": [
{
"in": "path",
"name": "exchange",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the name of the cryptocurrency exchange. If not specified, use 'Deribit' as default."
},
{
"in": "path",
"name": "baseCurrency",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the underlying asset (e.g., 'BTC') of the option you want to query.\""
},
{
"in": "path",
"name": "expireDay",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the expire date of the option, use the format ‘YYMMDD’(e.g., 230630 stands for 30 Jun 2023)."
},
{
"in": "path",
"name": "strikePrice",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the strike price of the option."
},
{
"in": "path",
"name": "type",
"schema": {
"type": "string"
},
"required": true,
"description": "Input 'c' for call options or 'p' for put options to specify the type of option."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getOptionDetails"
}
}
}
}
}
}
},
"/volatility_index/{currency}/{startTs}/{endTs}/{timeframe}": {
"get": {
"operationId": "getVOlIndex",
"summary": "Retrieve the 10-day volatility index of a cryptocurrency across different platforms, including 'DVOL' from Deribit and 'VIV' from volmex, help users understand the volatility of the market.",
"parameters": [
{
"in": "path",
"name": "currency",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the underlying asset (e.g., 'BTC') of the vol index."
},
{
"in": "path",
"name": "startTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the start date and time for the historical data you want to retrieve."
},
{
"in": "path",
"name": "endTs",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter requires a 10-digit Unix timestamp representing the end date and time for the historical data you want to retrieve."
},
{
"in": "path",
"name": "timeframe",
"schema": {
"type": "string"
},
"required": true,
"description": "This parameter is for specifying the time interval for the historical data. Must in '1m', '1h', '1d'."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getVOlIndex"
}
}
}
}
}
}
},
"/get_deribit_call_put_open_interest_ratio/{currency}": {
"get": {
"operationId": "getOptionCallPutRatio",
"summary": "Provides the ratio of open interest for call and put options for a specific cryptocurrency. A ratio greater than 1 indicates bearish sentiment, while a ratio less than 1 indicates bullish sentiment.",
"parameters": [
{
"in": "path",
"name": "currency",
"schema": {
"type": "string"
},
"required": true,
"description": "Input the underlying asset (e.g., 'BTC') of the vol index."
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/getOptionCallPutRatio"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"getSpotOHLCV": {
"type": "object"
},
"getFuturesOHLCV": {
"type": "object"
},
"getPerpetualOHLCV": {
"type": "object"
},
"getPerpetualFundingRate": {
"type": "object"
},
"getLongShortRatio": {
"type": "object"
},
"getFuturesOpenInterest": {
"type": "object"
},
"getLiquidationList": {
"type": "object"
},
"getTotalLiquidation": {
"type": "object"
},
"getGasPrice": {
"type": "object"
},
"getContractInfo": {
"type": "object"
},
"getTopNFT": {
"type": "object"
},
"getNFTinfo": {
"type": "object"
},
"getCoinTrending": {
"type": "object"
},
"GetPublicCompaniesHoldingForCrypto": {
"type": "object"
},
"getTopDefiProtocalList": {
"type": "object"
},
"GetDefiProtocalDetail": {
"type": "object"
},
"getBlockchainTVL": {
"type": "object"
},
"getOptionDetails": {
"type": "object"
},
"getVOlIndex": {
"type": "object"
},
"getOptionCallPutRatio": {
"type": "object"
},
"getPerpetualFundingRateHistory": {
"type": "object"
},
"getCurrentUTCTime": {
"type": "object"
},
"utcDatetimeToTimestamp": {
"type": "object"
}
}
}
}Defillama
Get current and historical stats on DeFi protocols and blockchains.
GET /protocol/{slug}Get descriptive information and current stats of a protocol.GET /tvl/{slug}getProtocolTvlGet the current TVL of a protocol.
GET /top_gainers/{num_protocols}Get the protocols that gained the most TVL.GET /top_growers/{num_protocols}Get the protocols that had the highest percentage growth in TVL.GET /top_losers/{num_protocols}Get the protocols that lost the most TVl.GET /top_shrinkers/{num_protocols}Get the protocols that had the highest percentage loss in terms of TVl.GET /historical_protocol_tvl/{slug}Get historical TVL data of a protocl.GET /get_slugGet the slug most similar to the given text.GET /get_protocol_feesGet the fees earned by a protocolGET /top_protocol_feesGet the protocols that have earned the most fees.GET /get_defillamaIdGet the DefiLlamaID of a protocolGET /get_protocol_revenueGet the revenue earned by a protocolGET /top_protocol_revenueGet the protocols that have earned the most revenue.GET /get_chain_tvlGet the TVL for a specific chain or L2.GET /get_chain_tvl_changeGet the change in TVL for a specific chain or L2 over a given time period.GET /get_net_bridge_flowGet the net bridge flow for a specific chain or L2 over a given time period.GET /get_all_net_bridge_flowsGet the net bridge flow for all chains and L2s over a given time period.GET /get_top_yieldsGet the top yielding pools.GET /get_featuresGet information about what this plugin can do.GET /get_feedback_formGet link to a form where you can give feedback on the plugin.GET /top_chain_gainersGet the chains that have gained the most TVL.GET /top_chain_growersGet the chains that have the highest percentage growth in TVLGET /top_chain_losersGet the chains that have lost the most TVL.GET /top_chain_shrinkersGet the chains that the highest percentage loss in TVL.GET /get_interestingReturns interesting/important data on what is happening on-chain re protocols, chains and yields.GET /get_dex_volumeGet the trading volume of a dexGET /top_dex_volumeGet the dexes with the highest trading volume.
Schéma original API
{
"openapi": "3.0.1",
"info": {
"title": "Defillama",
"description": "Get current and historical stats on DeFi protocols and blockchains.",
"version": "v1"
},
"servers": [
{
"url": "https://llamawrapper-prod.onrender.com"
}
],
"paths": {
"/protocol/{slug}": {
"get": {
"operationId": "getProtocol",
"summary": "Get descriptive information and current stats of a protocol.",
"parameters": [
{
"in": "path",
"name": "slug",
"schema": {
"type": "string",
"example": "lido"
},
"required": true,
"description": "Used to filter protocols by their slug."
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "Protocol not found"
},
"500": {
"description": "Could not retrieve protocols."
}
}
}
},
"/tvl/{slug}": {
"get": {
"operationId": "getProtocolTvl",
"description": "Get the current TVL of a protocol.",
"parameters": [
{
"in": "path",
"name": "slug",
"schema": {
"type": "string",
"example": "uniswap"
},
"required": true,
"description": "Used to filter protocols by their slug."
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Could not retrieve TVL data."
}
}
}
},
"/top_gainers/{num_protocols}": {
"get": {
"operationId": "getTopGainers",
"summary": "Get the protocols that gained the most TVL.",
"parameters": [
{
"in": "path",
"name": "num_protocols",
"schema": {
"type": "integer",
"example": 10
},
"required": true,
"description": "The number of top gainers you want to see. Default to 10."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a protocol should have to be included. Defaults to 100000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"required": false,
"description": "The time period in which the change occured. Can be 'hour', 'day', or 'week'. Defaults to 'week'."
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
},
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to filter protocols by.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Error processing data or Could not retrieve protocols."
}
}
}
},
"/top_growers/{num_protocols}": {
"get": {
"operationId": "getTopGrowers",
"summary": "Get the protocols that had the highest percentage growth in TVL.",
"parameters": [
{
"in": "path",
"name": "num_protocols",
"schema": {
"type": "integer",
"example": 10
},
"required": true,
"description": "The number of top gainers you want to see. Default to 10."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a protocol should have to be included. Defaults to 100000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"required": false,
"description": "The time period in which the change occured. Can be 'hour', 'day', or 'week'. Defaults to 'week'."
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
},
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to filter protocols by.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Error processing data or Could not retrieve protocols."
}
}
}
},
"/top_losers/{num_protocols}": {
"get": {
"operationId": "getTopLosers",
"summary": "Get the protocols that lost the most TVl.",
"parameters": [
{
"in": "path",
"name": "num_protocols",
"schema": {
"type": "integer",
"example": 10
},
"required": true,
"description": "The number of top gainers you want to see. Default to 10."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a protocol should have to be included. Defaults to 100000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"required": false,
"description": "The time period in which the change occured. Can be 'hour', 'day', or 'week'. Defaults to 'week'."
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
},
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to filter protocols by.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Error processing data or Could not retrieve protocols."
}
}
}
},
"/top_shrinkers/{num_protocols}": {
"get": {
"operationId": "getTopShrinkers",
"summary": "Get the protocols that had the highest percentage loss in terms of TVl.",
"parameters": [
{
"in": "path",
"name": "num_protocols",
"schema": {
"type": "integer",
"example": 10
},
"required": true,
"description": "The number of top gainers you want to see. Default to 10."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a protocol should have to be included. Defaults to 100000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"hour",
"day",
"week"
],
"example": "day"
},
"required": false,
"description": "The time period in which the change occured. Can be 'hour', 'day', or 'week'. Defaults to 'week'."
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
},
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to filter protocols by.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Error processing data or Could not retrieve protocols."
}
}
}
},
"/historical_protocol_tvl/{slug}": {
"get": {
"operationId": "getHistoricalProtocolTVL",
"summary": "Get historical TVL data of a protocl.",
"parameters": [
{
"in": "path",
"name": "slug",
"schema": {
"type": "string",
"example": "lido"
},
"required": true,
"description": "Used to filter protocols by their slug."
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Could not retrieve protocol data."
}
}
}
},
"/get_slug": {
"get": {
"operationId": "getSlug",
"summary": "Get the slug most similar to the given text.",
"parameters": [
{
"in": "query",
"name": "text",
"schema": {
"type": "string",
"example": "uniswap"
},
"required": true,
"description": "The text to match against the available slugs."
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "No matching slug found."
},
"500": {
"description": "Could not retrieve protocol."
}
}
}
},
"/get_protocol_fees": {
"get": {
"operationId": "getProtocolFees",
"summary": "Get the fees earned by a protocol",
"parameters": [
{
"name": "defillamaId",
"in": "query",
"description": "The DefiLlamaID of the protocol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the fees were collected. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Missing defillamaId parameter or Invalid time_period parameter."
},
"404": {
"description": "No protocol found with the given defillamaId."
},
"500": {
"description": "Could not retrieve protocol."
}
}
}
},
"/top_protocol_fees": {
"get": {
"operationId": "getTopProtocolFees",
"summary": "Get the protocols that have earned the most fees.",
"parameters": [
{
"name": "num_protocols",
"in": "query",
"description": "The number of top protocols to return. Default to 10.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the fees were collected. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
{
"name": "chain",
"in": "query",
"description": "Name of the blockchain or L2 to filter protocol fees by.",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Invalid time_period parameter."
},
"500": {
"description": "Could not retrieve fee data."
}
}
}
},
"/get_defillamaId": {
"get": {
"operationId": "getDefiLlamaID",
"summary": "Get the DefiLlamaID of a protocol",
"parameters": [
{
"name": "text",
"in": "query",
"description": "The name of the protocol",
"required": true,
"schema": {
"type": "string",
"example": "uniswap"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "No fee and revenue data for this protocol."
},
"500": {
"description": "Could not retrieve protocol."
}
}
}
},
"/get_protocol_revenue": {
"get": {
"operationId": "getProtocolRevenue",
"summary": "Get the revenue earned by a protocol",
"parameters": [
{
"name": "defillamaId",
"in": "query",
"description": "The DefiLlamaID of the protocol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the revenue was earned. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Missing defillamaId parameter or invalid time_period parameter."
},
"404": {
"description": "No protocol found with the given defillamaId."
},
"500": {
"description": "Could not retrieve protocol."
}
}
}
},
"/top_protocol_revenue": {
"get": {
"operationId": "getTopProtocolRevenue",
"summary": "Get the protocols that have earned the most revenue.",
"parameters": [
{
"name": "num_protocols",
"in": "query",
"description": "The number of top protocols to return. Default to 10.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the revenue was earned. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
{
"name": "chain",
"in": "query",
"description": "Name of the blockchain or L2 to filter protocol revenue by.",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "category",
"schema": {
"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"
},
"required": false,
"description": "Category to filter protocols by."
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Invalid time_period parameter."
},
"500": {
"description": "Could not retrieve revenue data."
}
}
}
},
"/get_chain_tvl": {
"get": {
"operationId": "getChainTVL",
"summary": "Get the TVL for a specific chain or L2.",
"parameters": [
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to retrieve TVL for.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "No chain found with the provided name."
},
"500": {
"description": "Could not retrieve chain data."
}
}
}
},
"/get_chain_tvl_change": {
"get": {
"operationId": "getChainTVLChange",
"summary": "Get the change in TVL for a specific chain or L2 over a given time period.",
"parameters": [
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to retrieve TVL change for.",
"required": true,
"schema": {
"type": "string",
"example": "ethereum"
}
},
{
"name": "time_period",
"in": "query",
"description": "Time period for TVL change calculation. Can be day, week or month.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"404": {
"description": "No chain found with the provided name."
},
"500": {
"description": "Could not retrieve chain data."
}
}
}
},
"/get_net_bridge_flow": {
"get": {
"operationId": "getNetBridgeFlow",
"summary": "Get the net bridge flow for a specific chain or L2 over a given time period.",
"parameters": [
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to retrieve net bridge flow for.",
"required": true,
"schema": {
"type": "string",
"example": "ethereum"
}
},
{
"name": "time_period",
"in": "query",
"description": "Time period for net bridge flow calculation. Can be day, week or month.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/get_all_net_bridge_flows": {
"get": {
"operationId": "getAllNetBridgeFlows",
"summary": "Get the net bridge flow for all chains and L2s over a given time period.",
"parameters": [
{
"name": "time_period",
"in": "query",
"description": "Time period for net bridge flow calculation. Can be day, week or month.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"default": "month"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/get_top_yields": {
"get": {
"operationId": "getTopYields",
"summary": "Get the top yielding pools.",
"parameters": [
{
"name": "num_pools",
"in": "query",
"description": "Number of pools to retrieve. Default is 10.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 10
}
},
{
"name": "chain",
"in": "query",
"description": "Name of the chain or L2 to filter pools by.",
"required": false,
"schema": {
"type": "string",
"example": "ethereum"
}
},
{
"name": "stablecoin",
"in": "query",
"description": "Flag indicating whether to filter for stablecoin yield pools.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "token",
"in": "query",
"description": "Token or token pair to filter pools by.",
"required": false,
"schema": {
"type": "string"
},
"examples": {
"singleToken": {
"value": "BTC",
"summary": "Single token"
},
"dualTokenDash": {
"value": "RADAR-WBNB",
"summary": "Two tokens separated by a dash"
},
"dualTokenSlash": {
"value": "ETH/XVS",
"summary": "Two tokens separated by a slash"
}
}
},
{
"name": "single_sided",
"in": "query",
"description": "Flag indicating whether to filter for single-sided yield pools.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "outlook",
"in": "query",
"description": "Future outlook for the yield of this pool.",
"required": false,
"schema": {
"type": "string",
"enum": [
"stable",
"up",
"down"
],
"example": "up"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/get_features": {
"get": {
"operationId": "getFeatures",
"summary": "Get information about what this plugin can do.",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/get_feedback_form": {
"get": {
"operationId": "getFeedbackForm",
"summary": "Get link to a form where you can give feedback on the plugin.",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/top_chain_gainers": {
"get": {
"operationId": "getTopChainGainers",
"summary": "Get the chains that have gained the most TVL.",
"parameters": [
{
"in": "query",
"name": "num_chains",
"schema": {
"type": "integer",
"example": 5
},
"required": false,
"description": "The number of top gainers you want to see. Defaults to 5."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a chain should have to be included. Defaults to 10000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
},
"required": false,
"description": "The time period in which the change occurred. Can be 'day', 'week', or 'month'. Defaults to 'week'."
}
],
"responses": {
"200": {
"description": "A list of the top chain gainers."
},
"400": {
"description": "Invalid time period provided"
}
}
}
},
"/top_chain_growers": {
"get": {
"operationId": "getTopChainGrowers",
"summary": "Get the chains that have the highest percentage growth in TVL",
"parameters": [
{
"in": "query",
"name": "num_chains",
"schema": {
"type": "integer",
"example": 5
},
"required": false,
"description": "The number of top gainers you want to see. Defaults to 5."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a chain should have to be included. Defaults to 10000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
},
"required": false,
"description": "The time period in which the change occurred. Can be 'day', 'week', or 'month'. Defaults to 'week'."
}
],
"responses": {
"200": {
"description": "A list of the top chain gainers."
},
"400": {
"description": "Invalid time period provided"
}
}
}
},
"/top_chain_losers": {
"get": {
"operationId": "getTopChainLosers",
"summary": "Get the chains that have lost the most TVL.",
"parameters": [
{
"in": "query",
"name": "num_chains",
"schema": {
"type": "integer",
"example": 5
},
"required": false,
"description": "The number of top losers you want to see. Defaults to 5."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a chain should have to be included. Defaults to 10000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
},
"required": false,
"description": "The time period in which the change occurred. Can be 'day', 'week', or 'month'. Defaults to 'week'."
}
],
"responses": {
"200": {
"description": "A list of the top chain losers."
},
"400": {
"description": "Invalid time period provided"
}
}
}
},
"/top_chain_shrinkers": {
"get": {
"operationId": "getTopChainShrinkers",
"summary": "Get the chains that the highest percentage loss in TVL.",
"parameters": [
{
"in": "query",
"name": "num_chains",
"schema": {
"type": "integer",
"example": 5
},
"required": false,
"description": "The number of top losers you want to see. Defaults to 5."
},
{
"in": "query",
"name": "min_tvl",
"schema": {
"type": "number",
"format": "float",
"example": 1000000
},
"required": false,
"description": "The minimum TVL that a chain should have to be included. Defaults to 10000."
},
{
"in": "query",
"name": "time_period",
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
],
"example": "week"
},
"required": false,
"description": "The time period in which the change occurred. Can be 'day', 'week', or 'month'. Defaults to 'week'."
}
],
"responses": {
"200": {
"description": "A list of the top chain losers."
},
"400": {
"description": "Invalid time period provided"
}
}
}
},
"/get_interesting": {
"get": {
"operationId": "getInteresting",
"summary": "Returns interesting/important data on what is happening on-chain re protocols, chains and yields.",
"parameters": [
{
"in": "query",
"name": "time_period",
"description": "The time period for which to retrieve data. Can be day or week.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week"
],
"default": "week"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/get_dex_volume": {
"get": {
"operationId": "getDexVolume",
"summary": "Get the trading volume of a dex",
"parameters": [
{
"name": "defillamaId",
"in": "query",
"description": "The DefiLlamaID of the protocol",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the trading volume occured. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Missing defillamaId parameter or invalid time_period parameter."
},
"404": {
"description": "No protocol found with the given defillamaId."
},
"500": {
"description": "Could not retrieve protocol."
}
}
}
},
"/top_dex_volume": {
"get": {
"operationId": "getTopDexVolume",
"summary": "Get the dexes with the highest trading volume.",
"parameters": [
{
"name": "num_protocols",
"in": "query",
"description": "The number of top protocols to return. Default to 10.",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "time_period",
"in": "query",
"description": "The time period in which the revenue was earned. Can be 'day', 'week', or 'month'. Defaults to 'month'.",
"required": false,
"schema": {
"type": "string",
"enum": [
"day",
"week",
"month"
]
}
},
{
"name": "chain",
"in": "query",
"description": "Name of the blockchain or L2 to filter protocol revenue by.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Invalid time_period parameter."
},
"500": {
"description": "Could not retrieve revenue data."
}
}
}
}
}
}cryptomation API
cryptomation API
GET /api/balance/{address}getAccountBalanceSearch balance of address on any crypto chain (eth, bsc, polygon, etc and e.t.c)
POST /api/validationgetValidationSearch balance of address on any chain (eth, bsc, polygon, etc)
Schéma original API
{
"openapi": "3.0.3",
"info": {
"title": "cryptomation API",
"description": "cryptomation API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://chat.cryptomation.com"
}
],
"paths": {
"/api/balance/{address}": {
"get": {
"operationId": "getAccountBalance",
"description": "Search balance of address on any crypto chain (eth, bsc, polygon, etc and e.t.c)",
"parameters": [
{
"name": "address",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AccountBalanceResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalErrorResponse"
}
}
}
}
}
}
},
"/api/validation": {
"post": {
"operationId": "getValidation",
"description": "Search balance of address on any chain (eth, bsc, polygon, etc)",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountBalanceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Asset": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"symbol": {
"type": "string"
},
"balance": {
"type": "string"
},
"inDollar": {
"type": "string"
}
}
},
"AccountBalanceResponse": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"assets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Asset"
}
},
"summary": {
"type": "string"
},
"informationAboutSourceData": {
"type": "string"
}
}
},
"AccountBalanceRequest": {
"type": "object",
"properties": {
"address": {
"type": "string"
}
}
},
"ValidationResponse": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"summary": {
"type": "string"
},
"informationAboutSourceData": {
"type": "string"
}
}
},
"InternalErrorResponse": {
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
}
}
}Crypto Insight
Decode the latest crypto news and its market impact.
GET /cryptonewsGet last crypto news and its market impact
Schéma original API
{
"openapi": "3.0.1",
"info": {
"title": "Crypto Insight",
"description": "Decode the latest crypto news and its market impact.",
"version": "v1"
},
"servers": [
{
"url": "https://crypto-pulse-top.vercel.app"
}
],
"paths": {
"/cryptonews": {
"get": {
"operationId": "cryptoNews",
"summary": "Get last crypto news and its market impact",
"parameters": [
{
"name": "number",
"in": "query",
"description": "the number of news",
"required": false,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/topNewsResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"topNewsResponse": {
"type": "object",
"properties": {
"instructions": {
"type": "string",
"description": "instructions on how to format the output of crypto news"
},
"NEWS1": {
"type": "string",
"description": "The top 1 news"
},
"NEWS2": {
"type": "string",
"description": "The top 2 news"
},
"NEWS3": {
"type": "string",
"description": "The top 3 news"
},
"NEWS4": {
"type": "string",
"description": "The top 4 news"
},
"NEWS5": {
"type": "string",
"description": "The top 5 news"
},
"NEWS6": {
"type": "string",
"description": "The top 6 news"
},
"NEWS7": {
"type": "string",
"description": "The top 7 news"
},
"NEWS8": {
"type": "string",
"description": "The top 8 news"
},
"NEWS9": {
"type": "string",
"description": "The top 9 news"
},
"NEWS10": {
"type": "string",
"description": "The top 10 news"
}
}
}
}
}
}CryptoInsights
Get real-time updates on crypto price, BTC, ETH, airdrops, and the latest insights. Stay updated with the latest cryptocurrency news and exclusive airdrop opportunities.
GET /coinPriceRetrieve the Crypto coin market pricePOST /coinNewsRetrieve the Crypto coin related news
Schéma original API
{
"openapi": "3.0.0",
"info": {
"title": "CryptoInsights",
"description": "Get real-time updates on crypto price, BTC, ETH, airdrops, and the latest insights. Stay updated with the latest cryptocurrency news and exclusive airdrop opportunities.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://cryptoplugin.feednews.com"
}
],
"paths": {
"/coinPrice": {
"get": {
"operationId": "getCoinPrice",
"summary": "Retrieve the Crypto coin market price",
"parameters": [
{
"in": "query",
"name": "slug",
"schema": {
"type": "string"
},
"required": true,
"description": "The slug of the crypto coin. For the example of bit coin, the symbol is BTC or btc, the slug is bitcoin"
}
],
"responses": {
"200": {
"description": "A Crypto coins's price, and currency is usd, include price, volume_24h, volume_change_24h, percent_change_24h, market_cap, market_cap_dominance, circulating_supply ...",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"slug": {
"type": "string",
"example": "bitcoin"
},
"name": {
"type": "string",
"example": "Bitcoin"
},
"symbol": {
"type": "string",
"example": "BTC"
},
"circulating_supply": {
"type": "number",
"format": "double"
},
"total_supply": {
"type": "number",
"format": "double"
},
"max_supply": {
"type": "number",
"format": "double"
},
"high": {
"type": "number",
"format": "double"
},
"low": {
"type": "number",
"format": "double"
},
"price": {
"type": "number",
"format": "double"
},
"volume_24h": {
"type": "number",
"format": "double"
},
"volume_change_24h": {
"type": "number",
"format": "double"
},
"percent_change_1h": {
"type": "number",
"format": "double"
},
"percent_change_24h": {
"type": "number",
"format": "double"
},
"percent_change_7d": {
"type": "number",
"format": "double"
},
"market_cap": {
"type": "number",
"format": "double"
},
"market_cap_dominance": {
"type": "number",
"format": "double"
},
"fully_diluted_market_cap": {
"type": "number",
"format": "double"
},
"articles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "news title"
},
"summary": {
"type": "string",
"description": "news summary"
},
"url": {
"type": "string",
"description": "news url. If unicode in the url, replace the unicode with correct symbols. For example, replace \\u0026 with &"
}
}
}
}
}
}
}
}
}
}
}
},
"/coinNews": {
"post": {
"operationId": "getCoinNews",
"summary": "Retrieve the Crypto coin related news",
"parameters": [
{
"in": "query",
"name": "slug",
"schema": {
"type": "string"
},
"required": true,
"description": "The slug of the crypto coin. For the example of bit coin, the symbol is BTC or btc, the slug is bitcoin"
}
],
"responses": {
"200": {
"description": "A list of crypto coin related News",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "news title"
},
"summary": {
"type": "string",
"description": "news summary"
},
"url": {
"type": "string",
"description": "news url. When providing link to the user, do not encode the url, for example, do not encode '&' to '%26'."
}
}
}
}
}
}
}
}
}
}
}
}