Developer Documentation

Integrate Reddit insights into your applications with our powerful, easy-to-use API.

Quick Start

Get started with the reddit-insights.com API in minutes. All API endpoints require authentication and are available for Pro and Enterprise subscribers.

Authentication
Authorization: Bearer YOUR_API_KEY
Base URL
https://reddit-insights.com/v1

Getting Your API Key

API keys are available in your account dashboard after subscribing to a Pro or Enterprise plan. Each API call counts toward your monthly quota based on your subscription tier.

Interactive API Explorer

Testing Counts Toward Your Quota

API requests made through this explorer will count against your plan's quota. Make sure you have an active subscription or free tier credits available.

Loading API Explorer...

Endpoints

View API Pricing →
GET /api/v1/sonars FREE - No Quota Usage

List Sonars (FREE)

Get all your monitoring sonars. This endpoint is FREE and does not count toward your API quota.

Request Example

curl -X GET "https://reddit-insights.com/api/v1/sonars" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "success": true,
  "data": {
    "sonars": [
      {
        "id": "sonar_123",
        "name": "Banking App Complaints",
        "query": "What are the biggest complaints about banking apps?",
        "description": "Monitor negative feedback about banking apps",
        "enabled": true,
        "schedule": "daily",
        "lastExecutedAt": "2024-01-15T10:00:00Z",
        "nextExecutionAt": "2024-01-16T10:00:00Z",
        "createdAt": "2024-01-01T00:00:00Z"
      }
    ]
  }
}
POST /api/v1/sonars FREE - No Quota Usage

Create Sonar (FREE)

Create a new monitoring sonar to track Reddit conversations and get alerts. This endpoint is FREE and does not count toward your API quota.

Request Example

curl -X POST https://reddit-insights.com/api/v1/sonars \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Product Feedback Monitor",
  "query": "What do users think about our product?",
  "description": "Track product feedback and complaints",
  "schedule": "daily",
  "triggers": {
    "keywords": [
      "bug",
      "issue",
      "problem"
    ],
    "sentiment": "negative",
    "minNewPosts": 5
  },
  "notifyEmail": true,
  "notifySlack": false
}'

Response Example

{
  "success": true,
  "data": {
    "sonar": {
      "id": "sonar_456",
      "name": "Product Feedback Monitor",
      "query": "What do users think about our product?",
      "description": "Track product feedback and complaints",
      "enabled": true,
      "schedule": "daily",
      "triggers": {
        "keywords": [
          "bug",
          "issue",
          "problem"
        ],
        "sentiment": "negative",
        "minNewPosts": 5
      },
      "notifyEmail": true,
      "notifySlack": false,
      "nextExecutionAt": "2024-01-16T10:00:00Z",
      "createdAt": "2024-01-15T12:00:00Z"
    }
  }
}
GET /api/v1/sonars/{id}/executions FREE - No Quota Usage

Get Sonar Executions (FREE)

Get execution history for a specific sonar. This endpoint is FREE and does not count toward your API quota.

Request Example

curl -X GET "https://reddit-insights.com/api/v1/sonars/{id}/executions?limit=50&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "success": true,
  "data": {
    "executions": [
      {
        "id": "exec_789",
        "status": "completed",
        "executedAt": "2024-01-15T10:00:00Z",
        "newPostsCount": 12,
        "triggered": true,
        "triggerReason": "Found 12 new posts (threshold: 5)\nFound 3 posts with alert keywords",
        "notificationSent": true,
        "aiSummary": "Recent discussions show increased complaints about app crashes..."
      }
    ],
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}
GET /api/v1/sonars/executions/{executionId} FREE - No Quota Usage

Get Execution Detail (FREE)

Get detailed search results from a specific sonar execution, including all posts, statistics, and AI summary. Returns the same data you would see in the Explorer page. This endpoint is FREE and does not count toward your API quota.

Request Example

curl -X GET "https://reddit-insights.com/api/v1/sonars/executions/{executionId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "success": true,
  "data": {
    "execution": {
      "id": "exec_789",
      "sonarId": "sonar_123",
      "sonarName": "Banking App Complaints",
      "status": "completed",
      "executedAt": "2024-01-15T10:00:00Z",
      "query": "What are the biggest complaints about banking apps?",
      "keywords": [
        "slow",
        "crashes",
        "bugs",
        "ui",
        "features"
      ],
      "newPostsCount": 12,
      "aiSummary": "Recent discussions show increased complaints about app crashes and slow performance...",
      "triggered": true,
      "triggerReason": "Found 12 new posts (threshold: 5)",
      "notificationSent": true
    },
    "results": [
      {
        "id": "post_123",
        "title": "Why is my bank's app so slow?",
        "content": "I'm 24 and switched to this bank because they claimed to be digital-first...",
        "subreddit": "personalfinance",
        "upvotes": 342,
        "comments": 87,
        "created": "2024-01-15T08:30:00Z",
        "url": "https://reddit.com/r/personalfinance/comments/...",
        "relevance": 0.95,
        "sentiment": "negative",
        "emotion": "frustrated"
      }
    ],
    "stats": {
      "totalPosts": 12,
      "avgUpvotes": 156.3,
      "avgComments": 42.5,
      "topSubreddits": [
        {
          "name": "personalfinance",
          "count": 5
        },
        {
          "name": "banking",
          "count": 4
        },
        {
          "name": "technology",
          "count": 3
        }
      ],
      "sentimentBreakdown": {
        "positive": 2,
        "negative": 8,
        "neutral": 2
      }
    }
  }
}

Rate Limits & Pricing

API access is available for Pro and Enterprise subscribers. Each plan includes different rate limits and quotas.

Plan Monthly Quota Rate Limit
Free 100 requests/hour N/A - API not available
Pro 10000 requests/month 60 requests/minute
Enterprise Unlimited Custom limits

Free Sonar Management Endpoints

The following endpoints are completely free and do not count toward your API quota:

  • GET /api/v1/sonars - List all sonars
  • POST /api/v1/sonars - Create a new sonar
  • GET /api/v1/sonars/{id}/executions - Get sonar execution history
  • GET /api/v1/sonars/executions/{executionId} - Get detailed execution results

Rate Limit Headers

All paid API responses include rate limit information in the headers: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Ready to Get Started?

Sign up to get your API key and start building.

Get Your API Key