Skip to content

WeChat Official Accounts Keyword Search API (V1)

GET
/api/weixin/search/v1
API health status
Healthy Available Limited Mostly unavailable No data
Loading health status...

Get WeChat Official Accounts keyword Search data, including account names, titles, and publish times, for content discovery.

Parameters

NameInTypeRequiredDefaultDescription
tokenquerystringYes-Access token for the API.
keywordquerystringYes-The search keyword.
offsetqueryintegerNo0Pagination offset (starts with 0, increment by 20).
searchTypequerystringNo_0Type of search results (accounts, articles, etc.).

Available Values:
- _0: All
- _1: WeChat Official Account
- _2: Article
- _7: WeChat Channel
- _262208: Wechat Mini Program
- _384: Emoji
- _16777728: Encyclopedia
- _9: Live
- _1024: Book
- _512: Music
- _16384: News
- _8192: Wechat Index
- _8: Moments
sortTypequerystringNo_0Sorting criteria for search results.

Available Values:
- _0: Default
- _2: Latest
- _4: Hot

Code Samples

💡 Environment Note

Use https://api.justoneapi.com by default. Mainland China users can use http://47.117.133.51:30015 instead.

bash
curl -X GET "https://api.justoneapi.com/api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE"
text
I want to use the "Keyword Search (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/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE
API Endpoint: BASE_URL + /api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE
HTTP Method: GET
Authentication: Append "?token=YOUR_API_KEY" to the URL.
OpenAPI Definition: https://docs.justoneapi.com/openapi/wechat-official-accounts/keyword-search-v1-en.json

Parameters:
- token (query): Access token for the API. (Required)
- keyword (query): The search keyword. (Required)
- offset (query): Pagination offset (starts with 0, increment by 20).
- searchType (query): Type of search results (accounts, articles, etc.).

Available Values:
- `_0`: All
- `_1`: WeChat Official Account
- `_2`: Article
- `_7`: WeChat Channel
- `_262208`: Wechat Mini Program
- `_384`: Emoji
- `_16777728`: Encyclopedia
- `_9`: Live
- `_1024`: Book
- `_512`: Music
- `_16384`: News
- `_8192`: Wechat Index
- `_8`: Moments
- sortType (query): Sorting criteria for search results.

Available Values:
- `_0`: Default
- `_2`: Latest
- `_4`: Hot

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
import requests

BASE_URL = "https://api.justoneapi.com"  # Mainland China: "http://47.117.133.51:30015"

url = BASE_URL + "/api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE"
response = requests.get(url)
print(response.json())
js
const BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
const url = BASE_URL + "/api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE";

const response = await fetch(url, {
  method: "GET"
});
const data = await response.json();
console.log(data);
java
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 {
        final String BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
        final String url = BASE_URL + "/api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create(url))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

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

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

const BASE_URL = "https://api.justoneapi.com" // Mainland China: "http://47.117.133.51:30015"

func main() {
	client := &http.Client{}
	url := BASE_URL + "/api/weixin/search/v1?token=YOUR_API_KEY&keyword=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
<?php
$BASE_URL = "https://api.justoneapi.com"; // Mainland China: "http://47.117.133.51:30015"
$url = $BASE_URL . "/api/weixin/search/v1?token=YOUR_API_KEY&keyword=VALUE";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Response Example

Loading the latest successful example...