API Documentation

The Open Sparrow API allows you to programmatically manage your products, subscriptions, and analytics. All API requests must be authenticated using your API key.

Base URL

Authentication

Include your API key in the Authorization header:

List Products

Retrieve all your products with pagination support.

Query Parameters:

• page - Page number (default: 1)
• per_page - Items per page (default: 20, max: 100)
• status - Filter by status (active, inactive)

Create Product

Create a new product with file upload support.

Request Body:

{
  "title": "Product Name",
  "description": "Product description",
  "price": 29.99,
  "category": "digital",
  "files": ["file1_id", "file2_id"]
}

List Subscription Tiers

Get all your subscription tiers and their details.

Create Subscription Tier

Request Body:

{
  "name": "Premium Tier",
  "description": "Access to premium content",
  "price": 19.99,
  "billing_interval": "monthly",
  "features": ["feature1", "feature2"]
}

List Subscribers

Retrieve subscribers with filtering options.

Revenue Analytics

Get revenue data with date range filtering.

Query Parameters:

• start_date - Start date (YYYY-MM-DD)
• end_date - End date (YYYY-MM-DD)
• granularity - Data granularity (day, week, month)

Subscriber Growth

Track subscriber growth over time.

Open Sparrow sends webhook notifications for important events. Configure your webhook URLs in your account settings.

Supported Events

• product.created - New product created
• product.sold - Product purchased
• subscription.created - New subscription
• subscription.cancelled - Subscription cancelled
• payment.completed - Payment processed successfully

Webhook Payload Example

{
  "event": "product.sold",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "product_id": "prod_123",
    "buyer_email": "customer@example.com",
    "amount": 29.99,
    "currency": "USD"
  }
}

Rate limits are per API key. Contact support for higher limits.