Download a TikTok video file

Try in Playground

Download the video file of one post by permalink or share link. A successful response is the file itself (HTTP 200, the media host's video content type and length); failures are JSON. Photo posts have no video file and answer unsupported_media; their images download directly from the video route's imagePost addresses.

GET/v1/tiktok/video/mediax-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

https://www.tiktok.com/@{handle}/video/{id}, https://www.tiktok.com/t/{code}, https://vm.tiktok.com/{code} or https://vt.tiktok.com/{code}; query strings and fragments are accepted and dropped. Photo permalinks answer unsupported_media.

max 512 chars

Examplehttps://www.tiktok.com/@example/video/7400000000000000001

Response fields

requestIdstring

Request correlation UUID (also the x-request-id header of a successful download).

Upstream calls made, decoded bytes delivered to the parser and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

Present on failures only: false.

statusenum

failed or challenged on failures.

one of: failed, challenged

Failure code and content-free message.

failure.codeenum

Always included.

one of: invalid_request, unauthorized, not_found, restricted_page, upstream_challenged, upstream_rate_limited, upstream_error, unsupported_page, response_too_large, unsafe_redirect, request_limit, payload_too_complex, timeout, busy, unsupported_media

failure.messagestring

Always included.

HTTP 200 returns the file itself (video/mp4 family) with its content-length when known, not JSON. The fields above describe the JSON body of a failure, explained in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, handles, cursors, regions, sorts or languages.
401	`unauthorized`	Invalid API key.
403	`restricted_page`	TikTok restricts the account or post (private video, private account, region block, or a redirect to its login page).
404	`not_found`	Unknown or removed account, post, hashtag or sound, a post without captions, or a TikTok status code naming a missing resource.
422	`unsupported_media`	A video file was requested for a photo post, which has no video file.
429	`upstream_rate_limited`	TikTok rate limited the request.
502	`upstream_challenged`	TikTok answered its verification page, an HTTP 401/403, a document without the app state, or refused a feed call with an empty body (status challenged).
502	`unsafe_redirect`	TikTok redirected outside the requested resource.
502	`unsupported_page`	Layout, identity or feed-envelope checks failed, or a non-JSON feed answer was served.
502	`response_too_large`	The upstream response exceeded 4 MiB (512 KiB for caption files).
502	`payload_too_complex`	The embedded JSON exceeded parsing limits.
502	`request_limit`	The upstream call budget was exhausted.
502	`upstream_error`	Network failure, a stalled exit, an unexpected upstream status after one retry, or an unexpected TikTok status code.
503	`busy`	All retrieval slots are occupied.
504	`timeout`	The 90-second deadline elapsed.

Code example

curl "https://api.scrapeatlas.com/v1/tiktok/video/media?url=https%3A%2F%2Fwww.tiktok.com%2F%40example%2Fvideo%2F7400000000000000001" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/tiktok/video/media?url=https%3A%2F%2Fwww.tiktok.com%2F%40example%2Fvideo%2F7400000000000000001",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/tiktok/video/media?url=https%3A%2F%2Fwww.tiktok.com%2F%40example%2Fvideo%2F7400000000000000001",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`TikTok request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/tiktok/video/media",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.tiktok.com/@example/video/7400000000000000001"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/tiktok/video/media?url=https%3A%2F%2Fwww.tiktok.com%2F%40example%2Fvideo%2F7400000000000000001", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/tiktok/video/media?url=https%3A%2F%2Fwww.tiktok.com%2F%40example%2Fvideo%2F7400000000000000001"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

HTTP 200 returns the file itself (video/mp4 family) with its content-length when known, not JSON.

Missing, duplicate, ambiguous or unsupported parameters, unsupported URL forms, handles, cursors, regions, sorts or languages.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}