User Lookup Video Info TikMatrix API Docs Story Viewer Url Tracker Video Downloader

📚 API Documentation

TikTok User & Video API Reference

Join Our Telegram Channel

🚀 Introduction

Welcome to the TikTok User Finder API documentation. Our API provides programmatic access to TikTok user profiles and video information. All endpoints return JSON responses and support CORS for easy integration.

Note: API key authentication is required for certain endpoints. Contact us to obtain an API key.

👤 User API

GET /api/user

Retrieves detailed information about a TikTok user including profile data, statistics, and metadata.

Request Parameters

Parameter Type Required Description
username string Required TikTok username (with or without @ symbol)
api_key string Optional API key for authentication (can also be sent via X-API-Key header)

Example Request

GET /api/user?username=tiktok

cURL Example

curl -X GET "https://user.tikmatrix.com/api/user?username=tiktok" \
  -H "X-API-Key: your_api_key_here"

JavaScript Example

fetch('https://user.tikmatrix.com/api/user?username=tiktok', {
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Response Format

{
  "profile": {
    "Username": "@tiktok",
    "Nickname": "TikTok",
    "Avatar URL": "https://...",
    "Country": "United States",
    "Language": "English",
    "About": "Make Your Day",
    "Bio Link": "https://...",
    "User ID": "123456789",
    "SecUID": "SEC_UID_...",
    "Account Created": "2020-01-01",
    "Nickname Last Modified": "2023-01-01",
    "Username Last Modified": "2023-01-01"
  },
  "stats": {
    "Followers": 1000000,
    "Following": 100,
    "Hearts": 5000000,
    "Videos": 500,
    "Friends": 50
  },
  "cache": {
    "status": "HIT",
    "timestamp": 1704019200000
  }
}

Response Fields

Field Type Description
profile.Username string TikTok username with @ symbol
profile.Nickname string Display name of the user
profile.Avatar URL string URL to user's avatar image
stats.Followers number Total number of followers
stats.Following number Total number of accounts following
stats.Hearts number Total likes received across all videos
stats.Videos number Total number of videos posted
cache.status string Cache status: "HIT" or "MISS"
cache.timestamp number Unix timestamp of when data was cached

Error Responses

// Missing username parameter
{
  "error": "username parameter is required"
}

// Invalid username format
{
  "error": "Invalid username format"
}

// User not found
{
  "error": "User not found"
}

🎥 Video API

GET /api/video

Retrieves detailed information about a TikTok video including metadata, statistics, author information, and music details.

Request Parameters

Parameter Type Required Description
url string Required Full TikTok video URL (e.g., https://www.tiktok.com/@username/video/1234567890)
api_key string Optional API key for authentication (can also be sent via X-API-Key header)

Example Request

GET /api/video?url=https://www.tiktok.com/@username/video/1234567890

cURL Example

curl -X GET "https://user.tikmatrix.com/api/video?url=https://www.tiktok.com/@username/video/1234567890" \
  -H "X-API-Key: your_api_key_here"

JavaScript Example

const videoUrl = encodeURIComponent('https://www.tiktok.com/@username/video/1234567890');
fetch(`https://user.tikmatrix.com/api/video?url=${videoUrl}`, {
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Response Format

{
  "videoId": "1234567890",
  "desc": "Video description text",
  "createTime": "2024-01-01T00:00:00Z",
  "video": {
    "duration": 30,
    "width": 1080,
    "height": 1920,
    "cover": "https://..."
  },
  "author": {
    "username": "username",
    "nickname": "Display Name",
    "avatar": "https://...",
    "userId": "123456789",
    "secUid": "SEC_UID_...",
    "verified": true
  },
  "stats": {
    "playCount": 1000000,
    "diggCount": 50000,
    "commentCount": 1000,
    "shareCount": 5000,
    "collectCount": 2000
  },
  "music": {
    "title": "Song Title",
    "author": "Artist Name",
    "duration": 30
  },
  "challenges": [
    {
      "title": "#challenge1"
    }
  ]
}

Response Fields

Field Type Description
videoId string Unique identifier for the video
desc string Video description/caption
createTime string ISO 8601 timestamp of when video was created
video.duration number Video duration in seconds
video.cover string URL to video cover image
author.username string Video author's username
author.verified boolean Whether the author is verified
stats.playCount number Number of video views
stats.diggCount number Number of likes
stats.commentCount number Number of comments
stats.shareCount number Number of shares
music.title string Title of the music used in video
challenges array Array of hashtag challenges associated with video

Error Responses

// Missing URL parameter
{
  "error": "url parameter is required. Format: https://www.tiktok.com/@username/video/videoId"
}

// Invalid URL format
{
  "error": "Invalid video URL format. Expected: https://www.tiktok.com/@username/video/videoId"
}

// Video not found
{
  "error": "Video not found or unavailable"
}

🔐 Authentication

API key authentication is required for accessing our endpoints. You can provide your API key in three ways:

1. X-API-Key Header (Recommended)

curl -X GET "https://user.tikmatrix.com/api/user?username=tiktok" \
  -H "X-API-Key: your_api_key_here"

2. Authorization Header

curl -X GET "https://user.tikmatrix.com/api/user?username=tiktok" \
  -H "Authorization: Bearer your_api_key_here"

3. Query Parameter

curl -X GET "https://user.tikmatrix.com/api/user?username=tiktok&api_key=your_api_key_here"
Getting an API Key: Contact us via Telegram (@tikmatrix_agent_bot) to request an API key for programmatic access.

⚡ Rate Limits & Caching

To ensure fair usage and optimal performance:

Pro Tip: Check the X-Cache response header to quickly identify if data was served from cache (HIT) or fetched fresh (MISS).

💬 Support & Contact

Need help or have questions? We're here to assist you!