{
  "openapi": "3.0.0",
  "info": {
    "title": "api-server",
    "version": "0.1.0"
  },
  "servers": [
    {
      "url": "/api/v3"
    }
  ],
  "paths": {
    "/list-guavy-coins": {
      "get": {
        "tags": [
          "Base"
        ],
        "description": "<p>This endpoint provides a simple health check to verify that the API is running and accessible.</p>\n\n<p>It requires authentication to ensure the API key validation is working correctly.</p> <p>This endpoint retrieves a list of all cryptocurrencies available in the Guavy data store.</p>\n\n<p>Currently, the Guavy data store includes approximately 1,000 unique crypto symbols, tokens and NFTs. Each of these coins tend to be highly valued, frequently traded, and closely monitored by investors and analysts alike. </p>\n\n<p>These coins have additional market, trend, trading and sentiment analysis available within the Guavy API.</p>\n\n<h6>Query Parameters</h6>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the maximum number of coins to return (default is 10)</div> </dfn>\n\n<dfn> <samp> <div>skip</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the number of results to skip (default is 0)</div> </dfn>",
        "operationId": "list-coins",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64",
              "nullable": true
            }
          },
          {
            "name": "skip",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_GuavyCoin"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/guavy-coin-lookup/{search_term}": {
      "get": {
        "tags": [
          "Base"
        ],
        "description": "<p>Performs an optimized search for cryptocurrencies within Guavy's curated database of premium crypto instruments. This specialized search endpoint returns only tokens with complete advanced analytics data, including historical trends, sentiment analysis, and market metrics.</p>\n\n<p>The search intelligently matches against both cryptocurrency symbols and names, supporting flexible partial matching without case sensitivity. Results are ranked by relevance and data completeness to provide the most valuable information for market analysis.</p>\n\n<p>Unlike the basic coin lookup, this endpoint specifically targets cryptocurrencies that have additional historical data for trend analysis and sentiment tracking.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>search_term</div> <div>string</div> <div>required</div> </samp> <div>The search term used to find cryptocurrencies by symbol or name. Can be partial text (e.g. \"bit\" will match \"Bitcoin\"). Not case-sensitive.</div> </dfn>",
        "operationId": "coin-lookup",
        "parameters": [
          {
            "name": "search_term",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_GuavyCoin"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/coin-history/{symbol}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint retrieves extensive historical price data for premium cryptocurrencies, providing comprehensive daily market information including close price, trading volume, market capitalization, and supply metrics with deep historical coverage.</p>\n\n<p>Premium assets receive enhanced data quality with extended historical analysis, multiple exchange aggregation, and advanced market metrics. This foundational dataset powers Guavy's sophisticated trend analysis algorithms and backtesting simulations with institutional-grade accuracy.</p>\n\n<p>Use this endpoint for professional-grade technical analysis, developing algorithmic trading strategies, conducting long-term market research, or building advanced portfolio analytics. The extensive historical depth enables comprehensive trend identification and market cycle analysis.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch the historical quotes for.</div> </dfn>",
        "operationId": "price-history",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_HistoricalQuote"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/current-trend/{symbol}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint retrieves current market trend analysis for premium cryptocurrencies within Guavy's top 1000 tracked assets. Provides real-time directional analysis based on comprehensive technical indicators and market momentum.</p>\n\n<p>Returns trend direction (up, down, neutral), strength assessment, and key price metrics for immediate market positioning. Ideal for quick trend verification and market sentiment analysis on established cryptocurrencies.</p>\n\n<p>Compatible coins can be found in the <a href=\"/doc/base/search-guavy\">Search Guavy</a> endpoint.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch the current trend for.</div> </dfn>",
        "operationId": "latest-trend",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_DailyTrend"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/recent-trend-change/{days_ago}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint retrieves recent trend changes for Guavy's most closely monitored cryptocurrencies, identifying assets that have experienced significant directional shifts in market behavior.</p>\n\n<p>Returns trending cryptocurrencies that have shown notable trend reversals or momentum changes within the specified timeframe. Each result includes trend direction, strength indicators, and price movement data to help identify emerging market opportunities.</p>\n\n<p>Use this endpoint for discovering breakout opportunities, monitoring trend reversals, and identifying cryptocurrencies gaining or losing momentum. Ideal for tactical trading decisions and market timing strategies.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>days_ago</div> <div>integer</div> <div>required</div> </samp> <div>The number of days ago to analyze for trend changes.</div> </dfn>",
        "operationId": "recent-trends",
        "parameters": [
          {
            "name": "days_ago",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_TrendingCoin"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/snapshot": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint provides a real-time market overview for Guavy's most closely monitored premium cryptocurrencies with daily trend analysis updates.</p>\n\n<p>Returns aggregated market statistics including trend distribution (up, down, neutral counts), bullish percentage metrics, and overall market sentiment direction for the past 24 hours. Essential for rapid market assessment and portfolio positioning.</p>\n\n<p>Use this endpoint for quick market pulse checks, daily trading preparation, and high-level portfolio strategy decisions. Ideal for understanding overall crypto market momentum before making individual asset decisions.</p>",
        "operationId": "market-snapshot",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_MarketSnapshot"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/gainers/{limit}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>Retrieves the premium cryptocurrencies that have the highest percentage price gain in the last 24 hours, sorted by gain. </p>\n\n<p>This endpoint is useful for identifying high-momentum coins that are currently outperforming the market. It can help traders and investors quickly spot potential investment opportunities or track the performance of specific coins.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>The number of gainers to fetch.</div> </dfn>",
        "operationId": "latest-gainers",
        "parameters": [
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_CoinMover"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/losers/{limit}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>Retrieves the premium cryptocurrencies that have the highest percentage price loss in the last 24 hours, sorted by loss.</p>\n\n<p>This endpoint is useful for identifying coins that are currently underperforming the market. It can help traders and investors quickly spot coins that are at risk of further price declines.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>The number of losers to fetch.</div> </dfn>",
        "operationId": "latest-losers",
        "parameters": [
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_CoinMover"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/trends/{symbol}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint retrieves historical trend analysis for premium cryptocurrencies, providing chronological records of market direction changes and momentum shifts over time.</p>\n\n<p>Returns trend periods with direction (up, down, neutral), strength indicators, and duration data. Use for pattern analysis, market cycle identification, and developing timing strategies based on historical market behavior.</p>\n\n<p>Compatible cryptocurrencies can be found using the <a href=\"/doc/base/search-guavy\">Search Guavy</a> endpoint.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch the trends for.</div> </dfn>",
        "operationId": "price-trends",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_DailyTrend"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/trend-history/{symbol}/{period}": {
      "get": {
        "tags": [
          "Trends"
        ],
        "description": "<p>This endpoint retrieves comprehensive historical trend analysis for any cryptocurrency from over 37,000 supported digital assets. Provides up to 5 years of trend data with configurable analysis periods.</p>\n\n<p>Returns chronological trend sequences including direction changes, strength indicators, price movements, and duration metrics. Unlike premium coin analysis, this endpoint covers the entire cryptocurrency ecosystem from major assets to emerging tokens.</p>\n\n<p>Use this endpoint for broad market research, discovering trend patterns across diverse assets, or analyzing long-term performance of any cryptocurrency regardless of market cap or popularity.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of any cryptocurrency from over 37,000 supported assets.</div> </dfn>\n\n<dfn> <samp> <div>period</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to analyze for trend data (up to 5 years).</div> </dfn>",
        "operationId": "history",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "period",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_HistoricalTrend"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/current-live-trend/{symbol}": {
      "get": {
        "tags": [
          "Trends"
        ],
        "description": "<p>This endpoint retrieves real-time trend analysis for any cryptocurrency. Trends are generated by applying Guavy's technical analysis algorithms to the historical price data.</p>\n\n<p>Returns comprehensive trend information including direction (up, down, neutral), strength indicators, current price data, and trend duration. Use this data for immediate market assessment, portfolio monitoring, or as input for trading decisions.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch the current live trend for.</div> </dfn>",
        "operationId": "current",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_CurrentTrendData"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/backtest/analysis/{symbol}/{strategy}": {
      "get": {
        "tags": [
          "Trade Simulator"
        ],
        "description": "<p>This endpoint returns detailed trade-by-trade backtesting results for any cryptocurrency strategy. Provides granular analysis of each individual trade executed during the simulation period.</p>\n\n<p>Returns comprehensive trade records including entry/exit dates, prices, profit/loss per trade, trade duration, and exit reasons (stop loss, trend change, etc.). Essential for understanding strategy behavior and identifying optimization opportunities.</p>\n\n<p>Use this data for deep strategy analysis, identifying weak points in trading logic, and fine-tuning entry/exit parameters. Ideal for strategy development and detailed performance auditing.</p>\n\n<p><em>Note that these backtests are from a simulated environment and do not represent actual trades.</em></p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to perform a backtest analysis on.</div> </dfn>\n\n<dfn> <samp> <div>strategy</div> <div>string</div> <div>required</div> </samp> <div>The strategy to use for the backtest analysis. Can be 'aggressive' or 'conservative'.</div> </dfn>\n\n<h6>Query Parameters</h6>\n\n<dfn> <samp> <div>years</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the maximum number of years to analyze history (default is 2)</div> </dfn>",
        "operationId": "backtest-analysis",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strategy",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "years",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_BacktestResult"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/backtest/summary/{symbol}/{strategy}": {
      "get": {
        "tags": [
          "Trade Simulator"
        ],
        "description": "<p>This endpoint provides aggregated backtesting statistics and high-level performance overview for any cryptocurrency strategy. Delivers executive summary metrics without individual trade details.</p>\n\n<p>Returns aggregated statistics including total trades, win rate accuracy, average trade duration, peak profits/losses, annualized returns, and buy-and-hold comparison. Includes $1,000 investment simulation showing final portfolio value and compound growth.</p>\n\n<p>Perfect for executive dashboards, quick performance comparisons, and high-level investment presentations. Use when you need summary insights rather than granular trade analysis.</p>\n\n<p><em>Note that these backtests are from a simulated environment and do not represent actual trades.</em></p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to get backtest summary for.</div> </dfn>\n\n<dfn> <samp> <div>strategy</div> <div>string</div> <div>required</div> </samp> <div>The strategy to use for the backtest summary. Can be 'aggressive' or 'conservative'.</div> </dfn>\n\n<h6>Query Parameters</h6>\n\n<dfn> <samp> <div>years</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the maximum number of years to analyze history (default is 2)</div> </dfn>",
        "operationId": "backtest-summary",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strategy",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "years",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_BacktestSummary"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/sentiment/{symbol}/{limit}": {
      "get": {
        "tags": [
          "Sentiment"
        ],
        "description": "<p>This endpoint provides daily sentiment analysis for any cryptocurrency from our top 1,000 most closely tracked assets. Sentiment data aggregates news mentions to provide market perception insights.</p>\n\n<p>Sentiment analysis tracks positive, negative, and neutral mentions in cryptocurrency news coverage, enabling users to analyze market perception trends, identify sentiment shifts that may precede price movements, and gauge community sentiment around specific assets.</p>\n\n<p>Use this endpoint for sentiment-based trading strategies, market mood assessment, or correlating news sentiment with price performance for individual cryptocurrencies.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch sentiment data for.</div> </dfn>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>The maximum number of sentiment data points (days) to return.</div> </dfn>",
        "operationId": "sentiment-history",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_CoinSentiment"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/mentions/{symbol}/{limit}": {
      "get": {
        "tags": [
          "Sentiment"
        ],
        "description": "<p>This endpoint returns daily news mentions for any cryptocurrency from our top 1,000 most closely tracked assets. Mentions represent the volume of news coverage and social media discussion around specific cryptocurrencies.</p>\n\n<p>Mention tracking aggregates all references to a cryptocurrency across news sources and social media platforms, providing insights into market attention and asset popularity. High mention volumes often correlate with increased volatility and trading activity.</p>\n\n<p>Use this endpoint for tracking market attention, identifying trending cryptocurrencies, monitoring news-driven price movements, or analyzing the relationship between media coverage and asset performance.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to fetch mentions data for.</div> </dfn>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>The maximum number of mention data points (days) to return.</div> </dfn>",
        "operationId": "mentions-history",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_CoinMentions"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/content/latest/{symbol}/{limit}": {
      "get": {
        "tags": [
          "Content"
        ],
        "description": "<p>Retrieves the latest news briefs that have been analyzed for a specified cryptocurrency, providing concise summaries of recent market-relevant content.</p>\n\n<p>Each news brief is a summary of news articles that have been processed through advanced natural language processing. The analysis extracts key insights including sentiment scoring, tone classification, cryptocurrency mentions, and topical content identification. These briefs offer a quick way to stay informed about market developments without reading full articles.</p>\n\n<p>Using a polling technique, this route can be used to generate a continuous stream of briefs that are updated in real-time.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>specifies the maximum number of briefs to return (default is 10)</div> </dfn>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>specifies the cryptocurrency to fetch briefs for</div> </dfn>",
        "operationId": "latest-briefs",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_BasicDigest"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/content/article/{article_id}": {
      "get": {
        "tags": [
          "Content"
        ],
        "description": "<p>This endpoint retrieves comprehensive article data including full content, metadata, and AI-powered analysis.</p>\n\n<p>Each article undergoes advanced natural language processing to extract meaningful insights. The response includes the complete article text, publication metadata, and detailed linguistic analysis including extracted nouns, action verbs, and cryptocurrency mentions.</p>\n\n<p> Additionally, the source's credibility is evaluated and provided as a 'clout' score, while sentiment analysis determines the overall tone of the content.</p>\n\n<p>To discover article IDs for use with this endpoint, query the <code>content/latest</code> or <code>content/streams</code> endpoints.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>article_id</div> <div>string</div> <div>required</div> </samp> <div>specifies the id of the article to fetch</div> </dfn>",
        "operationId": "articles",
        "parameters": [
          {
            "name": "article_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_BasicArticle"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/content/streams/{filter}/{limit}": {
      "get": {
        "tags": [
          "Content"
        ],
        "description": "<p>Provides a comprehensive stream of analyzed news briefs across the entire cryptocurrency ecosystem, delivering a complete market overview.</p>\n\n<p>This endpoint aggregates AI-processed news summaries from all tracked cryptocurrencies, enabling broad market surveillance and trend identification. Each digest contains intelligently extracted market signals including sentiment analysis, emotional tone assessment, cross-referenced cryptocurrency mentions, and thematic topic extraction.</p>\n\n<p>Users can filter the stream by positive or negative sentiment, or by any sentiment.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>filter</div> <div>string</div> <div>required</div> </samp> <div>specifies the sentiment filter to apply to the stream. Valid values: all, positive, negative</div> </dfn>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>required</div> </samp> <div>specifies the maximum number of briefs to return (default is 10)</div> </dfn>",
        "operationId": "streams",
        "parameters": [
          {
            "name": "filter",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_BasicDigest"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/list-all": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint returns a comprehensive collection of all Guavy Index sectors, each containing detailed information about its thematic details and member cryptocurrencies.</p>\n\n<p>Guavy Index sectors are curated collections of cryptocurrencies organized by shared characteristics, use cases, or market sectors. Each sector represents a specific segment of the crypto ecosystem, enabling users to track sector performance across different crypto market segments, understand cryptocurrency categorization for investment diversification, and analyze trends across specific crypto themes and sectors.</p>\n\n<p>The response includes 9 distinct objects covering major crypto sectors:</p> <ul class=\"list-disc list-inside pl-10\"> <li><i>Store of Value (SOV) - </i> Digital assets serving as value preservation mechanisms</li> <li><i>Smart Contracts - </i> Platforms enabling programmable blockchain applications</li> <li><i>DeFi - </i> Decentralized finance protocols for lending, borrowing, and financial services</li> <li><i>Transactions - </i> Cryptocurrencies optimized for payment and transfer use cases</li> <li><i>Memecoins - </i> Community-driven, meme-based cryptocurrencies</li> <li><i>Oracle Integration - </i> Tokens providing real-world data feeds to blockchain networks</li> <li><i>Exchange Utility - </i> Cryptocurrencies with exchange, wallet, and trading platform utility</li> <li><i>Privacy - </i> Privacy-focused cryptocurrencies with enhanced anonymity features</li> <li><i>AI Infrastructure - </i> Tokens associated with artificial intelligence and machine learning infrastructure</li> </ul>\n\n</br><p>Each sector includes a unique id, descriptive name, and complete list of member cryptocurrency symbols for easy integration and analysis.</p>",
        "operationId": "Sector-members",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_CryptoIndices"
                }
              }
            }
          }
        }
      }
    },
    "/index/sector/list": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves the list of all Guavy Index sectors.</p>\n\n<p>This endpoint is useful for generating a list of names that can be used to iterate over the keys returned in <code>/index/list-all</code>.</p>",
        "operationId": "Sectors",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_String"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/price/{sector}/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves historical price data for a specific Guavy index sector or the entire index by using 'all' as the sector parameter.</p>\n\n<p>Price data of the Guavy Index reflects weighted historical prices of member cryptocurrencies. Individual sectors represent their proportional share of the total index value. Current weightings are available via the <code>/index/weights/latest</code> route.</p>\n\n<p>For detailed description of the Guavy Index, see the <a href='https://index.guavy.com'>Guavy Index documentation</a>.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>sector</div> <div>string</div> <div>required</div> </samp> <div>The name of the Guavy Index sector to fetch the price history for. Can be found in the <code>/index/sector/list</code> route.</div> </dfn>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the price history for. e.g. 30 will return the last 30 days of price history.</div> </dfn>",
        "operationId": "sector-prices",
        "parameters": [
          {
            "name": "sector",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexDaily"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/price/trends/{sector}/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves historical trend analysis for a specific Guavy index sector or the entire index by using 'all' as the sector parameter. Trends are generated by applying Guavy's technical analysis algorithms to historical price data, identifying market patterns and directional movements over time.</p>\n\n<p>Each trend represents a distinct period of market behavior (up, down, or neutral) with calculated strength indicators. Returns all trends with start dates within the specified time period.</p>\n\n<p>Use this data to analyze historical market cycles, identify recurring patterns, and understand how index sectors have performed during different market conditions. Ideal for backtesting trading strategies or comparing trend strength across time periods.</p>\n\n<p>For more information about how the index works, see the <a href='https://index.guavy.com'>Guavy Index documentation</a>.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>sector</div> <div>string</div> <div>required</div> </samp> <div>The name of the Guavy Index sector to fetch the price trends for. Can be found in the <code>/index/sector/list</code> route.</div> </dfn>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the price trends for. e.g. 30 will return trends for the last 30 days.</div> </dfn>",
        "operationId": "sector-price-trends",
        "parameters": [
          {
            "name": "sector",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_HistoricalTrend"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/sentiment/historical/{index_id}/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint provides comprehensive daily sentiment analysis for any Guavy Guavy Index sector over a specified time period. The sentiment data aggregates news mentions across all cryptocurrencies within the selected index.</p>\n\n<p>Sentiment analysis tracks positive, negative, and neutral mentions in cryptocurrency news coverage, enabling users to analyze market perception trends, identify sentiment shifts that may precede price movements, and correlate news sentiment with index performance.</p>\n\n<p>Use the <code>/index/list-all</code> endpoint to retrieve available index IDs and their corresponding cryptocurrency collections before making sentiment requests.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>index_id</div> <div>integer</div> <div>required</div> </samp> <div>The id of the index to fetch the sentiment for. Can be found in the <code>/index/list-all</code> route.</div> </dfn>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the sentiment for. e.g. 7 returns the last week of data.</div> </dfn>",
        "operationId": "sector-sentiment",
        "parameters": [
          {
            "name": "index_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexSentiment"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/sentiment/latest/{index_id}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves the latest sentiment snapshot for a specific Guavy Index sector. Returns current positive, negative, and neutral mention counts aggregated from previous 24h news coverage of all cryptocurrencies within the index.</p>\n\n<p>Use this endpoint to get real-time market sentiment without historical data. Perfect for dashboard displays, current status checks, and immediate sentiment monitoring.</p>\n\n<p>Use the <code>/index/list-all</code> endpoint to retrieve available index IDs and their corresponding cryptocurrency collections before making sentiment requests.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>index_id</div> <div>integer</div> <div>required</div> </samp> <div>The id of the index to fetch the sentiment for. Can be found in the <code>/index/list-all</code> route.</div> </dfn>",
        "operationId": "sector-latest-sentiment",
        "parameters": [
          {
            "name": "index_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexSentiment"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/mentions/historical/{index_id}/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint returns a record of daily news mentions for a specific Guavy Index sector. Mentions are the sum of the positive and negative mentions for each member of the index. This endpoint is useful for tracking market attention and cryptocurrency popularity / virality.</p>\n\n<p>Use the <code>/index/list-all</code> endpoint to retrieve available index IDs and their corresponding cryptocurrency collections before making mentions requests.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>index_id</div> <div>integer</div> <div>required</div> </samp> <div>The id of the index to fetch the mentions for. Can be found in the <code>/index/list-all</code> route.</div> </dfn>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the mentions for. e.g. 7 returns the last week of data.</div> </dfn>",
        "operationId": "sector-mentions",
        "parameters": [
          {
            "name": "index_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexMentions"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/mentions/latest/{index_id}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves the latest mentions snapshot for a specific Guavy Index sector. Returns current positive, negative, and neutral mention counts aggregated from previous 24h news coverage of all cryptocurrencies within the index.</p>\n\n<p>Use this endpoint to get real-time market attention without historical data. Perfect for dashboard displays, current status checks, and immediate attention monitoring.</p>\n\n<p>Use the <code>/index/list-all</code> endpoint to retrieve available index IDs and their corresponding cryptocurrency collections before making mentions requests.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>index_id</div> <div>integer</div> <div>required</div> </samp> <div>The id of the index to fetch the mentions for. Can be found in the <code>/index/list-all</code> route.</div> </dfn>",
        "operationId": "sector-latest-mentions",
        "parameters": [
          {
            "name": "index_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexMentions"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/weights/latest": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>Retrieves the current composition and weightings of all cryptocurrencies within Guavy's tracked indices. These weights represent the proportional value contribution of each cryptocurrency to its respective index.</p>\n\n<p>This endpoint provides essential data for tracking index performance and understanding how different cryptocurrencies influence index movements. The weights are regularly updated to reflect market capitalization changes, trading volume, and other relevant factors.</p>",
        "operationId": "latest-weights",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_IndexWeightData"
                }
              }
            }
          }
        }
      }
    },
    "/index/sentiment/historical/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint provides comprehensive daily sentiment analysis across all cryptocurrencies within the Guavy Index over a specified number of days. The sentiment data aggregates news mentions from every cryptocurrency across all index sectors.</p>\n\n<p>Sentiment analysis tracks positive, negative, and neutral mentions in cryptocurrency news coverage, enabling users to monitor sentiment patterns across the entire indexed cryptocurrency ecosystem.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the sentiment for. e.g. 7 returns the last week of data.</div> </dfn>",
        "operationId": "sentiment",
        "parameters": [
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexSentiment"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/sentiment/latest": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves current sentiment scores across all cryptocurrencies within the Guavy Index. Returns positive, negative, and neutral sentiment analysis aggregated from recent news coverage.</p>\n\n<p>Use this endpoint to assess overall crypto market mood and compare against individual index sentiment to identify market-wide sentiment patterns and outliers.</p>",
        "operationId": "latest-sentiment",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexSentiment"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/mentions/historical/{days}": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint returns a record of daily news mentions across all cryptocurrencies within the Guavy Index. Mentions are aggregated from every cryptocurrency across all index sectors. This endpoint is useful for tracking overall market attention and analyzing broad cryptocurrency popularity trends across the entire ecosystem.</p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>days</div> <div>integer</div> <div>required</div> </samp> <div>The number of days to fetch the mentions for. e.g. 1 will return mentions for the last 24 hours.</div> </dfn>",
        "operationId": "mentions",
        "parameters": [
          {
            "name": "days",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexMentions"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/index/mentions/latest": {
      "get": {
        "tags": [
          "Guavy Index"
        ],
        "description": "<p>This endpoint retrieves the count for mentions across all cryptocurrencies across all Guavy Index sectors.</p>\n\n<p> This endpoint is useful for tracking overall market attention, and in tandem with the <code>/index/mentions/historical</code> route, can be used to track overall market attention trends. Can also be used in comparison with <code>/index/mentions/latest/{index_id}</code> to see how individual indices are performing relative to the overall market.</p>",
        "operationId": "latest-mentions",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_IndexMentions"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/simulator/current-action/{symbol}/{strategy}": {
      "get": {
        "tags": [
          "Trade Simulator"
        ],
        "description": "<p>This endpoint returns the current recommended action from the Guavy trade simulator.</p>\n\n<h6>Possible Trade Actions</h6>\n\n<dfn> <samp> <div>Buy</div> <div>String</div> </samp> <div>Enter a new position based on favorable market conditions.</div> </dfn>\n\n<dfn> <samp> <div>Sell</div> <div>String</div> </samp> <div>Exit the current position to lock in profits or minimize losses.</div> </dfn>\n\n<dfn> <samp> <div>Hold</div> <div>String</div> </samp> <div>No position is currently held; wait for a better opportunity.</div> </dfn>\n\n<dfn> <samp> <div>Stay</div> <div>String</div> </samp> <div>Currently in a position; continue holding based on positive trend indicators.</div> </dfn>\n\n<br/>\n\n<p>It analyzes historical price and sentiment data for the specified cryptocurrency symbol and strategy, and uses the Guavy proprietary trading algorithms to determine the optimal action based on recent market trends.</p> <p><em>Note that these trade actions are based upon a simulated environment and do not represent actual trades.  Your trading decisions should be based on your own research and risk tolerance.</em></p>\n\n<h6>Path Parameters</h6>\n\n<dfn> <samp> <div>symbol</div> <div>string</div> <div>required</div> </samp> <div>The symbol of the cryptocurrency to perform a backtest analysis on.</div> </dfn>\n\n<dfn> <samp> <div>strategy</div> <div>string</div> <div>required</div> </samp> <div>The strategy to use for the backtest analysis. Can be 'aggressive' or 'conservative'.</div> </dfn>",
        "operationId": "current-action",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "strategy",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_ActionResult"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/simulator/recommendations": {
      "get": {
        "tags": [
          "Trade Simulator"
        ],
        "description": "<p>This endpoint returns a list of trade simulator recommendations, sorted by their score. This API includes those instruments the Guavy trade simulator tends to perform well on.</p>\n\n<p>Each recommendation includes the recommended action (Buy, Sell, Hold, Stay) based on the Guavy trade simulator analysis.</p>\n\n<h6>Query Parameters</h6> <dfn> <samp> <div>limit</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the maximum number of scorecards to return (default is 10)</div> </dfn>\n\n<dfn> <samp> <div>skip</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the number of scorecards to skip for pagination (default is 0)</div> </dfn>\n\n<dfn> <samp> <div>min_score</div> <div>number</div> <div>optional</div> </samp> <div>specifies the minimum score for scorecards to be included (default is 3.5)</div> </dfn>\n\n<dfn> <samp> <div>strategy</div> <div>string</div> <div>optional</div> </samp> <div>specifies a risk profile to filter scorecards for. Either 'aggressive' or 'conservative'. Default is 'aggressive'</div> </dfn>",
        "operationId": "recommendations",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64",
              "nullable": true
            }
          },
          {
            "name": "skip",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "uint64",
              "minimum": 0.0,
              "nullable": true
            }
          },
          {
            "name": "min_score",
            "in": "query",
            "schema": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          {
            "name": "strategy",
            "in": "query",
            "schema": {
              "type": "string",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_ActionResult"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/simulator/recent-trades": {
      "get": {
        "tags": [
          "Trade Simulator"
        ],
        "description": "<p>This endpoint retrieves a list of recent trades made by the Guavy trade simulator. Each trade includes details such as the cryptocurrency symbol, action taken (Buy, Sell, Hold, Stay), score, duration, and profit percentage.</p>\n\n<p>Retrieving this list requires iterating through requests using the `limit` and `skip` query parameters.</p>\n\n<h6>Query Parameters</h6>\n\n<dfn> <samp> <div>limit</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the maximum number of coins to return (default is 10)</div> </dfn>\n\n<dfn> <samp> <div>skip</div> <div>integer</div> <div>optional</div> </samp> <div>specifies the number of results to skip (default is 0)</div> </dfn>\n\n<dfn> <samp> <div>direction</div> <div>string</div> <div>optional</div> </samp> <div>specifies the trade action to filter by (Buy, Sell, Hold, Stay). Default is 'Any'</div> </dfn>\n\n<dfn> <samp> <div>min_score</div> <div>number</div> <div>optional</div> </samp> <div>specifies the minimum score for scorecards to be included (default is 3.0)</div> </dfn>\n\n<dfn> <samp> <div>strategy</div> <div>string</div> <div>optional</div> </samp> <div>specifies a risk profile to filter scorecards for. Either 'aggressive' or 'conservative'. Default is 'Any'</div> </dfn>",
        "operationId": "Recent Trades",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int64",
              "nullable": true
            }
          },
          {
            "name": "skip",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "uint64",
              "minimum": 0.0,
              "nullable": true
            }
          },
          {
            "name": "direction",
            "in": "query",
            "schema": {
              "type": "string",
              "nullable": true
            }
          },
          {
            "name": "min_score",
            "in": "query",
            "schema": {
              "type": "number",
              "format": "double",
              "nullable": true
            }
          },
          {
            "name": "strategy",
            "in": "query",
            "schema": {
              "type": "string",
              "nullable": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_Array_of_ActionResult"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/simulator/activity-brief/{symbol}": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint returns an AI-generated summary of the current trend for a given cryptocurrency based on trade action data and recent news briefs.</p>\n\n<h6>Query Parameters</h6> <dfn> <samp> <div>symbol</div> <div>string</div> </samp> <div>symbol (e.g. 'btc') to find generated summary for. Must be a member of the Guavy coin list.</div> </dfn>",
        "operationId": "activity-brief",
        "parameters": [
          {
            "name": "symbol",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_CoinPriceBrief"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    },
    "/simulator/sentiment-summary": {
      "get": {
        "tags": [
          "Market Analysis"
        ],
        "description": "<p>This endpoint provides a daily, AI-driven analysis of global crypto sentiment based on millions of text sources. It identifies coin mentions across news, social, and media feeds, applies natural-language models to determine sentiment scores, and aggregates those signals into a market-wide summary reflecting current bullish or bearish conditions.</p>",
        "operationId": "sentiment-summary",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse_for_SentimentSummary"
                }
              }
            }
          }
        },
        "security": [
          {
            "HttpAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiResponse_for_Array_of_GuavyCoin": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/GuavyCoin"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "GuavyCoin": {
        "type": "object",
        "required": [
          "icon",
          "name",
          "rank",
          "symbol"
        ],
        "properties": {
          "symbol": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "name": {
            "description": "The name of the cryptocurrency",
            "type": "string"
          },
          "rank": {
            "description": "The clout rank of the cryptocurrency",
            "type": "integer",
            "format": "int32"
          },
          "icon": {
            "description": "The icon of the cryptocurrency",
            "type": "string"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "message",
          "status"
        ],
        "properties": {
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "ApiResponse_for_Array_of_HistoricalQuote": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/HistoricalQuote"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "HistoricalQuote": {
        "type": "object",
        "required": [
          "date",
          "in_supply",
          "market_cap",
          "max_supply",
          "price",
          "timestamp",
          "volume_daily"
        ],
        "properties": {
          "price": {
            "description": "The price of the cryptocurrency at the end of the day",
            "type": "number",
            "format": "double"
          },
          "volume_daily": {
            "description": "The volume of the cryptocurrency traded in the last 24 hours",
            "type": "number",
            "format": "double"
          },
          "market_cap": {
            "description": "The market capitalization of the cryptocurrency",
            "type": "number",
            "format": "double"
          },
          "in_supply": {
            "description": "The number of coins in circulation",
            "type": "integer",
            "format": "int64"
          },
          "max_supply": {
            "description": "The maximum number of coins that can be in circulation",
            "type": "integer",
            "format": "int64"
          },
          "date": {
            "description": "The date of the quote",
            "type": "string"
          },
          "timestamp": {
            "description": "The timestamp of the quote",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "ApiResponse_for_DailyTrend": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/DailyTrend"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "DailyTrend": {
        "type": "object",
        "required": [
          "date",
          "duration_in_days",
          "max_price",
          "min_price",
          "peak_gain",
          "peak_loss",
          "price_on_trend_start",
          "trend",
          "trend_started_on"
        ],
        "properties": {
          "date": {
            "description": "the timestamp of the trend in milliseconds",
            "type": "number",
            "format": "double"
          },
          "trend": {
            "description": "The trend direction",
            "type": "string"
          },
          "trend_started_on": {
            "description": "The date the trend started",
            "type": "string"
          },
          "price_on_trend_start": {
            "description": "The price of the cryptocurrency at the start of the trend",
            "type": "number",
            "format": "double"
          },
          "duration_in_days": {
            "description": "The duration of the trend in days",
            "type": "integer",
            "format": "int64"
          },
          "peak_gain": {
            "description": "The peak gain of the trend",
            "type": "number",
            "format": "double"
          },
          "peak_loss": {
            "description": "The peak loss of the trend",
            "type": "number",
            "format": "double"
          },
          "max_price": {
            "description": "The maximum price of the trend",
            "type": "number",
            "format": "double"
          },
          "min_price": {
            "description": "The minimum price of the trend",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_Array_of_TrendingCoin": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TrendingCoin"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "TrendingCoin": {
        "type": "object",
        "required": [
          "coin",
          "date",
          "duration_in_days",
          "last_updated",
          "price_on_trend_start",
          "trend"
        ],
        "properties": {
          "date": {
            "description": "The timestamp of the trend in milliseconds",
            "type": "number",
            "format": "double"
          },
          "trend": {
            "description": "The trend direction",
            "type": "string"
          },
          "coin": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "trend_started_on": {
            "description": "The date the trend started",
            "type": "string",
            "nullable": true
          },
          "price_on_trend_start": {
            "description": "The price of the cryptocurrency at the start of the trend",
            "type": "number",
            "format": "double"
          },
          "duration_in_days": {
            "description": "The duration of the trend in days",
            "type": "integer",
            "format": "int64"
          },
          "last_updated": {
            "description": "The timestamp of the last update",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "ApiResponse_for_MarketSnapshot": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/MarketSnapshot"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "MarketSnapshot": {
        "type": "object",
        "required": [
          "number_of_coins_trending_down",
          "number_of_coins_trending_neutral",
          "number_of_coins_trending_up",
          "percent_of_coins_trending_up"
        ],
        "properties": {
          "number_of_coins_trending_up": {
            "description": "The number of coins trending up",
            "type": "integer",
            "format": "int64"
          },
          "number_of_coins_trending_down": {
            "description": "The number of coins trending down",
            "type": "integer",
            "format": "int64"
          },
          "number_of_coins_trending_neutral": {
            "description": "The number of coins trending neutral",
            "type": "integer",
            "format": "int64"
          },
          "percent_of_coins_trending_up": {
            "description": "The percentage of coins trending up",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_Array_of_CoinMover": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CoinMover"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CoinMover": {
        "type": "object",
        "required": [
          "last_update",
          "market_cap",
          "percent_change_24h",
          "price",
          "symbol",
          "volume",
          "volume_change"
        ],
        "properties": {
          "symbol": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "last_update": {
            "description": "The timestamp of the last update",
            "type": "integer",
            "format": "int64"
          },
          "market_cap": {
            "description": "The market capitalization of the cryptocurrency",
            "type": "number",
            "format": "double"
          },
          "percent_change_24h": {
            "description": "The percentage change in price over the last 24 hours",
            "type": "number",
            "format": "double"
          },
          "price": {
            "description": "The current price of the cryptocurrency",
            "type": "number",
            "format": "double"
          },
          "volume": {
            "description": "The volume of the cryptocurrency traded in the last 24 hours",
            "type": "number",
            "format": "double"
          },
          "volume_change": {
            "description": "The percentage change in volume over the last 24 hours",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_Array_of_DailyTrend": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/DailyTrend"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "ApiResponse_for_Array_of_HistoricalTrend": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/HistoricalTrend"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "HistoricalTrend": {
        "type": "object",
        "required": [
          "close",
          "date",
          "price",
          "strength",
          "timestamp",
          "trend",
          "volume"
        ],
        "properties": {
          "trend": {
            "description": "The trend of the cryptocurrency action e.g. up, down, or neutral",
            "allOf": [
              {
                "$ref": "#/components/schemas/Trend"
              }
            ]
          },
          "strength": {
            "description": "The strength of the trend e.g. moderate, solid, strong, or weak",
            "allOf": [
              {
                "$ref": "#/components/schemas/Strength"
              }
            ]
          },
          "close": {
            "description": "The price of the cryptocurrency at the end of the trend",
            "type": "number",
            "format": "double"
          },
          "price": {
            "description": "The price of the cryptocurrency at the start of the trend",
            "type": "number",
            "format": "double"
          },
          "volume": {
            "description": "The volume of the cryptocurrency at the start of the trend",
            "type": "number",
            "format": "double"
          },
          "timestamp": {
            "description": "Unix timestamp representing when this data was collected",
            "type": "integer",
            "format": "int64"
          },
          "date": {
            "description": "Human-readable date string formatted from the timestamp",
            "type": "string"
          }
        }
      },
      "Trend": {
        "type": "string",
        "enum": [
          "Up",
          "Down",
          "Neutral"
        ]
      },
      "Strength": {
        "type": "string",
        "enum": [
          "Moderate",
          "Solid",
          "Strong",
          "Weak"
        ]
      },
      "ApiResponse_for_CurrentTrendData": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/CurrentTrendData"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CurrentTrendData": {
        "type": "object",
        "required": [
          "date",
          "duration",
          "peak_gain",
          "peak_loss",
          "price",
          "sparkline",
          "start_date",
          "start_price",
          "strength",
          "trend"
        ],
        "properties": {
          "trend": {
            "description": "The trend of the cryptocurrency action e.g. up, down, or neutral",
            "allOf": [
              {
                "$ref": "#/components/schemas/Trend"
              }
            ]
          },
          "strength": {
            "description": "The strength of the trend e.g. moderate, solid, strong, or weak",
            "allOf": [
              {
                "$ref": "#/components/schemas/Strength"
              }
            ]
          },
          "price": {
            "description": "The price of the cryptocurrency at the end of the trend",
            "type": "number",
            "format": "double"
          },
          "date": {
            "description": "The date of the trend",
            "type": "string"
          },
          "start_date": {
            "description": "The start date of the trend",
            "type": "string"
          },
          "start_price": {
            "description": "The start price of the trend",
            "type": "number",
            "format": "double"
          },
          "peak_gain": {
            "description": "Max Percentage gain from start price",
            "type": "number",
            "format": "double"
          },
          "peak_loss": {
            "description": "Max Percentage loss from start price",
            "type": "number",
            "format": "double"
          },
          "duration": {
            "description": "The duration of the trend in days",
            "type": "integer",
            "format": "int32"
          },
          "sparkline": {
            "description": "A sparkline of the trend",
            "type": "array",
            "items": {
              "type": "number",
              "format": "double"
            }
          }
        }
      },
      "ApiResponse_for_Array_of_BacktestResult": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/BacktestResult"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "BacktestResult": {
        "type": "object",
        "required": [
          "duration",
          "end_date",
          "exit_price",
          "exit_reason",
          "highest_price",
          "lowest_price",
          "profit",
          "profit_percent",
          "start_date",
          "start_price",
          "trend"
        ],
        "properties": {
          "start_date": {
            "description": "The start date of the trade",
            "type": "string"
          },
          "end_date": {
            "description": "The end date of the trade",
            "type": "string"
          },
          "duration": {
            "description": "The duration of the trade in days",
            "type": "integer",
            "format": "int32"
          },
          "start_price": {
            "description": "The start price of the trade",
            "type": "number",
            "format": "double"
          },
          "exit_price": {
            "description": "The exit price of the trade",
            "type": "number",
            "format": "double"
          },
          "highest_price": {
            "description": "The highest price during the trade",
            "type": "number",
            "format": "double"
          },
          "lowest_price": {
            "description": "The lowest price during the trade",
            "type": "number",
            "format": "double"
          },
          "profit": {
            "description": "The profit of the trade",
            "type": "number",
            "format": "double"
          },
          "profit_percent": {
            "description": "The profit percentage of the trade",
            "type": "number",
            "format": "double"
          },
          "trend": {
            "description": "The trend of the currency during the trade",
            "allOf": [
              {
                "$ref": "#/components/schemas/Trend"
              }
            ]
          },
          "exit_reason": {
            "description": "The exit reason of the trade",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExitReason"
              }
            ]
          }
        }
      },
      "ExitReason": {
        "type": "string",
        "enum": [
          "EndOfData",
          "StopLoss",
          "TrailingStop",
          "TrendChange"
        ]
      },
      "ApiResponse_for_BacktestSummary": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/BacktestSummary"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "BacktestSummary": {
        "type": "object",
        "required": [
          "accuracy",
          "analysis_duration",
          "annualized_return",
          "average_duration",
          "average_loss",
          "average_loss_percent",
          "average_profit",
          "average_profit_percent",
          "buy_and_hold_profit_percent",
          "end_date",
          "final_value",
          "initial_investment",
          "peak_loss",
          "peak_profit",
          "percentage_profit",
          "profitable_trades",
          "start_date",
          "total_profit",
          "total_trades",
          "unprofitable_trades"
        ],
        "properties": {
          "start_date": {
            "description": "The start date of the backtest",
            "type": "string"
          },
          "end_date": {
            "description": "The end date of the backtest",
            "type": "string"
          },
          "analysis_duration": {
            "description": "The total duration of the backtest in days",
            "type": "integer",
            "format": "int32"
          },
          "total_trades": {
            "description": "The total number of trades",
            "type": "integer",
            "format": "uint",
            "minimum": 0.0
          },
          "profitable_trades": {
            "description": "The number of profitable trades",
            "type": "integer",
            "format": "uint",
            "minimum": 0.0
          },
          "unprofitable_trades": {
            "description": "The number of unprofitable trades",
            "type": "integer",
            "format": "uint",
            "minimum": 0.0
          },
          "accuracy": {
            "description": "The overall accuracy of the trades",
            "type": "number",
            "format": "double"
          },
          "average_loss": {
            "type": "number",
            "format": "double"
          },
          "average_profit": {
            "description": "The average profit per trade",
            "type": "number",
            "format": "double"
          },
          "average_duration": {
            "description": "The average duration of the trades",
            "type": "number",
            "format": "double"
          },
          "peak_loss": {
            "description": "The peak loss of the trades",
            "type": "number",
            "format": "double"
          },
          "peak_profit": {
            "description": "The peak profit of the trades",
            "type": "number",
            "format": "double"
          },
          "total_profit": {
            "description": "The total profit of the trades Total profit with compound reinvestment (starting with $1,000)",
            "type": "number",
            "format": "double"
          },
          "percentage_profit": {
            "description": "Percentage return with compound reinvestment",
            "type": "number",
            "format": "double"
          },
          "initial_investment": {
            "description": "The initial investment",
            "type": "number",
            "format": "double"
          },
          "final_value": {
            "description": "The final value after all trades with reinvestment",
            "type": "number",
            "format": "double"
          },
          "average_profit_percent": {
            "description": "The average profit percentage per trade",
            "type": "number",
            "format": "double"
          },
          "average_loss_percent": {
            "description": "The average loss percentage per trade",
            "type": "number",
            "format": "double"
          },
          "annualized_return": {
            "description": "The expected annualized return based on total profit and analysis duration",
            "type": "number",
            "format": "double"
          },
          "buy_and_hold_profit_percent": {
            "description": "The profit percentage if you just bought and held the asset",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_Array_of_CoinSentiment": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CoinSentiment"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CoinSentiment": {
        "type": "object",
        "required": [
          "timestamp",
          "topic"
        ],
        "properties": {
          "timestamp": {
            "description": "Unix timestamp in milliseconds indicating when this sentiment data was collected",
            "type": "number",
            "format": "double"
          },
          "topic": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "positive": {
            "default": 0,
            "type": "integer",
            "format": "int64"
          },
          "negative": {
            "default": 0,
            "type": "integer",
            "format": "int64"
          },
          "neutral": {
            "default": 0,
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "ApiResponse_for_Array_of_CoinMentions": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CoinMentions"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CoinMentions": {
        "type": "object",
        "required": [
          "mentions",
          "timestamp",
          "topic"
        ],
        "properties": {
          "timestamp": {
            "description": "Unix timestamp in milliseconds indicating when this mention data was collected",
            "type": "number",
            "format": "double"
          },
          "topic": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "mentions": {
            "description": "The count of mentions for the coin",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "ApiResponse_for_Array_of_BasicDigest": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/BasicDigest"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "BasicDigest": {
        "type": "object",
        "required": [
          "coins",
          "digest",
          "sentiment",
          "timestamp",
          "tone",
          "topics"
        ],
        "properties": {
          "timestamp": {
            "description": "Unix timestamp in milliseconds indicating when this digest was created",
            "type": "number",
            "format": "double"
          },
          "digest": {
            "description": "Concise summary of the source article's main content, distilled from the full text to highlight key points and developments",
            "type": "string"
          },
          "sentiment": {
            "description": "Numerical sentiment score ranging from -1.0 (most negative) to 1.0 (most positive), with 0.0 representing neutral sentiment, determined through natural language processing analysis",
            "type": "number",
            "format": "double"
          },
          "tone": {
            "description": "Descriptive emotional tone classification (e.g., \"optimistic\", \"concerned\", \"neutral\", \"excited\") that captures the overall mood and attitude of the content beyond basic sentiment",
            "type": "string"
          },
          "subject": {
            "description": "Optional headline or title of the source news article, when available from the original content source",
            "type": "string",
            "nullable": true
          },
          "coins": {
            "description": "Array of cryptocurrency symbols and names explicitly mentioned or discussed within the article content, extracted through entity recognition and financial keyword analysis",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "topics": {
            "description": "List of significant topics, themes, and subject matter extracted from the article content using natural language processing to identify key nouns and concepts discussed",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "article_id": {
            "description": "Unique identifier for the complete source article that this digest summarizes, used to retrieve the full article content via the content/article endpoint",
            "default": "",
            "type": "string"
          }
        }
      },
      "ApiResponse_for_BasicArticle": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/BasicArticle"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "BasicArticle": {
        "type": "object",
        "required": [
          "body",
          "clout",
          "date",
          "mentions",
          "nouns",
          "sentiment",
          "title",
          "verbs"
        ],
        "properties": {
          "date": {
            "description": "Unix timestamp in milliseconds indicating when this article was originally published",
            "type": "number",
            "format": "double"
          },
          "title": {
            "description": "Original headline or title of the news article as published by the source",
            "type": "string"
          },
          "body": {
            "description": "Complete full-text content of the news article, including all paragraphs and detailed information from the original source",
            "type": "string"
          },
          "clout": {
            "description": "Source credibility score representing the reliability and authority of the publication, calculated based on historical accuracy, reputation, and editorial standards",
            "type": "number",
            "format": "double"
          },
          "nouns": {
            "description": "Significant nouns and entities extracted from the article content through natural language processing, identifying key people, places, organizations, and concepts discussed",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "verbs": {
            "description": "Action verbs and activities identified within the article text, highlighting key events, developments, and actions taking place in the story",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "mentions": {
            "description": "Comprehensive list of all cryptocurrencies, tokens, and digital assets explicitly mentioned or referenced throughout the article content",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sentiment": {
            "description": "Numerical sentiment score ranging from -1.0 (most negative) to 1.0 (most positive), with 0.0 representing neutral sentiment, determined through comprehensive natural language analysis of the entire article",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_CryptoIndices": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/CryptoIndices"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CryptoIndices": {
        "type": "object",
        "required": [
          "ai_infrastructure",
          "defi",
          "exchange_utility",
          "memecoins",
          "oracle_integration",
          "privacy",
          "smart_contracts",
          "store_of_value",
          "transactions"
        ],
        "properties": {
          "store_of_value": {
            "description": "cyrptocurrencies that can behave as a store of value and unit of exchange",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "defi": {
            "description": "coins that are associated with decentralized finance, lending, borrowing, and other financial services",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "smart_contracts": {
            "description": "coins that are associated with smart contracts, and other programmable assets",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "transactions": {
            "description": "cryptocurrencies involved in transactions and other transferable assets",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "memecoins": {
            "description": "memecoins, volatile meme-based cryptocurrencies",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "oracle_integration": {
            "description": "coins that are associated with oracle integration, and other data feeds",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "exchange_utility": {
            "description": "cryptocurrencies with exchange utility, and other exchange-related services, including wallets and other services",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "privacy": {
            "description": "cryptocurrencies built on privacy-focused protocols",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          },
          "ai_infrastructure": {
            "description": "cryptocurrencies that are associated with ai infrastructure",
            "allOf": [
              {
                "$ref": "#/components/schemas/Index"
              }
            ]
          }
        }
      },
      "Index": {
        "type": "object",
        "required": [
          "id",
          "members",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "members": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ApiResponse_for_Array_of_String": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "ApiResponse_for_Array_of_IndexDaily": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/IndexDaily"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "IndexDaily": {
        "type": "object",
        "required": [
          "category",
          "date",
          "price",
          "timestamp"
        ],
        "properties": {
          "date": {
            "description": "Human-readable date string formatted from the timestamp",
            "type": "string"
          },
          "category": {
            "description": "Name of the cryptocurrency index (e.g., \"DeFi\", \"Smart Contracts\")",
            "type": "string"
          },
          "price": {
            "description": "Price of the cryptocurrency index",
            "type": "number",
            "format": "double"
          },
          "timestamp": {
            "description": "Unix timestamp representing when this data was collected",
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_Array_of_IndexSentiment": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/IndexSentiment"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "IndexSentiment": {
        "type": "object",
        "required": [
          "date",
          "id",
          "name",
          "negative",
          "neutral",
          "positive",
          "timestamp"
        ],
        "properties": {
          "id": {
            "description": "Unique identifier for the cryptocurrency index",
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "description": "Name of the cryptocurrency index (e.g., \"DeFi\", \"Smart Contracts\")",
            "type": "string"
          },
          "positive": {
            "description": "Total number of positive mentions for all cryptocurrencies in the index",
            "type": "integer",
            "format": "int64"
          },
          "negative": {
            "description": "Total number of negative mentions for all cryptocurrencies in the index",
            "type": "integer",
            "format": "int64"
          },
          "neutral": {
            "description": "Total number of neutral mentions for all cryptocurrencies in the index",
            "type": "integer",
            "format": "int64"
          },
          "timestamp": {
            "description": "Unix timestamp representing when this data was collected",
            "type": "number",
            "format": "double"
          },
          "date": {
            "description": "Human-readable date string formatted from the timestamp",
            "type": "string"
          }
        }
      },
      "ApiResponse_for_Array_of_IndexMentions": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/IndexMentions"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "IndexMentions": {
        "description": "Represents aggregated cryptocurrency mention data for an index\n\nThis struct contains information about how many times cryptocurrencies within a specific index were mentioned across monitored sources during a time period.",
        "type": "object",
        "required": [
          "date",
          "id",
          "members",
          "mentions",
          "name",
          "timestamp"
        ],
        "properties": {
          "id": {
            "description": "Unique identifier for the cryptocurrency index",
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "description": "Name of the cryptocurrency index (e.g., \"DeFi\", \"Smart Contracts\")",
            "type": "string"
          },
          "mentions": {
            "description": "Total number of mentions for all cryptocurrencies in the index",
            "type": "integer",
            "format": "int64"
          },
          "members": {
            "description": "List of cryptocurrency symbols that are members of this index",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "timestamp": {
            "description": "Unix timestamp representing when this data was collected",
            "type": "number",
            "format": "double"
          },
          "date": {
            "description": "Human-readable date string formatted from the timestamp",
            "type": "string"
          }
        }
      },
      "ApiResponse_for_IndexWeightData": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/IndexWeightData"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "IndexWeightData": {
        "type": "object",
        "required": [
          "coins",
          "date"
        ],
        "properties": {
          "date": {
            "description": "Date the weights were calculated.",
            "type": "string"
          },
          "coins": {
            "description": "List of cryptocurrencies with their respective indices and relative weights.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IndexWeight"
            }
          }
        }
      },
      "IndexWeight": {
        "type": "object",
        "required": [
          "category",
          "category_weight",
          "index_weight",
          "price",
          "symbol"
        ],
        "properties": {
          "category": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "format": "double"
          },
          "category_weight": {
            "type": "number",
            "format": "double"
          },
          "index_weight": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "ApiResponse_for_ActionResult": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/ActionResult"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "ActionResult": {
        "type": "object",
        "required": [
          "action",
          "duration",
          "end_date",
          "exit_price",
          "exit_reason",
          "highest_price",
          "in_trade",
          "lowest_price",
          "profit",
          "profit_percent",
          "score",
          "start_date",
          "start_price",
          "strategy",
          "symbol",
          "trend"
        ],
        "properties": {
          "symbol": {
            "description": "The symbol of the cryptocurrency",
            "type": "string"
          },
          "score": {
            "description": "The symbols Guavy scorecard score",
            "type": "number",
            "format": "double"
          },
          "strategy": {
            "description": "The strategy used for the trade (aggressive | conservative)",
            "type": "string"
          },
          "start_date": {
            "description": "The start date of the trade",
            "type": "string"
          },
          "end_date": {
            "description": "The end date of the trade",
            "type": "string"
          },
          "duration": {
            "description": "The duration of the trade in days",
            "type": "integer",
            "format": "int32"
          },
          "start_price": {
            "description": "The start price of the trade",
            "type": "number",
            "format": "double"
          },
          "exit_price": {
            "description": "The exit price of the trade",
            "type": "number",
            "format": "double"
          },
          "highest_price": {
            "description": "The highest price during the trade",
            "type": "number",
            "format": "double"
          },
          "lowest_price": {
            "description": "The lowest price during the trade",
            "type": "number",
            "format": "double"
          },
          "profit": {
            "description": "The profit of the trade",
            "type": "number",
            "format": "double"
          },
          "profit_percent": {
            "description": "The profit percentage of the trade",
            "type": "number",
            "format": "double"
          },
          "trend": {
            "description": "The trend of the currency during the trade",
            "allOf": [
              {
                "$ref": "#/components/schemas/Trend"
              }
            ]
          },
          "exit_reason": {
            "description": "The exit reason of the trade",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExitReason"
              }
            ]
          },
          "in_trade": {
            "description": "Whether currently in a trade",
            "type": "boolean"
          },
          "action": {
            "description": "The recommended action based on the most trade simulator activity (Buy, Sell, Hold, Stay)",
            "allOf": [
              {
                "$ref": "#/components/schemas/Action"
              }
            ]
          }
        }
      },
      "Action": {
        "type": "string",
        "enum": [
          "Buy",
          "Sell",
          "Hold",
          "Stay"
        ]
      },
      "ApiResponse_for_Array_of_ActionResult": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ActionResult"
                }
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "ApiResponse_for_CoinPriceBrief": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/CoinPriceBrief"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "CoinPriceBrief": {
        "type": "object",
        "required": [
          "brief",
          "symbol"
        ],
        "properties": {
          "symbol": {
            "type": "string"
          },
          "brief": {
            "type": "string"
          }
        }
      },
      "ApiResponse_for_SentimentSummary": {
        "oneOf": [
          {
            "type": "object",
            "required": [
              "Success"
            ],
            "properties": {
              "Success": {
                "$ref": "#/components/schemas/SentimentSummary"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "Error"
            ],
            "properties": {
              "Error": {
                "$ref": "#/components/schemas/ErrorResponse"
              }
            },
            "additionalProperties": false
          }
        ]
      },
      "SentimentSummary": {
        "type": "object",
        "required": [
          "summary",
          "timestamp"
        ],
        "properties": {
          "summary": {
            "type": "string"
          },
          "timestamp": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "HttpAuth": {
        "description": "Requires an Bearer (API auth) token to access, get it from your account settings.",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "bearer"
      }
    }
  }
}