Skip to main content

Quick Start

This guide shows how to:

  1. Authenticate
  2. Submit a scraping task and retrieve results

All examples use the Shopee scraper, but the flow is identical for other supported platforms.

1. Authentication​

All requests must include your API token using the Authorization header:

Authorization: Bearer ${token}

To get your token, log in to the Console and click Get API Token.

Keep it secret. Treat it like a password.

2. Submit a scraping task and retrieve results​

To submit a Shopee scraping task, send a POST request:

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer ${token}" \
  --request POST \
  --data '{"requests":[{"url": "https://shopee.sg/api/v4/search/search_items?keyword=tshirt"}]}' \
 https://continuous-scraper.common.chartedapi.com/scraping-tasks/shopee/run

What this does​

  • Creates a scraping task
  • Queues it for asynchronous execution
  • Wait for Shopee's response

By default, the /scraping-tasks/{scraper}/run API is synchronous (it waits for the response), but it also supports an asynchronous mode with waitForCompletion=false, read the API Reference to learn more about it.

Example Response​

[
  {
    "url": "https://shopee.sg/api/v4/search/search_items?keyword=tshirt",
    "status": "SUCCESS",
    "responseBody": "... raw response from Shopee ..."
  }
]

Only successful requests are billed.

Exploring the API​

You can use tools like:

to explore and test endpoints interactively.

See the full API Reference for supported parameters and advanced options.

Next Steps​

If you need higher volume or custom configuration, contact us.