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

# Scrapengine API Introduction

> Powerful web scraping API with browser automation capabilities and specialized data extraction

## Welcome to Scrapengine API

Scrapengine is an API aggregator that helps you scrape data from various platforms including bypassing anti-bots and accessing specialized APIs. Our platform provides dedicated endpoints for popular services, making data extraction simple and reliable.

## Key Features

<CardGroup cols={2}>
  <Card title="Renderless Scraping" icon="gauge-simple-high">
    Fast, lightweight scraping without JavaScript rendering
  </Card>

  <Card title="Renderful Scraping" icon="chrome">
    Full browser automation with JavaScript execution
  </Card>

  <Card title="Proxy Support" icon="shield">
    Built-in support for IP rotation and geo-targeting
  </Card>

  <Card title="AI Extraction" icon="microchip-ai">
    LLM-powered data extraction using schemas or prompts
  </Card>
</CardGroup>

## API Endpoints

### Web Scraping

Scrape any website with anti-bot bypass capabilities.

| Endpoint                | Method | Description                                    |
| ----------------------- | ------ | ---------------------------------------------- |
| `/scrape`               | POST   | Scrape any website with optional AI extraction |
| `/scrape/{jobScrapeId}` | GET    | Get status of an async scraping job            |

### Search Engines

Dedicated endpoints for search engine results with structured data.

| Endpoint         | Method | Description                                                |
| ---------------- | ------ | ---------------------------------------------------------- |
| `/google/search` | GET    | Google Search results with organic listings, ads, and more |
| `/bing/search`   | GET    | Bing Search results with web pages, news, and images       |

### E-Commerce

Product search APIs for major e-commerce platforms.

| Endpoint                  | Method | Description                                          |
| ------------------------- | ------ | ---------------------------------------------------- |
| `/amazon/search`          | GET    | Amazon product search with pricing and reviews       |
| `/lazada/search`          | GET    | Lazada product search across Southeast Asian markets |
| `/shopee/search`          | GET    | Shopee product search (requires render)              |
| `/shopee/product`         | GET    | Shopee product details                               |
| `/shopee/product/reviews` | GET    | Shopee product reviews                               |
| `/shopee/shop`            | GET    | Shopee shop information                              |
| `/shopee/shop/products`   | GET    | List products from a Shopee shop                     |

## Credits Pricing

API requests are charged in credits based on the platform complexity. Credits are deducted only on successful requests.

| Platform    | Credits per Request |
| ----------- | ------------------- |
| Amazon      | 5 credits           |
| eBay        | 5 credits           |
| Google Play | 5 credits           |
| Booking.com | 5 credits           |
| TripAdvisor | 5 credits           |
| Zillow      | 5 credits           |
| Xiaohongshu | 5 credits           |
| TikTok      | 15 credits          |
| Taobao      | 15 credits          |
| Shopee      | 25 credits          |

<Note>
  Credits are only deducted for successful requests. Failed requests do not consume credits.
</Note>

## Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

<Card title="Get Your API Key" icon="key" href="https://app.scrapengine.io">
  Sign up for a free account to get your API key
</Card>

## Base URL

All API requests should be made to:

```
https://api.scrapengine.io/api/v1
```

## Rate Limits

Scrapengine implements rate limiting to ensure fair usage and system stability. Rate limits vary based on your subscription plan:

| Plan       | Rate Limit              |
| ---------- | ----------------------- |
| Free Tier  | 100 requests per hour   |
| Pro Tier   | 1,000 requests per hour |
| Enterprise | Custom limits           |

## Response Headers

All responses include these headers:

| Header                | Description                     |
| --------------------- | ------------------------------- |
| `x-remaining-credits` | Number of API credits remaining |
| `x-trace-id`          | Unique identifier for debugging |

## Error Handling

The API uses standard HTTP status codes and returns detailed error information:

| Status | Description                                                                                                                                         |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | Bad Request - Invalid parameters                                                                                                                    |
| 401    | Unauthorized - Invalid API key                                                                                                                      |
| 402    | Payment Required - Account has no remaining credits. Applied globally by authentication, so any endpoint may return 402 when credits are exhausted. |
| 403    | Forbidden - Access denied                                                                                                                           |
| 404    | Not Found - Resource not found                                                                                                                      |
| 408    | Request Timeout                                                                                                                                     |
| 429    | Too Many Requests - Rate limit exceeded                                                                                                             |
| 500    | Internal Server Error                                                                                                                               |
| 550    | Faulted After Retries - Job failed after multiple attempts                                                                                          |

### Error Response Format

```json theme={null}
{
  "error": "Error description message",
  "traceId": "abc123-def456",
  "timestamp": "2024-01-15T10:30:00.000Z"
}
```

## Getting Started

<Steps>
  <Step title="Get your API key">
    Sign up at [app.scrapengine.io](https://app.scrapengine.io) and copy your API key
  </Step>

  <Step title="Make your first request">
    Use the `/scrape` endpoint to scrape your first website
  </Step>

  <Step title="Explore specialized APIs">
    Try Google, Amazon, Bing, or Lazada endpoints for structured data
  </Step>

  <Step title="Monitor your usage">
    Track your API credits and usage in the dashboard
  </Step>
</Steps>

<Card title="Quick Start Guide" icon="rocket" href="/quickstart">
  Get started with Scrapengine in minutes
</Card>