API Examples

This page provides code examples for using the TikMatrix Local API in different programming languages.

Python

import requests
import json

BASE_URL = "http://localhost:50809/api/v1"

def check_license():
    """Check if API access is available"""
    response = requests.get(f"{BASE_URL}/license/check")
    return response.json()

def create_task(serials, script_name, script_config=None, multi_account=False):
    """Create a new task"""
    payload = {
        "serials": serials,
        "script_name": script_name,
        "script_config": script_config or {},
        "enable_multi_account": multi_account,
        "min_interval": 2,
        "max_interval": 5
    }
    response = requests.post(
        f"{BASE_URL}/task",
        headers={"Content-Type": "application/json"},
        json=payload
    )
    return response.json()

def list_tasks(status=None, page=1, page_size=20):
    """List tasks with optional filters"""
    params = {"page": page, "page_size": page_size}
    if status is not None:
        params["status"] = status
    response = requests.get(f"{BASE_URL}/task", params=params)
    return response.json()

def get_task(task_id):
    """Get task details"""
    response = requests.get(f"{BASE_URL}/task/{task_id}")
    return response.json()

def delete_task(task_id):
    """Delete a task"""
    response = requests.delete(f"{BASE_URL}/task/{task_id}")
    return response.json()

def stop_task(task_id):
    """Stop a running task"""
    response = requests.post(f"{BASE_URL}/task/{task_id}/stop")
    return response.json()

def retry_task(task_id):
    """Retry a failed task"""
    response = requests.post(f"{BASE_URL}/task/{task_id}/retry")
    return response.json()

def get_stats():
    """Get task statistics"""
    response = requests.get(f"{BASE_URL}/task/stats")
    return response.json()

# Usage example
if __name__ == "__main__":
    # Check license first
    license_info = check_license()
    if license_info["code"] != 0:
        print("API access not available:", license_info["message"])
        exit(1)
    
    print("License OK:", license_info["data"]["plan_name"])
    
    # Create a follow task
    result = create_task(
        serials=["device_serial_1"],
        script_name="follow",
        script_config={"target_username": "@tikmatrix"}
    )
    print("Task created:", result)
    
    # Get statistics
    stats = get_stats()
    print("Stats:", stats["data"])

JavaScript / Node.js

const BASE_URL = 'http://localhost:50809/api/v1';

async function checkLicense() {
  const response = await fetch(`${BASE_URL}/license/check`);
  return response.json();
}

async function createTask(serials, scriptName, scriptConfig = {}, multiAccount = false) {
  const response = await fetch(`${BASE_URL}/task`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      serials,
      script_name: scriptName,
      script_config: scriptConfig,
      enable_multi_account: multiAccount,
      min_interval: 2,
      max_interval: 5
    })
  });
  return response.json();
}

async function listTasks(status = null, page = 1, pageSize = 20) {
  const params = new URLSearchParams({ page, page_size: pageSize });
  if (status !== null) params.append('status', status);
  const response = await fetch(`${BASE_URL}/task?${params}`);
  return response.json();
}

async function getTask(taskId) {
  const response = await fetch(`${BASE_URL}/task/${taskId}`);
  return response.json();
}

async function deleteTask(taskId) {
  const response = await fetch(`${BASE_URL}/task/${taskId}`, { method: 'DELETE' });
  return response.json();
}

async function stopTask(taskId) {
  const response = await fetch(`${BASE_URL}/task/${taskId}/stop`, { method: 'POST' });
  return response.json();
}

async function retryTask(taskId) {
  const response = await fetch(`${BASE_URL}/task/${taskId}/retry`, { method: 'POST' });
  return response.json();
}

async function getStats() {
  const response = await fetch(`${BASE_URL}/task/stats`);
  return response.json();
}

// Usage example
async function main() {
  // Check license
  const license = await checkLicense();
  if (license.code !== 0) {
    console.error('API access not available:', license.message);
    return;
  }
  console.log('License OK:', license.data.plan_name);

  // Create a task
  const result = await createTask(
    ['device_serial_1'],
    'follow',
    { target_username: '@tikmatrix' }
  );
  console.log('Task created:', result);

  // Get stats
  const stats = await getStats();
  console.log('Stats:', stats.data);
}

main().catch(console.error);

cURL

# Check license
curl http://localhost:50809/api/v1/license/check

# Create a task
curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "follow",
    "script_config": {"target_username": "@tikmatrix"},
    "enable_multi_account": false,
    "min_interval": 2,
    "max_interval": 5
  }'

# List pending tasks
curl "http://localhost:50809/api/v1/task?status=0&page=1&page_size=20"

# Get task details
curl http://localhost:50809/api/v1/task/1

# Stop a task
curl -X POST http://localhost:50809/api/v1/task/1/stop

# Retry a task
curl -X POST http://localhost:50809/api/v1/task/1/retry

# Delete a task
curl -X DELETE http://localhost:50809/api/v1/task/1

# Batch delete tasks
curl -X DELETE http://localhost:50809/api/v1/task/batch \
  -H "Content-Type: application/json" \
  -d '{"task_ids": [1, 2, 3]}'

# Retry all failed tasks
curl -X POST http://localhost:50809/api/v1/task/retry-all

# Get task statistics
curl http://localhost:50809/api/v1/task/stats

PowerShell

$BaseUrl = "http://localhost:50809/api/v1"

function Check-License {
    $response = Invoke-RestMethod -Uri "$BaseUrl/license/check" -Method Get
    return $response
}

function Create-Task {
    param(
        [string[]]$Serials,
        [string]$ScriptName,
        [hashtable]$ScriptConfig = @{},
        [bool]$MultiAccount = $false
    )
    
    $body = @{
        serials = $Serials
        script_name = $ScriptName
        script_config = $ScriptConfig
        enable_multi_account = $MultiAccount
        min_interval = 2
        max_interval = 5
    } | ConvertTo-Json -Depth 10
    
    $response = Invoke-RestMethod -Uri "$BaseUrl/task" -Method Post `
        -ContentType "application/json" -Body $body
    return $response
}

function Get-Tasks {
    param(
        [int]$Status = $null,
        [int]$Page = 1,
        [int]$PageSize = 20
    )
    
    $uri = "$BaseUrl/task?page=$Page&page_size=$PageSize"
    if ($null -ne $Status) { $uri += "&status=$Status" }
    
    $response = Invoke-RestMethod -Uri $uri -Method Get
    return $response
}

function Stop-TaskById {
    param([int]$TaskId)
    $response = Invoke-RestMethod -Uri "$BaseUrl/task/$TaskId/stop" -Method Post
    return $response
}

function Remove-TaskById {
    param([int]$TaskId)
    $response = Invoke-RestMethod -Uri "$BaseUrl/task/$TaskId" -Method Delete
    return $response
}

# Usage example
$license = Check-License
if ($license.code -ne 0) {
    Write-Error "API access not available: $($license.message)"
    exit 1
}

Write-Host "License OK: $($license.data.plan_name)"

# Create a task
$result = Create-Task -Serials @("device_serial_1") `
    -ScriptName "follow" `
    -ScriptConfig @{ target_username = "@tikmatrix" }

Write-Host "Task created: $($result | ConvertTo-Json)"

Common Use Cases

Batch Create Tasks for Multiple Devices

# Python example: Create follow tasks for all connected devices
devices = ["device_1", "device_2", "device_3", "device_4", "device_5"]

result = create_task(
    serials=devices,
    script_name="follow",
    script_config={"target_username": "@target_user"},
    multi_account=True
)

print(f"Created {result['data']['created_count']} tasks")

Monitor Task Progress

import time

def wait_for_completion(task_ids, timeout=300):
    """Wait for all tasks to complete"""
    start_time = time.time()
    
    while time.time() - start_time < timeout:
        stats = get_stats()
        running = stats['data']['running']
        pending = stats['data']['pending']
        
        if running == 0 and pending == 0:
            print("All tasks completed!")
            return True
        
        print(f"Running: {running}, Pending: {pending}")
        time.sleep(5)
    
    print("Timeout waiting for tasks")
    return False

Retry Failed Tasks Automatically

def auto_retry_failed(max_retries=3):
    """Automatically retry failed tasks"""
    for i in range(max_retries):
        # Get failed tasks
        failed = list_tasks(status=3)
        if failed['data']['total'] == 0:
            print("No failed tasks")
            return
        
        print(f"Retrying {failed['data']['total']} failed tasks (attempt {i+1})")
        
        # Retry all
        result = requests.post(f"{BASE_URL}/task/retry-all")
        
        # Wait for completion
        time.sleep(30)

Python​

JavaScript / Node.js​

cURL​

PowerShell​

Common Use Cases​

Batch Create Tasks for Multiple Devices​

Monitor Task Progress​

Retry Failed Tasks Automatically​

Python

JavaScript / Node.js

cURL

PowerShell

Common Use Cases

Batch Create Tasks for Multiple Devices

Monitor Task Progress

Retry Failed Tasks Automatically