YouTube General Search API (V1)
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...
Search YouTube videos by keyword with optional language, upload-date, duration, and sort filters, or continue with a pagination token. Use it to discover public videos or browse additional result pages.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
token | query | string | Yes | - | Access token for this API service. |
keyword | query | string | No | | Search term. Required for the first page; leave empty when using nextToken. |
lang | query | string | No | - | Optional IETF language tag for localized results, such as en-US. Leave empty to use the default language. |
uploadDate | query | string | No | all | Upload-date filter. Available Values: - all: No upload-date limit- lastHour: Uploaded within the last hour- today: Uploaded today- thisWeek: Uploaded this week- thisMonth: Uploaded this month- thisYear: Uploaded this year |
duration | query | string | No | all | Video-duration filter. Available Values: - all: No duration limit- short: Short videos under 4 minutes- medium: Medium videos from 4 to 20 minutes- long: Long videos over 20 minutes |
sortBy | query | string | No | relevance | Sort order for search results. Available Values: - relevance: Sort by relevance- uploadDate: Sort by upload date- viewCount: Sort by view count- rating: Sort by rating |
nextToken | query | string | No | - | Pagination token returned by the previous response. When provided, the keyword and filter parameters are ignored; very long tokens may exceed GET URL limits. |
Code Samples
bash
curl --max-time 120 -X GET 'https://huoke.xiansuoai.com/api/youtube/search/v1?token=YOUR_API_KEY'text
I want to use the "General Search (V1)" API from 线索AI.
Base URL: https://huoke.xiansuoai.com.
API Path: /api/youtube/search/v1?token=YOUR_API_KEY
API Endpoint: BASE_URL + /api/youtube/search/v1?token=YOUR_API_KEY
HTTP Method: GET
Authentication: Append the "token" query parameter to the URL.
OpenAPI Definition: https://huoke.xiansuoai.com/openapi/youtube/general-search-v1-en.json
Parameters:
- token (query): Access token for this API service. (Required)
- keyword (query): Search term. Required for the first page; leave empty when using nextToken.
- lang (query): Optional IETF language tag for localized results, such as en-US. Leave empty to use the default language.
- uploadDate (query): Upload-date filter.
Available Values:
- `all`: No upload-date limit
- `lastHour`: Uploaded within the last hour
- `today`: Uploaded today
- `thisWeek`: Uploaded this week
- `thisMonth`: Uploaded this month
- `thisYear`: Uploaded this year
- duration (query): Video-duration filter.
Available Values:
- `all`: No duration limit
- `short`: Short videos under 4 minutes
- `medium`: Medium videos from 4 to 20 minutes
- `long`: Long videos over 20 minutes
- sortBy (query): Sort order for search results.
Available Values:
- `relevance`: Sort by relevance
- `uploadDate`: Sort by upload date
- `viewCount`: Sort by view count
- `rating`: Sort by rating
- nextToken (query): Pagination token returned by the previous response. When provided, the keyword and filter parameters are ignored; very long tokens may exceed GET URL limits.
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://huoke.xiansuoai.com" # Provided by OpenAPI servers
url = BASE_URL + "/api/youtube/search/v1?token=YOUR_API_KEY"
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")js
const BASE_URL = "https://huoke.xiansuoai.com"; // Provided by OpenAPI servers
const url = BASE_URL + "/api/youtube/search/v1?token=YOUR_API_KEY";
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://huoke.xiansuoai.com"; // Provided by OpenAPI servers
final String url = BASE_URL + "/api/youtube/search/v1?token=YOUR_API_KEY";
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://huoke.xiansuoai.com" // Provided by OpenAPI servers
func main() {
client := &http.Client{Timeout: 120 * time.Second}
url := BASE_URL + "/api/youtube/search/v1?token=YOUR_API_KEY"
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://huoke.xiansuoai.com'; // Provided by OpenAPI servers
$url = $BASE_URL . '/api/youtube/search/v1?token=YOUR_API_KEY';
$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;
}Response Example
Loading the response example...