> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pond3r.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Start creating automated crypto intelligence reports in under 5 minutes

## Getting Started with Pond3r

This guide will help you quickly get started with Pond3r's AI-powered analytics platform to create automated crypto intelligence reports.

### Creating Your First Automated Report

The easiest way to start is by creating your first automated report through our web interface.

<Steps>
  <Step title="Navigate to the report creation interface">
    Go directly to [makeit.pond3r.xyz](https://makeit.pond3r.xyz).
  </Step>

  <Step title="Describe what you want to track">
    Use natural language to describe your analysis needs. Examples:

    ```
    Track AI agent launches on Virtuals Protocol with graduation success rates
    ```

    ```
    Monitor new tokens on Uniswap with less than $500K market cap and rising liquidity
    ```

    ```
    Daily yield farming report across Aave, Compound, and Convex protocols
    ```
  </Step>

  <Step title="AI generates your analysis">
    Pond3r's AI data scientist will automatically:

    * Create sophisticated Python analysis scripts
    * Set up data ingestion from multiple sources
    * Apply advanced statistical analysis to identify patterns
    * Configure risk metrics and growth indicators
  </Step>

  <Step title="Set your delivery schedule">
    Choose how often you want to receive reports:

    * Daily updates for fast-moving opportunities
    * Weekly summaries for trend analysis
    * Monthly deep dives for strategic insights
  </Step>

  <Step title="Receive your first report">
    Your report will be delivered directly to your email inbox, containing:

    * Executive summary with key findings
    * Statistical analysis with trend identification
    * Risk assessments with mathematical precision
    * Actionable insights prioritized by opportunity size
  </Step>
</Steps>

### Accessing Reports via API

Perfect for AI agents and automated trading systems to consume structured intelligence reports.

<Steps>
  <Step title="Get your API key">
    Navigate to "Settings" > "API Keys" in your Pond3r dashboard and click "Generate New Key". Give your key a name (e.g., "Trading Bot API") and click "Create".

    <Warning>
      Keep your API key secure and never expose it in client-side code. We recommend using environment variables to store your key.
    </Warning>
  </Step>

  <Step title="Create an automated report">
    Use the API to set up automated reports for your systems:

    <CodeGroup>
      <CodeBlock title="Node.js" language="javascript">
        ```javascript theme={null}
        const axios = require('axios');

        async function createReport() {
          try {
            const response = await axios.post('https://api.pond3r.xyz/v1/api/reports', {
              description: 'Track new tokens on Uniswap with less than $500K market cap and rising liquidity',
              schedule: 'daily',
              delivery_format: 'structured_markdown'
            }, {
              headers: {
                'x-api-key': 'YOUR_API_KEY',
                'Content-Type': 'application/json'
              }
            });
            
            return response.data.reportId;
          } catch (error) {
            console.error('Error creating report:', error.response ? error.response.data : error.message);
            throw error;
          }
        }
        ```
      </CodeBlock>

      <CodeBlock title="Python" language="python">
        ```python theme={null}
        import requests

        def create_report():
            url = 'https://api.pond3r.xyz/v1/api/reports'
            headers = {
                'x-api-key': 'YOUR_API_KEY',
                'Content-Type': 'application/json'
            }
            data = {
                'description': 'Track new tokens on Uniswap with less than $500K market cap and rising liquidity',
                'schedule': 'daily',
                'delivery_format': 'structured_markdown'
            }
            
            try:
                response = requests.post(url, json=data, headers=headers)
                response.raise_for_status()
                return response.json()['reportId']
            except requests.exceptions.RequestException as e:
                print(f"Error creating report: {e}")
                raise
        ```
      </CodeBlock>
    </CodeGroup>
  </Step>

  <Step title="Retrieve report data">
    Access your latest reports in structured format:

    <CodeGroup>
      <CodeBlock title="Node.js" language="javascript">
        ```javascript theme={null}
        async function getLatestReport(reportId) {
          try {
            const response = await axios.get(`https://api.pond3r.xyz/v1/api/reports/${reportId}/latest`, {
              headers: {
                'x-api-key': 'YOUR_API_KEY'
              }
            });
            
            return response.data;
          } catch (error) {
            console.error('Error fetching report:', error.response ? error.response.data : error.message);
            throw error;
          }
        }
        ```
      </CodeBlock>

      <CodeBlock title="Python" language="python">
        ```python theme={null}
        def get_latest_report(report_id):
            url = f'https://api.pond3r.xyz/v1/api/reports/{report_id}/latest'
            headers = {
                'x-api-key': 'YOUR_API_KEY'
            }
            
            try:
                response = requests.get(url, headers=headers)
                response.raise_for_status()
                return response.json()
            except requests.exceptions.RequestException as e:
                print(f"Error fetching report: {e}")
                raise
        ```
      </CodeBlock>
    </CodeGroup>
  </Step>

  <Step title="Handle structured report data">
    Reports are returned in structured JSON format with markdown content:

    ```json theme={null}
    {
      "reportId": "report_123456",
      "title": "New Token Opportunities - Daily Report",
      "generatedAt": "2024-03-24T09:00:00Z",
      "executiveSummary": {
        "keyFindings": "3 new tokens identified with 50%+ liquidity growth",
        "topOpportunity": "TOKEN_ABC showing 85% volume increase"
      },
      "analysis": {
        "statisticalInsights": "# Statistical Analysis\n\n...",
        "riskAssessment": "# Risk Assessment\n\n...",
        "actionableInsights": "# Actionable Insights\n\n..."
      },
      "opportunities": [
        {
          "token": "TOKEN_ABC",
          "riskScore": 0.3,
          "opportunitySize": "High",
          "details": "Rising liquidity with institutional backing"
        }
      ]
    }
    ```

    <Note>
      All analysis sections use structured markdown format, making them perfect for AI agents to parse and act upon.
    </Note>
  </Step>
</Steps>

### Next steps

Now that you've created your first automated report with Pond3r, you can:

<CardGroup>
  <Card title="Explore Report Examples" icon="book-open" href="examples">
    See examples of effective report descriptions for different analysis types
  </Card>

  <Card title="Browse Available Data" icon="database" href="onchain">
    Learn what chains, protocols, and data types Pond3r can analyze
  </Card>

  <Card title="Read API Documentation" icon="code" href="api-reference/introduction">
    Get detailed information about report endpoints and structured data formats
  </Card>
</CardGroup>