diff --git a/README.md b/README.md index 055c983..7ce502a 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,42 @@ -# Mintlify Starter Kit +# Gigabrain Docs -Use the starter kit to get your docs deployed and ready to customize. +Documentation for [Gigabrain](https://gigabrain.gg) — an AI-powered market intelligence platform for crypto. -Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with +Built with [Mintlify](https://mintlify.com). -- Guide pages -- Navigation -- Customizations -- API reference pages -- Use of popular components +## Local Development -**[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)** +1. Install the Mintlify CLI: -## Development - -Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command: - -``` +```bash npm i -g mint ``` -Run the following command at the root of your documentation, where your `docs.json` is located: +2. Run the docs locally: -``` +```bash mint dev ``` -View your local preview at `http://localhost:3000`. +3. Open `http://localhost:3000` to preview. -## Publishing changes +## Project Structure -Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch. - -## Need help? - -### Troubleshooting +``` +├── index.mdx # Homepage +├── quickstart.mdx # User onboarding +├── pricing.mdx # Subscription tiers +├── core-features/ # Chat, Alpha, Agents +├── guides/ # Setup guides (agents, integrations, token) +├── developers/ # REST API overview +├── api-reference/ # API endpoint reference +├── ai-tools/ # Cursor, Claude Code, Windsurf setup +├── support/ # FAQs, contact, risk disclosure +├── legal/ # Terms and privacy policy +├── docs.json # Navigation and site config +└── style.css # Custom styling +``` -- If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI. -- If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`. +## Publishing -### Resources -- [Mintlify documentation](https://mintlify.com/docs) +Push to the default branch. The Mintlify GitHub app deploys automatically. diff --git a/api-reference/endpoint/create.mdx b/api-reference/endpoint/create.mdx deleted file mode 100644 index 5689f1b..0000000 --- a/api-reference/endpoint/create.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Create Plant' -openapi: 'POST /plants' ---- diff --git a/api-reference/endpoint/delete.mdx b/api-reference/endpoint/delete.mdx deleted file mode 100644 index 657dfc8..0000000 --- a/api-reference/endpoint/delete.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Delete Plant' -openapi: 'DELETE /plants/{id}' ---- diff --git a/api-reference/endpoint/get.mdx b/api-reference/endpoint/get.mdx deleted file mode 100644 index 56aa09e..0000000 --- a/api-reference/endpoint/get.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Get Plants' -openapi: 'GET /plants' ---- diff --git a/api-reference/endpoint/webhook.mdx b/api-reference/endpoint/webhook.mdx deleted file mode 100644 index 3291340..0000000 --- a/api-reference/endpoint/webhook.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'New Plant' -openapi: 'WEBHOOK /plant/webhook' ---- diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx deleted file mode 100644 index c835b78..0000000 --- a/api-reference/introduction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: 'Introduction' -description: 'Example section for showcasing API endpoints' ---- - - - If you're not looking to build API reference documentation, you can delete - this section by removing the api-reference folder. - - -## Welcome - -There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. - - - View the OpenAPI specification file - - -## Authentication - -All API endpoints are authenticated using Bearer tokens and picked up from the specification file. - -```json -"security": [ - { - "bearerAuth": [] - } -] -``` diff --git a/api-reference/openapi.json b/api-reference/openapi.json deleted file mode 100644 index da5326e..0000000 --- a/api-reference/openapi.json +++ /dev/null @@ -1,217 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "OpenAPI Plant Store", - "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", - "license": { - "name": "MIT" - }, - "version": "1.0.0" - }, - "servers": [ - { - "url": "http://sandbox.mintlify.com" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "paths": { - "/plants": { - "get": { - "description": "Returns all plants from the system that the user has access to", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "The maximum number of results to return", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Plant response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plant" - } - } - } - } - }, - "400": { - "description": "Unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - }, - "post": { - "description": "Creates a new plant in the store", - "requestBody": { - "description": "Plant to add to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewPlant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "plant response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plant" - } - } - } - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - }, - "/plants/{id}": { - "delete": { - "description": "Deletes a single plant based on the ID supplied", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of plant to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Plant deleted", - "content": {} - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - } - }, - "webhooks": { - "/plant/webhook": { - "post": { - "description": "Information about a new plant added to the store", - "requestBody": { - "description": "Plant added to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewPlant" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - } - } - } - }, - "components": { - "schemas": { - "Plant": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the plant", - "type": "string" - }, - "tag": { - "description": "Tag to specify the type", - "type": "string" - } - } - }, - "NewPlant": { - "allOf": [ - { - "$ref": "#/components/schemas/Plant" - }, - { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identification number of the plant", - "type": "integer", - "format": "int64" - } - } - } - ] - }, - "Error": { - "required": [ - "error", - "message" - ], - "type": "object", - "properties": { - "error": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - } -} \ No newline at end of file diff --git a/core-features/agents.mdx b/core-features/agents.mdx index 5cb82f6..d14c384 100644 --- a/core-features/agents.mdx +++ b/core-features/agents.mdx @@ -1,45 +1,262 @@ --- title: Agents -description: Automate Your Intuition +description: Autonomous trading execution with adaptive intelligence --- -Agents are autonomous units that are powered by the [The Intelligence Collective](https://docs.gigabrain.gg/#the-intelligence-collective). Moving beyond static "workflows," these agents use a recursive feedback loop to analyze, execute, and most importantly learn from every market outcome. +Agents are autonomous programs that execute trading strategies on your behalf. Each agent runs on a configurable schedule, analyzes market conditions using the Intelligence Collective, and executes trades according to your defined rules. -### Adaptive Learning: The Feedback Loop +## How it works -The core strength of an Agent is its ability to learn from its own "mistakes." +An agent consists of four components: -- **Outcome Monitoring**: Agents track entries against actual price action—identifying if a signal was overridden by macro volatility or a microstructure shift. -- **Strategy Refinement**: Every post-mortem updates the agent's internal **Learnings** database, refining how it weights different variables (e.g., favoring macro news over technical indicators during high-volatility events). -- **Transparent Reasoning**: Use the **Changelog** and **Learnings** tabs to audit how your agent is evolving its strategy over time. + + + The rules that define when and how your agent trades + + + Your strategic objective and risk parameters + + + The schedule on which your agent runs (e.g., every 1 hr) + + + Connected exchange accounts and notification channels + + -### Agent Archetypes: What You Can Build +### Execution cycle -#### 1. The Adaptive Swing Trader (BTC Focus) +Every time your agent's trigger fires: -> _"Analyze 4H BTC chart, microstructure, and whale positioning every 4 hours. Place a trade with 10% margin once confidence exceeds 75%. Re-analyze open trades every 30 minutes and send a performance summary to Telegram."_ +1. **Query current state**: Retrieve account balance, open positions, and recent performance +2. **Analyze market conditions**: Delegate to relevant specialists (Macro, Microstructure, Price Movement, etc.) +3. **Evaluate instructions**: Determine whether entry, exit, or risk management criteria are satisfied +4. **Execute actions**: Place orders, modify positions, or do nothing based on evaluation +5. **Record outcome**: Log the reasoning, actions taken, and market state to the Learnings database -#### 2. The Alpha Sniper (Asset-Agnostic) -> _"Monitor the Intelligence Feed. When a high-conviction signal (Confidence >75%) is flagged for **any** supported token, instantly open a $100 position at 5x leverage on that specific asset."_ +## Configuration -#### 3. The Protocol KPI Hunter (Fundamental) +### Instructions -> _"Monitor Hyperliquid protocol fees daily. If daily fees exceed $3M, open a long HYPE position with 10% account margin."_ +Define your trading logic using natural language. Be explicit about entry criteria, position sizing, exit rules, and risk limits. -#### 4. The Macro Guardian (Risk Mitigation) + +``` +Monitor BTC and ETH on the 15m timeframe. -> _"Monitor global news and the **Macro Analyst** for keywords like 'war', 'invasion', or 'geopolitical escalation'. If a high-impact macro shock is detected, immediately close 50% of all altcoin exposure and open an OCO hedge on BTC."_ +ENTRY CRITERIA: -### Specialist Delegation +- Price breaks above previous 4H high with volume >150% of 20-period average +- RSI(14) between 55-70 (momentum confirmed, not overbought) +- Funding rate <0.03% (avoiding overleveraged longs) +- Taker buy volume >55% over last 3 candles (aggressive buying) -Agents route tasks to specialized domain experts in real-time: +FILTERS (DO NOT ENTER IF): -- **Macro Analyst**: Monitors global liquidity, Fed policy, and geopolitical shocks. -- **Market State Analyst**: Classifies the regime (Risk-On/Off) to define current strategy. -- **Microstructure Analyst**: Identifies liquidation clusters and funding skews. -- **Trenches Analyst**: Scours social sentiment for micro-cap tokens (Rank 500+). +- VIX >30 (macro risk-off environment) +- Major resistance within 2% above entry +- Ongoing high-impact news event within next 2 hours -### Intelligent Synthesis +POSITION SIZING: -Every run is delivered as a structured report featuring a **Convicted Thesis**, **Risk Assessment**, **Execution Details**, **Learnings**, and **Invalidation Points**. \ No newline at end of file +- Base size: 5% of account balance +- Leverage: 3x (15% notional exposure) +- Maximum 2 concurrent positions + +EXIT RULES: + +- Take profit: +6% from entry (trim 50%), +10% (close remaining) +- Stop loss: -3% from entry (hard stop) +- Time stop: Close after 48 hours if neither TP nor SL hit +- Trailing stop: Once +5%, trail stop at -2% from peak + +RISK MANAGEMENT: + +- Daily loss limit: -5% of account (halt all trading) +- Weekly profit target: +15% (reduce position sizes by 50%) +- Maximum 4 trades per day (prevent overtrading) + +``` + + + +Instructions are interpreted by the agent's language model. Ambiguous phrasing may lead to unexpected behavior. Test new instructions with small position sizes. + + +### Triggers + +Choose how often your agent analyzes the market: + +| Frequency | Best for | +|-----------|----------| +| Every 5 minutes | Scalping strategies requiring frequent monitoring | +| Every 15 minutes | Intraday momentum trading | +| Hourly | Swing trading setups | +| Every 4 hours | Position trading with lower frequency | +| Daily | Fundamental-based strategies | + +### Integrations + +Connect your exchange account in [Integrations](https://gigabrain.gg/profile?tab=integrations) to enable live trading. Set read-only for monitoring or read-write for execution. + +## Monitoring + + + + Each agent run generates a trace showing: + - Current account state (balance, open positions, P&L) + - Market analysis from consulted specialists + - Evaluation of entry/exit criteria + - Actions taken or reasons for inaction + + Use this to verify the agent interprets your instructions correctly. + + + + View accumulated knowledge from past trades: + - Position history with entry/exit details + - Post-trade analysis of what worked and what didn't + - Evolving market pattern recognition + - Strategy refinement notes + + + + Audit trail of all agent modifications: + - Instruction updates + - Goal changes + - Trigger frequency adjustments + - Integration modifications + + + +## Example strategies + + + + + **Objective**: Identify and ride explosive moves across any asset. + + - **Trigger**: Every 15 minutes + - **Specialists**: Market State Analyst, Trenches Analyst, Price Movement Analyst + - **Entry**: High-conviction signal from Intelligence Feed (>75% confidence) + - **Position sizing**: 5% of account per trade, 5x leverage + - **Exit**: Trailing stop at 2% below peak, manual review after 24h + - **Risk limit**: Maximum 3 concurrent positions + + + + **Objective**: Take directional positions when technical and macro factors align. + + - **Trigger**: Every 4 hours + - **Specialists**: Macro Analyst, Market State Analyst, Price Movement Analyst + - **Entry**: 4H chart setup + favorable risk regime + positive BTC correlation + - **Position sizing**: 10% of account, 3x leverage + - **Exit**: TP at +8%, SL at -4% + - **Risk limit**: No new entries during risk-off regimes + + + + **Objective**: Trade based on on-chain metrics and protocol health. + + - **Trigger**: Daily at 00:00 UTC + - **Specialists**: Fundamentals Analyst, Market State Analyst + - **Entry**: Daily protocol fees >$3M, TVL increasing week-over-week + - **Position sizing**: 10% of account, 2x leverage + - **Exit**: Hold until fundamentals deteriorate or -10% SL + - **Risk limit**: Maximum 2 protocol-based positions + + + +## Best practices + + + + Use small position sizes (1-5%), set tight stops, and monitor the first 10-20 reasoning traces closely before scaling up. + + + + Review the Learnings tab weekly to identify failure modes, optimal conditions, and opportunities to refine entry criteria. + + + + Set profit caps at 2-5% of account value to prevent overtrading and lock in gains. + + + + Reduce position sizes during high VIX, avoid mean-reversion in trending Fed policy, pause during major geopolitical events. + + + + Run agents in read-only mode for at least one week, review all traces, then switch to read-write only when confident. + + + + Regularly check traces to verify correct interpretation and identify edge cases in your strategy logic. + + + +## Troubleshooting + + + + **Possible causes**: + 1. Trigger is not firing (check agent state is "Online") + 2. Entry criteria are not being met (review reasoning traces) + 3. Daily cap has been reached (check recent P&L) + 4. Risk limit has been triggered (check account balance vs. floor) + 5. Integration permissions are read-only (verify exchange API settings) + + + + **Possible causes**: + 1. Instructions are ambiguous (refine phrasing and test again) + 2. Market conditions changed rapidly between trigger intervals + 3. Specialist data was stale or delayed + 4. Edge case not covered in your instructions + + Review the reasoning trace for the specific run to understand what triggered the trade. + + + + **Possible causes**: + 1. Market regime has shifted (e.g., trending to range-bound) + 2. Strategy has attracted attention (edge degradation) + 3. Position sizing is too large for current volatility + 4. Stop losses are too tight for current ATR + + Review learnings for patterns and adjust instructions accordingly. + + + +## Limitations + + + + Agent actions are subject to trigger interval (minimum 5 minutes), API latency to exchanges, order processing time, and network conditions. Do not use agents for strategies requiring sub-minute execution. + + + + Agents cannot predict unexpected events (exchange outages, liquidity crises), guarantee fills at expected prices during volatile markets, or prevent slippage on large orders in illiquid markets. + + + + The language model may misinterpret ambiguous phrasing, cannot execute logic requiring external data not available through specialists, and has a knowledge cutoff. Review reasoning traces to verify correct interpretation. + + + +## Next steps + + + + Step-by-step instructions for creating your first agent + + + + Connect Hyperliquid and Telegram to enable live trading + + + + +**Not financial advice**: Agents execute your strategy, but they do not provide financial advice. You are responsible for defining appropriate risk parameters, understanding the strategies you implement, monitoring agent performance, and complying with relevant regulations. + diff --git a/core-features/alpha.mdx b/core-features/alpha.mdx index dc37b39..5b75c35 100644 --- a/core-features/alpha.mdx +++ b/core-features/alpha.mdx @@ -1,19 +1,90 @@ --- title: Alpha -description: Curated Market Insights +description: Market intelligence synthesis for crypto trading --- -![Alpha Feed](/images/alpha.png) +![Alpha Feed](/images/alpha-feed.png) -Alpha in Gigabrain is a way to get important market stories and insights that can really move prices. It pulls from smart searches, news about specific cryptocurrencies (like big investor buys or new rules), and recent events to highlight key indicators: think whale activity, regulations, or shifts in sectors like DeFi or AI. +Alpha is a market intelligence system that identifies price relevant events and narratives by analyzing news, onchain activity, and social signals. It surfaces actionable insights before they reach broader market awareness. -Unlike just reading raw headlines from news sites or aggregators, Alpha combines this info with fresh data (like current prices) to give you clear, practical summaries. This helps you spot trading opportunities early, before everyone else jumps in. It's like having a quick briefing from a team of analysts who connect the dots, saving you hours of scrolling through unrelated noise. +## What Alpha monitors -## Why Use Alpha? + + + Protocol announcements, regulatory developments, macroeconomic events + + + Large wallet movements, exchange flows, smart contract interactions + + + Narrative formation, KOL positioning, community sentiment shifts + + + Liquidation clusters, funding rate anomalies, OI/price divergences, squeeze + detection + + + Correlation tracking between crypto, equities, and DXY to identify + decoupling or global liquidity trends + + + Protocol-specific metrics: TVL growth for DeFi, API usage for AI, node + growth for infrastructure + + -- **Spot Hidden Edges**: It uncovers narratives that aren't obvious, such as a whale quietly building a position in a low-cap token or a regulatory rumor gaining traction. -- **Time Saver**: Instead of manual research, get synthesized overviews with context, like how a Fed announcement might ripple through crypto. -- **Actionable Focus**: Every insight includes an "impact rating" (low to high) and ties to real-time data, so you can decide if it's worth digging deeper. -- **Tailored to Crypto**: Optimized for markets like BTC/ETH trends, protocol launches, or meme coin hype, with cross-checks for accuracy. +Each insight includes an **impact rating** (Low/Medium/High), **context** on market conditions, **real-time data**, **actionability assessment**, and **invalidation criteria** for high-impact signals. -To access Alpha, navigate to the [Alpha Feed](https://gigabrain.gg/alpha) in the Gigabrain Terminal. +## How it works + +### Information sources + +Alpha continuously ingests data from: + +1. **Crypto native news**: Protocol blogs, governance forums, official announcements +2. **Traditional financial media**: Fed statements, regulatory filings, macro developments +3. **Onchain indexers**: Whale wallet tracking, exchange inflows/outflows, gas consumption +4. **Social platforms**: Twitter/X activity, Telegram signals, Discord announcements +5. **Prediction markets**: Polymarket odds, event probabilities +6. **Macro indicators**: VIX, DXY (Dollar Strength), Treasury Yields for risk regime classification + +### Synthesis process + +Raw information is filtered and analyzed to: + +- **Identify catalysts**: Events likely to drive price action (token unlocks, partnerships) +- **Detect early narratives**: Emerging themes before mainstream attention (sector rotation to AI tokens) +- **Flag anomalies**: Z-score anomalies (metrics 2+ standard deviations from 30-day mean) indicating statistically significant moves +- **Cross reference sources**: Verify information across channels to reduce false signals +- **Classify risk regime**: Determine if market is Risk-On, Risk-Off, or Neutral based on macro volatility +- **Detect squeeze setups**: Identify liquidation clusters where price is likely to be pulled to trigger stops + +### Insight format + +Each Alpha card displays: + +- **Headline**: Concise summary of the key development +- **Analysis**: Expandable section with market context, directional bias, and timing considerations +- **Invalidation criteria**: For high-impact insights, the specific price or event that nullifies the thesis +- **Tags**: Sentiment (BULLISH ↗ / BEARISH ↘), Impact level, Category, Timestamp +- **Actions**: Star to bookmark, "Suggest Trade" button for trade ideas + +### Suggest Trade + +Each insight includes a **Suggest Trade** button that: + +1. Analyzes the specific insight and current market conditions +2. Generates concrete trade ideas with entry criteria, position sizing, and exit rules +3. Can be used to manually execute trades or configure an Agent to act on similar signals automatically + +## Next steps + + + + Start discovering market insights in real-time + + + + Configure agents to act on Alpha signals automatically + + diff --git a/core-features/chat.mdx b/core-features/chat.mdx index 57481f5..0ec29c4 100644 --- a/core-features/chat.mdx +++ b/core-features/chat.mdx @@ -3,70 +3,199 @@ title: Chat description: Interactive Market Queries --- -![Chat Interface](/images/chat.png) -Gigabrain Chat is the conversational access to of the platform, enabling real-time market queries via natural language. It routes inputs to the Intelligence Collective, a team of specialized agents for parallel analysis, fetching live data from sources like prices, order books, onchain metrics, news, and sentiment. Responses synthesize insights with clear theses, risks, and invalidations, drawing from our four pillars for objective, trader-grade outputs. Chat supports iterative follow ups with session memory, allowing you to refine queries like a live trading desk conversation. -## Use Cases +![Chat Response Example](/images/chat-response.png) -### Trading +Gigabrain Chat is your conversational interface to the Intelligence Collective a team of specialized market analysts that work together to answer your questions in real-time. Instead of scrolling through charts, reading news, and checking onchain data separately, just ask a question and get a synthesized answer with a clear thesis, risk assessment, and invalidation points. -Get real-time price action, technical levels, and actionable edges for daily trading. +Chat pulls live data from prices, order books, funding rates, onchain metrics, news feeds, and social sentiment. It supports follow up questions with session memory, so you can refine your analysis like you're having a conversation with a trading desk. -- **Token Analysis**: "Analyze ETH's price movement, key levels, and is it a good time to long?" -- **Fundamentals**: "What's the TVL and revenue story for Aave?" -- **Trade Setups**: "Give me a BTC trade setup based on the 4H timeframe" -- **Market Updates**: "What's moving the market today?" -- **Sentiment Research**: "What's the buzz on Solana DeFi?" -- **Low-Cap Evaluation**: "Analyze the low-cap token PEPE" -- **Risk Regime**: "Is the market risk-on or risk-off right now?" +## How it works -### Polymarket + + + Your query is sent to the right analysts (Macro, Microstructure, + Fundamentals, Price Action, etc.) + + + Pulls current prices, funding rates, whale activity, protocol metrics, and + news + + + Combines all the data into a clear answer with a verdict, setup, and trade + idea + + + Remembers your conversation so you can ask follow ups without repeating + yourself + + -Prediction market odds cross referenced with crypto/macro data for probability leans. +You don't need to know which specialist to ask the system figures it out automatically. -- **Price Predictions**: "Will BTC hit $100K by EOY? Analyze the odds" -- **Event Analysis**: "Analyze the US election winner odds on Polymarket" -- **Token Markets**: "What's the lean on this token's FDV market one day after launch?" -- **Macro Alignment**: "How do Polymarket Fed rate cut odds align with macro liquidity?" -- **Trending Events**: "What's hot on Polymarket right now for crypto?" +## What you can ask -### Microstructure + + + Get actionable trade ideas with entry zones, targets, and invalidation levels. If your exchange is connected, you can execute trades directly from Chat. -Target perp futures dynamics for liquid tokens, spotting leverage risks and flows. + **Analysis examples:** + - "Analyze ETH's price movement, key levels, and is it a good time to long?" + - "Give me a BTC trade setup based on the 4H timeframe" + - "What's moving the market today?" -- **OI Tracking**: "Is OI spiking on ETH perps, indicating fresh longs?" -- **Funding Rates**: "Funding rates turning negative, short squeeze risk?" -- **Liquidations**: "BTC liquidations above $95K, downside trigger if support breaks?" -- **Long/Short Ratios**: "Longs at 70%, crowded trade, watch for reversals?" -- **Whale Positioning**: "Whales adding to shorts on SOL, bearish indicator?" + **Execution examples** (requires connected exchange): + - "Long ETH with $500 at 5x leverage" + - "Buy 0.5 SOL at market price" + - "Close my entire HYPE position" -### Macro + **What you get:** Current price action, technical levels, momentum analysis, and a clear verdict on whether there's an edge. -Evaluate economic regimes and policy impacts on crypto as a risk asset. + -- **Fed Policy**: "Fed pivot incoming, risk on for alts?" -- **Liquidity**: "Liquidity drying up, correlated BTC pullback likely?" -- **Risk Environment**: "Risk off mode, BTC tracking Nasdaq downside?" -- **Economic Events**: "Post CPI, hot inflation caps upside to $100K?" -- **Correlations**: "DXY strength pressuring BTC like in 2022?" -- **Geopolitical**: "Election uncertainty boosting BTC as hedge?" -- **Regime Shifts**: "Disinflation regime favors alts over BTC?" + + Deep dive into protocols, DeFi metrics, and token economics. -## Best Practices for Using Gigabrain Chat + **Examples:** + - "What's the TVL and revenue story for Aave?" + - "Deep dive on Aave TVL, revenue, utilization, token metrics" + - "What's the buzz on Solana DeFi?" -Gigabrain is built for sharp, data driven crypto market intel think real-time analysis, specialist breakdowns, and alpha hunting. Treat it like consulting a team of traders, not a general AI. Here's how to get the most value: + **What you get:** Protocol health metrics, revenue trends, competitive positioning, and whether fundamentals support the current price. -1. **Be Specific and Actionable**: Frame questions around decisions, like "What's the edge on SOL long here?" or "Break down ETH fundamentals post-Dencun." Vague asks like "Tell me about crypto" get generic responses; tie to timeframes, tokens, or events for depth. + -2. **Leverage the Specialist Team**: Mention what you need (e.g., "Macro view on BTC" or "Microstructure for UNI perps") to route to the right agent. We handle macro regimes, token fundamentals, price action, low cap narratives, and Polymarket odds. + + Understand leverage, positioning, and where the market is vulnerable. -3. **Iterate on Responses**: Follow up on key points, like "Elaborate on the invalidation level" or "Compare to last FOMC." This builds a conversation without restarting. + **Examples:** + - "Is OI spiking on ETH perps, indicating fresh longs?" + - "Funding rates turning negative, short squeeze risk?" + - "Longs at 70%, crowded trade, watch for reversals?" -4. **Combine Angles**: Ask for multi faceted views, e.g., "Fundamentals + technicals on ARB." We cross validate indicators for conviction. + **What you get:** Funding rates, open interest, long/short ratios, liquidation zones, and whale positioning with interpretation of what it means for price. -5. **Time It Right**: Use for pre trade checks or event previews (CPI, unlocks). Responses pull live data, so they're freshest during market hours. + -## Have a Market Query? + + Evaluate how broader economic conditions affect crypto. -Head to the [Gigabrain Terminal](https://gigabrain.gg/chat) and start chatting with the agent swarm!Ready to start querying? + **Examples:** + - "Fed pivot incoming, risk on for alts?" + - "Risk off mode, BTC tracking Nasdaq downside?" + - "DXY strength pressuring BTC like in 2022?" + + **What you get:** Analysis of Fed policy, liquidity conditions, DXY, VIX, yields, and how they're affecting crypto as a risk asset. + + + + + Cross reference prediction market odds with crypto and macro data. + + **Examples:** + - "Will BTC hit $100K by EOY? Analyze the odds" + - "What's hot on Polymarket right now for crypto?" + + **What you get:** Current odds, trend direction, and whether the prediction market signal aligns with other data. + + + + + Run analysis across multiple assets and discover opportunities. + + **Examples:** + - "Analyze a portfolio of 50% BTC, 30% ETH, 20% SOL" + - "List all tokens that gained more than 20% in the last 24 hours" + - "Get token unlocks for the next 14 days" + + **What you get:** Structured data, rankings, upcoming events, and context on what to watch. + + + + + +### Integrations + +Connect your exchange account to enable direct trade execution from Chat. + + + + 1. Navigate to Settings → Integrations + 2. Select your exchange (Hyperliquid, Binance, etc.) + 3. Authorize API access with trading permissions + 4. Return to Chat + + + + Once connected, ask Chat to execute trades directly: + - "Buy 0.1 ETH at market price" + - "Long BTC with $500, 3x leverage" + - "Place limit order for SOL at $140" + - "Close 50% of my ETH position" + + Chat will confirm the order details before execution. For automated trading without manual approval, use [Agents](/core-features/agents). + + + + + + Only connect exchanges you trust and understand the API permissions you're + granting. Always start with small position sizes to test functionality. + + +## Best Practices + + + + **Vague:** "Tell me about crypto" + **Better:** "Analyze BTC on the 4H chart. Is this a continuation or reversal setup?" + + + + **5m-15m** — Scalping **1H-4H** — Intraday/swing **1D-1W** — Position trading + + + + "Analyze SOL: fundamentals + technicals + microstructure" When all three + align, you have a stronger edge. + + + + "ETH long at $2,050. Check for major resistance nearby, funding rate extremes, + and upcoming macro events" + + + + - "Elaborate on the invalidation level" - "What historical precedent supports + this?" - "How does this compare to last FOMC?" + + + + Most useful during market hours, before major events (CPI, FOMC), or when you need a quick read on current conditions. + + + +## What Chat is (and isn't) + + + + ✓ Analyzes current market conditions across price, fundamentals, macro, and positioning + ✓ Provides clear theses with entry, target, and invalidation levels + ✓ Synthesizes data from multiple sources into one coherent view + ✓ Maintains conversation context for iterative follow ups + ✓ Pulls live data so analysis reflects current state + ✓ Executes trades directly when your exchange is connected + + + + ✗ Make trading decisions for you (it provides analysis, you decide whether to trade) + ✗ Predict the future with certainty (it analyzes current data and patterns) + ✗ Replace your own judgment (it's a tool to inform decisions, not make them) + ✗ Cover non-crypto markets in depth (focus is crypto with macro context) + + + +## Ready to start? + +Head to the [Gigabrain Terminal](https://gigabrain.gg/chat) and ask your first question. diff --git a/developers/brain-api-overview.mdx b/developers/brain-api-overview.mdx new file mode 100644 index 0000000..f293151 --- /dev/null +++ b/developers/brain-api-overview.mdx @@ -0,0 +1,275 @@ +--- +title: "Brain API Overview" +description: "Everything you can query from Gigabrain agents, data types, market intelligence, and response formats" +--- + +The Gigabrain API gives you programmatic access to the full Intelligence Collective, 7 specialized agents and 30+ data categories covering every corner of the crypto market. This page is the complete reference for what you can query, what data comes back, and how to use it. + +## The Intelligence Collective + +Every query is routed to one or more specialized agents. Here's what each agent covers and what you can ask. + +### Macro Analyst + +Global economic regimes and their crypto impact. + +**What it provides:** DXY, VIX, Treasury yields (2Y, 10Y), Fed Funds rate, S&P 500/Nasdaq changes, gold price, risk regime classification (Risk-On/Risk-Off/Neutral), and crypto macro correlations. + +**Example query:** +``` +Get current macro indicators. Respond as JSON with: dxy (value, change_24h), +vix (value, change_24h), us_10y_yield, us_2y_yield, fed_funds_rate, +sp500_change_24h, nasdaq_change_24h, gold_price, risk_regime, crypto_correlation +``` + +**Example response:** +```json +{ + "dxy": { "value": 97.52, "change_24h": "+0.08%" }, + "vix": { "value": 16.22, "change_24h": "-7.00%" }, + "us_10y_yield": "4.28%", + "us_2y_yield": "4.27%", + "fed_funds_rate": "3.64%", + "sp500_change_24h": "-0.84%", + "nasdaq_change_24h": "-1.43%", + "gold_price": 4947.55, + "risk_regime": "Risk-Neutral", + "crypto_correlation": "Mixed (BTC/SPX: -0.54, BTC/DXY: +0.68)" +} +``` + +--- + +### Microstructure Analyst + +Perpetual futures dynamics the leverage and positioning layer. + +**What it provides:** Open interest (absolute and delta), funding rates (current and predicted), long/short ratios, liquidation data (longs vs shorts, totals), whale positioning, taker flow imbalance, and CVD (Cumulative Volume Delta). + +**Funding rates:** +``` +Get funding rates for top 20 perpetual contracts. Respond as JSON array with: +symbol, funding_rate, predicted_rate, open_interest, long_short_ratio +``` + +```json +[ + { "symbol": "BTC", "funding_rate": 0.004495, "open_interest": 48667142312.64, "long_short_ratio": 2.93 }, + { "symbol": "ETH", "funding_rate": -0.009918, "open_interest": 26435246163.78, "long_short_ratio": 3.15 }, + { "symbol": "SOL", "funding_rate": -0.041527, "open_interest": 6356234179.05, "long_short_ratio": 4.45 } +] +``` + +**Liquidations:** +``` +Get liquidation data for past 24 hours. Respond as JSON with: +total_liquidations_usd, long_liquidations, short_liquidations, +largest_single_liquidation, top_liquidated_tokens (array with symbol and amount) +``` + +```json +{ + "total_liquidations_usd": 808370000, + "long_liquidations": 629650000, + "short_liquidations": 178720000, + "largest_single_liquidation": { + "amount_usd": 13390000, + "token": "ETH", + "exchange": "Hyperliquid", + "side": "long" + }, + "top_liquidated_tokens": [ + { "symbol": "ETH", "amount": 312540000 }, + { "symbol": "BTC", "amount": 305360000 }, + { "symbol": "SOL", "amount": 64990000 } + ] +} +``` + +--- + +### Fundamentals Analyst + +Protocol health and onchain metrics. + +**What it provides:** Total Value Locked (TVL) with changes, protocol revenue/fees, chain deployment info, utilization rates, active users, governance data, and token metrics (price, market cap, PE ratio). Supports deep dives on individual protocols. + +**DeFi rankings:** +``` +List top 15 DeFi protocols by TVL. Respond as JSON array with: +protocol, chain, tvl_usd, tvl_change_24h, tvl_change_7d, category, fees_24h +``` + +```json +[ + { + "protocol": "Aave", + "chain": "Ethereum", + "tvl_usd": 29268445970, + "tvl_change_24h": -0.78, + "tvl_change_7d": -15.77, + "category": "Lending", + "fees_24h": 3590000 + }, + { + "protocol": "Lido", + "chain": "Ethereum", + "tvl_usd": 28450000000, + "tvl_change_24h": -0.5, + "tvl_change_7d": -10.2, + "category": "Liquid Staking", + "fees_24h": 640000 + } +] +``` + +**Protocol deep dive:** +``` +Deep dive on Aave protocol. Respond as JSON with: tvl, tvl_change_7d, +chains_deployed, total_borrowed, total_supplied, utilization_rate, +revenue_24h, revenue_30d, active_users_daily, top_markets, +governance_proposals_active, token_price, token_mcap, pe_ratio +``` + +--- + +### Market State Analyst + +Overall sentiment and regime shifts. + +**What it provides:** Fear & Greed Index, BTC dominance, Altcoin Season Index, total market cap, volume data, narrative tracking with momentum scoring, and regime classification. + +**Sentiment indicators:** +``` +Get BTC fear and greed index and market sentiment indicators. Respond as JSON with: +fear_greed_index, fear_greed_label, btc_dominance, altcoin_season_index, +market_cap_total, market_cap_change_24h, volume_24h_total +``` + +```json +{ + "fear_greed_index": 14, + "fear_greed_label": "Extreme Fear", + "btc_dominance": 58.9, + "altcoin_season_index": 34, + "market_cap_total": 2490000000000, + "market_cap_change_24h": -1.42, + "volume_24h_total": 171610000000 +} +``` + +**Narrative tracking:** +``` +Get current crypto narratives ranked by momentum. Respond as JSON array with: +narrative, momentum_score (1-100), top_tokens, sentiment, key_catalyst +``` + +```json +[ + { "narrative": "Advanced Perp DEXs", "momentum_score": 95, "top_tokens": ["HYPE", "DYDX", "GMX"], "sentiment": "bullish" }, + { "narrative": "AI Agents & Compute", "momentum_score": 88, "top_tokens": ["FET", "TAO", "RENDER"], "sentiment": "bullish" }, + { "narrative": "Prediction Markets", "momentum_score": 82, "top_tokens": ["UMA", "GNO", "DRIFT"], "sentiment": "bullish" } +] +``` + +--- + +### Price Movement Analyst + +Technical analysis and trade signals. + +**What it provides:** Price and changes, EMAs (20, 50, 200), RSI, MACD, ADX, Supertrend, support/resistance levels, volume analysis, and trade setups with entry/exit/stop-loss. + +**Trading signals:** +``` +Get top trading signals right now. Respond as JSON array with: +symbol, signal_type, timeframe, entry_price, stop_loss, take_profit_1, +take_profit_2, risk_reward_ratio, confidence, reasoning +``` + +```json +[ + { + "symbol": "ETH", + "signal_type": "long", + "timeframe": "4h", + "entry_price": 2148, + "stop_loss": 2105, + "take_profit_1": 2231, + "take_profit_2": 2300, + "risk_reward_ratio": 1.9, + "confidence": 8, + "reasoning": "Extreme short crowding signals a contrarian squeeze..." + } +] +``` + +**Multi-asset comparison:** +``` +Compare BTC, ETH, and SOL for trading. Respond as JSON array with: +symbol, current_price, trend, momentum, support, resistance, +funding_rate, recommendation, confidence, key_catalyst +``` + +--- + +### Trenches Analyst + +Micro-cap discovery (under $100M market cap). + +**What it provides:** Micro-cap token discovery, social momentum tracking, KOL/influencer mentions, narrative analysis, risk assessment, and volume spikes. + +**Example query:** +``` +What micro-cap tokens under 50M are showing unusual social momentum right now? +``` + +--- + +### Polymarket Analyst + +Prediction markets. + +**What it provides:** Trending markets, odds (yes/no), volume data, resolution dates, and cross-referencing with macro/crypto data. + +**Trending predictions:** +``` +Get trending Polymarket crypto predictions. Respond as JSON array with: +market_title, yes_odds, no_odds, volume_24h, total_volume, end_date, category +``` + +```json +[ + { + "market_title": "Bitcoin all time high by March 31, 2026?", + "yes_odds": "3%", + "no_odds": "97%", + "volume_24h": "Low", + "total_volume": "$17,903", + "end_date": "2026-04-01", + "category": "Crypto" + } +] +``` + +--- + +## All Available Data + +All 30+ data categories support structured JSON responses. Here's what you can query across every domain, with examples. + +| Domain | Data Types | +| --- | --- | +| **Market Data** | Token prices, order book depth, short squeeze candidates, top gainers/losers, perp DEX rankings | +| **onchain & DeFi** | Whale activity, exchange flows, DEX volumes, L2 metrics, ETH onchain, yield opportunities, bridge flows, NFT collections, TVL, protocol revenue | +| **Macro & Derivatives** | ETF flows, options data, mining data, macro events calendar, correlations, DXY, VIX, yields | +| **Microstructure** | Funding rates, open interest, liquidations, long/short ratios, CVD, taker flow | +| **Sentiment & Research** | Fear & Greed, narratives, Polymarket predictions, portfolio analysis, relative strength, token unlocks, trading signals | + + +Some complex queries may time out (504 error) after approximately 600 seconds. This can happen with very broad social sentiment queries, large dataset NFT queries, or complex multi chain aggregations. If you hit a timeout, break the query into smaller, more specific requests. + + + +Gigabrain provides market intelligence and research tools not financial advice. Always do your own research before trading. See the [Risk Disclosure](/support/risk-disclosure). + diff --git a/developers/introduction.mdx b/developers/introduction.mdx index 8c14a49..bf9691c 100644 --- a/developers/introduction.mdx +++ b/developers/introduction.mdx @@ -3,7 +3,7 @@ title: REST API description: Programmatic access to Gigabrain's Intelligence Collective --- -The Gigabrain REST API provides programmatic access to the Intelligence Collective for automated market analysis. It is architected for seamless integration with trading bots, terminal applications, custom scripts, and backend services. +The Gigabrain REST API provides programmatic access to the Intelligence Collective for automated market analysis. It is architected for seamless integration with trading bots, terminal applications, custom scripts, and backend services. The API supports both markdown and **structured JSON responses**. ## Base URL @@ -83,18 +83,36 @@ The response includes a `Retry-After` header with the number of seconds to wait. ## Response Format -All endpoints return a consistent JSON structure: +All endpoints return a consistent JSON structure. The analysis response is in the `content` field. + + +The response field is `content` (not `message`). This applies to all chat responses. + ### Success Response ```json { "session_id": "uuid", - "message": "BTC is currently trading at $45,234...", + "content": "BTC is currently trading at $73,722...", "timestamp": "2026-01-07T12:00:00Z" } ``` +### JSON Response + +When you include "Respond as JSON" in your query message, the `content` field contains structured JSON data: + +```json +{ + "session_id": "uuid", + "content": "{\"fear_greed_index\": 14, \"fear_greed_label\": \"Extreme Fear\", \"btc_dominance\": 58.9}", + "timestamp": "2026-01-07T12:00:00Z" +} +``` + +Parse the `content` field to access the structured data. See the [Brain API Overview](/guides/structured-data) for all available query patterns and data types. + ### Error Response ```json @@ -105,6 +123,21 @@ All endpoints return a consistent JSON structure: } ``` +## Response Times + +Response times vary depending on query complexity: + +| Query Type | Typical Response Time | +| --- | --- | +| Simple data lookups (prices, funding rates, Fear & Greed) | 40–60 seconds | +| Multi-agent analysis (trade setups, protocol deep dives) | 60–120 seconds | +| Complex aggregations (yield opportunities, perp DEX rankings) | 120–180 seconds | +| Maximum timeout | ~600 seconds | + + +Set your HTTP client timeout to at least 600 seconds. If a query times out (504 error), break it into smaller, more specific requests. + + ## HTTP Status Codes | Status | Code | Meaning | @@ -115,6 +148,7 @@ All endpoints return a consistent JSON structure: | `404` | - | Resource not found | | `429` | `RATE_LIMIT_EXCEEDED` | Rate limit exceeded | | `500` | `API_ERROR` | Server error | +| `504` | - | Query timeout (try a simpler query) | ## Endpoints @@ -146,7 +180,7 @@ curl -X POST https://api.gigabrain.gg/v1/chat \ ```json { "session_id": "550e8400-e29b-41d4-a716-446655440000", - "message": "BTC is currently trading at $45,234. The 4H chart shows...", + "content": "BTC is currently trading at $73,722. The 4H chart shows...", "timestamp": "2026-01-07T12:00:00Z" } ``` @@ -184,7 +218,7 @@ curl -X GET "https://api.gigabrain.gg/v1/sessions?limit=10" \ ## Code Examples -### Python +### Python — Standard Query ```python import requests @@ -198,10 +232,40 @@ response = requests.post( "Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json" }, - json={"message": "What is the price of ETH?"} + json={"message": "What is the price of ETH?"}, + timeout=600 ) -print(response.json()) +data = response.json() +print(data["content"]) +``` + +### Python — JSON Query + +```python +import requests +import json + +API_KEY = "gb_sk_..." +BASE_URL = "https://api.gigabrain.gg" + +response = requests.post( + f"{BASE_URL}/v1/chat", + headers={ + "Authorization": f"Bearer {API_KEY}", + "Content-Type": "application/json" + }, + json={ + "message": "Get funding rates for top 10 perps. Respond as JSON array with: symbol, funding_rate, open_interest" + }, + timeout=600 +) + +data = response.json() +funding_data = json.loads(data["content"]) + +for token in funding_data: + print(f"{token['symbol']}: {token['funding_rate']}") ``` ### JavaScript (Node.js) @@ -216,11 +280,14 @@ const res = await fetch("https://api.gigabrain.gg/v1/chat", { "Content-Type": "application/json", }, body: JSON.stringify({ - message: "What is the price of ETH?", + message: "Get BTC fear and greed. Respond as JSON with: fear_greed_index, fear_greed_label", }), + signal: AbortSignal.timeout(600000), }); -console.log(await res.json()); +const data = await res.json(); +const sentiment = JSON.parse(data.content); +console.log(`Fear & Greed: ${sentiment.fear_greed_index} (${sentiment.fear_greed_label})`); ``` ### cURL @@ -228,7 +295,7 @@ console.log(await res.json()); ```bash curl -X POST https://api.gigabrain.gg/v1/chat \ -H "Authorization: Bearer gb_sk_" \ - -H "Content-Type: "application/json" \ + -H "Content-Type: application/json" \ -d '{"message": "Analyze BTC 4H chart"}' ``` @@ -278,6 +345,12 @@ Server error occurred. **Solution:** Retry your request. If the issue persists, contact support with the `session_id`. +### 504 Gateway Timeout + +Query took too long to process. + +**Solution:** Break your query into smaller, more specific requests. Avoid very broad social sentiment queries, large-dataset NFT queries, or complex multi-chain aggregations in a single request. + ## Best Practices 1. **Secure Your API Key** @@ -292,17 +365,23 @@ Server error occurred. - Implement exponential backoff when hitting limits - Cache responses when appropriate -3. **Error Handling** +3. **Set Appropriate Timeouts** + + - Set HTTP client timeout to at least 600 seconds + - Break complex queries into smaller requests to reduce response time + +4. **Use JSON for Automation** + + - Add "Respond as JSON" to queries for parseable responses + - Specify exact fields for consistent data structures + - See [Brain API Overview](/guides/structured-data) for query patterns + +5. **Error Handling** - Always handle API errors gracefully - - Implement retry logic for transient errors (500, 503) + - Implement retry logic for transient errors (500, 503, 504) - Log `session_id` for debugging and support requests -4. **Optimize Requests** - - Batch related queries when possible - - Use streaming for real-time responses - - Implement request timeouts - ## Support Need help? We're here for you: diff --git a/development.mdx b/development.mdx deleted file mode 100644 index ac633ba..0000000 --- a/development.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: 'Development' -description: 'Preview changes locally to update your docs' ---- - - - **Prerequisites**: - - Node.js version 19 or higher - - A docs repository with a `docs.json` file - - -Follow these steps to install and run Mintlify on your operating system. - - - - -```bash -npm i -g mint -``` - - - - -Navigate to your docs directory where your `docs.json` file is located, and run the following command: - -```bash -mint dev -``` - -A local preview of your documentation will be available at `http://localhost:3000`. - - - - -## Custom ports - -By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. For example, to run Mintlify on port 3333, use this command: - -```bash -mint dev --port 3333 -``` - -If you attempt to run Mintlify on a port that's already in use, it will use the next available port: - -```md -Port 3000 is already in use. Trying 3001 instead. -``` - -## Mintlify versions - -Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI: - -```bash -npm mint update -``` - -## Validating links - -The CLI can assist with validating links in your documentation. To identify any broken links, use the following command: - -```bash -mint broken-links -``` - -## Deployment - -If the deployment is successful, you should see the following: - - - Screenshot of a deployment confirmation message that says All checks have passed. - - -## Code formatting - -We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. - -## Troubleshooting - - - - - This may be due to an outdated version of node. Try the following: - 1. Remove the currently-installed version of the CLI: `npm remove -g mint` - 2. Upgrade to Node v19 or higher. - 3. Reinstall the CLI: `npm i -g mint` - - - - - Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again. - - - -Curious about what changed in the latest CLI version? Check out the [CLI changelog](https://www.npmjs.com/package/mintlify?activeTab=versions). diff --git a/docs.json b/docs.json index 2d01db1..54d2dd1 100644 --- a/docs.json +++ b/docs.json @@ -18,32 +18,40 @@ } }, "favicon": "/logo/logo.svg", - "css": "/styles.css", + "css": "/style.css", "navigation": { "tabs": [ { "tab": "Terminal", "groups": [ { - "group": "About", + "group": "Getting Started", "pages": [ - "index" + "index", + "quickstart", + "pricing" ] }, { - "group": "Core Features & Interface", + "group": "Core Features", "pages": [ "core-features/chat", "core-features/alpha", "core-features/agents" ] }, + { + "group": "Guides", + "pages": [ + "guides/agents-setup", + "guides/integrations" + ] + }, { "group": "Support", "pages": [ "support/faqs", "support/contact", - "support/agents-guide", "support/risk-disclosure" ] }, @@ -62,6 +70,7 @@ { "group": "Getting Started", "pages": [ + "developers/brain-api-overview", "developers/introduction" ] }, @@ -136,4 +145,4 @@ "telegram": "https://t.me/gigabraingg" } } -} \ No newline at end of file +} diff --git a/essentials/code.mdx b/essentials/code.mdx deleted file mode 100644 index ae2abbf..0000000 --- a/essentials/code.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: 'Code blocks' -description: 'Display inline code and code blocks' -icon: 'code' ---- - -## Inline code - -To denote a `word` or `phrase` as code, enclose it in backticks (`). - -``` -To denote a `word` or `phrase` as code, enclose it in backticks (`). -``` - -## Code blocks - -Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. - -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` - -````md -```java HelloWorld.java -class HelloWorld { - public static void main(String[] args) { - System.out.println("Hello, World!"); - } -} -``` -```` diff --git a/essentials/images.mdx b/essentials/images.mdx deleted file mode 100644 index 1144eb2..0000000 --- a/essentials/images.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: 'Images and embeds' -description: 'Add image, video, and other HTML elements' -icon: 'image' ---- - - - -## Image - -### Using Markdown - -The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code - -```md -![title](/path/image.jpg) -``` - -Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. - -### Using embeds - -To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images - -```html - -``` - -## Embeds and HTML elements - - - -
- - - -Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility. - - - -### iFrames - -Loads another HTML page within the document. Most commonly used for embedding videos. - -```html - -``` diff --git a/essentials/markdown.mdx b/essentials/markdown.mdx deleted file mode 100644 index a45c1d5..0000000 --- a/essentials/markdown.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: 'Markdown syntax' -description: 'Text, title, and styling in standard markdown' -icon: 'text-size' ---- - -## Titles - -Best used for section headers. - -```md -## Titles -``` - -### Subtitles - -Best used for subsection headers. - -```md -### Subtitles -``` - - - -Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. - - - -## Text formatting - -We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. - -| Style | How to write it | Result | -| ------------- | ----------------- | --------------- | -| Bold | `**bold**` | **bold** | -| Italic | `_italic_` | _italic_ | -| Strikethrough | `~strikethrough~` | ~strikethrough~ | - -You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text. - -You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text. - -| Text Size | How to write it | Result | -| ----------- | ------------------------ | ---------------------- | -| Superscript | `superscript` | superscript | -| Subscript | `subscript` | subscript | - -## Linking to pages - -You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com). - -Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section. - -Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily. - -## Blockquotes - -### Singleline - -To create a blockquote, add a `>` in front of a paragraph. - -> Dorothy followed her through many of the beautiful rooms in her castle. - -```md -> Dorothy followed her through many of the beautiful rooms in her castle. -``` - -### Multiline - -> Dorothy followed her through many of the beautiful rooms in her castle. -> -> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. - -```md -> Dorothy followed her through many of the beautiful rooms in her castle. -> -> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. -``` - -### LaTeX - -Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component. - -8 x (vk x H1 - H2) = (0,1) - -```md -8 x (vk x H1 - H2) = (0,1) -``` diff --git a/essentials/navigation.mdx b/essentials/navigation.mdx deleted file mode 100644 index 60adeff..0000000 --- a/essentials/navigation.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: 'Navigation' -description: 'The navigation field in docs.json defines the pages that go in the navigation menu' -icon: 'map' ---- - -The navigation menu is the list of links on every website. - -You will likely update `docs.json` every time you add a new page. Pages do not show up automatically. - -## Navigation syntax - -Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names. - - - -```json Regular Navigation -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Getting Started", - "pages": ["quickstart"] - } - ] - } - ] -} -``` - -```json Nested Navigation -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Getting Started", - "pages": [ - "quickstart", - { - "group": "Nested Reference Pages", - "pages": ["nested-reference-page"] - } - ] - } - ] - } - ] -} -``` - - - -## Folders - -Simply put your MDX files in folders and update the paths in `docs.json`. - -For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`. - - - -You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted. - - - -```json Navigation With Folder -"navigation": { - "tabs": [ - { - "tab": "Docs", - "groups": [ - { - "group": "Group Name", - "pages": ["your-folder/your-page"] - } - ] - } - ] -} -``` - -## Hidden pages - -MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them. diff --git a/essentials/reusable-snippets.mdx b/essentials/reusable-snippets.mdx deleted file mode 100644 index 376e27b..0000000 --- a/essentials/reusable-snippets.mdx +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "Reusable snippets" -description: "Reusable, custom snippets to keep content in sync" -icon: "recycle" ---- - -import SnippetIntro from '/snippets/snippet-intro.mdx'; - - - -## Creating a custom snippet - -**Pre-condition**: You must create your snippet file in the `snippets` directory. - - - Any page in the `snippets` directory will be treated as a snippet and will not - be rendered into a standalone page. If you want to create a standalone page - from the snippet, import the snippet into another file and call it as a - component. - - -### Default export - -1. Add content to your snippet file that you want to re-use across multiple - locations. Optionally, you can add variables that can be filled in via props - when you import the snippet. - -```mdx snippets/my-snippet.mdx -Hello world! This is my content I want to reuse across pages. My keyword of the -day is {word}. -``` - - - The content that you want to reuse must be inside the `snippets` directory in - order for the import to work. - - -2. Import the snippet into your destination file. - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import MySnippet from '/snippets/path/to/my-snippet.mdx'; - -## Header - -Lorem impsum dolor sit amet. - - -``` - -### Reusable variables - -1. Export a variable from your snippet file: - -```mdx snippets/path/to/custom-variables.mdx -export const myName = 'my name'; - -export const myObject = { fruit: 'strawberries' }; -``` - -2. Import the snippet from your destination file and use the variable: - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import { myName, myObject } from '/snippets/path/to/custom-variables.mdx'; - -Hello, my name is {myName} and I like {myObject.fruit}. -``` - -### Reusable components - -1. Inside your snippet file, create a component that takes in props by exporting - your component in the form of an arrow function. - -```mdx snippets/custom-component.mdx -export const MyComponent = ({ title }) => ( -
-

{title}

-

... snippet content ...

-
-); -``` - - - MDX does not compile inside the body of an arrow function. Stick to HTML - syntax when you can or use a default export if you need to use MDX. - - -2. Import the snippet into your destination file and pass in the props - -```mdx destination-file.mdx ---- -title: My title -description: My Description ---- - -import { MyComponent } from '/snippets/custom-component.mdx'; - -Lorem ipsum dolor sit amet. - - -``` diff --git a/essentials/settings.mdx b/essentials/settings.mdx deleted file mode 100644 index 884de13..0000000 --- a/essentials/settings.mdx +++ /dev/null @@ -1,318 +0,0 @@ ---- -title: 'Global Settings' -description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file' -icon: 'gear' ---- - -Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below. - -## Properties - - -Name of your project. Used for the global title. - -Example: `mintlify` - - - - - An array of groups with all the pages within that group - - - The name of the group. - - Example: `Settings` - - - - The relative paths to the markdown files that will serve as pages. - - Example: `["customization", "page"]` - - - - - - - - Path to logo image or object with path to "light" and "dark" mode logo images - - - Path to the logo in light mode - - - Path to the logo in dark mode - - - Where clicking on the logo links you to - - - - - - Path to the favicon image - - - - Hex color codes for your global theme - - - The primary color. Used for most often for highlighted content, section - headers, accents, in light mode - - - The primary color for dark mode. Used for most often for highlighted - content, section headers, accents, in dark mode - - - The primary color for important buttons - - - The color of the background in both light and dark mode - - - The hex color code of the background in light mode - - - The hex color code of the background in dark mode - - - - - - - - Array of `name`s and `url`s of links you want to include in the topbar - - - The name of the button. - - Example: `Contact us` - - - The url once you click on the button. Example: `https://mintlify.com/docs` - - - - - - - - - Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. - - - If `link`: What the button links to. - - If `github`: Link to the repository to load GitHub information from. - - - Text inside the button. Only required if `type` is a `link`. - - - - - - - Array of version names. Only use this if you want to show different versions - of docs with a dropdown in the navigation bar. - - - - An array of the anchors, includes the `icon`, `color`, and `url`. - - - The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor. - - Example: `comments` - - - The name of the anchor label. - - Example: `Community` - - - The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. - - - The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color. - - - Used if you want to hide an anchor until the correct docs version is selected. - - - Pass `true` if you want to hide the anchor until you directly link someone to docs inside it. - - - One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" - - - - - - - Override the default configurations for the top-most anchor. - - - The name of the top-most anchor - - - Font Awesome icon. - - - One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" - - - - - - An array of navigational tabs. - - - The name of the tab label. - - - The start of the URL that marks what pages go in the tab. Generally, this - is the name of the folder you put your pages in. - - - - - - Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo). - - - The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url - options that the user can toggle. - - - - - - The authentication strategy used for all API endpoints. - - - The name of the authentication parameter used in the API playground. - - If method is `basic`, the format should be `[usernameName]:[passwordName]` - - - The default value that's designed to be a prefix for the authentication input field. - - E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. - - - - - - Configurations for the API playground - - - - Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple` - - Learn more at the [playground guides](/api-playground/demo) - - - - - - Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. - - This behavior will soon be enabled by default, at which point this field will be deprecated. - - - - - - - A string or an array of strings of URL(s) or relative path(s) pointing to your - OpenAPI file. - - Examples: - - ```json Absolute - "openapi": "https://example.com/openapi.json" - ``` - ```json Relative - "openapi": "/openapi.json" - ``` - ```json Multiple - "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] - ``` - - - - - - An object of social media accounts where the key:property pair represents the social media platform and the account url. - - Example: - ```json - { - "x": "https://x.com/mintlify", - "website": "https://mintlify.com" - } - ``` - - - One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news` - - Example: `x` - - - The URL to the social platform. - - Example: `https://x.com/mintlify` - - - - - - Configurations to enable feedback buttons - - - - Enables a button to allow users to suggest edits via pull requests - - - Enables a button to allow users to raise an issue about the documentation - - - - - - Customize the dark mode toggle. - - - Set if you always want to show light or dark mode for new users. When not - set, we default to the same mode as the user's operating system. - - - Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example: - - - ```json Only Dark Mode - "modeToggle": { - "default": "dark", - "isHidden": true - } - ``` - - ```json Only Light Mode - "modeToggle": { - "default": "light", - "isHidden": true - } - ``` - - - - - - - - - A background image to be displayed behind every page. See example with - [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io). - diff --git a/support/agents-guide.mdx b/guides/agents-setup.mdx similarity index 68% rename from support/agents-guide.mdx rename to guides/agents-setup.mdx index 6744df4..a572ffd 100644 --- a/support/agents-guide.mdx +++ b/guides/agents-setup.mdx @@ -11,14 +11,14 @@ description: "Step-by-step guide to creating and configuring your first Agent" ## Getting Started -### Step 1: Navigate to Agents -1. Visit [Agents page](https://gigabrain.gg/agents) -2. Click **Create New Agent** to begin + -### Step 2: Configure your agent + +- Visit [Agents page](https://gigabrain.gg/agents) - +- Click **Create New Agent** to begin + Write your agent's strategy in natural language in the input box. Be specific about: - Entry conditions (e.g., confidence thresholds, market state requirements) @@ -51,30 +51,3 @@ description: "Step-by-step guide to creating and configuring your first Agent" Make any necessary adjustments and click **Confirm** to proceed. - -## Monitoring Your Agent - -### Reasoning tab - -Track your agent's key metrics: - -- **Confidence**: Mean confidence level of executed trades -- **Market State**: Current market state -- **Specialists**: Specialists consulted -- **Instructions**: Instructions given to the agent - -### Learnings Tab - -Your agent's adaptive learning system tracks: - -- **Outcome Monitoring**: How predictions matched actual price action -- **Strategy Refinements**: Weight adjustments to different variables -- **Pattern Recognition**: Recurring market conditions that led to wins/losses - -### Changelog - -Audit trail of all agent modifications: - -- Configuration changes -- Instruction updates -- Performance milestones \ No newline at end of file diff --git a/guides/integrations.mdx b/guides/integrations.mdx new file mode 100644 index 0000000..67e5f69 --- /dev/null +++ b/guides/integrations.mdx @@ -0,0 +1,58 @@ +--- +title: "Integrations" +description: "Connect exchanges and messaging platforms to Gigabrain" +--- + +Gigabrain integrates with third-party platforms for trade execution and real-time notifications. All integrations are managed from your [Profile → Integrations](https://gigabrain.gg/profile?tab=integrations) page. + + +Gigabrain is non-custodial. We never have access to your funds. Exchange API keys only allow Gigabrain to place orders you configure, it cannot withdraw funds. Never share your wallet seed phrase or recovery phrase through the platform. + + +## Hyperliquid + +Hyperliquid is the primary execution venue for Gigabrain Agents. Connecting it allows your Agents to place, monitor, and close trades on your behalf based on the strategies you define. + +### Setup + + + + 1. Go to [Profile → Integrations](https://gigabrain.gg/profile?tab=integrations). + 2. Select **Hyperliquid**. + 3. Connect your wallet and sign transactions to authorize generate apis wallet to trade on your behalf. + + + Once connected, you should see a **Connected** status on your Integrations page. Your Agents can now execute trades on Hyperliquid. + + + +### Key considerations + +- **Execution risk**: Orders are submitted to Hyperliquid under its rules. Slippage, partial fills, and liquidation mechanics are controlled by Hyperliquid, not Gigabrain. See the [Risk Disclosure](/support/risk-disclosure) for details. + +## Telegram Notifications + +Connect Telegram to receive real-time alerts from your Agents, including trade executions, performance summaries, and market signals. + +### Setup + + + + 1. Go to [Profile → Integrations](https://gigabrain.gg/profile?tab=integrations). + 2. Select **Telegram**. + 3. Copy the displayed code and message it to [telegram bot](https://t.me/AskGigabrainBot). + + + + 1. You should see a **Connected** status on your Integrations page. + + + + +## Managing Integrations + +- View and manage all connected integrations from your [Profile → Integrations](https://gigabrain.gg/profile?tab=integrations) page. +- You can disconnect any integration at any time. +- Disconnecting an exchange integration will stop any active Agents from executing trades. + +Need help? Contact on [Telegram](https://t.me/gigabraingg). diff --git a/images/alpha-feed.png b/images/alpha-feed.png new file mode 100644 index 0000000..75c4d00 Binary files /dev/null and b/images/alpha-feed.png differ diff --git a/images/chat-response.png b/images/chat-response.png new file mode 100644 index 0000000..3e93744 Binary files /dev/null and b/images/chat-response.png differ diff --git a/index.mdx b/index.mdx index b0e4fbe..7dcb50e 100644 --- a/index.mdx +++ b/index.mdx @@ -3,20 +3,55 @@ title: What is Gigabrain? description: Your AI trading desk for crypto markets --- -## - -Gigabrain is an advanced reasoning engine designed for real-time market analysis. It emulates the structured thinking of a professional trader by integrating data from multiple sources, including live prices, on-chain metrics, news, and sentiment. Users can query Gigabrain via natural language prompts to obtain synthesized insights, eliminating the need for manual data aggregation across liquidations, microstructure, fundamentals, technical analysis, and external events. This enables faster, more informed decision making while adhering to best practices for market analysis. +Gigabrain is an advanced reasoning engine designed for real-time market analysis. It emulates the structured thinking of a professional trader by integrating data from multiple sources, including live prices, onchain metrics, news, and sentiment. Users can query Gigabrain via natural language prompts to obtain synthesized insights eliminating the need for manual data aggregation across liquidations, microstructure, fundamentals, technical analysis, and external events. This enables faster, more informed decision making while adhering to best practices for market analysis. ## The Intelligence Collective -Gigabrain operates through a team of domain specific agents, each equipped with tailored tools and expertise. These agents work in parallel under a central coordinator to gather, analyze, and reconcile data, providing comprehensive market intelligence that turns raw inputs into alpha-generating insights. The core agents are: +Gigabrain operates through a team of domain specific agents, each equipped with tailored tools and expertise. These agents work in parallel under a central coordinator to gather, analyze, and reconcile data, providing comprehensive market intelligence that turns raw inputs into alpha-generating insights. + + + + Global economic regimes DXY, VIX, Treasury yields (2Y, 10Y), Fed Funds rate, S&P 500/Nasdaq, gold, risk regime classification, and crypto-macro correlations. + + + + Perpetual futures dynamics open interest, funding rates, liquidation data, long/short ratios, whale positioning, taker flow imbalance, and CVD. + + + + Protocol health TVL, revenue, fees, chain deployments, utilization rates, active users, governance data, and token metrics (price, market cap, PE ratio). + + + + Overall sentiment Fear & Greed Index, BTC dominance, Altcoin Season Index, total market cap, volume data, narrative tracking, and regime classification. + + + + Technical analysis EMAs (20, 50, 200), RSI, MACD, ADX, Supertrend, support/resistance levels, volume analysis, and trade setups with entry/exit. + + + + Micro-cap tokens (under $100M market cap) social momentum, KOL/influencer mentions, narrative analysis, volume spikes, and risk assessment. + + + + Prediction markets trending markets, odds (yes/no), volume, resolution dates, and cross-referencing with macro and crypto data. + + + +## Beyond the Agents + +In addition to the specialized agents, Gigabrain provides access to a wide range of market data: + +| Category | Examples | +| --- | --- | +| **Market Data** | Token prices, funding rates, open interest, liquidations, order book depth | +| **Onchain** | TVL, protocol revenue, DEX volumes, whale activity, exchange flows, bridge flows | +| **Macro** | ETF flows, options data, mining data, macro events calendar, correlations | +| **Derivatives** | Short squeeze candidates, perp DEX rankings, top gainers/losers | +| **Research** | Yield opportunities, token unlocks, L2 metrics, NFT collections, relative strength | +| **Sentiment** | Fear & Greed, narrative tracking, Polymarket predictions, portfolio analysis | -- **Macro Analyst**: Examines global economic regimes, including DXY, VIX, Treasury yields, commodities (e.g., gold/silver), and liquidity flows to contextualize risk on/off environments. -- **Microstructure Analyst**: Focuses on perpetual futures dynamics, such as open interest (OI), funding rates, liquidations, and positioning to identify imbalances and short-term moves. -- **Fundamentals Analyst**: Assesses protocol health via metrics like TVL, revenue, emissions, unlocks, and ecosystem activity, tailored to asset type. -- **Market State Analyst**: Evaluates overall sentiment, high impact alphas, and regime shifts using news, events, and macro insights for broad market overviews. -- **Price Movement Analyst**: Performs technical analysis on price action, including EMAs, SMAs, momentum indicators, volume profiles, and key support/resistance zones to spot patterns and trends. -- **Trenches Analyst**: Specializes in micro cap tokens (under $100M market cap), leveraging social intelligence and narratives analysis, sentiment, and low liquidity risks. -- **Polymarket Analyst**: Analyzes prediction markets for odds, volume, and resolutions across crypto, politics, and events to gauge probabilistic outcomes. +All data types support **structured JSON responses** when explicitly requested, making Gigabrain ideal for building trading bots, dashboards, and data pipelines. See the [Brain API Overview](/guides/brain-api-overview) for details. Gigabrain is your personal market intelligence engine thinking with you, to provide professional grade, real-time edge comparable to top quant funds. It transforms data overload into decisive insights, all from a simple prompt. diff --git a/legal/terms-and-conditions.mdx b/legal/terms-and-conditions.mdx index 8742ee7..1ded97e 100644 --- a/legal/terms-and-conditions.mdx +++ b/legal/terms-and-conditions.mdx @@ -23,7 +23,7 @@ If you are accepting these Terms on behalf of a company, organization, partnersh 2.2. Words and expressions defined in any part of these Terms shall have the same meaning throughout the document unless expressly stated otherwise or unless the context requires a different interpretation. Defined terms may be used in singular or plural form and capitalised for convenience, however, failure to capitalise a defined term shall not affect its intended meaning. - 2.3. These Terms incorporate by reference the Platform’s Privacy Policy \[*insert hyperlink*\], Risk Disclosure Statement \[*insert hyperlink*\], and any additional terms or notices published by Gigabrain from time to time. All such incorporated documents shall be read together with these Terms and shall form part of the legally binding agreement between you and Gigabrain. In the event of inconsistency between these Terms and any incorporated document, these Terms shall prevail unless expressly stated otherwise. + 2.3. These Terms incorporate by reference the Platform's [Privacy Policy](/legal/privacy-policy), [Risk Disclosure Statement](/support/risk-disclosure), and any additional terms or notices published by Gigabrain from time to time. All such incorporated documents shall be read together with these Terms and shall form part of the legally binding agreement between you and Gigabrain. In the event of inconsistency between these Terms and any incorporated document, these Terms shall prevail unless expressly stated otherwise. 2.4. The words “include,” “includes,” “including,” “such as,” “for example,” and similar expressions shall be interpreted as illustrative and shall not limit the meaning of the words preceding them. Any examples are provided for clarity only and shall not be construed as exhaustive. @@ -45,11 +45,11 @@ If you are accepting these Terms on behalf of a company, organization, partnersh 4.3. The Services may utilize automated systems, including artificial intelligence and algorithmic processes, to generate outputs such as commentary, analysis, summaries, classifications, or structured responses. These outputs are generated based on patterns, data inputs, and probabilistic models, and may contain errors, omissions, outdated information, or incomplete analysis. You acknowledge that AI-generated outputs are inherently uncertain and should not be relied upon as a substitute for independent judgment or professional advice. Gigabrain does not guarantee the accuracy, completeness, or timeliness of any output and disclaims responsibility for decisions made in reliance on such outputs. - 4. You acknowledge that cryptocurrency markets are highly volatile and risky. You may lose all or part of the funds you deploy in any trading or investment activity. Past performance, back-tests, sample results, or stated accuracy rates do not guarantee future results. + 4.4. You acknowledge that cryptocurrency markets are highly volatile and risky. You may lose all or part of the funds you deploy in any trading or investment activity. Past performance, back-tests, sample results, or stated accuracy rates do not guarantee future results. 5. **Access and Wallet Connection** - 5.1. Access to the Services may require connecting a compatible web3 wallet or other authentication mechanism made available by Gigabrain. You are responsible for maintaining the confidentiality and security of your authentication method and for all activity conducted through your account or connected wallet(s). You must notify us at \[support@gigabrain.gg\] if you suspect unauthorized access or misuse. + 5.1. Access to the Services may require connecting a compatible web3 wallet or other authentication mechanism made available by Gigabrain. You are responsible for maintaining the confidentiality and security of your authentication method and for all activity conducted through your account or connected wallet(s). You must notify us at [support@gigabrain.gg](mailto:support@gigabrain.gg) if you suspect unauthorized access or misuse. 5.2. Gigabrain does not control your wallet provider, wallet software, or private keys. You are solely responsible for maintaining the security of your wallet, private keys, seed phrase, and recovery phrase. You must never share your seed phrase or recovery phrase with Gigabrain or submit it through the Services. @@ -167,34 +167,34 @@ We may update these Terms from time to time. When we do, we will revise the “L 21. **Governing Law & Jurisdiction** - 1. In the event of any dispute arising out of or relating to these Terms, the parties agree to first attempt to resolve the dispute informally through good-faith negotiation. If a potential dispute arises, you must contact us by sending an email to \[support@gigabrain.gg\], so that we can attempt to resolve it without resorting to formal dispute resolution. If we aren't able to reach an informal resolution within 60 (sixty) days of your email, then you and we both agree to resolve the potential dispute according to the process set forth herein. + 21.1. In the event of any dispute arising out of or relating to these Terms, the parties agree to first attempt to resolve the dispute informally through good-faith negotiation. If a potential dispute arises, you must contact us by sending an email to [support@gigabrain.gg](mailto:support@gigabrain.gg), so that we can attempt to resolve it without resorting to formal dispute resolution. If we aren't able to reach an informal resolution within 60 (sixty) days of your email, then you and we both agree to resolve the potential dispute according to the process set forth herein. - 2. These Terms, and all matters or disputes arising out of or in connection with these Terms, the subject matter hereof or the activities of you or Gigabrain in connection with or contemplated by these Terms, including your access and use of the Services (including any act or omission related thereto) shall be governed and construed by the laws of the British Virgin Islands. The courts of the British Virgin Islands shall have exclusive jurisdiction to settle any dispute or claim (including non-contractual disputes or claims) arising out of or in connection with these Terms or their subject matter or formation. + 21.2. These Terms, and all matters or disputes arising out of or in connection with these Terms, the subject matter hereof or the activities of you or Gigabrain in connection with or contemplated by these Terms, including your access and use of the Services (including any act or omission related thereto) shall be governed and construed by the laws of the British Virgin Islands. The courts of the British Virgin Islands shall have exclusive jurisdiction to settle any dispute or claim (including non-contractual disputes or claims) arising out of or in connection with these Terms or their subject matter or formation. 22. **Miscellaneous** - 21.1. **Entire Agreement.** These Terms, the Privacy Policy and the Risk Disclosure, along with any other policies or guidelines that Gigabrain publishes or makes available through the Platform from time to time, constitute the entire agreement between you and Gigabrain with respect to the Services, and supersedes any prior or contemporaneous agreements, communications, or arrangements, whether oral or written, regarding the Services. + 22.1. **Entire Agreement.** These Terms, the Privacy Policy and the Risk Disclosure, along with any other policies or guidelines that Gigabrain publishes or makes available through the Platform from time to time, constitute the entire agreement between you and Gigabrain with respect to the Services, and supersedes any prior or contemporaneous agreements, communications, or arrangements, whether oral or written, regarding the Services. - 21.2. **Maintenance of Platform.** Your access to and use of the Platform may occasionally be interrupted for various reasons, including but not limited to maintenance, updates, repairs, or upgrades initiated by Gigabrain. While we endeavour to notify users of scheduled maintenance activities whenever feasible, urgent maintenance may occur without prior notice. During such maintenance periods, the availability or functionality of certain features of the Services may be temporarily affected. Gigabrain strives to minimize disruptions and will schedule maintenance during off-peak hours whenever possible to maintain the optimal performance, security, and functionality of the Services. + 22.2. **Maintenance of Platform.** Your access to and use of the Platform may occasionally be interrupted for various reasons, including but not limited to maintenance, updates, repairs, or upgrades initiated by Gigabrain. While we endeavour to notify users of scheduled maintenance activities whenever feasible, urgent maintenance may occur without prior notice. During such maintenance periods, the availability or functionality of certain features of the Services may be temporarily affected. Gigabrain strives to minimize disruptions and will schedule maintenance during off-peak hours whenever possible to maintain the optimal performance, security, and functionality of the Services. - 21.3. **Waiver.** The failure of Gigabrain to enforce any right or provision of these Terms shall not constitute a waiver of such right or provision. Any waiver of any provision of these Terms will be effective only if in writing and signed by Gigabrain. + 22.3. **Waiver.** The failure of Gigabrain to enforce any right or provision of these Terms shall not constitute a waiver of such right or provision. Any waiver of any provision of these Terms will be effective only if in writing and signed by Gigabrain. - 21.4. **Severability.** If any provision of these Terms is found to be unlawful, void, or unenforceable, that provision shall be deemed severable from these Terms and shall not affect the validity and enforceability of any remaining provisions, which shall continue in full force and effect. + 22.4. **Severability.** If any provision of these Terms is found to be unlawful, void, or unenforceable, that provision shall be deemed severable from these Terms and shall not affect the validity and enforceability of any remaining provisions, which shall continue in full force and effect. - 21.5. **Assignment.** You may not assign or transfer any rights or obligations under these Terms without our prior written consent. Gigabrain may freely assign or transfer its rights and obligations under these Terms without restriction, including in connection with a merger, acquisition, or sale of assets, or by operation of law. + 22.5. **Assignment.** You may not assign or transfer any rights or obligations under these Terms without our prior written consent. Gigabrain may freely assign or transfer its rights and obligations under these Terms without restriction, including in connection with a merger, acquisition, or sale of assets, or by operation of law. - 21.6. **Relationship of the Parties.** These Terms do not create a joint venture, partnership, employment, or agency relationship between you and Gigabrain. Both parties act independently and have no authority to bind the other in any respect. + 22.6. **Relationship of the Parties.** These Terms do not create a joint venture, partnership, employment, or agency relationship between you and Gigabrain. Both parties act independently and have no authority to bind the other in any respect. - 21.7. **Force Majeure.** Gigabrain shall not be liable for any failure or delay resulting from any circumstances beyond its reasonable control, including but not limited to acts of God, natural disasters, war, governmental actions or acts of terrorism, civil disturbances, labour conditions, power failures, internet interruptions, mechanical or data processing failures or other unforeseen events. + 22.7. **Force Majeure.** Gigabrain shall not be liable for any failure or delay resulting from any circumstances beyond its reasonable control, including but not limited to acts of God, natural disasters, war, governmental actions or acts of terrorism, civil disturbances, labour conditions, power failures, internet interruptions, mechanical or data processing failures or other unforeseen events. - 21.8. **Construction.** The rule of construction that a contract should be interpreted against the party responsible for its drafting shall not apply. + 22.8. **Construction.** The rule of construction that a contract should be interpreted against the party responsible for its drafting shall not apply. - 21.9. **Survival.** The provisions of these Terms that by their nature should survive termination, including but not limited to indemnity, disclaimers, limitations of liability, intellectual property rights, governing law, and miscellaneous provisions, shall survive any termination or expiration of these Terms. + 22.9. **Survival.** The provisions of these Terms that by their nature should survive termination, including but not limited to indemnity, disclaimers, limitations of liability, intellectual property rights, governing law, and miscellaneous provisions, shall survive any termination or expiration of these Terms. - 21.10. **Electronic Communications.** By creating an account or using the Services, you consent to receive all notices, disclosures, agreements, records, statements, and other communications (“**Electronic Communications**”) in electronic form. Electronic Communications may be delivered via email to the email address associated with your account or through notifications or messages displayed via your user dashboard on the Platform or any other electronic method reasonably designed to provide notice to you. + 22.10. **Electronic Communications.** By creating an account or using the Services, you consent to receive all notices, disclosures, agreements, records, statements, and other communications (“**Electronic Communications**”) in electronic form. Electronic Communications may be delivered via email to the email address associated with your account or through notifications or messages displayed via your user dashboard on the Platform or any other electronic method reasonably designed to provide notice to you. You agree that all Electronic Communications provided by Gigabrain shall satisfy any legal requirement that such communications be in writing, and you waive any right to insist on receiving communications in paper or non-electronic form, except where applicable law specifically requires otherwise. You are responsible for ensuring that your email address and all other contact information associated with your account are accurate, current, and capable of receiving Electronic Communications. - 21.11. **Reporting.** If you identify any vulnerabilities, security issues, or concerns regarding the Services, please report them promptly by contacting \[support@gigabrain.gg\]. Your cooperation helps us maintain a secure and reliable Platform. + 22.11. **Reporting.** If you identify any vulnerabilities, security issues, or concerns regarding the Services, please report them promptly by contacting [support@gigabrain.gg](mailto:support@gigabrain.gg). Your cooperation helps us maintain a secure and reliable Platform. \ No newline at end of file diff --git a/pricing.mdx b/pricing.mdx new file mode 100644 index 0000000..2ae2ef2 --- /dev/null +++ b/pricing.mdx @@ -0,0 +1,68 @@ +--- +title: Pricing +description: Access plans for Gigabrain +--- + +Gigabrain offers two access models: **pay-as-you-go** starting at $5, or **token-gated access** for BRAIN holders. + +## Pay-as-you-go + +Start using Gigabrain for as low as $5. + +**What's included:** + +- Chat: Pay per query for market analysis and trade intelligence +- API access: Programmatic queries with structured JSON responses +- Agents: Deploy autonomous trading strategies +- Alpha Feed: Real-time intelligence on market moving events + +**How it works:** + +Credits are consumed per query based on complexity and data sources used. Simple price checks consume minimal credits, while multi specialist analysis with full market context consumes more. Pricing is usage based you only pay for what you use. + +## Token-gated access + +Hold 1M BRAIN tokens to unlock unlimited access. + +**What's included:** + +- Unlimited Chat: No per query fees, ask as many questions as you need +- API access: Programmatic queries with structured JSON responses +- Agents: Deploy autonomous trading strategies +- Alpha Feed: Real-time intelligence on market moving events +- Monthly API credits: Free API credits based on token holdings +- Alpha Community: Private community access for BRAIN holders + +**How it works:** + +Maintain 1M BRAIN tokens in your connected wallet to access all features without per-query fees. API credits scale with holdings—larger positions receive more monthly credits. + +## Feature comparison + +| Feature | Pay-as-you-go | Token-gated (1M BRAIN) | +| ----------------------- | ------------------- | ----------------------------- | +| **Chat access** | Pay per query | Unlimited | +| **API access** | ✓ | ✓ | +| **Agents** | ✓ | ✓ | +| **Alpha Feed** | ✓ | ✓ | +| **Monthly API credits** | Purchase separately | Included (scaled by holdings) | +| **Alpha Community** | ✗ | ✓ | +| **Minimum cost** | $5 | 1M BRAIN tokens | + +## Getting started + +### Pay-as-you-go + +1. Head to [profile](https://gigabrain.gg/profile?tab=credits) and click on "Add Credits" +2. Complete the payment process via coinbase commerce +3. Start using Chat, Agents, or API immediately + +### Token-gated access + +1. Acquire 1M BRAIN [tokens](https://app.virtuals.io/virtuals/18114) +2. Connect your wallet with token holdings +3. Access unlocks automatically upon verification + +--- + +For account specific pricing questions, contact on [telegram](https://t.me/gigabraingg). diff --git a/quickstart.mdx b/quickstart.mdx index c711458..7167fc1 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,80 +1,67 @@ --- title: "Quickstart" -description: "Start building awesome documentation in minutes" +description: "Get started with Gigabrain in minutes" --- -## Get started in three steps +Go from zero to your first market insight in three steps. -Get your documentation site running locally and make your first customization. + + + 1. Go to the [Gigabrain Terminal](https://gigabrain.gg/login). + 2. Connect a compatible web3 wallet to sign in. + 3. Once connected, you'll land on the Gigabrain dashboard. + -### Step 1: Set up your local environment + + Navigate to [Chat](https://gigabrain.gg/chat) and type a natural language query. - - - During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). - - To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs. - - - 1. Install the Mintlify CLI: `npm i -g mint` - 2. Navigate to your docs directory and run: `mint dev` - 3. Open `http://localhost:3000` to see your docs live! - - Your preview updates automatically as you edit files. - - - -### Step 2: Deploy your changes - - - - Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). - - Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. - - - For a first change, let's update the name and colors of your docs site. - - 1. Open `docs.json` in your editor. - 2. Change the `"name"` field to your project name. - 3. Update the `"colors"` to match your brand. - 4. Save and see your changes instantly at `http://localhost:3000`. - Try changing the primary color to see an immediate difference! - - + -### Step 3: Go live + + Head to the [Alpha Feed](https://gigabrain.gg/alpha) to see curated market + insights, narratives, whale activity, regime shifts, and catalysts synthesized + and scored so you can spot opportunities early. + - - 1. Commit and push your changes. - 2. Your docs will update and be live in moments! - - -## Next steps + + Ready to automate? Go to [Agents](https://gigabrain.gg/agents) to create your first AI trading agent. + + See the [Agent Setup Guide](/guides/agents-setup) for detailed instructions. + + -Now that you have your docs running, explore these key features: +## What's next? + + Learn how to get the most out of market queries. + - - Learn MDX syntax and start writing your documentation. + + Curated insights that surface before the crowd. - - Make your docs match your brand perfectly. + + Automate your trading strategy with AI agents. - - Include syntax-highlighted code blocks. + + Link Hyperliquid for execution and Telegram for alerts. - - Auto-generate API docs from OpenAPI specs. + + Everything you can query, agents, data types, and response formats. + + Build integrations with programmatic API access. + - - **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community). - + + Gigabrain provides market intelligence and research tools not financial + advice. Cryptocurrency markets are volatile and you can lose money. Always do + your own research before trading. See the [Risk + Disclosure](/support/risk-disclosure). + diff --git a/snippets/snippet-intro.mdx b/snippets/snippet-intro.mdx deleted file mode 100644 index e20fbb6..0000000 --- a/snippets/snippet-intro.mdx +++ /dev/null @@ -1,4 +0,0 @@ -One of the core principles of software development is DRY (Don't Repeat -Yourself). This is a principle that applies to documentation as -well. If you find yourself repeating the same content in multiple places, you -should consider creating a custom snippet to keep your content in sync. diff --git a/support/faqs.mdx b/support/faqs.mdx index 46e65ca..fb37861 100644 --- a/support/faqs.mdx +++ b/support/faqs.mdx @@ -1,74 +1,268 @@ --- -title: "FAQs" -description: "Frequently Asked Questions" +title: FAQ +description: Frequently asked questions --- - - The Intelligence Collective is Gigabrain's team of specialized agents (e.g., - Macro, Microstructure, Fundamentals) that work in parallel to analyze data - and synthesize unified insights. A central coordinator routes queries for - comprehensive coverage of regimes, imbalances, and catalysts. + + Gigabrain is a market intelligence platform for crypto trading. It analyzes markets in real-time by combining price data, onchain metrics, derivatives positioning, fundamentals, news, and social sentiment. You ask questions in natural language and get structured analysis with clear trade theses, supporting data, and risk assessments. -{" "} + + ChatGPT is a general purpose AI with a knowledge cutoff it doesn't have access + to live market data or specialized crypto analysis tools. Gigabrain pulls + real-time prices, funding rates, onchain flows, whale activity, and news as + you query. It's built specifically for crypto trading with specialized + analysts for macro, microstructure, fundamentals, technicals, and more. + + + + No. Chat works entirely through natural language just type questions like + "Analyze ETH on the 4H chart" + + + + Yes. You can explore Alpha Feed and for chat access and agents access you will + need API credits + + + + Anything related to crypto markets: + - Trade setups: "Give me a BTC long setup on the 1H chart" + - Market conditions: "What's moving the market today?" + - Fundamentals: "Analyze Aave's TVL and revenue" + - Positioning: "Are longs crowded on SOL?" + - Macro: "Is the market risk on or risk off right now?" + - Data requests: "Get token unlocks for next 14 days" + + See the [Chat documentation](/core-features/chat) for more examples. + + + + + Gigabrain synthesizes current market data and applies established analytical + frameworks (technical analysis, onchain metrics, macro correlations). It's as + accurate as the data it receives and the patterns it recognizes. However, + markets are inherently unpredictable no analysis tool can guarantee future + price movements. Use Gigabrain to inform your decisions, not replace your + judgment. + + + + Yes, if you connect your exchange account in Integrations. Once connected, you + can ask Chat to place trades like "Long ETH with $500 at 5x leverage" and it + will execute after confirmation. See [Integrations](/guides/integrations) for + setup details. + - - Gigabrain pulls real-time data from crypto markets (OHLCV, OI, funding), macro - indicators (DXY, VIX, yields, commodities), on-chain metrics (TVL, revenue, - unlocks), fundamentals (protocol activity), social sentiment (X/Twitter), and - curated news. All sources are processed through secure pipelines for accuracy. + + Yes, within the same conversation session. You can ask follow up questions + without repeating context. For example, after asking "Analyze BTC," you can + follow up with "What about the fundamentals?" and it will understand you're + still talking about BTC. Starting a new chat resets the context. -{" "} + + Data is pulled in real-time when you query. Prices, funding rates, and most + market metrics are current within seconds. + - - Data is fetched live for every query, with our own scoring mechanisms, - regimes, and alphas recalculated on demand. + + Alpha is an automated intelligence feed that surfaces market moving events as + they happen. It monitors news, onchain activity, social signals, whale + movements, and macro developments, then alerts you to things that could affect + prices before they reach mainstream awareness. -{" "} + + News sites show you everything most of it is noise. Alpha filters for events + with actual price relevance, provides context on why it matters, cross + references with current market data, and assigns impact ratings. It's + synthesized intelligence not raw headlines. + - - Gigabrain uses verifiable, deterministic data to avoid hallucinations and - provide objective insights. Markets are volatile, so always verify with your - own research it's a tool for informed decisions, not financial advice. Do your - due diligence before acting. + + Yes. You can filter by category (MACRO, FUNDAMENTALS, WHALES, ONCHAIN, + INSTITUTIONAL, MARKET STRUCTURE) and view only STARRED insights you've + bookmarked. -{" "} + + Agents are autonomous programs that execute trading strategies on your behalf. + You define the rules (when to enter, how much to risk, when to exit), connect + your exchange, and the Agent monitors markets 24/7 and trades when your + criteria are met. + - - Yes, responses include key references such as metrics (e.g., OI changes), - sources, and data timestamps. While not all raw data is shown, specific data - can be requested in your query, and all essential insights are highlighted. + + Yes, that's the point. You set the strategy in the Instructions, and the Agent + executes automatically when conditions match. If you want manual approval for + each trade, use Chat with exchange integration instead Chat requires you to + explicitly request each trade. -{" "} + + Yes. Every Agent run produces a reasoning trace in the Reasoning tab that + shows exactly what data it analyzed, which criteria were met or not met, and + why it decided to trade or stay sidelined. You can review these in real-time. + + + + Agents execute the strategy you define. If trades are unprofitable, the + strategy needs refinement adjust your Instructions based on what you learn + from the Learnings tab. Start with small position sizes, tight stop losses, + and daily profit caps until you're confident the strategy works. + + + + Yes. Click the Pause button and the Agent stops immediately. You can resume it + anytime. You can also set risk limits in your Instructions like "Halt all + trading if account drops to $X" or "Stop trading during high VIX + environments." + + + + Yes. You can deploy multiple Agents with different strategies on different + assets or timeframes. For example, one Agent could scalp BTC on 5m while + another swing trades ETH on 4H. + + + + Currently supported exchanges are listed in the Integrations section of your + account settings. This includes major perpetual futures platforms. The list is + updated as new integrations are added. + + + + No. APIs wallets used for trade execution does not have withdrawal + permissions. + + + + Yes, you can run paper trading with your Agent. + + + + Yes. You can ask Chat questions like "Analyze a portfolio of 50% BTC, 30% ETH, + 20% SOL" and get risk assessment, correlation analysis, and suggestions for + rebalancing. + - - We are planning to add watchlists for alerts on shifts, imbalances, or - catalysts, and scheduled automated reports via email or integrations. These - features will be part of the upcoming Personalization feature set. + + No. Gigabrain analyzes current conditions and identifies potential setups + based on technical, fundamental, macro, and positioning factors. It provides + probabilistic assessments (e.g., "bearish bias until support holds") not price + targets with certainty. -{" "} + + Each specialist focuses on one domain of market analysis: + - **Macro Analyst** examines Fed policy, DXY, yields, risk environment + - **Microstructure Analyst** tracks funding rates, open interest, liquidations + - **Fundamentals Analyst** analyzes TVL, revenue, protocol health + - **Price Movement Analyst** does technical analysis and chart patterns + - **Market State Analyst** assesses overall sentiment and narratives + - **Trenches Analyst** focuses on low cap tokens and social momentum + - **Polymarket Analyst** interprets prediction market odds - - Yes, Gigabrain integrates with platforms like Hyperliquid for trading and - Telegram for real-time alerts. We are continuously expanding our integrations - to include more exchanges. check profile page for more [details](https://gigabrain.gg/profile). + When you ask a question, the relevant specialists are consulted automatically. See [What is Gigabrain](/index#the-intelligence-collective) for full details. + + + + + Yes. You can request specific data points like "Get funding rates for top 20 + perpetual contracts" or "Get token unlocks for next 14 days" and receive + structured data with minimal commentary. - - Gigabrain offers three subscription tiers: Lite ($29/month) for trying Brain's capabilities with Chat Access and Alpha Feed; Pro ($149/month, coming soon) for active decision-making with Full Chat Access, Realtime Alpha Feed, 10 Workflows, and API Access; and Elite (Hold 1M $BRAIN) for those ahead of the curve with Full Chat Access, Alpha Feed, Unlimited Workflows, Alpha Community Access, and Beta Features. [Visit](https://gigabrain.gg/pricing) for details. + + **Pay-as-you-go**: Start at $5, pay per Chat query, includes API and Agents access. + + **Token-gated (1M BRAIN)**: Hold 1M BRAIN tokens for unlimited Chat, included monthly API credits, and access to Alpha Community. + + See [Pricing](/pricing) for full comparison. + + + Pricing is usage based and depends on query complexity. Simple questions + consume fewer credits than multi specialist deep dives. Your account dashboard + shows credit consumption per query. + - + + API Credits purchased has expiry date of 1 year. + + + + Yes. All Chat queries can return structured JSON responses when you add + "Respond as JSON" to your question. This enables programmatic integration for + bots, dashboards, and automated systems. See the [Brain API + documentation](/developers/brain-api-overview) for implementation details. + + + + Yes. Trading via Gigabrain incurs a small fee charged as builder fees. This + applies to trades executed through Chat (when exchange is connected) and + trades executed by Agents. + + + No. Gigabrain runs on cloud infrastructure with access to real-time data + feeds, exchange integrations, and the Intelligence Collective. It's not + available for self-hosting. + + + A private community for BRAIN token holders (1M+ tokens). It includes + exclusive channels for strategy discussion, early alpha sharing, and direct + interaction with the Gigabrain team. + -## + + For technical issues and general discussion, join the [Gigabrain + Telegram](https://t.me/gigabraingg). + + + + Yes. Feature requests are welcome via the community channels. The team + prioritizes features based on user demand and technical feasibility. + + + + Yes. The Brain API documentation covers structured JSON output, programmatic + query formatting, and integration patterns for building custom tools. Access + it from [Brain API Overview](/developers/brain-api-overview). + + + + No. Gigabrain is a tool for market analysis and trade execution. It does not + provide personalized financial advice or recommendations. You are responsible + for your own trading decisions and risk management. + + + + You should never rely solely on any automated tool for all trading decisions. + Use Gigabrain to inform your analysis, validate your ideas, and execute + strategies you understand. Always maintain appropriate position sizing, stop + losses, and risk limits. + + + + Markets are unpredictable. Even high conviction analysis can be invalidated by + unexpected events (regulatory changes, exchange hacks, black swan events). + This is why every response includes invalidation criteria conditions under + which the thesis no longer holds. Use stop losses, position size + appropriately, and never risk more than you can afford to lose. + + + + Agents execute strategies you define with rules you set. Profitable or unprofitable outcomes result from the strategy, market conditions, and your risk management not from Gigabrain making decisions on your behalf. + + --- + +## Still have questions? + +For questions not covered in the docs, join the [Gigabrain Telegram](https://t.me/gigabraingg). diff --git a/support/risk-disclosure.mdx b/support/risk-disclosure.mdx index 0fb4909..9fd80cd 100644 --- a/support/risk-disclosure.mdx +++ b/support/risk-disclosure.mdx @@ -110,4 +110,4 @@ Gigabrain does not guarantee any particular outcome from using the Services, inc ii. If you choose to use the Services, you accept full responsibility for your use, including any trading activity you initiate or authorize through third party platforms, and any losses that may result. -If you have questions about this Risk Disclosure or wish to report a risk or vulnerability, please contact us at: \[support@gigabrain.gg\]. \ No newline at end of file +If you have questions about this Risk Disclosure or wish to report a risk or vulnerability, please contact us at: [support@gigabrain.gg](mailto:support@gigabrain.gg). \ No newline at end of file