Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation TikTok profile
Markdown ↗
TikTok APIs

TikTok profile

Fetch public TikTok profile metadata and a paginated slice of recent public videos from a creator profile.

POST/v1/tiktok/profile
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

usernamestringRequired

TikTok username, with or without the leading @. Minimum length: 1. Maximum length: 2000.

limitintegerOptional

Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported. Default: 30. Minimum: 0. Maximum: 100.

cursorstringOptional

Zero-based pagination cursor returned as next_cursor from the previous response.

Advanced & compatibility inputs 1
max_videosintegerOptional

Maximum number of public videos to collect from the rendered page. You can also use limit. Default: 30. Minimum: 0. Maximum: 100.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "success",
    "profile",
    "videos",
    "count",
    "max_videos_requested",
    "pagination"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "videos": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "url",
          "caption",
          "thumbnail_url",
          "views_text",
          "view_count",
          "author_username",
          "author_display_name",
          "hashtags"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "caption": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "hashtags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "view_count": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "views_text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "thumbnail_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "author_username": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "author_display_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "profile": {
      "type": "object",
      "required": [
        "id",
        "username",
        "display_name",
        "bio",
        "bio_link",
        "avatar_url",
        "avatar_url_hd",
        "verified",
        "private",
        "followers",
        "following",
        "likes",
        "video_count",
        "profile_url"
      ],
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "bio": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "likes": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "private": {
          "type": "boolean"
        },
        "bio_link": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "username": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        },
        "followers": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "following": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "avatar_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "profile_url": {
          "type": "string"
        },
        "video_count": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "avatar_url_hd": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "success": {
      "type": "boolean"
    },
    "pagination": {
      "type": "object",
      "required": [
        "cursor",
        "next_cursor",
        "has_next_page",
        "count"
      ],
      "properties": {
        "count": {
          "type": "integer"
        },
        "cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "next_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "has_next_page": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "max_videos_requested": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "tiktok-profile",
  "task_name": "TikTok profile",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "count": 1,
    "videos": [
      {
        "id": "id-1",
        "url": "https://example.com/item-1",
        "caption": "sample",
        "hashtags": [
          "Featured"
        ],
        "view_count": 1,
        "views_text": "Sample views_text 1",
        "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg",
        "author_username": "Stylish Shoreditch Loft with Balcony",
        "author_display_name": "Stylish Shoreditch Loft with Balcony"
      }
    ],
    "profile": {
      "id": "id-1",
      "bio": "sample",
      "likes": 1.5,
      "private": true,
      "bio_link": "https://example.com/item-1",
      "username": "Stylish Shoreditch Loft with Balcony",
      "verified": true,
      "followers": 1.5,
      "following": 1.5,
      "avatar_url": "https://images.example.com/avatar_url-1.jpg",
      "profile_url": "https://example.com/item-1",
      "video_count": 1,
      "display_name": "Stylish Shoreditch Loft with Balcony",
      "avatar_url_hd": "https://images.example.com/avatar_url_hd-1.jpg"
    },
    "success": true,
    "pagination": {
      "count": 1,
      "cursor": "cursor-page-1",
      "next_cursor": "cursor-page-1",
      "has_next_page": true
    },
    "max_videos_requested": 1
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/tiktok/profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username":"tiktok"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/tiktok/profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username":"tiktok","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/tiktok-profile/runs.