TikTok — hashtag info

curl --request POST \
  --url https://app.sideshift.app/api/v1/scrape/tiktok/hashtag \
  --header 'Content-Type: application/json' \
  --data '
{
  "hashtag": "booktok"
}
'

import requests

url = "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag"

payload = { "hashtag": "booktok" }
headers = {"Content-Type": "application/json"}

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hashtag' => 'booktok'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag"

	payload := strings.NewReader("{\n  \"hashtag\": \"booktok\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/v1/scrape/tiktok/hashtag")
  .header("Content-Type", "application/json")
  .body("{\n  \"hashtag\": \"booktok\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/v1/scrape/tiktok/hashtag")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hashtag\": \"booktok\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "hashtag": {
      "cover_url": "https://p16-common-sign.tiktokcdn.com/tiktok-obj/ffd11355ceddd5cb7a3f7f4a1f059df0.png~tplv-tiktokx-origin.image",
      "description": "Calling all book lovers, join the #BookTok Post Contest from April 13th to May 11th for a chance to win $3000! Click here to join: https://vt.tiktok.com/ZSHgdjSGp/",
      "hashtag_id": "1622962893630470",
      "hashtag_link": "https://www.tiktok.com/tag/BookTok",
      "name": "BookTok",
      "is_challenge": false,
      "is_commerce": false,
      "is_pgc_show": false,
      "is_strong_music": false,
      "post_count": 83398624,
      "type": 2,
      "view_count": 540913519879
    }
  },
  "request_id": "req_8f3c9a2b1d4e6f70",
  "upstream_calls": 1,
  "meta": {
    "credits_charged": 1,
    "credits_remaining": 9998
  }
}

{
  "error": "INVALID_INPUT",
  "message": "Invalid request body.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UNAUTHORIZED",
  "message": "Invalid scraper API key.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "INSUFFICIENT_SCRAPER_CREDITS",
  "message": "Insufficient scraper credits.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "Requested resource not found or unavailable.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "PAYLOAD_TOO_LARGE",
  "message": "Request body must be 32KB or smaller.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "SCRAPER_RATE_LIMITED",
  "message": "Scraper API rate limit exceeded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "INTERNAL_ERROR",
  "message": "Request failed. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UPSTREAM_ERROR",
  "message": "Data source failed. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UPSTREAM_TIMEOUT",
  "message": "Data source timed out. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

POST

scrape

tiktok

hashtag

TikTok — hashtag info

curl --request POST \
  --url https://app.sideshift.app/api/v1/scrape/tiktok/hashtag \
  --header 'Content-Type: application/json' \
  --data '
{
  "hashtag": "booktok"
}
'

import requests

url = "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag"

payload = { "hashtag": "booktok" }
headers = {"Content-Type": "application/json"}

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'hashtag' => 'booktok'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/v1/scrape/tiktok/hashtag"

	payload := strings.NewReader("{\n  \"hashtag\": \"booktok\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/v1/scrape/tiktok/hashtag")
  .header("Content-Type", "application/json")
  .body("{\n  \"hashtag\": \"booktok\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/v1/scrape/tiktok/hashtag")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hashtag\": \"booktok\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "hashtag": {
      "cover_url": "https://p16-common-sign.tiktokcdn.com/tiktok-obj/ffd11355ceddd5cb7a3f7f4a1f059df0.png~tplv-tiktokx-origin.image",
      "description": "Calling all book lovers, join the #BookTok Post Contest from April 13th to May 11th for a chance to win $3000! Click here to join: https://vt.tiktok.com/ZSHgdjSGp/",
      "hashtag_id": "1622962893630470",
      "hashtag_link": "https://www.tiktok.com/tag/BookTok",
      "name": "BookTok",
      "is_challenge": false,
      "is_commerce": false,
      "is_pgc_show": false,
      "is_strong_music": false,
      "post_count": 83398624,
      "type": 2,
      "view_count": 540913519879
    }
  },
  "request_id": "req_8f3c9a2b1d4e6f70",
  "upstream_calls": 1,
  "meta": {
    "credits_charged": 1,
    "credits_remaining": 9998
  }
}

{
  "error": "INVALID_INPUT",
  "message": "Invalid request body.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UNAUTHORIZED",
  "message": "Invalid scraper API key.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "INSUFFICIENT_SCRAPER_CREDITS",
  "message": "Insufficient scraper credits.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "RESOURCE_NOT_FOUND",
  "message": "Requested resource not found or unavailable.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "PAYLOAD_TOO_LARGE",
  "message": "Request body must be 32KB or smaller.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "SCRAPER_RATE_LIMITED",
  "message": "Scraper API rate limit exceeded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "INTERNAL_ERROR",
  "message": "Request failed. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UPSTREAM_ERROR",
  "message": "Data source failed. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

{
  "error": "UPSTREAM_TIMEOUT",
  "message": "Data source timed out. Your credits were refunded.",
  "request_id": "req_8f3c9a2b1d4e6f70"
}

Body

application/json

Option 1
Option 2
Option 3

Use a topic name or topic id, not both.

hashtag

string | null

required

Topic name or topic URL. Accepted names: hashtag or challenge_name. Send only one.

challenge_id

string | null

Numeric topic id.

challenge_name

string | null

Topic name or topic URL. Accepted names: hashtag or challenge_name. Send only one.

Response

Completed lookup. Standard cost: 1 SideShift credit; account-specific pricing, when present, is shown in the Scraper dashboard and returned in the billing headers.

data

object

required

TikTok platform data payload. Field names and nesting are preserved.

Show child attributes

request_id

string

required

SideShift request id. Include it in support requests.

upstream_calls

enum<integer>

required

Number of data-source lookups performed.

Available options:

1

Guides

Reference

TikTok — hashtag info

Body

Response