Introduction

Welcome to the KayWat Codes Enterprise API. Our API allows you to programmatically access all our scraping tools, including TikTok Comment Exports, Profile Archiving, and Analytics.

Base URL

Data Formats

All requests and responses use standard `application/json` format. Dates are returned in ISO 8601 format (UTC).

Authentication

Authenticate your requests by including your API key in the `Authorization` header as a Bearer token.

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.kaywat.codes/v1/job

Warning: Your API key carries full administrative privileges. Keep it secure and never expose it in client-side code or public repositories.

Create a Scraping Job

Launch a new scraper by sending a POST request with the specific mode and parameters.

1. TikTok Comment Export

Extract details from video comments, sound grids, or creator posts.

{
  "mode": "comments",
  "params": {
    "url": "https://www.tiktok.com/@user/video/..."
  }
}

2. Profile Archiver

Download full profiles and metadata.

{
  "mode": "archiver",
  "params": {
    "username": "tiktok",
    "max_videos": 100
  }
}

Check Job Status

Poll the status of an ongoing job or retrieve the final scraped data.

{
  "job_id": "897be298-6bab-42f2-8007-84a141ef1943",
  "status": "completed",
  "progress": 100,
  "result": {
    "total_records": 12503,
    "download_url": "https://api.kaywat.codes/v1/download/...",
    "data": [...]
  }
}

Webhooks

Instead of polling our status endpoint, you can provide a `webhook_url` in your settings to receive an automated POST request when the job is done.

Payload Structure

{
  "event": "job.completed",
  "job_id": "...",
  "status": "completed",
  "data_preview": [...],
  "download_url": "..."
}

Rate Limits

Enterprise accounts are capped at **5 requests per second**. If you exceed this, you will receive a `429 Too Many Requests` error.