> ## 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.

# Shopify Stores API

**Endpoint**

text

```text theme={null}
POST /api/vi/shopify-stores
```

**Authentication**\
Include your API Key in the request header:

text

```text theme={null}
X-VIP-TOKEN: your_api_key_here
```

**Request Parameters**

|     **Parameter**     | **Type** | **Required** | **Description**                                                                                                                                       |
| :-------------------: | :------- | :----------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
|      search\_key      | string   | No           | Store name or domain keyword                                                                                                                          |
|        country        | string   | No           | Country code (e.g., US, CN)                                                                                                                           |
|          year         | int      | No           | Store creation year filter: 1=last 1 year, 2=1-2 years, 3=2-3 years, 4=3+ years                                                                       |
|        sort\_by       | int      | No           | Sort field: 0=product count, 1=category count, 2=monthly visits, 3=FB followers, 4=Ins followers, 5=ad count, 6=relevance, 7=monthly orders (default) |
|       order\_by       | string   | No           | Sort direction: asc/desc, default desc                                                                                                                |
|       page\_num       | int      | No           | Page number, starting from 1                                                                                                                          |
|       page\_size      | int      | No           | Items per page, max 100                                                                                                                               |
|   product\_num\_min   | int      | No           | Minimum product count                                                                                                                                 |
|   product\_num\_max   | int      | No           | Maximum product count                                                                                                                                 |
| advertise\_count\_min | int      | No           | Minimum ad count                                                                                                                                      |
| advertise\_count\_max | int      | No           | Maximum ad count                                                                                                                                      |
|  monthly\_visit\_min  | int      | No           | Minimum monthly visits                                                                                                                                |
|  monthly\_visit\_max  | int      | No           | Maximum monthly visits                                                                                                                                |
|   month\_order\_min   | int      | No           | Minimum monthly orders                                                                                                                                |
|   month\_order\_max   | int      | No           | Maximum monthly orders                                                                                                                                |
|          lang         | string   | No           | Language: en/cn, default en                                                                                                                           |

**Request Example**

python

```python theme={null}
import requests
import json

url = "https://api.ehunt.ai/api/vi/shopify-stores"
headers = {
    "Content-Type": "application/json",
    "X-VIP-TOKEN": "your_api_key_here"
}
payload = {
    "search_key": "fashion",
    "country": "US",
    "product_num_min": 100,
    "month_order_min": 1000,
    "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

```json theme={null}
{
  "code": 200,
  "message": "OK",
  "data": {
    "store_num": 100,
    "page_size": 20,
    "final_count": 20,
    "list": [
      {
        "store_id": "store_123",
        "shop_id": "shop_123",
        "store_name": "Fashion Hub",
        "store_domain": "fashionhub.myshopify.com",
        "store_link": "https://fashionhub.myshopify.com",
        "country": "United States",
        "created_time": "2020-01-15",
        "product_num": 2500,
        "category_num": 15,
        "categories": [
          {"id": "123", "name": "Women's Clothing"},
          {"id": "456", "name": "Accessories"}
        ],
        "monthly_visit": "2.5M",
        "month_order_num": "15.2k",
        "fb_followers": "125k",
        "ins_followers": "89k",
        "advertise_count": 45,
        "ad_link": "https://www.facebook.com/ads/library/?view_all_page_id=...",
        "email": "contact@fashionhub.com",
        "facebook_url": "https://www.facebook.com/fashionhub",
        "instagram_url": "https://www.instagram.com/fashionhub",
        "social_links": {},
        "global_rank": "125000",
        "logo": "https://cdn.shopify.com/.../logo.png",
        "available_status": 1
      }
    ]
  },
  "used_today": 150,
  "remaining_today": 350
}
```

**Response Fields**

|     **Field**     | **Type** | **Description**            |
| :---------------: | :------- | :------------------------- |
|     store\_id     | string   | Store ID                   |
|      shop\_id     | string   | Shop ID                    |
|    store\_name    | string   | Store name                 |
|   store\_domain   | string   | Store domain               |
|    store\_link    | string   | Store URL                  |
|      country      | string   | Country name               |
|   created\_time   | string   | Creation date              |
|    product\_num   | int      | Product count              |
|   category\_num   | int      | Category count             |
|     categories    | array    | Category list              |
|   monthly\_visit  | string   | Monthly visits (formatted) |
| month\_order\_num | string   | Monthly orders (formatted) |
|   fb\_followers   | string   | Facebook followers         |
|   ins\_followers  | string   | Instagram followers        |
|  advertise\_count | int      | Ad count                   |
|      ad\_link     | string   | Facebook Ad Library link   |
|       email       | string   | Contact email              |
|   facebook\_url   | string   | Facebook page URL          |
|   instagram\_url  | string   | Instagram profile URL      |
|   social\_links   | object   | Other social links         |
|    global\_rank   | string   | Global rank                |
|        logo       | string   | Store logo URL             |
| available\_status | int      | Store status (1=active)    |

## **Common Response Codes**

| **Code** | **Description**                                 |
| :------: | :---------------------------------------------- |
|    200   | Success                                         |
|    401   | Authentication failed (invalid/expired API Key) |
|    402   | Insufficient credits or subscription expired    |
|    403   | Access denied                                   |
|    429   | Rate limit exceeded                             |
|    500   | Internal 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.