# Yiwugo API - Search for Yiwugo products by keywords

## API Overview

- Get a list of products based on keyword
- Total number of products
- Product information (title/price/image/unit)
- Shop information (shop name/shop URL/shop location)
- Sales information (GMV/sales quantity)

## API URL

`GET http://api.tmapi.top/yiwugo/search/items`

## Request Parameters

### Query

| Field | Type | Explanation | Required |
| --- | --- | --- | --- |
| keyword | string | Search keywords | true |
| page | integer | Page number<br/>Default value: 1 | false |
| page_size | integer | Number of items per page<br/>Default value: 10 | false |
| language | string | Optional values: `zh`, `en`<br/>Default value: en | false |

## Security Auth

> Please go to [Console-API Keys](https://console.tmapi.io/account/api-keys) to create your apikey.

> Add your apikey to the request headers. Please refer to the examples below.

## Request Example

```bash

curl --request GET 'http://api.tmapi.top/yiwugo/search/items?keyword=%E6%89%8B%E6%9C%BA%E5%A3%B3&language=zh' \
+  --header 'apikey: xxxxxx'

```

## Response Example

```json

{
  "code": 200,
  "msg": "success",
  "data": {
    "keywords": "手机壳",
    "total": 19500,
    "page": 1,
    "page_size": 10,
    "items": [
      {
        "item_id": 930986264,
        "title": "新款IP 11  PRO 苹果电镀TPU皮套+指环支架一体保护套手机壳",
        "price": "",
        "vip_price": "",
        "currency": "CNY",
        "img": "http://img1.yiwugo.com/i004/2019/11/16/52/bec0b7537ebd6a8a6145c6e1369b679c.png",
        "shop_info": {
          "shop_id": 516312,
          "shop_name": "倚天手机配件",
          "shop_url": "https://www.yiwugo.com/hu/0217603.html",
          "seller_type": "2",
          "shop_location": "义乌国际商贸城二区35门3楼5街17603,17604",
          "factory_location": ""
        },
        "sale_info": {
          "gmv": 0,
          "sale_quantity": 0
        },
        "start_num": 0,
        "is_living": false,
        "is_ad": true,
        "unit": "个"
      },
      {
        "item_id": 949410881,
        "title": "适用苹果14promax手机壳水钻玫瑰抖音同款iPhone13奢华全包保护套",
        "price": "16.0",
        "vip_price": "",
        "currency": "CNY",
        "img": "http://ywgimg.yiwugo.com/product/shop_108085/normal/949410881/20250524/eYNAYTATQf2io0bM.jpg?x-oss-process=image/resize,m_lfit,h_500,w_500",
        "shop_info": {
          "shop_id": 584008,
          "shop_name": "义乌原创通讯 ",
          "shop_url": "https://www.yiwugo.com/hu/02179521.html",
          "seller_type": "1",
          "shop_location": "浙江省金华市义乌市财富大厦B座4楼435",
          "factory_location": "浙江省 金华市 义乌市 财富大厦B座4楼435"
        },
        "sale_info": {
          "gmv": 0,
          "sale_quantity": 0
        },
        "start_num": 2,
        "is_living": false,
        "is_ad": false,
        "unit": "个"
      },
      {
        "item_id": 976126059,
        "title": "透明适用苹果15/16防摔14手机壳iphone13pro手机套PM软壳11批发13",
        "price": "0.72",
        "vip_price": "",
        "currency": "CNY",
        "img": "http://ywgimg.yiwugo.com/product/shop_238953/normal/976126059/20250607/FJUWxS6qZ7elvurD.jpg?x-oss-process=image/resize,m_lfit,h_500,w_500",
        "shop_info": {
          "shop_id": 728073,
          "shop_name": "尚宝钰头饰品实力供应商",
          "shop_url": "https://www.yiwugo.com/hu/0442847B01.html",
          "seller_type": null,
          "shop_location": "浙江省金华市义乌市浙江省金华市义乌市福田街道尚经村三区",
          "factory_location": "浙江省 金华市 义乌市 浙江省金华市义乌市福田街道尚经村三区"
        },
        "sale_info": {
          "gmv": 502,
          "sale_quantity": 535
        },
        "start_num": 1,
        "is_living": false,
        "is_ad": false,
        "unit": "个"
      }
    ]
  }
}

```