Skip to content
Scrappa Get API key
Tokopedia API 1 credit / request

Tokopedia Search API Documentation

GET https://scrappa.co/api/tokopedia/search

Tokopedia Search API searches products on Tokopedia in Indonesia. Each item has the price, original price and discount as IDR numbers, the rating, review count, shop, shop location and a full-size image.

Filter by price range, minimum rating, category, location and sort. Every item in the answer follows the filters you send. There are 60 results per page. The product id and shop id feed the other routes unchanged.

Sold count is a product-route field and is null on search cards.

Filters and sort apply to the cards of the returned page, not to a new upstream result set. The upstream filter keys are not proven, so price, rating, location and sort are confirmed on that page. filtered_out counts the cards removed; has_next still describes the upstream next page.

The discount is derived from the original and sale price when the source reports zero. A product with no reviews has a null rating.

Costs 1 credit per successful request. Empty results and failed requests are free.

Tokopedia Search API Documentation 1 credit / request

Endpoint

Request preview
GET
https://scrappa.co/api/tokopedia/search
Auth header
x-api-key
Cost
1 credit / request
query = coffee shops
Response preview
200 OK
{
    "data": {
        "query": "sepatu lari",
        "results": [
            {
                "url": "https://www.tokopedia.com/olahraga-store/sepatu-lari",
                "shop": {
                    "id": "123456",
                    "name": "Olahraga Store",
                    "location": "Jakarta Pusat",
                    "is_official": true
                },
                "image": "https://images.tokopedia.net/abc.jpg",
                "price": 250000,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

7 optional filters available.

query string Required

Search text, 1 to 120 characters, for example sepatu lari.

Example value coffee shops
page integer Optional

One-based page number, 60 results per page (default 1).

Example value 1
sort string Optional

One of relevance, price_asc, price_desc, rating.

Example value relevance
min_price number Optional

Lowest price in IDR.

Example value 10
max_price number Optional

Highest price in IDR.

Example value 10
min_rating number Optional

Lowest item rating, 0 to 5.

Example value 10
category string Optional

Category name from an earlier search.

Example value example
location string Optional

Shop location text to match.

Example value Austin, Texas

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "query": "sepatu lari",
        "results": [
            {
                "url": "https://www.tokopedia.com/olahraga-store/sepatu-lari",
                "shop": {
                    "id": "123456",
                    "name": "Olahraga Store",
                    "location": "Jakarta Pusat",
                    "is_official": true
                },
                "image": "https://images.tokopedia.net/abc.jpg",
                "price": 250000,
                "title": "Sepatu Lari Pria",
                "rating": 4.8,
                "currency": "IDR",
                "location": "Jakarta Pusat",
                "product_id": "123456789",
                "sold_count": null,
                "review_count": 120,
                "original_price": 350000,
                "discount_percent": 28.6
            }
        ],
        "currency": "IDR",
        "pagination": {
            "page": 1,
            "has_next": true,
            "per_page": 60,
            "total_results": 100420
        }
    },
    "meta": {
        "credits": 1,
        "billable": true,
        "endpoint_family": "search"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A required parameter or a value is invalid. This response is not billable.

{
    "errors": {
        "query": [
            "A search text is required."
        ]
    },
    "message": "The request validation failed"
}
503

Upstream Unavailable

The source could not be reached. This response is not billable. Retry shortly.

{
    "meta": {
        "credits": 0,
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "A search text is required."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.