/tokopedia/products/search

POST /api/tokopedia/products/search

Price: 5 credits

Search Tokopedia products by keyword, or browse a category id, with filters (sort, location, shop type, condition, price range, rating, COD, discount, recency, pre-order, delivery speed). Returns product cards: name, price, list_price, discount, image, rating, sold_count, category, shop and badge.

How to use it

Search Tokopedia (Indonesia's largest marketplace) products by keyword, or browse a category id (from the categories endpoint). Provide either keyword or category. Supports sort (relevance, reviews, newest, price_high, price_low), location (Indonesian province/city), shop_type (mall/power_shop), condition (new/used), price_min/price_max (IDR), rating_4_plus, cod, discount_only, preorder, added_within and shipping. Each product card has id, name, url, price, list_price, discount, currency (IDR), image, rating, sold_count, category, shop_id/shop_name/shop_city, is_official and badge. Returns up to `count` products.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Search keyword (examples: "iphone", "sepatu pria"; minLength: 1)
• count integer required — Max number of products to return (min: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "reviews", "newest", "price_high", "price_low")
• category string nullable — Category id to browse (e.g. 65); from the categories endpoint
• location string nullable — Seller province or city filter (one of: "dki_jakarta", "jabodetabek", "bandung", "medan", "surabaya", "bali", "banten", "bengkulu", "di_aceh", "di_yogyakarta", "gorontalo", "jambi", "jawa_barat", "jawa_tengah", "jawa_timur", "kalimantan_barat", "kalimantan_selatan", "kalimantan_tengah", "kalimantan_timur", "kalimantan_utara", "kepulauan_bangka_belitung", "kepulauan_riau", "lampung", "maluku", "maluku_utara", "nusa_tenggara_barat", "nusa_tenggara_timur", "papua", "papua_barat", "riau", "sulawesi_barat", "sulawesi_selatan", "sulawesi_tengah", "sulawesi_tenggara", "sulawesi_utara", "sumatera_barat", "sumatera_selatan", "sumatera_utara", "kepulauan_seribu", "balikpapan", "banjar", "banjarbaru", "batam", "batu", "bau_bau", "bekasi", "bima", "binjai", "bitung", "blitar", "bogor", "bontang", "bukittinggi", "cilegon", "cimahi", "cirebon", "depok", "dumai", "gunungsitoli", "jakarta_barat", "jakarta_pusat", "jakarta_selatan", "jakarta_timur", "jakarta_utara", "kediri", "kotamobagu", "langsa", "lhokseumawe", "lubuk_linggau", "madiun", "magelang", "malang", "metro", "mojokerto", "padang_panjang", "padangsidimpuan", "pagar_alam", "palopo", "pare_pare", "pariaman", "pasuruan", "payakumbuh", "pekalongan", "pematang_siantar", "prabumulih", "probolinggo", "sabang", "salatiga", "sawahlunto", "sibolga", "singkawang", "solok", "sorong", "subulussalam", "sukabumi", "sungai_penuh", "surakarta", "tangerang", "tangerang_selatan", "tanjung_balai", "tarakan", "tasikmalaya", "tebing_tinggi", "tegal", "ternate", "tidore", "tidore_kepulauan", "tomohon", "tual", "denpasar_utara", "ambon", "banda_aceh", "bandar_lampung", "banjarmasin", "denpasar", "jayapura", "kendari", "kupang", "makassar", "manado", "mataram", "padang", "palangkaraya", "palembang", "palu", "pangkal_pinang", "pekanbaru", "pontianak", "samarinda", "semarang", "serang", "tanjung_pinang", "yogyakarta")
• shop_type string nullable — Seller type filter (one of: "mall", "power_shop")
• condition string nullable — Product condition filter (one of: "new", "used")
• price_min integer nullable — Minimum price in IDR (min: 0)
• price_max integer nullable — Maximum price in IDR (min: 0)
• rating_4_plus boolean — Only products rated 4 stars and above (default: false)
• cod boolean — Only cash-on-delivery products (default: false)
• discount_only boolean — Only discounted products (default: false)
• preorder boolean nullable — Filter pre-order (true) or ready-stock (false) products
• added_within string nullable — Only products added within this recency window (one of: "week", "two_weeks", "month", "three_months")
• shipping string nullable — Delivery-speed filter (one of: "instant", "same_day")

Response

• @type string (default: "TokopediaProductCard")
• id string required
• name string nullable
• url string nullable
• price number nullable
• list_price number nullable
• discount integer nullable
• currency string (default: "IDR")
• image string nullable
• rating number nullable
• sold_count integer nullable
• category string nullable
• category_id string nullable
• breadcrumb string nullable
• shop_id string nullable
• shop_name string nullable
• shop_url string nullable
• shop_city string nullable
• is_official boolean nullable
• badge string nullable
• has_free_shipping boolean nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.