Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.api.ehunt.ai/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint text 
POST /api/vi/shopify-items
Authentication
Include your API Key in the request header: text 
X-VIP-TOKEN: your_api_key_here
Request Parameters
ParameterTypeRequiredDescription
search_keystringNoSearch keyword or Shopify product/store URL
sort_byintNoSort field: 14=weekly sales desc (default), 1=published time desc, 2=published time asc, 3=price desc, 4=price asc, 7=weekly sales desc, 9=ad count desc, 10=ad count asc, 11=competition desc, 12=competition asc, 13=created at desc, 15=weekly sales asc, 16=weekly revenue desc, 17=weekly revenue asc, 18=weekly revenue growth desc, 19=weekly revenue growth asc, 20=relevance asc, 21=relevance desc
page_numintNoPage number, starting from 1
page_sizeintNoItems per page, max 100
price_minfloatNoMinimum price (USD)
price_maxfloatNoMaximum price (USD)
sales_weekly_minintNoMinimum weekly sales
sales_weekly_maxintNoMaximum weekly sales
published_time_beginstringNoListing start date (YYYY-MM-DD)
published_time_endstringNoListing end date (YYYY-MM-DD)
facebook_adintNoHas Facebook ads: 1=yes
competition_minintNoMinimum competition (number of stores)
competition_maxintNoMaximum competition
has_supplierintNoHas supplier: 1=yes, 0=no
show_deletedintNoShow delisted products: 1=yes, 0=no
countrystringNoShipping country code (e.g., US, CN)
langstringNoLanguage: en/cn, default en
Request Example python 
import requests
import json

url = "https://api.ehunt.ai/api/vi/shopify-items"
headers = {
    "Content-Type": "application/json",
    "X-VIP-TOKEN": "your_api_key_here"
}
payload = {
    "search_key": "dress",
    "price_min": 10,
    "price_max": 50,
    "sales_weekly_min": 10,
    "sort_by": 7,
    "page_num": 1,
    "page_size": 20
}
response = requests.post(url, headers=headers, json=payload)
print(json.dumps(response.json(), indent=2))
Response Example json 
{
  "code": 200,
  "message": "OK",
  "data": {
    "product_num": 100,
    "page_size": 20,
    "final_count": 20,
    "list": [
      {
        "product_id": "12345",
        "title": "Vintage Cotton Dress",
        "product_link": "https://example.myshopify.com/products/vintage-dress",
        "preview_image_url": "https://cdn.shopify.com/.../image.jpg",
        "country": "US",
        "min_price": 29.99,
        "max_price": 49.99,
        "store_id": "store_123",
        "shop_id": "shop_123",
        "store_link": "example.myshopify.com",
        "store_rank": "A",
        "competitor_count": 15,
        "facebook_ad_count": 3,
        "week_order_count": "1,234",
        "week_revenue_count": "12,345",
        "week_revenue_growth": 15.5,
        "shelf_time": "2024-01-15",
        "is_deleted": 0,
        "is_favourite": 0
      }
    ]
  },
  "used_today": 150,
  "remaining_today": 350
}
Response Fields
FieldTypeDescription
product_idstringProduct ID
titlestringProduct title
product_linkstringProduct URL
preview_image_urlstringMain image URL
countrystringShipping country
min_pricefloatMinimum price (USD)
max_pricefloatMaximum price (USD)
store_idstringStore ID
shop_idstringShop ID
store_linkstringStore URL
store_rankstringStore rank
competitor_countintCompetition (number of stores)
facebook_ad_countintNumber of Facebook ads
week_order_countstringWeekly sales (formatted)
week_revenue_countstringWeekly revenue (formatted)
week_revenue_growthfloatWeekly revenue growth (%)
shelf_timestringListing date
is_deletedintDelisted status (0=active, 1=delisted)
is_favouriteintFavorited flag

​
Common Response Codes

CodeDescription
200Success
401Authentication failed (invalid/expired API Key)
402Insufficient credits or subscription expired
403Access denied
429Rate limit exceeded
500Internal server error

​
Credit Usage

  • Each returned product/store consumes 1 credit.
  • Daily credit limit (shared across all VIP endpoints).
  • Response includes used_today and remaining_today to monitor usage.\