🚀 What is Browser SERP?

Browser SERP is a lightweight, high-performance API that provides real-time Google Search results. It uses managed remote browsers to bypass anti-bot detection and deliver real-time SERP data for your applications.

Unlike traditional SERP APIs that can be slow or expensive, Browser SERP is optimized for speed and scalability, making it perfect for AI agents, RAG pipelines, and market research tools.

Why use Browser SERP?

• ⚡ Ultra-Fast Results: Leverages connection pooling to keep browsers hot and ready.
• 🛡️ Reliable Access: Uses residential-grade remote browsers to ensure high success rates.
• 🧹 Clean JSON Output: Parses complex SERP layouts into structured, easy-to-consume JSON.
• 🏎️ High Concurrency: Built-in session management handles multiple parallel requests effortlessly.

✨ Features

• Live Google Search: Get real-time results for any query.
• Smart Extraction: Extracts organic results, snippets, and metadata.
• Session Pooling: Automatically manages browser lifecycles for optimal performance.
• Rate Limiting: Built-in protection against abuse.
• Docker Ready: Deploy anywhere with a lightweight container.

🛠️ Quick Start

Prerequisites

1. Node.js 18+ installed.
2. A Browser.cash API Key.

Installation

# Clone the repository
git clone https://github.com/yourusername/browser-serp.git
cd browser-serp

# Install dependencies
npm install

Configuration

Copy the example environment file and configure your settings:

cp .env.example .env

Open .env and set your BROWSER_API_KEY:

BROWSER_API_KEY=your_browser_cash_api_key_here

Running the Server

# Development mode
npm run dev

# Production build & start
npm run build
npm start

The server will start at http://0.0.0.0:8080.

📚 API Reference

1. Search

Performs a Google search and returns structured results.

Endpoint: POST /api/v1/search

CURL Request:

curl -X POST http://localhost:8080/api/v1/search \
  -H "Content-Type: application/json" \
  -d '{
    "q": "browser automation",
    "count": 5,
    "country": "us"
  }'

Response:

{
  "web": {
    "total": 135000000,
    "results": [
      {
        "title": "Browser Automation | The Ultimate Guide",
        "url": "https://example.com/guide",
        "description": "Learn everything about browser automation..."
      },
      {
        "title": "Top 10 Browser Automation Tools",
        "url": "https://example.com/tools",
        "description": "A comparison of the best tools for..."
      }
    ]
  }
}

2. Health Check

Endpoint: GET /health

CURL Request:

curl http://localhost:8080/health

Response:

{
  "ok": true
}

3. Pool Statistics

Get current browser session pool status.

Endpoint: GET /stats

CURL Request:

curl http://localhost:8080/stats

Response:

{
  "pool": {
    "size": 3,
    "available": 2,
    "active": 1
  }
}

⚙️ Configuration

Server & Infrastructure

Performance Tuning

🐳 Docker

You can run Browser SERP easily using Docker.

Build & Run

# Build the image
docker build -t browser-serp .

# Run with env file
docker run -p 8080:8080 --env-file .env browser-serp

Docker Compose

version: "3.8"
services:
  serp:
    build: .
    ports:
      - "8080:8080"
    environment:
      - BROWSER_API_KEY=${BROWSER_API_KEY}
      - SERP_POOL_SIZE=3

🤝 Contributing

Contributions are welcome! We appreciate your help in making Browser SERP better.

How to Contribute

1. Fork the Project: click the 'Fork' button at the top right of this page.
2. Create your Feature Branch: git checkout -b feature/AmazingFeature
3. Commit your Changes: git commit -m 'Add some AmazingFeature'
4. Push to the Branch: git push origin feature/AmazingFeature
5. Open a Pull Request: Submit your changes for review.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.