Shopee APIshopee.vn ↗
Access Shopee Vietnam product listings, shop profiles, search suggestions, and product details via a structured JSON API. 4 endpoints covering the shopee.vn marketplace.
What is the Shopee API?
The Shopee Vietnam API provides 4 endpoints for querying the shopee.vn marketplace, including product search, product detail retrieval, shop profile lookup, and keyword search suggestions. The get_shop_info endpoint returns fields like follower_count, rating_star, response_rate, and vacation status for any shop by numeric ID. The get_search_suggestions endpoint returns ranked suggestion objects with linked item and shop IDs, useful for autocomplete and keyword discovery.
curl -X GET 'https://api.parse.bot/scraper/f88dd171-7333-4da5-8a3e-03ff6573d062/get_search_suggestions?keyword=iphone' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace shopee-vn-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: Shopee Vietnam SDK — search suggestions and shop profiles."""
from parse_apis.shopee_vietnam_api import Shopee, Shop, SearchSuggestion, NotFoundError
shopee = Shopee()
# Search for keyword suggestions — single-page, limit caps total items
for suggestion in shopee.searchsuggestions.search(keyword="iphone", limit=5):
print(suggestion.text, suggestion.hint, suggestion.shop_ids)
# Drill into the first suggestion's linked shop
first = shopee.searchsuggestions.search(keyword="laptop", limit=1).first()
if first:
print(first.text, first.image, first.item_ids)
# Fetch a specific shop profile by its numeric ID
try:
shop = shopee.shops.get(shop_id="88201679")
print(shop.name, shop.rating_star, shop.follower_count, shop.item_count)
except NotFoundError as exc:
print(f"Shop not found: {exc}")
print("exercised: searchsuggestions.search / shops.get")
Get search suggestions for a keyword prefix. Returns suggested queries with associated item IDs, shop IDs, images, and hint text. Each suggestion includes a display text, image references, and linked item/shop identifiers. The response includes a has_more flag and session metadata for tracking.
| Param | Type | Description |
|---|---|---|
| keywordrequired | string | Search keyword prefix to get suggestions for. |
{
"type": "object",
"fields": {
"queries": "array of suggestion objects each with text, hint, image, item_ids, shop_ids",
"has_more": "boolean indicating more suggestions available",
"ss_session_id": "string session identifier"
},
"sample": {
"data": {
"queries": [
{
"hint": "Kính Gương",
"text": "Kính Gương",
"image": "6cbcc1172168fa87bb6225ed2ebe0ebf",
"item_ids": [
29112981443
],
"shop_ids": [
365272393
],
"icon_code": 0
}
],
"has_more": true,
"ss_session_id": "c29a1878-efc6-4763-8478-353db39de7f3"
},
"status": "success"
}
}About the Shopee API
Endpoints and Data Coverage
The API covers four distinct areas of the Shopee Vietnam marketplace. get_search_suggestions accepts a keyword prefix and returns an array of queries objects, each containing a suggestion text, hint, associated item_ids, shop_ids, and image references. The response also includes a has_more flag and a ss_session_id session token for tracking suggestion state across requests.
get_shop_info takes a numeric shop_id and returns the shop's display name, item_count, rating_star (float out of 5), follower_count, response_rate (integer percentage), and vacation status. The account sub-object exposes the shop's username and portrait image reference. This makes it suitable for building shop monitoring tools or vendor comparison dashboards.
Product Search and Detail
search_products accepts a keyword along with optional by (relevancy, price, sales, rating), order (asc, desc), limit, and offset parameters for sorting and pagination. It returns an items array and a total count. get_product_detail accepts both an item_id and shop_id to return the full item object for a specific listing. Note that both product endpoints may return error 90309999 under certain conditions, indicating an authentication or access block from the source.
Pagination and Sorting
Product search supports offset-based pagination via the offset and limit parameters. There is no cursor-based pagination. Sorting is controlled by the by field, which accepts relevancy, price, sales, or rating, combined with an order of asc or desc. Search suggestions do not support pagination beyond the has_more flag.
The Shopee API is a managed, monitored endpoint for shopee.vn — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when shopee.vn changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official shopee.vn API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Autocomplete search bars using keyword-ranked suggestions from
get_search_suggestions - Monitoring shop reputation metrics like
rating_star,follower_count, andresponse_rateover time - Detecting when a Shopee vendor activates vacation mode using the
vacationfield fromget_shop_info - Building price comparison tools by sorting
search_productsresults by price ascending or descending - Aggregating product catalog data for a specific shop by combining shop lookup with product search by shop
- Tracking item counts per shop using the
item_countfield returned byget_shop_info - Discovering trending search terms by analyzing suggestion frequency from
get_search_suggestions
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does Shopee Vietnam have an official developer API?+
What does the `get_shop_info` endpoint return beyond basic name and rating?+
name and rating_star, the endpoint returns follower_count, item_count, response_rate as an integer percentage, a vacation boolean indicating whether the shop is currently paused, and an account object containing the shop's username and portrait image reference. It also includes shop configuration fields such as A/B test flags and tab visibility settings.Why do `search_products` and `get_product_detail` sometimes return error 90309999?+
90309999 when the request is blocked due to authentication requirements on the Shopee platform. This is a known limitation documented on the endpoints themselves. get_search_suggestions and get_shop_info are less susceptible to this block. If you need consistent access to product data, you can fork this API on Parse and revise it to handle authenticated sessions or alternative data paths.Does the API return product reviews or ratings for individual items?+
Is category-based browsing supported, or is search keyword-only?+
search_products endpoint is keyword-driven and does not accept a category ID or browse-by-category parameter. Shop and category browse pages are not covered by the existing four endpoints. You can fork this API on Parse and revise it to add category-based product listing endpoints.