Dedicated APIsShopee

Shopee Syphoon API Documentation

Overview

Shopee Syphoon API lets you capture real-time data effortlessly and accurately for products, categories, and searches. We support Shopee HTML URLs and return data from API.

Our solution can extract a wide variety of data, including but not limited to:

  • Product Searches by Keyword
  • Product Searches by Category
  • Product Details

This documentation covers endpoints, authentication, rate limits, error handling, and best practices, with general structures and detailed examples for API responses.

Endpoint

  • URL: https://api.syphoon.com
  • Method: POST
  • General Post Body: 
     {
  "url": shopee_url,
 "key": syphoon_key, 
 "method": "GET"
 }

Explanation:

  • shopee_url : All Shopee HTML URLs are supported, as long as it does not require login. Please note that API URLs are not supported. Please pass the URLs that can be opened from a browser without login.
  • syphoon_key : Syphoon API Key present in your Syphoon Dashboard
  • method : Method should always be “GET”. Please note that we do not support “POST” requests for Shopee.

Sample URLs

 {
  https://shopee.vn/search?keyword=Detergents
  https://shopee.vn/search?keyword=sunsilk
 }

Product URLs

 {
  https://shopee.com.my/--i.13377506.161291428
  https://shopee.vn/--i.63521925.6142533094
 }

Authentication

Each request requires an API key in the POST data, provided upon subscription to the Syphoon service. The API key must be included in every request to authenticate the user.

Rate Limits

The rate limits applied to each user are custom and based on the subscription plan chosen. You should not cross the concurrency you have been assigned because you will get a “Too many requests” error.

Response Structure & Status Codes

For successful responses, you will get the API response as returned by the website. The Status Code will be 200 for these responses. For failed responses, the Status Code can be 4xx or 5xx.

  • Status Code 404 will be returned when the provided Shopee URL is incorrect (404 requests will be charged, so make sure of the URLs)
  • Status Code 429 will be returned when concurrency limits are breached
  • Status Code 400 will be returned if Shopee does not respond with a valid JSON (these will be charged)
  • Status Code 5xx will be sent for server errors

We request you to check the Status Code before trying to parse the response. You will only be charged for responses with Status Codes 200, 400 and 404.

For any help or assistance, please don’t hesitate to reach out to support@syphoon.com and we will be glad to help you.

AmazonWalmart