Search for images — TikTok Business API

Search for images

 |Changes{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|Endpoint path|/v1.2/file/image/ad/search/|/v1.3/file/image/ad/search/|
|Request parameter data type |`advertiser_id`: number|`advertiser_id`: string|
|Response parameter deprecated in v1.3|/|`id`: string|
|New response parameters|/|`is_carousel_usable`|

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/file/image/ad/search/" \
  -H "Authorization: Bearer $KEY"

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/file/image/ad/search/",
    params={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/file/image/ad/search/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/file/image/ad/search/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "page_info": {
            "page_size": 20,
            "total_page": 1,
            "total_number": 2,
            "page": 1
        },
        "list": [
            {
                "height": 720,
                "size": 118834,
                "image_url": "{{image_url}}",
                "modify_time": "{{modify_time}}",
                "create_time": "{{create_time}}",
                "image_id": "{{image_id}}",
                "file_name": "{{file_name}}",
                "width": 1280,
                "signature": "{{signature}}",
                "displayable": false,
                "material_id": "{{material_id}}",
                "format": "jpeg",
                "is_carousel_usable": false
            },
            {
                "height": 720,
                "size": 159992,
                "image_url": "{{image_url}}",
                "modify_time": "{{modify_time}}",
                "create_time": "{{create_time}}",
                "image_id": "{{image_id}}",
                "file_name": "{{file_name}}",
                "width": 1280,
                "signature": "{{signature}}",
                "displayable": false,
                "material_id": "{{material_id}}",
                "format": "jpeg",
                "is_carousel_usable": false
            }
        ]
    }
}
(/code);

Get started

1. Sign up for Partner
2. Enable a data type of the Ads (Marketing API) group on the platform page
3. Create an API key (tick the TikTok Business channel)
4. Call it as in the examples above