TikTok tikTok Hashtag API

Scrape TikTok videos for a hashtag

curl --request POST \
  --url https://api.stophy.dev/v1/tiktok/hashtag \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hashtag": "booktok"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({hashtag: 'booktok'})
};

fetch('https://api.stophy.dev/v1/tiktok/hashtag', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/tiktok/hashtag"

payload = { "hashtag": "booktok" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "videoUrl": "<string>",
        "type": "video",
        "authorUrl": "<string>",
        "authorIsVerified": true,
        "isAd": true,
        "isAiGenerated": true,
        "videoId": "<string>",
        "text": "<string>",
        "hashtags": [
          "<string>"
        ],
        "mentions": [
          "<string>"
        ],
        "publishedAt": "2023-11-07T05:31:56Z",
        "durationSeconds": 123,
        "thumbnailUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "views": 0,
        "likes": 0,
        "comments": 0,
        "shares": 0,
        "saves": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorAvatarUrl": "<string>",
        "audioId": "<string>",
        "audioTitle": "<string>",
        "audioArtist": "<string>",
        "audioIsOriginal": true
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

tiktok

hashtag

Scrape TikTok videos for a hashtag

curl --request POST \
  --url https://api.stophy.dev/v1/tiktok/hashtag \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hashtag": "booktok"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({hashtag: 'booktok'})
};

fetch('https://api.stophy.dev/v1/tiktok/hashtag', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/tiktok/hashtag"

payload = { "hashtag": "booktok" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "videoUrl": "<string>",
        "type": "video",
        "authorUrl": "<string>",
        "authorIsVerified": true,
        "isAd": true,
        "isAiGenerated": true,
        "videoId": "<string>",
        "text": "<string>",
        "hashtags": [
          "<string>"
        ],
        "mentions": [
          "<string>"
        ],
        "publishedAt": "2023-11-07T05:31:56Z",
        "durationSeconds": 123,
        "thumbnailUrl": "<string>",
        "imageUrls": [
          "<string>"
        ],
        "views": 0,
        "likes": 0,
        "comments": 0,
        "shares": 0,
        "saves": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorAvatarUrl": "<string>",
        "audioId": "<string>",
        "audioTitle": "<string>",
        "audioArtist": "<string>",
        "audioIsOriginal": true
      }
    ],
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape TikTok videos for a hashtag.

Request

hashtag is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.tiktok.hashtag({ hashtag: "booktok" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.tiktok.hashtag(hashtag="booktok")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/tiktok/hashtag \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"hashtag":"booktok"}'

stophy tiktok hashtag booktok

Response

If successful, the response body contains the standard envelope. data.results[] contains a page of videos for the hashtag. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "results": [
      {
        "videoId": "7223827494913215786",
        "videoUrl": "https://www.tiktok.com/@jenna_bushhager/video/7223827494913215786",
        "type": "video",
        "text": "#WorldBookDay is 4/23, and I've joined the #BookTok community to share our favorite books with you all! Duet to share…",
        "hashtags": ["worldbookday", "booktok"],
        "publishedAt": "2023-04-19T18:20:30.000Z",
        "durationSeconds": 82,
        "thumbnailUrl": "https://p19-common-sign.tiktokcdn-us.com/tos-useast5-p-0068-tx/ce0ee016ff8a483e8271ed4b4faebb3a~tplv-tiktokx-origin.ima…",
        "views": 39100,
        "likes": 997,
        "comments": 32,
        "shares": 36,
        "saves": 134,
        "authorId": "6915876645917082629",
        "authorUsername": "jenna_bushhager",
        "authorName": "Jenna Bush Hager",
        "authorUrl": "https://www.tiktok.com/@jenna_bushhager",
        "authorAvatarUrl": "https://p16-common-sign.tiktokcdn-us.com/tos-useast8-avt-0068-tx2/0707efff51851e19e5e88f36bd87a298~tplv-tiktokx-cropcen…",
        "authorIsVerified": true,
        "audioId": "7223827501163006766",
        "audioTitle": "original sound",
        "audioArtist": "Jenna Bush Hager",
        "audioIsOriginal": true,
        "isAd": false,
        "isAiGenerated": true
      }
    ],
    "cursor": "53"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`type`	string	The kind of item: `video` or `photo`.
`publishedAt`	string (ISO 8601)	The publication time, in UTC.
`durationSeconds`	number	The duration, in seconds.
`likes`	integer	The number of likes.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`cursor`	string	The pagination token from the previous response.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

TikTok tikTok Video: Accepts videoUrl. Scrape a TikTok video.
TikTok tikTok Sound: Accepts audioId. Scrape a TikTok sound and its videos.
TikTok tikTok Comments: Accepts videoUrl. Scrape the comments of a TikTok video.
TikTok tikTok Transcript: Accepts videoUrl. Scrape a TikTok video’s transcript.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

hashtag

string

required

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

TikTok tikTok Hashtag API

Request

Response

Optional parameters

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods