AV API Documentation

Welcome to the AV API - a platform for app store data scraping and analytics.

Overview

The AV API provides:

• 🔐 Google OAuth 2.0 - Secure authentication with JWT tokens
• 📊 Dual Database - PostgreSQL for transactions, ClickHouse for analytics
• 🚀 Data Collection - Apple and Android app store scraping
• 📈 Analytics - App performance metrics and insights

Quick Navigation

🚀 Getting Started

• Authentication - Google OAuth setup
• Token Management - JWT token handling
• Interactive API Explorer - Try the API live

🔌 API Reference

• Complete API Reference - All endpoints

System Architecture

┌─────────────────────────────────────────┐
│             Google OAuth                 │
└─────────────┬───────────────────────────┘
              │
              ▼
┌─────────────────────────────────────────┐
│            Django REST API               │
│         (JWT Authentication)             │
└─────────┬───────────────────────┬───────┘
          │                       │
          ▼                       ▼
    ┌──────────┐            ┌──────────┐
    │PostgreSQL│            │ClickHouse│
    └──────────┘            └──────────┘

Technology Stack

• Backend: Django 5.1, Django REST Framework
• Databases: PostgreSQL 18.0, ClickHouse 25.5.2
• Authentication: JWT (djangorestframework-simplejwt)
• Documentation: OpenAPI 3.0, Scalar UI
• Containerization: Docker, Docker Compose

API Base URL

http://localhost:8000/api/

Authentication Flow

1. Login with Google: POST /api/auth/google/
2. Receive JWT tokens: Access and refresh tokens
3. Use access token: Include in Authorization header
4. Refresh when expired: POST /api/token/refresh/

Need Help?

• 📖 Check the API Reference
• 🔑 Learn about Authentication
• 🎯 Use the Interactive API Explorer