Douyin Xingtu APIs - Author Spread Info (V1)

prod-global

GET

/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1

Get author's spread performance metrics.

Parameters

Name	In	Type	Required	Description
`token`	query	`string`	Yes	User authentication token.
`oAuthorId`	query	`string`	Yes	Author's unique ID.
`platform`	query	`string`	No	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	Time range. Available Values: - `DAY_30`: Last 30 days - `DAY_90`: Last 90 days
`type`	query	`string`	No	Video type. Available Values: - `PERSONAL_VIDEO`: Personal video - `XINTU_VIDEO`: Xingtu video
`onlyAssign`	query	`boolean`	No	Whether to only include assigned videos.
`flowType`	query	`string`	No	Flow type filter. Available Values: - `EXCLUDE`: Exclude - `INCLUDE`: Include

Code Samples

💡 Environment Note

Default samples use https://api.justoneapi.com (prod-global). For users in Mainland China, it is recommended to replace it with http://47.117.133.51:30015 (prod-cn) for better performance. See Environment Guide.

bash

# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
curl -X GET "https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE"

text

I want to use the "Author Spread Info (V1)" API from Just One API.
API Endpoint: https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/douyin-xingtu-apis/author-spread-info-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: JSON

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 request timeout to at least 60 seconds.
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

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

python

# Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
import requests

url = "https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE"
response = requests.get(url)
print(response.json())

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
const response = await fetch("https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE", {
  method: "GET"
});
const data = await response.json();
console.log(data);

java

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	client := &http.Client{}
	url := "https://api.justoneapi.com/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()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

php

// Tip: For Mainland China, replace https://api.justoneapi.com with http://47.117.133.51:30015
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.justoneapi.com/api/douyin-xingtu/gw/api/data_sp/get_author_spread_info/v1?token=YOUR_API_KEY&oAuthorId=VALUE");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;

[OpenAPI Definition (JSON)]

Responses

json

{
  "code": 0,
  "data": {
    "avg_duration": "2600",
    "base_resp": {
      "status_code": 0,
      "status_message": ""
    },
    "comment_avg": "4192",
    "expect_cpe": {
      "cpe_1_20": "253",
      "cpe_21_60": "633",
      "cpe_60": "633"
    },
    "expect_cpm": {
      "cpm_1_20": "5618",
      "cpm_21_60": "14043",
      "cpm_60": "14043"
    },
    "interact_rate": {
      "label": "剧情搞笑",
      "overtake": 5973,
      "value": 244
    },
    "item_num": "3",
    "item_rate": {
      "interact_rate": {},
      "item_num": {
        "label": "",
        "overtake": 10800,
        "value": 3
      },
      "play_mid": {
        "label": "",
        "overtake": 9993,
        "value": 3642403
      }
    },
    "like_avg": "95028",
    "play_mid": "3642403",
    "play_over_rate": {
      "label": "剧情搞笑",
      "overtake": 6400,
      "value": 1113
    },
    "play_stability": {
      "label": "剧情搞笑",
      "overtake": 8865,
      "value": 540887
    },
    "sales_expect_cpm": {
      "cpm_1_20": "6619",
      "cpm_21_60": "16543",
      "cpm_60": "16543"
    },
    "share_avg": "9637"
  }
}

💡 Note: For list data, the example shows only 1-2 items for simplicity. The actual count depends on the API response.

Douyin Xingtu APIs - Author Spread Info (V1) ​

Parameters ​

Code Samples ​

Responses ​

Douyin Xingtu APIs - Author Spread Info (V1)

Parameters

Code Samples

Responses