Adspy List Interface

Interface Information

• Interface Name: Get Adspy List
• Request Method: POST
• Interface Address: /open-api/v1/data
• Interface Path: /v3/api/open/adspy/list
• Interface Description: Get Adspy list information based on filter conditions with pagination support
• Pricing: Retrieving one data result consumes 1 credit

Request Headers:

• Content-Type: application/json
• Accept: application/json

Request Parameters

Request Structure

Parameter List (params object)

Required Parameters

Optional Parameters (Alphabetical Order)

Keyword Search Format Specification

The extend_keywords and exclude_keywords parameters use JSON format:

  [
    {
      "type": 1,
      "keyword": "search keyword"
    }
  ]

Search Type (type) Explanation:

• type:1 - Ad keyword search: the user-entered keyword will be matched against ad copy, advertiser, landing page URL, product, App, account, and creative material
• type:2 - Ad copy: the user-entered keyword will only match against ad copy
• type:3 - Advertiser: the user-entered keyword will search advertisers
• type:4 - Landing page URL: the user-entered keyword will search landing page URLs and redirect links
• type:5 - E-commerce product: the user-entered keyword will search e-commerce product names
• type:6 - TikTok Shop store: the user-entered keyword will search TikTok Shop store names
• type:7 - APP name: the user-entered keyword will search App application names
• type:8 - APP developer: the user-entered keyword will search APP developer names
• type:9 - Social media account (page name): the user-entered keyword will search social media accounts (TT account/Page ID)
• type:10 - Creative material (script/hook/tag): the user-entered keyword will search creative material information (script/hook/tag)
• type:11 - E-commerce store/URL: the user-entered keyword will search e-commerce store/URL
• type:12 - TikTok Shop product: the user-entered keyword will search TikTok Shop products

Request Example

curl -X POST "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
        "key": "your_api_key_here",
        "uri": "/v3/api/open/adspy/list",
        "params": {
          "is_participle": false,
          "shop_type": [
            "magento",
            "shopify"
          ],
          "extend_keywords": [
            {
                "type": 1,
                "keyword": "shorts"
            },
            {
                "type": 2,
                "keyword": "black"
            }
          ],
          "plat_type": 1,
          "search_type": 1,
          "sort": 2,
          "sort_type": "desc",
          "current_page": 1,
          "play_count_min": 1000,
          "play_count_max": 10000,
          "create_time_start": 1761580800,
          "create_time_end": 1764172799,
          "page_size": 20
        }
  }'

Response Parameters

Response Body Structure

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      // Ad data list
    ],
    "page": {
      // Pagination info
    }
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
  "success": true,
  "fail": false
}

Response Field Description

Main Response Fields

Ad Data Fields (data) - Alphabetical Order

Carousel Fields (carousel) - Alphabetical Order

Pagination Info Fields (page)

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "search_by_image_tag": true,
        "comment_count": 2,
        "app_dev_id": "",
        "digg_play_rate": 0.0067,
        "modify_time": 1752204344,
        "pack_url": "",
        "type": 1,
        "is_collection": false,
        "platform": 1,
        "duration": 59,
        "cover": "https://cdn-video.pipispy.com/cover_7f33700d982493b5a19b158a7068af93.jpg",
        "share_play_rate": 0.0007,
        "last_put_time": 1752204344,
        "root_path_id": "61f57e4d9a301ef93d53b88a",
        "put_days": 12,
        "app_title": "I don't believe it! Your hair is oilier than mine!! #amaxy #fyp",
        "fetch_region": ["MY"],
        "ad_create_time": 1745303145,
        "play_count": 47527,
        "share_count": 32,
        "app_name": "🇲🇾Live Streamers Regina & Fiona",
        "found_time": 1749614161,
        "ad_id": "1833892866239586",
        "hot_value": 352,
        "digg_count": 318,
        "is_download": false,
        "data_type": [3],
        "button_text": "Buy now",
        "desc": "I don't believe it! Your hair is oilier than mine!! #amaxy #fyp",
        "video_id": "d9055376ae19819f4756",
        "app_image": "https://cdn-video.pipispy.com/avatar_0aa449789bac7929f216b33fde973196.jpg",
        "video_url": "https://cdn-video.pipispy.com/video_39551dc815f2501724d82a30c4a389c3.mp4",
        "ai_analysis_main_hook": "Is your hair this oily?",
        "ai_analysis_script": "Is your hair this oily? To do a test for you, I'm making such a sacrifice. This is oil, oh my, I have to make this thing. Is your hair this oily? Let me tell you, I'm only washing once. Let me see if its effect can really help us remove oil? If not, don't buy. OK, is that enough? Look at its foam, it's quite dense, and it smells nice with this fresh scent. For oily hair, you should buy this blue one, it'll help you remove oil. Then use a bit of its conditioner and apply it to the ends of your hair. Is it smooth? Oh my god, I put so much oil, and I only washed once, you see it's clean, no oil at all, no oily smell, and it's very dry and fluffy, wow it's just as it says. So if you have oily hair, I highly recommend you buy this blue amaxy, it's a gift box set with two bottles of shampoo, one bottle is 400ml, and this is a conditioner to make your hair smoother, also 400ml. If you buy this, more than a hundred bucks right? I'll give you two more 100ml bottles of shampoo, and 12 packets of shampoo, one packet is 8ml, I'm giving you nearly 300ml, one full-size is 400ml, I'm giving you almost one bottle, going right? If you also have oily hair and it's very oily if you don't wash for a day, click the link in the lower left corner of the video to buy, it really works, you'll like it.",
        "ai_analysis_tags": [
          "#shampoo",
          "#conditioner",
          "#haircare",
          "#oilyhair",
          "#amaxy",
          "#hairproduct",
          "#hair",
          "#beauty"
        ],
        "ai_analysis_language": "zh-cn",
        "ai_analysis_human_presenter": "yes",
        "had_ai_analysis": true,
        "min_cpm": 33.74,
        "min_cpa": 1.0,
        "unique_id": "hows.sis"
      }
    ],
    "page": {
      "total_count": 10000,
      "page_count": 500,
      "current_page": 1,
      "page_size": 20,
      "is_next": true
    }
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 20,
  "success": true,
  "fail": false
}

Error Code Description