Douyin Creator Marketplace (Xingtu) Spread Metrics API (V1)

GET

API health status

24h health

24h avg latency

Last checked

Healthy Available Limited Mostly unavailable No data

Healthy

Loading health status...

24h trend

30d trend

Provides access to Douyin Creator Marketplace (Xingtu) spread metrics. Use it when an application needs Douyin Creator Marketplace (Xingtu) spread metrics.

Capabilities and contract

Contract status: pending — Insufficient verified response evidence

Use cases

• Integrate Douyin Creator Marketplace (Xingtu) spread metrics into application workflows.

Parameters

Name	In	Type	Required	Default	Description
token	query	string	Yes	-	User authentication token.
oAuthorId	query	string	Yes	-	Author's unique ID.
platform	query	string	No	SHORT_VIDEO	Platform type. Available Values: - SHORT_VIDEO: Short video - LIVE_STREAMING: Live streaming - PICTURE_TEXT: Picture and text - SHORT_DRAMA: Short drama
range	query	string	No	DAY_30	Time range. Available Values: - DAY_30: Last 30 days - DAY_90: Last 90 days
type	query	string	No	PERSONAL_VIDEO	Video type. Available Values: - PERSONAL_VIDEO: Personal video - XINTU_VIDEO: Xingtu video
onlyAssign	query	boolean	No	false	Whether to only include assigned videos.
flowType	query	string	No	EXCLUDE	Flow type filter. Available Values: - EXCLUDE: Exclude - INCLUDE: Include

Code Samples

💡 Environment Note

Use https://api.justoneapi.com by default. Alternative: http://47.117.133.51:30015.

🐚 cURL

curl --max-time 120 -X GET 'https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE'

🤖 AI Prompt

I want to use the "Spread Metrics (V1)" API from Just One API.
Base URL: use https://api.justoneapi.com by default. Mainland China users can use http://47.117.133.51:30015 instead.
API Path: /api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE
API Endpoint: BASE_URL + /api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/douyin-creator-marketplace-xingtu/spread-metrics-v1-en.json

Parameters:
- token (query): User authentication token. (Required)
- oAuthorId (query): Author's unique ID. (Required)
- platform (query): Platform type.

Available Values:
- `SHORT_VIDEO`: Short video
- `LIVE_STREAMING`: Live streaming
- `PICTURE_TEXT`: Picture and text
- `SHORT_DRAMA`: Short drama
- range (query): Time range.

Available Values:
- `DAY_30`: Last 30 days
- `DAY_90`: Last 90 days
- type (query): Video type.

Available Values:
- `PERSONAL_VIDEO`: Personal video
- `XINTU_VIDEO`: Xingtu video
- onlyAssign (query): Whether to only include assigned videos.
- flowType (query): Flow type filter.

Available Values:
- `EXCLUDE`: Exclude
- `INCLUDE`: Include

Return format: safely handle JSON or text according to the actual Content-Type.

Response Handling & Error Codes:
1. Business results should be determined by the "code" field in the response body (code 0 means success).
2. Timeout Recommendation: Set the request timeout to 120 seconds. If 120 seconds is too long for your use case, use at least 60 seconds, but a small number of requests may time out before receiving a result.
3. Business Code Reference:
   - 0: Success
   - 100: Invalid or Inactive Token
   - 301: Collection Failed. Please Retry.
   - 302: Rate Limit Exceeded
   - 303: Daily Quota Exceeded
   - 400: Invalid Parameters
   - 500: Internal Server Error
   - 600: Permission Denied
   - 601: Insufficient Balance
   - 602: Token Budget Exceeded
4. Code 601 means the shared account balance is insufficient. Code 602 means the current API token's own cumulative budget limit has been reached. Token budget limits do not transfer funds out of the shared account balance.

Please help me write a script in my preferred programming language to call this API and handle the response.

🐍 Python

import requests

BASE_URL = "https://api.justoneapi.com"  # Alternative server: "http://47.117.133.51:30015"

url = BASE_URL + "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE"
response = requests.get(url, timeout=120)
print(response.status_code)
if response.content:
    content_type = response.headers.get("content-type", "").lower()
    if "json" in content_type:
        try:
            print(response.json())
        except ValueError:
            print(response.text)
    elif content_type.startswith("text/") or "xml" in content_type or content_type.split(";", 1)[0].strip() in {"application/javascript", "application/x-www-form-urlencoded", "application/graphql"}:
        print(response.text)
    else:
        with open("response.bin", "wb") as output:
            output.write(response.content)
        print(f"Saved {len(response.content)} bytes to response.bin")

🌐 JavaScript

const BASE_URL = "https://api.justoneapi.com"; // Alternative server: "http://47.117.133.51:30015"
const url = BASE_URL + "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE";

const response = await fetch(url, {
  method: "GET",
  signal: AbortSignal.timeout(120000)
});
console.log(response.status);
const responseBytes = await response.arrayBuffer();
if (responseBytes.byteLength) {
  const contentType = (response.headers.get("content-type") || "").toLowerCase();
  const mediaType = contentType.split(";", 1)[0].trim();
  const textual = contentType.startsWith("text/") || contentType.includes("json") || contentType.includes("xml") || ["application/javascript", "application/x-www-form-urlencoded", "application/graphql"].includes(mediaType);
  if (textual) {
    const responseText = new TextDecoder().decode(responseBytes);
    let data = responseText;
    if (contentType.includes("json")) {
      try { data = JSON.parse(responseText); } catch { /* Keep the raw body. */ }
    }
    console.log(data);
  } else {
    console.log(`Received ${responseBytes.byteLength} binary bytes`);
  }
}

☕ Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;

public class Main {
    public static void main(String[] args) throws Exception {
        final String BASE_URL = "https://api.justoneapi.com"; // Alternative server: "http://47.117.133.51:30015"
        final String url = BASE_URL + "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE";

        HttpClient client = HttpClient.newBuilder().connectTimeout(Duration.ofSeconds(120)).build();
        HttpRequest.Builder builder = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .timeout(Duration.ofSeconds(120))
            .method("GET", HttpRequest.BodyPublishers.noBody());

        HttpRequest request = builder.build();

        HttpResponse<byte[]> response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());
        System.out.println(response.statusCode());
        String contentType = response.headers().firstValue("content-type").orElse("").toLowerCase();
        String mediaType = contentType.split(";", 2)[0].trim();
        if (contentType.startsWith("text/") || contentType.contains("json") || contentType.contains("xml") || mediaType.equals("application/javascript") || mediaType.equals("application/x-www-form-urlencoded") || mediaType.equals("application/graphql")) {
            System.out.println(new String(response.body(), StandardCharsets.UTF_8));
        } else {
            Files.write(Path.of("response.bin"), response.body());
            System.out.println("Saved " + response.body().length + " bytes to response.bin");
        }
    }
}

🐹 Go

package main

import (
	"fmt"
	"io"
	"os"
	"strings"
	"net/http"
	"time"
)

const BASE_URL = "https://api.justoneapi.com" // Alternative server: "http://47.117.133.51:30015"

func main() {
	client := &http.Client{Timeout: 120 * time.Second}
	url := BASE_URL + "/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE"
	req, _ := http.NewRequest("GET", url, nil)
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	fmt.Println(resp.StatusCode)
	bodyBytes, _ := io.ReadAll(resp.Body)
	contentType := strings.ToLower(resp.Header.Get("Content-Type"))
	mediaType := strings.TrimSpace(strings.SplitN(contentType, ";", 2)[0])
	if strings.HasPrefix(contentType, "text/") || strings.Contains(contentType, "json") || strings.Contains(contentType, "xml") || mediaType == "application/javascript" || mediaType == "application/x-www-form-urlencoded" || mediaType == "application/graphql" {
		fmt.Println(string(bodyBytes))
	} else {
		os.WriteFile("response.bin", bodyBytes, 0600)
		fmt.Printf("Saved %d bytes to response.bin\n", len(bodyBytes))
	}
}

🐘 PHP

<?php
$BASE_URL = 'https://api.justoneapi.com'; // Alternative server: "http://47.117.133.51:30015"
$url = $BASE_URL . '/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 120);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$contentType = strtolower((string) curl_getinfo($ch, CURLINFO_CONTENT_TYPE));
curl_close($ch);
echo $status . PHP_EOL;
$mediaType = trim(explode(';', $contentType, 2)[0]);
if (str_starts_with($contentType, 'text/') || str_contains($contentType, 'json') || str_contains($contentType, 'xml') || in_array($mediaType, ['application/javascript', 'application/x-www-form-urlencoded', 'application/graphql'], true)) {
    echo $response;
} else {
    file_put_contents('response.bin', $response);
    echo 'Saved ' . strlen($response) . ' bytes to response.bin' . PHP_EOL;
}

[OpenAPI Definition (JSON)]

Response Schema

200 · application/json

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "enum": [
            0
          ]
        },
        "message": {
          "type": [
            "string",
            "null"
          ]
        },
        "data": {},
        "recordTime": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "code",
        "data",
        "message",
        "recordTime"
      ]
    },
    {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "enum": [
            202,
            300,
            301,
            601,
            602
          ]
        },
        "message": {
          "type": [
            "string",
            "null"
          ]
        },
        "data": {},
        "recordTime": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "code",
        "data",
        "message",
        "recordTime"
      ]
    }
  ]
}

400 · application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        100,
        101,
        202,
        300,
        301,
        302,
        303,
        400,
        404,
        500,
        600,
        601,
        602
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {},
    "recordTime": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "data",
    "message",
    "recordTime"
  ]
}

401 · application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        100,
        101,
        202,
        300,
        301,
        302,
        303,
        400,
        404,
        500,
        600,
        601,
        602
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {},
    "recordTime": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "data",
    "message",
    "recordTime"
  ]
}

403 · application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        100,
        101,
        202,
        300,
        301,
        302,
        303,
        400,
        404,
        500,
        600,
        601,
        602
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {},
    "recordTime": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "data",
    "message",
    "recordTime"
  ]
}

429 · application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        100,
        101,
        202,
        300,
        301,
        302,
        303,
        400,
        404,
        500,
        600,
        601,
        602
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {},
    "recordTime": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "data",
    "message",
    "recordTime"
  ]
}

500 · application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32",
      "enum": [
        0,
        100,
        101,
        202,
        300,
        301,
        302,
        303,
        400,
        404,
        500,
        600,
        601,
        602
      ]
    },
    "message": {
      "type": [
        "string",
        "null"
      ]
    },
    "data": {},
    "recordTime": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "data",
    "message",
    "recordTime"
  ]
}

Synthetic Response Example

Loading the response example...