Platform availability
- 24h health
- 71%
Last 30 days
Available capabilities
Each WeChat Official Accounts action, what it does, its price and its health over the last 24 hours. Open an action for its parameters, response fields and code samples.
| Capability | What it does | Per 1,000 | 24-hour health |
|---|---|---|---|
Article searcharticle_search | Find WeChat Official Account articles on a topic, up to 400 per call, with title, summary, cover image, account name and publish time. | $5.56 per 1,000 requests | Healthy · health 97% |
Article detailsarticle_detail | Fetch the full body of one WeChat Official Account article as plain text and original HTML, with author, digest, cover, tags, original-content flag and IP region. | $5.56 per 1,000 requests | Available · health 75% |
Account searchaccount_search | Look up WeChat Official Accounts by keyword, up to 400 per call, with name, WeChat ID alias, description, avatar, verification flag and the gh_ and __biz identifiers. | $5.56 per 1,000 requests | Normal |
Mini Program searchmini_program_search | Discover WeChat Mini Programs for a keyword, with name, icon, description, username and whether each one is a mini game. | $5.56 per 1,000 requests | Temporarily unavailable |
Search suggestionssearch_suggestions | Get the autocomplete suggestions WeChat offers for a keyword, along with the number of terms returned. | $5.56 per 1,000 requests | Temporarily unavailable |
Account detailsaccount_profile | See the name, description, avatar and type, subscription or service, of one WeChat Official Account, plus its account_id and the biz key that links its articles back to it. | $5.56 per 1,000 requests | Normal |
Account owneraccount_principal | Read the registered owner behind a WeChat Official Account: company or operator name, entity type, verification status and date, registration country and date, and authorized agents. | $5.56 per 1,000 requests | Normal |
Account articlesaccount_articles | Pull the article history of one WeChat Official Account, 8 by default and up to 160 per call, with title, link, cover, publish time, position and original or deleted flags. | $5.56 per 1,000 requests | Normal |
Today's account articlesaccount_today_articles | Track what one WeChat Official Account has published today, with each article's title, link, cover, publish time, position and original or deleted flags. | $5.56 per 1,000 requests | Temporarily unavailable |
Article commentsarticle_comments | Collect reader comments on one WeChat Official Account article, up to 260 per call, with text, author, likes, pinned flag, reply count and displayed location. | $5.56 per 1,000 requests | Normal |
Comment repliescomment_replies | List the replies under one comment on a WeChat Official Account article, each with text, replier, likes, time and the country, province and city shown. | $5.56 per 1,000 requests | Temporarily unavailable |
Article engagementarticle_metrics | Check engagement on one WeChat Official Account article: reads, likes, shares, saves, comments and the WeChat-specific watching count, which is separate from likes. | $5.56 per 1,000 requests | Normal |
WeChat Indexwechat_index | Gauge how much attention a keyword gets on WeChat: the latest index value and its date, plus the trend series behind it. | $5.56 per 1,000 requests | Temporarily unavailable |
Open a capability for its parameters, response fields, code samples and trial.
What does each WeChat Official Accounts action accept?
Each answer below pairs one callable action with its real inputs. Parameter meanings and allowed values are action-specific; a familiar name does not carry the same meaning across every platform.
Official sources are linked only to clarify the platform term beside them. They do not imply platform authorization or endorsement, and they do not add official-site features to the EveryInfra API contract.
| Action | Required | Optional | Delivery | Limit | Per 1,000 | Response fields |
|---|---|---|---|---|---|---|
article_searchArticle search Find WeChat Official Account articles on a topic, up to 400 per call, with title, summary, cover image, account name and publish time. Full article text is not included, and the followed and recently read sections of | keyword | category, sub_type | Sync delivery | Catalog values: defaultLimit=20, maxLimit=400. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $5.56 per 1,000 requests | id · title · summary · url · cover_image_url · account_name · posted_at · relative_time · kind · platform |
article_detailArticle details Fetch the full body of one WeChat Official Account article as plain text and original HTML, with author, digest, cover, tags, original-content flag and IP region. Copy the article's own mp.weixin.qq.com link; temporary links from search results may be unreadable, and comments are not included. | url | — | Sync delivery | — | $5.56 per 1,000 requests | id · title · url · content_text · content_html · author · account_name · account_ghid · digest · cover_image_url · images · hashtags · is_original · posted_at · ip_region · platform |
account_searchAccount search Look up WeChat Official Accounts by keyword, up to 400 per call, with name, WeChat ID alias, description, avatar, verification flag and the gh_ and __biz identifiers. A match does not prove legal identity or that anyone subscribes to the account. | keyword | — | Sync delivery | Catalog values: defaultLimit=20, maxLimit=400. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $5.56 per 1,000 requests | account_id · ghid · name · description · alias · avatar_url · verify_flag · biz · platform |
mini_program_searchMini Program search Discover WeChat Mini Programs for a keyword, with name, icon, description, username and whether each one is a mini game. Results describe each listing only: the program is not launched and its internal data stays out of reach. | keyword | — | Sync delivery | Catalog values: defaultLimit=20, maxLimit=400. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $5.56 per 1,000 requests | id · name · description · icon_url · username · is_minigame · platform |
search_suggestionsSearch suggestions Get the autocomplete suggestions WeChat offers for a keyword, along with the number of terms returned. They are related terms for that query, not search volume, a ranking or a historical trend. | keyword | — | Sync delivery | — | $5.56 per 1,000 requests | suggestions · count · platform |
account_profileAccount details See the name, description, avatar and type, subscription or service, of one WeChat Official Account, plus its | account | — | Sync delivery | — | $5.56 per 1,000 requests | account_id · name · account_type · description · avatar_url · biz · platform |
account_principalAccount owner Read the registered owner behind a WeChat Official Account: company or operator name, entity type, verification status and date, registration country and date, and authorized agents. Values come back only when WeChat shows them; they do not replace a registry check and reveal no admin credentials. | account | — | Sync delivery | — | $5.56 per 1,000 requests | account_id · ghid · name · description · company_name · owner_name · customer_type · verify_status · verify_type · verified_at · registered_country · registered_at · is_overseas · last_login_province · authorized_agents · platform |
account_articlesAccount articles Pull the article history of one WeChat Official Account, 8 by default and up to 160 per call, with title, link, cover, publish time, position and original or deleted flags. Pass a WeChat ID, gh_ raw ID or account link, not a personal WeChat ID; one batch may not cover the full archive. | account | — | Sync delivery | Catalog values: defaultLimit=8, maxLimit=160. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $5.56 per 1,000 requests | id · title · url · cover_image_url · posted_at · position · is_original · is_deleted · account_name · account_id · account_ghid · platform |
account_today_articlesToday's account articles Track what one WeChat Official Account has published today, with each article's title, link, cover, publish time, position and original or deleted flags. It covers the current day only and is a pull you schedule, not a real-time subscription. | account | — | Sync delivery | — | $5.56 per 1,000 requests | id · title · url · cover_image_url · posted_at · position · is_original · is_deleted · account_name · account_id · account_ghid · platform |
article_commentsArticle comments Collect reader comments on one WeChat Official Account article, up to 260 per call, with text, author, likes, pinned flag, reply count and displayed location. Pass the article's own link rather than an account page; not every comment is guaranteed to come back. | url | — | Sync delivery | Catalog values: defaultLimit=13, maxLimit=260. A limit can control pages or per-parent expansion for some actions, so it is not always a final row count. | $5.56 per 1,000 requests | id · text · author_name · author_avatar_url · like_count · posted_at · is_top · reply_count · country · province · platform |
comment_repliesComment replies List the replies under one comment on a WeChat Official Account article, each with text, replier, likes, time and the country, province and city shown. Pair the | url, comment_id | content_id | Sync delivery | — | $5.56 per 1,000 requests | id · text · author_name · author_avatar_url · like_count · posted_at · country · province · city · platform |
article_metricsArticle engagement Check engagement on one WeChat Official Account article: reads, likes, shares, saves, comments and the WeChat-specific watching count, which is separate from likes. Counts are a snapshot at call time, not a history or the account's private analytics. | url | — | Sync delivery | — | $5.56 per 1,000 requests | read_count · like_count · watching_count · share_count · collect_count · comment_count · platform |
wechat_indexWeChat Index Gauge how much attention a keyword gets on WeChat: the latest index value and its date, plus the trend series behind it. It is an index, not a count of searches or unique users, and not an EveryInfra metric. | keyword | — | Sync delivery | — | $5.56 per 1,000 requests | keyword · latest_index · latest_date · data_points · trend · platform |
What do the WeChat Official Accounts article_search parameters mean?
Find WeChat Official Account articles on a topic, up to 400 per call, with title, summary, cover image, account name and publish time. Full article text is not included, and the followed and recently read sections of category are not guaranteed because no personal WeChat sign-in is passed.
keywordRequired- Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats.
categoryOptional- Filters articles by category in the article_search action. Allowed values are ALL, LATEST, HOT, FOLLOWED, and RECENT_READ. Note that FOLLOWED and RECENT_READ depend on account state; because your personal WeChat login session is not passed, these options are not guaranteed to work and will not read your personal subscription or reading history.
sub_typeOptional- A compatibility alias for category in article_search that accepts the same five category values (automatically converted to uppercase). If both category and sub_type are provided, category takes precedence.
What do the WeChat Official Accounts article_detail parameters mean?
Fetch the full body of one WeChat Official Account article as plain text and original HTML, with author, digest, cover, tags, original-content flag and IP region. Copy the article's own mp.weixin.qq.com link; temporary links from search results may be unreadable, and comments are not included.
Full API reference: parameters, code samples, response example and health →urlRequired- Specifies the article's own mp.weixin.qq.com link for article_comments, comment_replies, article_metrics, and article_detail: open the article and copy it (a /s/<id> short link, or a link with __biz, mid, idx, and sn). Temporary links copied from search results (with signature/timestamp) may not be readable; when they cannot be read, the call returns 422 before any charge. Account-level actions accept this parameter only as a lowest-priority fallback input for resolving the target account.
What do the WeChat Official Accounts account_search parameters mean?
Look up WeChat Official Accounts by keyword, up to 400 per call, with name, WeChat ID alias, description, avatar, verification flag and the gh_ and __biz identifiers. A match does not prove legal identity or that anyone subscribes to the account.
Full API reference: parameters, code samples, response example and health →keywordRequired- Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats.WeChat: Official Account Nickname, WeChat ID, and Original ID — WeChat documentation defines nick_name, alias, and user_name as the nickname, user-configured WeChat ID, and original ID respectively, where alias may be empty. In search results on this page, name, account_id, and ghid must be verified individually and not treated as identical strings. · Checked
What do the WeChat Official Accounts mini_program_search parameters mean?
Discover WeChat Mini Programs for a keyword, with name, icon, description, username and whether each one is a mini game. Results describe each listing only: the program is not launched and its internal data stays out of reach.
Full API reference: parameters, code samples, response example and health →keywordRequired- Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats.
What do the WeChat Official Accounts search_suggestions parameters mean?
Get the autocomplete suggestions WeChat offers for a keyword, along with the number of terms returned. They are related terms for that query, not search volume, a ranking or a historical trend.
Full API reference: parameters, code samples, response example and health →keywordRequired- Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats.
What do the WeChat Official Accounts account_profile parameters mean?
See the name, description, avatar and type, subscription or service, of one WeChat Official Account, plus its account_id and the biz key that links its articles back to it. Only the visible profile is read; the admin backend stays closed and the owner is not validated.
accountRequired- Identifies the target WeChat Official Account using its WeChat ID, raw ID (starting with gh_), or a resolvable account/article URL. It does not accept personal WeChat IDs. Used by account_principal (for publisher profile metadata), account_articles (for historical post lists), and account_today_articles (for posts published today).WeChat: Account Type, Verification Type, and Principal Entity Name — Official WeChat documentation separately details account types, verification types, and principal entity names; account display names are distinct from principal entity names. This reference only aligns terminology, does not imply official account management authorization, and does not copy WeChat access_token or appid values into parameters for this API. · Checked
What do the WeChat Official Accounts account_principal parameters mean?
Read the registered owner behind a WeChat Official Account: company or operator name, entity type, verification status and date, registration country and date, and authorized agents. Values come back only when WeChat shows them; they do not replace a registry check and reveal no admin credentials.
Full API reference: parameters, code samples, response example and health →accountRequired- Identifies the target WeChat Official Account using its WeChat ID, raw ID (starting with gh_), or a resolvable account/article URL. It does not accept personal WeChat IDs. Used by account_principal (for publisher profile metadata), account_articles (for historical post lists), and account_today_articles (for posts published today).WeChat: Account Type, Verification Type, and Principal Entity Name — Official WeChat documentation separately details account types, verification types, and principal entity names; account display names are distinct from principal entity names. This reference only aligns terminology, does not imply official account management authorization, and does not copy WeChat access_token or appid values into parameters for this API. · Checked
What do the WeChat Official Accounts account_articles parameters mean?
Pull the article history of one WeChat Official Account, 8 by default and up to 160 per call, with title, link, cover, publish time, position and original or deleted flags. Pass a WeChat ID, gh_ raw ID or account link, not a personal WeChat ID; one batch may not cover the full archive.
Full API reference: parameters, code samples, response example and health →accountRequired- Identifies the target WeChat Official Account using its WeChat ID, raw ID (starting with gh_), or a resolvable account/article URL. It does not accept personal WeChat IDs. Used by account_principal (for publisher profile metadata), account_articles (for historical post lists), and account_today_articles (for posts published today).
What do the WeChat Official Accounts account_today_articles parameters mean?
Track what one WeChat Official Account has published today, with each article's title, link, cover, publish time, position and original or deleted flags. It covers the current day only and is a pull you schedule, not a real-time subscription.
Full API reference: parameters, code samples, response example and health →accountRequired- Identifies the target WeChat Official Account using its WeChat ID, raw ID (starting with gh_), or a resolvable account/article URL. It does not accept personal WeChat IDs. Used by account_principal (for publisher profile metadata), account_articles (for historical post lists), and account_today_articles (for posts published today).
What do the WeChat Official Accounts article_comments parameters mean?
Collect reader comments on one WeChat Official Account article, up to 260 per call, with text, author, likes, pinned flag, reply count and displayed location. Pass the article's own link rather than an account page; not every comment is guaranteed to come back.
Full API reference: parameters, code samples, response example and health →urlRequired- Specifies the article's own mp.weixin.qq.com link for article_comments, comment_replies, article_metrics, and article_detail: open the article and copy it (a /s/<id> short link, or a link with __biz, mid, idx, and sn). Temporary links copied from search results (with signature/timestamp) may not be readable; when they cannot be read, the call returns 422 before any charge. Account-level actions accept this parameter only as a lowest-priority fallback input for resolving the target account.WeChat Official Accounts: Distinction Between Article Comments and Featured Comments — WeChat comment documentation distinguishes among articles, comment IDs, featured flags, and reply details. The comment scope visible in the backend of official authorized interfaces is not identical to the visibility scope of this endpoint, and `is_top` cannot be directly treated as the official comment_type featured flag. · Checked
What do the WeChat Official Accounts comment_replies parameters mean?
List the replies under one comment on a WeChat Official Account article, each with text, replier, likes, time and the country, province and city shown. Pair the comment_id from article comments with that same article's link; replies outside this comment are not rebuilt.
urlRequired- Specifies the article's own mp.weixin.qq.com link for article_comments, comment_replies, article_metrics, and article_detail: open the article and copy it (a /s/<id> short link, or a link with __biz, mid, idx, and sn). Temporary links copied from search results (with signature/timestamp) may not be readable; when they cannot be read, the call returns 422 before any charge. Account-level actions accept this parameter only as a lowest-priority fallback input for resolving the target account.
comment_idRequired- Specifies the target comment ID for comment_replies. Obtain this value from the article_comments response for the same article. Must be paired with the corresponding article URL; this is not an article ID.WeChat Official Accounts: Existing Replies and Comment Management Operations — WeChat lists viewing comments, posting replies, deleting replies, and managing featured comments as separate operations. The `comment_replies` endpoint here reads existing replies only and does not grant capabilities to post, delete, or manage comments simply because its name includes replies. · Checked
content_idOptional- A compatibility alias for comment_id in the comment_replies action. It takes lower precedence than comment_id when both are provided.
What do the WeChat Official Accounts article_metrics parameters mean?
Check engagement on one WeChat Official Account article: reads, likes, shares, saves, comments and the WeChat-specific watching count, which is separate from likes. Counts are a snapshot at call time, not a history or the account's private analytics.
Full API reference: parameters, code samples, response example and health →urlRequired- Specifies the article's own mp.weixin.qq.com link for article_comments, comment_replies, article_metrics, and article_detail: open the article and copy it (a /s/<id> short link, or a link with __biz, mid, idx, and sn). Temporary links copied from search results (with signature/timestamp) may not be readable; when they cannot be read, the call returns 422 before any charge. Account-level actions accept this parameter only as a lowest-priority fallback input for resolving the target account.
What do the WeChat Official Accounts wechat_index parameters mean?
Gauge how much attention a keyword gets on WeChat: the latest index value and its date, plus the trend series behind it. It is an index, not a count of searches or unique users, and not an EveryInfra metric.
Full API reference: parameters, code samples, response example and health →keywordRequired- Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats.
How to use the WeChat Official Accounts API
- 01Read the public catalog and choose a platform action.
- 02Send the platform, action, and required parameters to POST /api/v1/social.
- 03Handle a synchronous result, or poll the returned job ID when the action runs asynchronously.
- 04Store the structured response fields needed by your application.
curl -X POST https://api.everyinfra.com/api/v1/social \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"platform":"wechat_oa","action":"article_search","params":{"keyword":"<keyword>"}}'
WeChat Official Accounts guides
Worked examples and methods built on these actions. Check the current actions, parameters and fields on this page first; an article's examples and limits do not replace the live catalog.
Multiplatform Reputation Monitoring Blueprint: Define Scope Before Evaluating Negative Shifts
Design a traceable reputation monitoring workflow starting with target lists, comment identities, and incremental cursors; use offline samples to demonstrate deduplication and ingestion gaps while preserving manual review.
Read the article →Unified Data API Getting Started: From Capability Catalog to First Available Result
Access multi-platform data using platform, action, and params: read the capability catalog, complete minimal requests, handle asynchronous tasks, partial results, and billing, and establish traceable data records.
Read the article →WeChat Official Accounts API questions
What can I retrieve with the WeChat Official Accounts API?
Set platform to wechat_oa. The current catalog lists article search, article details, account search, Mini Program search, search suggestions, and more. These action names identify different WeChat Official Accounts objects or views; they are not interchangeable search modes.
Does WeChat Official Accounts have an official API?
The WeChat Official Account API lets operators manage their own account (drafts, publishing, menus, followers, comments on their own articles and analytics) with that account's credentials. The official API reference has no endpoint for reading articles published by other accounts.
Official sources: WeChat Official Accounts API reference · Checked
Do I need a WeChat Official Accounts developer account or API key?
No. Requests go through EveryInfra with an EveryInfra API key: sign up, create a key in the console and send it as Authorization: Bearer <API_KEY>. You do not register a WeChat Official Accounts developer app, apply for WeChat Official Accounts API access or sign in with a WeChat Official Accounts account, and the actions return public WeChat Official Accounts data only.
How much does the WeChat Official Accounts API cost per 1,000 requests?
$5.56 per 1,000 requests, depending on the action; each action's price is listed in the table on this page and in the public catalog. There is no subscription: you top up a USD balance and pay per call, and failed calls and empty results are not charged.
Which input starts a WeChat Official Accounts `article_search` request?
Specifies the search term across WeChat Official Account actions, including searching articles (article_search), accounts (account_search), mini programs (mini_program_search), search auto-suggestions (search_suggestions), and trend indices (wechat_index). It does not search personal WeChat chats. Send it as keyword inside params.
Which fields can WeChat Official Accounts `article_search` return?
Its declared schema includes title, summary, cover_image_url, and account_name. A declared field can still be absent from an individual record, and every other action has its own field list.
Does every WeChat Official Accounts action return immediately?
Actions labeled asynchronous return a job ID you poll. Every other action can also run asynchronously: add "mode": "async" to the request body to receive a job ID immediately, useful for slow tasks or large limits. The current catalog contains sync delivery.