other · Listed · Found · 2,011 endpoints · Gateway-eligible
AIsa API
AIsa API
Capability layer for the agentic economy. Models, skills, payments, and deployment — everything AI agents need to reason, act, and transact. This spec consolida
Indexed from this operator's public /.well-known/x402.json. Found is not operator-owned and is not attested. Claim or opt out.
Agent Read · Cleared Index
ROUTE
Route when you need other at published x402 prices.
confidence
78%
source
signal
Index before you pay. Same payload for agents:
GET /api/cleared/agent-read?slug=aisa-api-hsvr
When to call
- Need other via x402 and want Cleared-indexed payTo with a live scorecard.
- Capability layer for the agentic economy. Models, skills, payments, and deployment — everything AI agents need to reason, act, and transact. This spec consolida
Risks
- Found — not operator-owned; claim status unknown.
- No Cleared settlement receipt on file yet.
- No Gateway traffic yet — market share unproven.
Price posture
2011 endpoints — confirm price on manifest before pay.
Category · Gateway
other · no Gateway routes yet — early / unproven on Cleared market share.
Endpoint hints
GET /apis/v1/agentmail/api-keysRetrieve a paginated list of API keys or create a new API key with optional permissions and scope settings. <!-- aisa-pricing:start --> Published reference pri
POST /apis/v1/agentmail/api-keysRetrieve a paginated list of API keys or create a new API key with optional permissions and scope settings. <!-- aisa-pricing:start --> Published reference pri
GET /apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may diff
GET /apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may diff
GET /apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may diff
GET /apis/v1/agentmail/domainsRetrieve a paginated list of domains or create a new domain with verification and feedback settings. <!-- aisa-pricing:start --> Published reference price: $0.
POST /apis/v1/agentmail/domainsRetrieve a paginated list of domains or create a new domain with verification and feedback settings. <!-- aisa-pricing:start --> Published reference price: $0.
GET /apis/v1/agentmail/domains/{domain_id}Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. <!-- aisa-pricing:start
Evidence (Cleared)
- → Intake verified · Gateway-eligible
- → Trust 70/100 · pass · tier listed
- → Protocol mpp
- → Manifest reachable · schema valid
- → Found listing — indexed from public x402.json, not operator-attested.
Endpoints
List And Create API Keys
$MeteredGET https://aisa.one/apis/v1/agentmail/api-keysRetrieve a paginated list of API keys or create a new API key with optional permissions and scope settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create API Keys
$MeteredPOST https://aisa.one/apis/v1/agentmail/api-keysRetrieve a paginated list of API keys or create a new API key with optional permissions and scope settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Delete API Key
$MeteredGET https://aisa.one/apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Delete API Key
$MeteredGET https://aisa.one/apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Delete API Key
$MeteredGET https://aisa.one/apis/v1/agentmail/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Domains
$MeteredGET https://aisa.one/apis/v1/agentmail/domainsRetrieve a paginated list of domains or create a new domain with verification and feedback settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Domains
$MeteredPOST https://aisa.one/apis/v1/agentmail/domainsRetrieve a paginated list of domains or create a new domain with verification and feedback settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Domain
$MeteredGET https://aisa.one/apis/v1/agentmail/domains/{domain_id}Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Domain
$MeteredGET https://aisa.one/apis/v1/agentmail/domains/{domain_id}Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Domain
$MeteredGET https://aisa.one/apis/v1/agentmail/domains/{domain_id}Retrieve, update, or delete a domain by its ID, including details such as verification status, DNS records, and notification settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Verify Domain
$MeteredPOST https://aisa.one/apis/v1/agentmail/domains/{domain_id}/verifyVerify Domain <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Zone File
$MeteredGET https://aisa.one/apis/v1/agentmail/domains/{domain_id}/zone-fileGet Zone File <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Drafts
$MeteredGET https://aisa.one/apis/v1/agentmail/draftsList Drafts <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Draft
$MeteredGET https://aisa.one/apis/v1/agentmail/drafts/{draft_id}Get Draft <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Attachment
$MeteredGET https://aisa.one/apis/v1/agentmail/drafts/{draft_id}/attachments/{attachment_id}Get Attachment <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Inboxes
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxesRetrieve a list of inboxes with pagination support or create a new inbox with optional custom username, domain, and display name. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Inboxes
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxesRetrieve a list of inboxes with pagination support or create a new inbox with optional custom username, domain, and display name. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Inbox
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}Retrieve, update, or delete a specific inbox by its ID. Returns inbox details including email, display name, client ID, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Inbox
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}Retrieve, update, or delete a specific inbox by its ID. Returns inbox details including email, display name, client ID, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Inbox
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}Retrieve, update, or delete a specific inbox by its ID. Returns inbox details including email, display name, client ID, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Inbox API Keys
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keysRetrieve a list of API keys for a specific inbox or create a new API key with optional permissions and name. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List And Create Inbox API Keys
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keysRetrieve a list of API keys for a specific inbox or create a new API key with optional permissions and name. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Delete API Key
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Delete API Key
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/api-keys/{api_key_id}Delete API Key <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Drafts
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/draftsRetrieve a list of email drafts from the specified inbox, with optional filters and pagination support. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Drafts
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/draftsRetrieve a list of email drafts from the specified inbox, with optional filters and pagination support. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Draft
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}Retrieve, update, or delete a specific email draft within an inbox by its ID. This endpoint allows you to get draft details, modify draft content and recipients, or remove the draft entirely. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Draft
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}Retrieve, update, or delete a specific email draft within an inbox by its ID. This endpoint allows you to get draft details, modify draft content and recipients, or remove the draft entirely. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Draft
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}Retrieve, update, or delete a specific email draft within an inbox by its ID. This endpoint allows you to get draft details, modify draft content and recipients, or remove the draft entirely. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Get Attachment
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}Get Attachment <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Send Draft
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/drafts/{draft_id}/sendSend Draft <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - List Inbox Events
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/eventsList Inbox Events <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Or Create Inbox List Entry
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type}Retrieve or add entries to a specific inbox list based on direction and type. Supports listing entries with pagination and creating new entries with optional reasons. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Or Create Inbox List Entry
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type}Retrieve or add entries to a specific inbox list based on direction and type. Supports listing entries with pagination and creating new entries with optional reasons. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get List Entry
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}Retrieve details of a specific list entry, such as an email address or domain, within an inbox's list based on direction and type. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get List Entry
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}Retrieve details of a specific list entry, such as an email address or domain, within an inbox's list based on direction and type. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - List Messages
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messagesList Messages <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Messages
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/searchFull-text search across one inbox's messages. Returns `count`, `limit`, `next_page_token` and `messages`; page with `next_page_token`. Same message fields as `get_agentmail_inbox_messages`, which is the one to use when you want everything in date order rather than a query. Searching conversations instead of individual messages is `get_agentmail_inbox_threads_search`.
Inboxes - Send Message
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/sendSend Message <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Inbox Message
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}Retrieve detailed information about a specific message within an inbox, including sender, recipients, content, labels, attachments, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Inbox Message
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}Retrieve detailed information about a specific message within an inbox, including sender, recipients, content, labels, attachments, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Inbox Message
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}Retrieve detailed information about a specific message within an inbox, including sender, recipients, content, labels, attachments, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Get Attachment
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/attachments/{attachment_id}Get Attachment <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Forward Message
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/forwardForward Message <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Get Raw Message
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/rawGet Raw Message <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Reply To Message
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/replyReply To Message <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Reply All Message
$MeteredPOST https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/{message_id}/reply-allReply All Message <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Query Metrics
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/metricsQuery Metrics <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - List Threads
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threadsList Threads <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Threads
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threads/searchFull-text search across one inbox's threads. Returns `count`, `limit`, `next_page_token` and `threads`; page with `next_page_token`. Same thread fields as `get_agentmail_inbox_threads`, which is the one to use for everything in date order. To search individual messages rather than conversations use `get_agentmail_inbox_messages_search`.
Manage Inbox Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id}Retrieve, update, or delete a specific email thread within an inbox, including details like messages, labels, senders, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Inbox Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id}Retrieve, update, or delete a specific email thread within an inbox, including details like messages, labels, senders, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Inbox Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id}Retrieve, update, or delete a specific email thread within an inbox, including details like messages, labels, senders, and timestamps. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Inboxes - Get Attachment
$MeteredGET https://aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/threads/{thread_id}/attachments/{attachment_id}Get Attachment <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage List Entries
$MeteredGET https://aisa.one/apis/v1/agentmail/lists/{direction}/{type}Retrieve or create entries in the specified list based on direction and type. Supports listing entries with pagination and adding new email addresses or domains with an optional reason. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage List Entries
$MeteredPOST https://aisa.one/apis/v1/agentmail/lists/{direction}/{type}Retrieve or create entries in the specified list based on direction and type. Supports listing entries with pagination and adding new email addresses or domains with an optional reason. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage List Entry
$MeteredGET https://aisa.one/apis/v1/agentmail/lists/{direction}/{type}/{entry}Retrieve or delete a specific email address or domain entry from a list based on its direction and type. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage List Entry
$MeteredGET https://aisa.one/apis/v1/agentmail/lists/{direction}/{type}/{entry}Retrieve or delete a specific email address or domain entry from a list based on its direction and type. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Query Metrics
$MeteredGET https://aisa.one/apis/v1/agentmail/metricsQuery Metrics <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Threads
$MeteredGET https://aisa.one/apis/v1/agentmail/threadsList Threads <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search All Threads
$MeteredGET https://aisa.one/apis/v1/agentmail/threads/searchFull-text search over threads in **every inbox in the account**. Returns `count`, `limit`, `next_page_token` and `threads`; page with `next_page_token`. Same fields as `get_agentmail_threads`, which is the one to use for everything in date order. This is the organization-wide view spanning every inbox in the account. Every AIsa caller shares one AgentMail account, so this reaches inboxes other callers created; the inbox-scoped twin `get_agentmail_inbox_threads_search` is the one to use when a single inbox is meant.
Manage Email Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/threads/{thread_id}Retrieve, update, or delete an email thread by its ID. Supports fetching thread details, modifying labels, and deleting the thread permanently or moving it to trash. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Email Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/threads/{thread_id}Retrieve, update, or delete an email thread by its ID. Supports fetching thread details, modifying labels, and deleting the thread permanently or moving it to trash. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Manage Email Thread
$MeteredGET https://aisa.one/apis/v1/agentmail/threads/{thread_id}Retrieve, update, or delete an email thread by its ID. Supports fetching thread details, modifying labels, and deleting the thread permanently or moving it to trash. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Attachment
$MeteredGET https://aisa.one/apis/v1/agentmail/threads/{thread_id}/attachments/{attachment_id}Get Attachment <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ahrefs Domain Rating
$MeteredGET https://aisa.one/apis/v1/ahrefs/site-explorer/domain-ratingReturn the Ahrefs Domain Rating (0-100 authority score) and Ahrefs Rank for a target domain on a given date. 4xx/5xx are not charged. <!-- aisa-pricing:start --> Published reference price: $0.08 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ahrefs Site Metrics
$MeteredGET https://aisa.one/apis/v1/ahrefs/site-explorer/metricsReturn core Site Explorer metrics for a target domain on a given date: organic and paid keyword counts, top-3 keyword count, organic traffic, and traffic value. 4xx/5xx are not charged. <!-- aisa-pricing:start --> Published reference price: $0.08 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Airbnb Listings
$MeteredGET https://aisa.one/apis/v1/airbnb/search<!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Company Enrichment
$MeteredGET https://aisa.one/apis/v1/akta/company/enrichmentEnrich a company profile by section: firmographics, business model, assessment, trust signals, hierarchy, digital presence, financial estimate, location, management, products, strategic signals, funding, M&A. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.8 USD (not a fixed price). Declared unit rate: $0.04 USD per akta_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Company Search
$MeteredGET https://aisa.one/apis/v1/akta/company/searchResolve a company by name, website or UUID; returns uuid, name, website, product_category, company_status. See the published pricing, suitable as health check. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Industry Search
$MeteredGET https://aisa.one/apis/v1/akta/industry/searchResolve an industry from free text to ranked industry codes (30K+ sub-sectors, 4-level taxonomy). See the published pricing. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filter Builder
$MeteredPOST https://aisa.one/apis/v1/akta/list/filter-builderConvert a natural-language description of target companies into a structured filters object for the List Generation API. <!-- aisa-pricing:start --> Published reference price: $0.025 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Generation
$MeteredPOST https://aisa.one/apis/v1/akta/list/generate/companiesBuild targeted company lists from structured filters or a natural-language query, with optional per-section enrichment. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Request Status
$MeteredGET https://aisa.one/apis/v1/akta/status/{request_id}Poll the status of an async request (e.g. company addition) by request_id. See the published pricing. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Anthropic Web Search
$MeteredPOST https://aisa.one/apis/v1/anthropic-websearch/searchAsk a question and get an answer that Claude wrote after searching the live web. Send a normal Messages request — a `messages` array plus `max_tokens` — and the endpoint injects a fixed, server-pinned model and the `web_search` tool for you; you cannot override the model or add tools, which keeps cost bounded. Claude decides when to search (up to `max_uses` searches, default 5), reads the results, and answers with inline citations. The response is a standard Anthropic Messages object: `content[]` contains `server_tool_use` (the queries issued), `web_search_tool_result` (the sources found) and `text` blocks (the answer with `citations`), and `usage.server_tool_use.web_search_requests` reports how many searches were billed. a failed search (HTTP 200 `web_search_tool_result_error`) is not billed. Use this when you want a written, cited answer grounded in current web content — for open-web research that returns ranked links and page text in one call use [`post_tavily_search`](/api-reference/search/post_tavily-search) instead, and for the OpenAI-model equivalent see [`post_openai_websearch_search`](/api-reference/search/post_openai-websearch-search). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.3 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Account Stages
$MeteredGET https://aisa.one/apis/v1/apollo/account_stagesList account stages. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create an Account
$MeteredPOST https://aisa.one/apis/v1/apollo/accountsCreate a new account. Duplicate domains are not allowed. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Create Accounts
$MeteredPOST https://aisa.one/apis/v1/apollo/accounts/bulk_createBulk create accounts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Update Accounts
$MeteredPOST https://aisa.one/apis/v1/apollo/accounts/bulk_updateBulk update accounts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Accounts
$MeteredPOST https://aisa.one/apis/v1/apollo/accounts/searchSearch for accounts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Account Owner for Multiple Accounts
$MeteredPOST https://aisa.one/apis/v1/apollo/accounts/update_ownersUpdate account owner for multiple accounts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update an Account
$MeteredGET https://aisa.one/apis/v1/apollo/accounts/{account_id}Update fields on an existing account. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
View an Account
$MeteredGET https://aisa.one/apis/v1/apollo/accounts/{id}View an account by ID. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Contact Stages
$MeteredGET https://aisa.one/apis/v1/apollo/contact_stagesList contact stages. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create a Contact
$MeteredPOST https://aisa.one/apis/v1/apollo/contactsCreate a new contact. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Create Contacts
$MeteredPOST https://aisa.one/apis/v1/apollo/contacts/bulk_createBulk create contacts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Update Contacts
$MeteredPOST https://aisa.one/apis/v1/apollo/contacts/bulk_updateBulk update contacts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Contacts
$MeteredPOST https://aisa.one/apis/v1/apollo/contacts/searchSearch for contacts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Contact Owner for Multiple Contacts
$MeteredPOST https://aisa.one/apis/v1/apollo/contacts/update_ownersUpdate contact owner for multiple contacts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Contact Stage for Multiple Contacts
$MeteredPOST https://aisa.one/apis/v1/apollo/contacts/update_stagesUpdate contact stage for multiple contacts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update or View Contact
$MeteredGET https://aisa.one/apis/v1/apollo/contacts/{contact_id}View a contact by ID. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update or View Contact
$MeteredGET https://aisa.one/apis/v1/apollo/contacts/{contact_id}View a contact by ID. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of Email Accounts
$MeteredGET https://aisa.one/apis/v1/apollo/email_accountsGet a list of email accounts. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Contact Status in a Sequence
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/remove_or_stop_contact_idsUpdate contact status in a sequence. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Sequences
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/searchSearch for sequences (emailer campaigns) in your Apollo account. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Deactivate a Sequence
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/{sequence_id}/abortDeactivate a sequence. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Add Contacts to a Sequence
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/{sequence_id}/add_contact_idsAdd contacts to a sequence. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Activate a Sequence
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/{sequence_id}/approveActivate a sequence. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Archive a Sequence
$MeteredPOST https://aisa.one/apis/v1/apollo/emailer_campaigns/{sequence_id}/archiveArchive a sequence (marks it inactive and finishes contacts). Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Outreach Emails
$MeteredGET https://aisa.one/apis/v1/apollo/emailer_messages/searchSearch for outreach emails. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Check Email Stats
$MeteredGET https://aisa.one/apis/v1/apollo/emailer_messages/{id}/activitiesCheck email stats for a specific outreach email. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of Fields + Create a Custom Field
$MeteredGET https://aisa.one/apis/v1/apollo/fieldsGet a list of fields. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of Fields + Create a Custom Field
$MeteredPOST https://aisa.one/apis/v1/apollo/fieldsGet a list of fields. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of All Lists
$MeteredGET https://aisa.one/apis/v1/apollo/labelsGet a list of all lists (labels). Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Organization Search
$MeteredPOST https://aisa.one/apis/v1/apollo/mixed_companies/searchFind companies matching criteria: name, domain, headcount, industry, location, funding stage and technologies in use. Returns `organizations` and `accounts` side by side — organizations are Apollo's global database, accounts are records that already exist in this Apollo workspace — plus `pagination` and `breadcrumbs` echoing the filters that were applied. Use it to build a target list. When you already know the domain, `get_apollo_organizations_enrich` answers directly and costs less. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
People API Search
$MeteredPOST https://aisa.one/apis/v1/apollo/mixed_people/api_searchUse the People API Search endpoint to find net new people in the Apollo database. Several filters are available to help narrow your search. This endpoint is optimized for API usage and does not consume credits. This endpoint is primarily designed for prospecting net new people. This endpoint does not return email addresses or phone numbers. Use the People Enrichment or Bulk People Enrichment endpoints to enrich data. This endpoint requires a master API key. Refer to Create API Keys to learn how to create a master API key. To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible. This limitation does not restrict your access to Apollo's database; you just need to access the data in batches. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
News Articles Search
$MeteredPOST https://aisa.one/apis/v1/apollo/news_articles/searchNews coverage for specific companies. `organization_ids[]` is required — omitting it returns HTTP 422 with "organization_ids is required", so resolve the companies first with `get_apollo_organizations_enrich` or `post_apollo_mixed_companies_search`. Narrow further with `categories[]` (funding, hires, launches and similar), `published_at[min]`, `published_at[max]`, and page with `page` and `per_page`. Returns `news_articles` and `pagination`. Use it to catch a trigger event before reaching out. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of Notes
$MeteredGET https://aisa.one/apis/v1/apollo/notesGet a list of notes. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Deal
$MeteredPOST https://aisa.one/apis/v1/apollo/opportunitiesCreate a deal (opportunity). Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List All Deals
$MeteredGET https://aisa.one/apis/v1/apollo/opportunities/searchList all deals (opportunities). Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
View or Update Deal
$MeteredGET https://aisa.one/apis/v1/apollo/opportunities/{opportunity_id}View a deal (opportunity) by ID. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
View or Update Deal
$MeteredGET https://aisa.one/apis/v1/apollo/opportunities/{opportunity_id}View a deal (opportunity) by ID. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Deal Stages
$MeteredGET https://aisa.one/apis/v1/apollo/opportunity_stagesList deal stages (opportunity stages). Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Organization Enrichment
$MeteredPOST https://aisa.one/apis/v1/apollo/organizations/bulk_enrichEnrich up to 10 companies in one call. Body takes `domains`, an array of bare domains. Returns the enriched organizations alongside `status`, `total_requested_domains`, `unique_domains`, `unique_records` and `unique_enriched_records` — compare the requested and enriched counts rather than assuming every domain resolved. For one domain `get_apollo_organizations_enrich` is a plain GET. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Organization Enrichment
$MeteredGET https://aisa.one/apis/v1/apollo/organizations/enrichEnrich one company by domain. `domain` is the only parameter and it must be the bare domain (apple.com), not a full URL. Returns an `organization` object with `id`, `name`, `website_url`, `linkedin_url`, `twitter_url`, `facebook_url`, `angellist_url`, `phone`, `founded_year`, `alexa_ranking`, `publicly_traded_symbol`, `publicly_traded_exchange` and `languages`. Use it as the entry point when all you have is a domain. For several domains at once use `post_apollo_organizations_bulk_enrich`; for the full record including funding and technology detail use `get_apollo_organizations_id`, which needs the Apollo organization id this call returns. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Complete Organization Info
$MeteredGET https://aisa.one/apis/v1/apollo/organizations/{id}The complete Apollo record for one company, by Apollo organization id (not by domain). Returns an `organization` object carrying everything enrichment returns plus the deeper fields: funding history, technology stack, department headcounts and related organizations. Get the id from `get_apollo_organizations_enrich` or `post_apollo_mixed_companies_search` first — this endpoint cannot take a domain. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Organization Job Postings
$MeteredGET https://aisa.one/apis/v1/apollo/organizations/{organization_id}/job_postingsLive job postings for one company, by Apollo organization id. Each posting carries its title, location, posted date and source URL. Useful as a hiring signal — which functions a company is expanding, and where. Get the organization id from `get_apollo_organizations_enrich` first. This reads Apollo's job board data, not the company's own careers page, so absence of postings is not proof a company is not hiring. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01975 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk People Enrichment
$MeteredPOST https://aisa.one/apis/v1/apollo/people/bulk_matchEnrich up to 10 people in one call. Body takes `details`, an array of the same identifier objects `post_apollo_people_match` accepts. Returns `matches` alongside `status`, `total_requested_enrichments`, `unique_enriched_records`, `missing_records` and `credits_consumed` — read `missing_records` rather than assuming every input matched. Costs one credit per record enriched, not per call. Use this over a loop of single calls: same credits, one round trip. For a single person `post_apollo_people_match` is simpler. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $1.7775 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
People Enrichment
$MeteredPOST https://aisa.one/apis/v1/apollo/people/matchEnrich one person: give whatever identifiers you have and get back Apollo's full record for them. Send identifiers in the JSON request body, not the query string. Accepts `email`, `first_name` plus `last_name`, `name`, `domain`, `organization_name`, `linkedin_url` or `hashed_email` — the more you supply, the likelier the match. Returns a `person` object with `id`, `name`, `title`, `headline`, `linkedin_url`, `twitter_url`, `github_url`, `photo_url`, `organization_id` and an `employment_history` array, plus a `request_id`. Personal emails and phone numbers are withheld unless `reveal_personal_emails` (body) or `reveal_phone_number` (query) is set, and those cost extra credits. A 200 does not guarantee a match — check whether `person` actually came back. Use `post_apollo_people_bulk_match` for up to 10 people in one call; use `post_apollo_mixed_people_api_search` when you do not have an identifier and need to find candidates first. <!-- aisa-pricing:start --> Published reference price: $0.01975 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Call Records
$MeteredPOST https://aisa.one/apis/v1/apollo/phone_callsCreate call records. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Calls
$MeteredGET https://aisa.one/apis/v1/apollo/phone_calls/searchSearch calls. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Call Records
$MeteredGET https://aisa.one/apis/v1/apollo/phone_calls/{id}Update call records. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Query Analytics Report
$MeteredPOST https://aisa.one/apis/v1/apollo/reports/sync_reportQuery analytics report. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create a Task
$MeteredPOST https://aisa.one/apis/v1/apollo/tasksCreate a task. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Create Tasks
$MeteredPOST https://aisa.one/apis/v1/apollo/tasks/bulk_createBulk create tasks. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search for Tasks
$MeteredPOST https://aisa.one/apis/v1/apollo/tasks/searchSearch tasks. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of All Custom Fields
$MeteredGET https://aisa.one/apis/v1/apollo/typed_custom_fieldsGet a list of all custom fields. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
View API Usage Stats and Rate Limits
$MeteredPOST https://aisa.one/apis/v1/apollo/usage_stats/api_usage_statsView API usage stats and rate limits. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a List of Users
$MeteredGET https://aisa.one/apis/v1/apollo/users/searchGet a list of users. Requires a master API key. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Answers
$MeteredPOST https://aisa.one/apis/v1/brave/chat/completions<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Image Search
$MeteredGET https://aisa.one/apis/v1/brave/images/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
LLM Context
$MeteredGET https://aisa.one/apis/v1/brave/llm/context<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
LLM Context
$MeteredPOST https://aisa.one/apis/v1/brave/llm/context<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
POI Descriptions
$MeteredGET https://aisa.one/apis/v1/brave/local/descriptions<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Place Search
$MeteredGET https://aisa.one/apis/v1/brave/local/place_search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Local POIs
$MeteredGET https://aisa.one/apis/v1/brave/local/pois<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
News Search
$MeteredGET https://aisa.one/apis/v1/brave/news/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
News Search
$MeteredPOST https://aisa.one/apis/v1/brave/news/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Spell Check
$MeteredGET https://aisa.one/apis/v1/brave/spellcheck/search<!-- aisa-pricing:start --> Published reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Suggest
$MeteredGET https://aisa.one/apis/v1/brave/suggest/search<!-- aisa-pricing:start --> Published reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Video Search
$MeteredGET https://aisa.one/apis/v1/brave/videos/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Video Search
$MeteredPOST https://aisa.one/apis/v1/brave/videos/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Rich Search
$MeteredGET https://aisa.one/apis/v1/brave/web/rich<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Web Search
$MeteredGET https://aisa.one/apis/v1/brave/web/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Web Search
$MeteredPOST https://aisa.one/apis/v1/brave/web/search<!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
BytePlus Fetch
$MeteredPOST https://aisa.one/apis/v1/byteplus/fetchFetch a single URL and return clean, structured page content — title, body text, and publish time. `Url` is required. The response wraps `ResponseMetadata.RequestId` and a `Result` object with the parsed content. Use it to extract full page content for URLs you already have, typically pairing it with `post_byteplus_web_search` results. failed requests are not charged. <!-- aisa-pricing:start --> Published reference price: $0.0008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
CreateMonitorTask
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/CreateMonitorTask创建监测任务 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
DisableSubsTask
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/DisableSubsTask删除监测任务 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
GetMonitorTask
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/GetMonitorTask查询监测任务 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
PullPosts
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/PullPosts分页拉取文章 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
UpdateMonitorTask
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/UpdateMonitorTask全量更新监测任务 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
UpdateSubsStatus
$MeteredPOST https://aisa.one/apis/v1/byteplus/mkt-insight/UpdateSubsStatus启用或暂停监测任务 BytePlus Market Insight monitor operation. Requires an AIsa API key and owner-scoped TaskID for existing tasks. Only POST JSON on the canonical path is supported; URL query parameters, proxy aliases, MPP and cost quotes are rejected. Request validation is owned by the handler; provider-specific Config fields and PullPosts filters are forwarded. Existing V2 customer pricing applies. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
BytePlus Web Search
$MeteredPOST https://aisa.one/apis/v1/byteplus/web-searchRun a real-time web search built for AI agents and return a ranked list of titled results with links and snippets. `Query` is required; narrow the result set with `Count` (≤ 20), `Filter` (restrict to `Sites` or exclude `BlockHosts`), `Language`, and `TimeRange`. The response wraps `ResponseMetadata.RequestId` and a `Result` list of web results. Use it for RAG retrieval augmentation, competitive/PR monitoring, fact-checking, and content sourcing; pair each result URL with `post_byteplus_fetch` to pull full page content. failed requests are not charged. <!-- aisa-pricing:start --> Published reference price: $0.0048 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
CNPJ Office Lookup
$MeteredGET https://aisa.one/apis/v1/cnpja/office/{taxId}Look up the registered profile of a Brazilian company office (establishment) by its 14-digit CNPJ tax ID. Returns the office's legal/company name, trade name (`alias`), registration status, founding date, full address, shareholder/member structure, and primary/secondary economic activities (CNAE). A "company not found" result returns HTTP 404 with a valid JSON body and is still billed 1 credit; only 429, 5xx, and network errors are not billed. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0288 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exchange Volume Chart by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/api/{id}/volume_chartThis endpoint allows you to **query the historical volume chart data with time in UNIX and trading volume data in BTC based on exchange's ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coins Categories List with Market Data
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/categoriesThis endpoint allows you to **query all the coins categories with market data (market cap, volume, ...) on CoinGecko** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coins Categories List (ID Map)
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/categories/listThis endpoint allows you to **query all the coins categories on CoinGecko** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coins List (ID Map)
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/listThis endpoint allows you to **query all the supported coins on CoinGecko with coins ID, name and symbol** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coins List with Market Data
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/marketsThis endpoint allows you to **query all the supported coins with price, market cap, volume and market related data** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Data by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on a particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Data by Token Address
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/contract/{contract_address}This endpoint allows you to **query all the metadata (image, websites, socials, description, contract address, etc.) and market data (price, ATH, exchange tickers, etc.) of a coin from the CoinGecko coin page based on an asset platform and a particular token contract address** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Historical Chart Data by Token Address
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/contract/{contract_address}/market_chartThis endpoint allows you to **get the historical chart data including time in UNIX, price, market cap and 24hr volume based on asset platform and particular token contract address** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Historical Chart Data within Time Range by Token Address
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/contract/{contract_address}/market_chart/rangeThis endpoint allows you to **get the historical chart data within certain time range in UNIX along with price, market cap and 24hr volume based on asset platform and particular token contract address** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Historical Data by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/historyThis endpoint allows you to **query the historical data (price, market cap, 24hrs volume, ...) at a given date for a coin based on a particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Historical Chart Data by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/market_chartThis endpoint allows you to **get the historical chart data of a coin including time in UNIX, price, market cap and 24hr volume based on particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Historical Chart Data within Time Range by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/market_chart/rangeThis endpoint allows you to **get the historical chart data of a coin within certain time range in UNIX along with price, market cap and 24hr volume based on particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin OHLC Chart by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/ohlcThis endpoint allows you to **get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Tickers by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/coins/{id}/tickersThis endpoint allows you to **query the coin tickers on both centralized exchange (CEX) and decentralized exchange (DEX) based on a particular coin ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exchanges List with Data
$MeteredGET https://aisa.one/apis/v1/coingecko/exchangesThis endpoint allows you to **query all the supported exchanges with exchanges' data (ID, name, country, ...) that have active trading volumes on CoinGecko** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exchanges List (ID Map)
$MeteredGET https://aisa.one/apis/v1/coingecko/exchanges/listThis endpoint allows you to **query all the exchanges with ID and name** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exchange Data by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/exchanges/{id}This endpoint allows you to **query exchange's data (name, year established, country, ...), exchange volume in BTC and top 100 tickers based on exchange's ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exchange Tickers by ID
$MeteredGET https://aisa.one/apis/v1/coingecko/exchanges/{id}/tickersThis endpoint allows you to **query exchange's tickers based on exchange's ID** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Crypto News
$MeteredGET https://aisa.one/apis/v1/coingecko/newsCrypto news headlines from CoinGecko, filterable by `coin_id`, `language` and `type` (`news` or `guides`), paged with `page` and `per_page`. Availability warning: this endpoint is restricted to CoinGecko Analyst plans and above, and on the current upstream subscription it returns HTTP 401 with an upgrade message in the body. Treat it as unavailable until the upstream plan changes. For coin context that does work today, `get_coingecko_coins_id` returns `description` and `links` including official channels.
Ping test
$MeteredGET https://aisa.one/apis/v1/coingecko/ping默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Trending Search List
$MeteredGET https://aisa.one/apis/v1/coingecko/search/trendingThis endpoint allows you **query trending search coins, NFTs and categories on CoinGecko in the last 24 hours** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Price by IDs, Symbols, or Names
$MeteredGET https://aisa.one/apis/v1/coingecko/simple/priceThis endpoint allows you to **query the prices of one or more coins by using their unique Coin API IDs, symbols, or names** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Supported Currencies List
$MeteredGET https://aisa.one/apis/v1/coingecko/simple/supported_vs_currenciesThis endpoint allows you to **query all the supported currencies on CoinGecko** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Coin Price by Token Addresses
$MeteredGET https://aisa.one/apis/v1/coingecko/simple/token_price/{id}This endpoint allows you to **query one or more token prices using their token contract addresses** <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
AI Keyword Data Keyword Search Volume
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/ai_keyword_data/keywords_search_volume/live This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.011 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations and Languages for AI Keyword Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/ai_keyword_data/locations_and_languages Using this endpoint you can get the full list of locations and languages supported in AI Keyword Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live ChatGPT LLM Responses
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/live Live ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT AI model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0695 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of ChatGPT models for LLM Responses
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/modelsYou will receive the list of available Chat GPT AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses Chat GPT Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_get/{id} Chat GPT LLM Responses endpoint allows you to retrieve structured responses from a specific Chat GPT model, based on the input parameters. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘LLM Responses ChatGPT’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/task_post ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses ChatGPT Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_responses/tasks_ready This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live ChatGPT LLM Scraper
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/advanced Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.004 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live ChatGPT LLM Scraper API HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/html Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ChatGPT LLM Scraper Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Ai Optimization Chat Gpt Llm Scraper Html Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id}DataForSEO GET /v3/ai_optimization/chat_gpt/llm_scraper/task_get/html/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Ai Optimization Chat Gpt Llm Scraper Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/chat_gpt/llm_scraper/task_postDataForSEO POST /v3/ai_optimization/chat_gpt/llm_scraper/task_post <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Claude LLM Responses
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/live Live Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0567 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Claude Models for LLM Responses
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/modelsYou will receive the list of available Claude AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses Claude Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_get/{id} Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting LLM Responses Claude Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/task_post Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses Claude Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/claude/llm_responses/tasks_ready This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Gemini LLM Responses
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/live Live Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini AI model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0707 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Gemini models for LLM Responses
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/modelsYou will receive the list of available Gemini AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses Gemini Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_get/{id} Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘LLM Responses Gemini’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/task_post Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get LLM Responses Gemini Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_responses/tasks_ready This endpoint is designed to provide you with a list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Gemini LLM Scraper Languages List
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Gemini LLM Scraper Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/advanced Live Gemini LLM Scraper endpoint provides structured results from Gemini. The results are specific to the selected location (see the List of Locations), language (see the List of Languages), and keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Gemini LLM Scraper HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/live/html Live Gemini LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language (see the List of Languages), and location (see the List of Locations). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Gemini LLM Scraper Locations List
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Gemini LLM Scraper Advanced
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Gemini LLM Scraper HTML
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Gemini LLM Scraper
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/task_post Gemini LLM Scraper API provides structured results from Gemini. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages), and keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Gemini LLM Scraper Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/gemini/llm_scraper/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live LLM Mentions Aggregated Metrics
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/aggregated_metrics/liveHow often assistants mention your target, as totals rather than individual answers: `total` and `items`. Measured at 7.0 KB. ⚠️ `target` is an **array of objects**, each `{"domain": "..."}` or `{"keyword": "..."}`; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from `get_dataforseo_ai_llm_mentions_available_filters`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. This is the headline visibility number; `post_dataforseo_ai_llm_mentions_search_live` shows the answers behind it, and `post_dataforseo_ai_llm_mentions_cross_metrics_live` compares several targets at once. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters for AI Optimization LLM Mentions API
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/available_filters Here you will find all the necessary information about filters that can be used with AI Optimization LLM Mentions API endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live LLM Mentions Cross Aggregated Metrics
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/cross_aggregated_metrics/liveCompares mention metrics across several targets in one call, grouped by `aggregation_key`. Takes `targets` as a list of target arrays rather than the single `target` its siblings take - the shapes differ, and mixing them up is rejected as an unknown field. ⚠️ `target` is an **array of objects**, each `{"domain": "..."}` or `{"keyword": "..."}`; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from `get_dataforseo_ai_llm_mentions_available_filters`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. Running `post_dataforseo_ai_llm_mentions_aggregated_metrics_live` once per target costs the same per call, so use this when the comparison itself is the point. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Historical
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/historical/liveDataForSEO POST /v3/ai_optimization/llm_mentions/historical/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations and Languages for AI Optimization LLM Mentions API
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/locations_and_languages Using this endpoint you can get the full list of locations and languages supported in AI Optimization LLM Mentions API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Multi Target Metrics
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/multi_target_metrics/liveDataForSEO POST /v3/ai_optimization/llm_mentions/multi_target_metrics/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live LLM Mentions
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/search/liveThe individual answers in which an assistant mentioned your target. Returns `total_count`, `current_offset`, `search_after_token` and `items` - page with the token, not `offset`, past the first pages. Measured at 7.7 KB for one item. ⚠️ `target` is an **array of objects**, each `{"domain": "..."}` or `{"keyword": "..."}`; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from `get_dataforseo_ai_llm_mentions_available_filters`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. For counts rather than the mentions themselves use `post_dataforseo_ai_llm_mentions_aggregated_metrics_live`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Search Mentions
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/search_mentions/liveDataForSEO POST /v3/ai_optimization/llm_mentions/search_mentions/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Target Metrics
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics/liveDataForSEO POST /v3/ai_optimization/llm_mentions/target_metrics/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Target Metrics Lite
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/target_metrics_lite/liveDataForSEO POST /v3/ai_optimization/llm_mentions/target_metrics_lite/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Timeseries Delta
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_delta/liveDataForSEO POST /v3/ai_optimization/llm_mentions/timeseries_delta/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Timeseries New Lost
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/timeseries_new_lost/liveDataForSEO POST /v3/ai_optimization/llm_mentions/timeseries_new_lost/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live LLM Mentions Top Domains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_domains/liveThe domains assistants cite most when answering about your target: `total` and `items`. Measured at 20.3 KB, the largest response in the mentions family. ⚠️ `target` is an **array of objects**, each `{"domain": "..."}` or `{"keyword": "..."}`; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from `get_dataforseo_ai_llm_mentions_available_filters`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. This is the list to pitch: these are the pages shaping what assistants say. For individual pages rather than domains use `post_dataforseo_ai_llm_mentions_top_pages_live`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Brand Categories
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Brand Categories Lite
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_brand_categories_lite/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Brands
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_brands/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Brands Lite
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_brands_lite/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_brands_lite/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Domains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_domains/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Domains Lite
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_domains_lite/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_domains_lite/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_pages/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Ai Optimization Llm Mentions Top Mentioned Pages Lite
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_mentioned_pages_lite/liveDataForSEO POST /v3/ai_optimization/llm_mentions/top_mentioned_pages_lite/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.101 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live LLM Mentions Top Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/llm_mentions/top_pages/liveThe individual pages assistants cite most when answering about your target: `total` and `items`. Measured at 13.1 KB. ⚠️ `target` is an **array of objects**, each `{"domain": "..."}` or `{"keyword": "..."}`; a bare string is rejected as the wrong type and an array of strings as 'Each target item must be an object'. Filter fields come from `get_dataforseo_ai_llm_mentions_available_filters`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. More actionable than its domain-level twin `post_dataforseo_ai_llm_mentions_top_domains_live` when you want to know which article to update or pitch, rather than which publisher. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.701 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Perplexity LLM Responses
$MeteredPOST https://aisa.one/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/live Live Perplexity LLM Responses endpoint allows you to retrieve structured responses from a specific Perplexity AI model, based on the input parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0163 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Perplexity models for LLM Responses
$MeteredGET https://aisa.one/apis/v1/dataforseo/ai_optimization/perplexity/llm_responses/modelsYou will receive the list of available Perplexity AI models by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Apple App Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/app_info/task_get/advanced/{id}This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, images, and other data. The results are specific to the app_id parameter specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Apple App Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/apple/app_info/task_post This endpoint will provide you with information about the App Store application specified in the app_id field of the POST request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Apple App List Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/app_list/task_get/advanced/{id}This endpoint will provide you with a list of applications published in the top app charts on the App Store platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Apple App List Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/apple/app_list/task_postThis endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. The returned results are specific to the app collection as well as the language and location parameters. for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/app_list/task_post/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of App Store Listings Categories for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/categoriesThis endpoint will provide you with a full list of app categories available on Apple App Store. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Apple App Listings Search Results
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/apple/app_listings/search/liveThis endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Apple App Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/app_reviews/task_get/advanced/{id}This endpoint will provide you with feedback data on applications listed on the App Store platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Apple App Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/apple/app_reviews/task_post This endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Apple App Searches Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/app_searches/task_get/advanced/{id}This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Apple App Searches Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/apple/app_searches/task_post This endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. The returned results are specific to the indicated keyword, as well as the location and language parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Apple App Categories for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/categoriesThis endpoint will provide you with a full list of app categories available on App Store. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Apple Languages for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/languagesBy calling this endpoint you will receive the list of Apple languages supported in App Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Apple Locations for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/apple/locationsBy calling this endpoint you will receive the list of Apple locations supported in App Data API. for more info please visit 'https://docs.dataforseo.com/v3/app_data/apple/locations/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_get/advanced/{id}This endpoint will provide you with information about the mobile application specified in a POST request. You will receive its ID, icon, description, reviews count, rating, number of installs, images, and other data. The results are specific to the app_id parameter specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App Info HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google App Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/google/app_info/task_post This endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App List Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_get/advanced/{id}This endpoint will provide you with a list of applications published in the top charts on the Google Play platform, including app IDs, ratings, prices, titles, and more. The results are specific to the app_collection as well as the location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App List HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google App List Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/google/app_list/task_post This endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. The returned results are specific to the app collection as well as the the language and location parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google App Listings Categories for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_listings/categoriesThis endpoint will provide you with a full list of app categories available on Google Play. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google App Listings Search Results
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/google/app_listings/search/liveThis endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. The results are specific to the title, description, and categories parameters specified in the API request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_get/advanced/{id}This endpoint will provide you with feedback data on applications listed on the Google Play platform, including review ratings, review content, user profile info of each reviewer, review publication dates, and more. The results are specific to the app_id as well as the location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get App Data Google App Reviews Html Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_get/html/{id}DataForSEO GET /v3/app_data/google/app_reviews/task_get/html/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google App Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/google/app_reviews/task_post This endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. The returned results are specific to the indicated language and location parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App Searches Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_get/advanced/{id}This endpoint will provide you with a list of apps ranking on Google Play for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google App Searches HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google App Searches Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/app_data/google/app_searches/task_post This endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. The returned results are specific to the indicated keyword, as well as the language and location parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google App Categories for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/categoriesThis endpoint will provide you with a full list of app categories available on Google Play. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Languages for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/languagesBy calling this endpoint you will receive the list of Google languages supported in App Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Locations for App Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/app_data/google/locationsBy calling this endpoint you will receive the list of Google locations supported in App Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Anchors
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/anchors/live This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.033 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/backlinks/live This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Backlinks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_backlinks/live This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk New & Lost Backlinks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_new_lost_backlinks/live This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk New & Lost Referring Domains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_new_lost_referring_domains/live This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Pages Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_pages_summary/liveThis endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0242 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Ranks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_ranks/live This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm. You can learn more about rank scores in this help center article <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.025 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Referring Domains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_referring_domains/live This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0254 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Spam Score
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/bulk_spam_score/live This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100. You can learn more about Spam Score, how it is calculated, and signals it takes into account in this help center article <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Competitors
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/competitors/live This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Intersection
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/domain_intersection/live This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/domain_pages/live This endpoint will provide you with a detailed overview of domain pages with backlink data for each page. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Pages Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/domain_pages_summary/liveThis endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks History
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/history/live This endpoint will provide you with historical backlinks data back to the beginning of 2019. You can receive the number of backlinks a given domain had in a specific time period, the number of new & lost backlinks, referring domains, and more. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0271 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks Index
$MeteredGET https://aisa.one/apis/v1/dataforseo/backlinks/index This endpoint will provide you with the total number of backlinks, domains, and pages our database contains for the moment when you make a request. You will also get stats for the last 12 months. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Page Intersection
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/page_intersection/live This endpoint will provide you with the list of referring pages pointing to the specified targets. It is especially useful for finding the backlinks that point to your competitors but don’t point to your website. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.033 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Referring Domains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/referring_domains/live This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Referring Networks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/referring_networks/live This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/summary/live This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
New & Lost Backlinks Timeseries Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/timeseries_new_lost_summary/live This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0372 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks Timeseries Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/backlinks/timeseries_summary/live This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0273 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Business Listings Search Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/business_listings/search/live Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Google Extended Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/extended_reviews/task_get/{id}The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Google Extended Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/extended_reviews/task_post This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Extended Reviews Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/extended_reviews/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Hotel Info Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/live/advanced Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Hotel Info HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/live/html Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Advanced Google Hotel Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/task_get/advanced/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Advanced Google Hotel Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/task_get/html/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Hotel Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/task_post Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Hotel Info Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_info/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Hotel Searches Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/live Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Hotel Searches Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/task_get/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Hotel Searches Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/task_post Hotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Hotel Searches Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/hotel_searches/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live Google My Business Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_info/live Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0054 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_info/task_get/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google My Business Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_info/task_post Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Info Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_info/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Updates Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_updates/task_get/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google My Business Updates Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_updates/task_post This endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Updates Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/my_business_updates/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live Google My Business Questions and Answers Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/questions_and_answers/live This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Questions and Answers Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/questions_and_answers/task_get/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google My Business Questions and Answers Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/questions_and_answers/task_post This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google My Business Questions and Answers Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/questions_and_answers/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Google Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/reviews/task_get/{id}The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Google Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/google/reviews/task_post This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Reviews Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/google/reviews/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Social Media Pinterest Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/social_media/pinterest/liveHow many times each of `targets` has been pinned on Pinterest. Returns `type`, `page_url` and `pins_count` per URL. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. Takes a list, so check a whole site's pages in one call. For Pinterest content rather than counts, the pinterest server reads the platform directly. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Social Media Reddit Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/social_media/reddit/liveIntended to return Reddit sharing counts for `targets`. 🔴 **Currently unavailable upstream**: it answers `status_code` 50304, `This function temporarily unavailable. Please contact support`, with no `tasks` array at all - the failure is at the top level of the envelope, not inside a task. Measured 2026-08-25. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. The Pinterest sibling `post_dataforseo_business_social_media_pinterest_live` works and costs almost nothing; for Reddit content itself, the reddit server reads the platform directly. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Tripadvisor Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_get/{id}This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Tripadvisor Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/task_post This endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tripadvisor Reviews Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/reviews/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Tripadvisor Search Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/search/task_get/{id}This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Tripadvisor Search Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/search/task_post This endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tripadvisor Search Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/tripadvisor/search/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Trustpilot Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/reviews/task_get/{id}This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Trustpilot Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/reviews/task_post This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Trustpilot Reviews Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/reviews/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Business Data Trustpilot Search Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/search/task_get/{id}This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Business Data Trustpilot Search Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/search/task_post This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.2428 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Trustpilot Search Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/business_data/trustpilot/search/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters for Content Analysis API
$MeteredGET https://aisa.one/apis/v1/dataforseo/content_analysis/available_filters Here you will find all the necessary information about filters that can be used with Content Analysis API endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Categories for Content Analysis API
$MeteredGET https://aisa.one/apis/v1/dataforseo/content_analysis/categoriesWe use Google product and service categories. This endpoint will provide you with the full list of available categories. You can also download the CSV file by this link. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Category Trends API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/category_trends/live This endpoint will provide you with data on all citations in the target category for the indicated date range. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Languages for Content Analysis API
$MeteredGET https://aisa.one/apis/v1/dataforseo/content_analysis/languagesYou will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations for Content Analysis API
$MeteredGET https://aisa.one/apis/v1/dataforseo/content_analysis/locationsYou will receive the list of locations by this API call. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Phrase Trends API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/phrase_trends/live This endpoint will provide you with data on all citations of the target keyword for the indicated date range. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Rating Distribution API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/rating_distribution/live This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Search API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/search/live This endpoint will provide you with detailed citation data available for the target keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Sentiment Analysis API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/sentiment_analysis/liveThis endpoint will provide you with sentiment analysis data for the citations available for the target keyword. for more info please visit 'https://docs.dataforseo.com/v3/content_analysis/sentiment_analysis/live/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Content Analysis – Summary API
$MeteredPOST https://aisa.one/apis/v1/dataforseo/content_analysis/summary/live This endpoint will provide you with an overview of citation data available for the target keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Amazon Bulk Search Volume
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/bulk_search_volume/live This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Here search volume represents the approximate number of monthly searches for a keyword on Amazon. The returned results are specific to the keywords, location, and language parameters specified in a POST request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Product Competitors
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/product_competitors/live This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. The data can help you identify product competitors for any listing published on Amazon. The returned results are specific to the asin as well as the location and language parameters specified in a POST request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Intersections
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/product_keyword_intersections/live This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Product Rank Overview
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/product_rank_overview/live This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ranked Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/ranked_keywords/live This endpoint will provide you with a list of keywords the target product ranks for on Amazon. The returned results are specific to the asin specified in a POST request. Learn more about ASIN in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Related Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/amazon/related_keywords/live The Related Keywords endpoint provides keywords appearing in the “Related Searches” section on Amazon. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
App Store App Competitors Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_competitors/live This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
App Store App Intersection Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
App Store Bulk App Metrics Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/bulk_app_metrics/live This endpoint will provide you with ranking metrics for up to 1000 App Store applications. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
App Store Keywords For App Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/keywords_for_app/live This endpoint will provide you with a list of keywords for which the target app ranks on App Store. You will obtain keyword data and discover the app’s ranking position for each returned keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters for DataForSEO Labs API
$MeteredGET https://aisa.one/apis/v1/dataforseo/dataforseo_labs/available_filters Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Google Play App Competitors Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/app_competitors/live This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Google Play App Intersection Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/app_intersection/live This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
DataForSEO Labs Google Available History
$MeteredGET https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/available_historyBy calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/available_history/live/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Google Play Bulk App Metrics Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/bulk_app_metrics/live This endpoint will provide you with ranking metrics for up to 1000 Google Play applications. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Keyword Difficulty
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/bulk_keyword_difficulty/liveThis endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0734 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Bulk Traffic Estimation
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/bulk_traffic_estimation/live This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Categories For Domain
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/categories_for_domain/live This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Furthermore, you will obtain general rankings and traffic data for the keywords under a certain category. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Languages for Google Categories for Keywords API
$MeteredGET https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/categories_for_keywords/languages Using this endpoint you can get the full list of languages supported for the Google Categories for Keywords endpoint of DataForSEO Labs API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Categories for Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/categories_for_keywords/liveThis endpoint will provide you with Google product and service categories related for each specified keyword. You can indicate a maximum of 1,000 keywords in one API request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Competitors Domain
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/competitors_domain/live This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.015 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Intersection
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/domain_intersection/liveThis endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and other data on each intersecting keyword. Along with that, you will get data on the first and second domain’s SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic. Domain Intersection endpoint supports organic, paid, local pack, and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/domain_intersection/live/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0124 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Metrics By Categories
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/domain_metrics_by_categories/live This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. You will receive historical ranking data from Google SERPs, along with valuable current and historical domain metrics, such as ETV, impressions ETV, estimated paid traffic cost, the total count of SERPs that contain domains, and more. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Rank Overview
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/domain_rank_overview/live This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0121 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Historical Bulk Traffic Estimation
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_bulk_traffic_estimation/live This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. If you do not specify the range, data will be returned for the previous 12 months. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Historical Keyword Data
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_keyword_data/live This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination. You can find the list of supported locations and languages here. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Historical Rank Overview
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Dataforseo Labs Google Historical Search Volume
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_search_volume/liveDataForSEO POST /v3/dataforseo_labs/google/historical_search_volume/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Historical SERPs
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_serps/live This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Ideas
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keyword_ideas/live The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Overview
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keyword_overview/live This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches, as well as SERP and backlink information. Additionally, you can obtain clickstream data, such as clickstream search volume, by specifying the include_clickstream_data parameter. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0254 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Suggestions
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keyword_suggestions/live The Keyword Suggestions endpoint provides search queries that include the specified seed keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Google Play Keywords For App Live
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_app/live This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. You will obtain keyword data and discover the app’s ranking position for each returned keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keywords For Categories
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_categories/live This endpoint will provide you with a list of keywords relevant to the specified product categories. You will get the search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values for each keyword. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keywords For Site
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/keywords_for_site/live The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain, subdomain, or webpage. Each keyword is supplied with relevant categories, search volume data for the last month, cost-per-click, competition, and search volume trend values for the past 12 months. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Page Intersection
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/page_intersection/liveThis endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results. for more info please visit 'https://docs.dataforseo.com/v3/dataforseo_labs/google/page_intersection/live/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ranked Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/ranked_keywords/live This endpoint will provide you with the list of keywords that any domain, subdomain, or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as monthly searches and other data relevant to the returned keywords. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.132 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Related Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/related_keywords/liveThe Related Keywords endpoint provides keywords appearing in the “Searches Related to” SERP element. View the element. You can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0156 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Relevant Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/relevant_pages/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.015 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Intent
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/search_intent/live This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword’s search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0073 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SERP Competitors
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/serp_competitors/live This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0192 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Subdomains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/subdomains/live This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Top Searches
$MeteredPOST https://aisa.one/apis/v1/dataforseo/dataforseo_labs/google/top_searches/live The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics, product categories, and Google SERP data. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
DataForSEO Labs Status
$MeteredGET https://aisa.one/apis/v1/dataforseo/dataforseo_labs/status By calling this endpoint, you will find out when the DataForSEO Labs data was last updated. The API response will provide separate update dates for the Google, Bing, and Amazon endpoints of DataForSEO Labs API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Aggregation Technologies
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/aggregation_technologies/live The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Alternatively, you can specify technology categories or groups to obtain wider stats. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters for Domain Analytics Technologies API
$MeteredGET https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/available_filters Here you will find all the necessary information about filters that can be used with Domain Analytics Technologies API endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Technologies
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/domain_technologies/live Using this endpoint you will get a list of technologies used in a particular domain. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domains by HTML Terms
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/domains_by_html_terms/live This endpoint provides domains based on the HTML terms they use on their homepage. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domains by Technology
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/domains_by_technology/live This endpoint provides domains based on the technology they use. In addition to the list of domains, you will also get their technology profiles, the country and language they belong to, and other related data. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Languages for Domain Analytics Technologies API
$MeteredGET https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/languagesYou will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations for Domain Analytics Technologies API
$MeteredGET https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/locationsYou will receive the list of locations by this API call. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Technologies for Domain Analytics Technologies API
$MeteredGET https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/technologiesThis endpoint will provide you with the full list of available technologies structured by technology groups and categories each particular technology belongs to. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Technologies Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/technologies_summary/live The Technologies Summary endpoint will provide you with the number of domains across different countries and languages that use the specified technology names, technology groups, or technology categories. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Technology Stats
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/technologies/technology_stats/live The Technology Stats endpoint will provide you with historical data on the number of domains across different countries and languages that use the specified technology. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters for Domain Analytics Whois API
$MeteredGET https://aisa.one/apis/v1/dataforseo/domain_analytics/whois/available_filters Here you will find all the necessary information about filters that can be used with Domain Analytics Whois API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Whois Overview
$MeteredPOST https://aisa.one/apis/v1/dataforseo/domain_analytics/whois/overview/live This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Industries for Bing Ads Audience Estimation
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/industriesBy calling this API you will receive the list of industries with industry_id supported by Bing Ads Audience Estimation endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Job Functions for Bing Ads Audience Estimation
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/job_functionsBy calling this API you will receive the list of job functions with job_function_id supported by Bing Ads Audience Estimation endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Bing Ads Audience Estimation’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/liveThis endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Bing Ads Audience Estimation Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/task_get/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Bing Ads Audience Estimation’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/task_post This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. It returns data on the total estimated audience, such as suggested bid and budget for an ad campaign and estimated engagement metrics. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Bing Ads Audience Estimation’ Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/audience_estimation/tasks_ready This endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Bing Keyword Performance’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_performance/live You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations and Languages for Keyword Performance endpoints
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_performance/locations_and_languages Using this endpoint you can get the full list of locations and languages supported in Keyword Performance endpoints of Bing Keywords Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Bing Keyword Performance’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_performance/task_get/{id} You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Bing Keyword Performance’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_performance/task_post You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Ad position, clicks, impressions, and other keyword metrics are aggregated for the last month for one or all of the following device types: mobile, desktop, tablet. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Bing Languages for Keyword Suggestions for URL
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/languagesThe languages `post_dataforseo_keywords_bing_kw_for_url_live` accepts. Free: upstream cost is 0. Note this is a narrower list than `get_dataforseo_keywords_bing_languages`, which serves the rest of the Bing family. Free: upstream cost is 0, and it is reference data - fetch once and keep what you need rather than calling it per request. ⚠️ Catalogues in this provider are not shared between families: the same endpoint name under a different product returns a different list, and one of them measured 46 MB. Check the list belonging to the endpoint you are actually calling. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Bing Ads Keyword Suggestions for URL’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/liveSuggests Bing keywords for one page `target`, reading the page itself rather than a seed list. `exclude_brands` drops brand terms, `language_code` scopes it. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. Use it when you have a URL and no keyword list yet; once you have seeds, `post_dataforseo_keywords_bing_kw_for_keywords_live` expands them. The submit and fetch twins of this endpoint do the same work asynchronously, at the same price, for batches too large to wait on. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Bing Ads Keyword Suggestions For URL Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/task_get/{id}Retrieves a queued Bing keywords-for-URL task by `id`. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. ⚠️ The response size was fixed by the `depth` or limit set at submit time and cannot be narrowed here; if it is too large, resubmit smaller rather than paging. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Keyword Suggestions For URL’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/task_postQueues a Bing keywords-for-URL task, returning a task `id`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. Retrieve with `get_dataforseo_keywords_bing_kw_for_url_fetch`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Bing Ads Keyword Suggestions For URL’ Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keyword_suggestions_for_url/tasks_readyLists finished Bing keywords-for-URL tasks awaiting collection. Free. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. A caller that holds its own task `id` can fetch directly and skip this. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Keywords For Keywords’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/live This endpoint will select the relevant keywords for the specified ones. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Keywords For Keywords’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/task_get/{id} This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Keywords For Keywords’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_keywords/task_post This endpoint will select relevant keywords for the specified terms. Set up to 200 keywords and get the results, which are suggested by Bing Ads for your query. You can get up to 3000 keyword suggestions using this function. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Keywords For Site’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/liveThis endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition values for paid search. The maximum number of returned keywords is 3000. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Keywords For Site’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/task_get/{id} This endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Keywords For Site’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/keywords_for_site/task_postThis endpoint will provide you with a list of keywords relevant to the specified website along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and competition level for paid search. The maximum number of returned keywords is 3000. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Bing Languages for Keywords Data
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/languagesBy calling this API you will receive the list of languages supported by Bing Ads API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Bing Locations for Keywords Data
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/locationsBy calling this API you will receive the list of locations supported in Bing Ads API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume/liveThis endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Search Volume Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume/task_get/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume/task_post This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.06 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Keywords Data Bing Search Volume History
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume_history/liveDataForSEO POST /v3/keywords_data/bing/search_volume_history/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations and Languages for Bing ‘Search Volume History’ Endpoint
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume_history/locations_and_languagesBy calling this API you will receive the list of locations and languages supported by Bing ‘Search Volume History’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Keywords Data Bing Search Volume History Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume_history/task_get/{id}DataForSEO GET /v3/keywords_data/bing/search_volume_history/task_get/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Keywords Data Bing Search Volume History Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/bing/search_volume_history/task_postDataForSEO POST /v3/keywords_data/bing/search_volume_history/task_post <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Bulk Clickstream Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/clickstream_data/bulk_search_volume/live The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers historical search volume values for up to 12 months (depending on keywords, location, and language parameters). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘DataForSEO Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/clickstream_data/dataforseo_search_volume/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Clickstream Global Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/clickstream_data/global_search_volume/live The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. What’s more, it offers geographical distribution of clickstream search volume values across all available locations. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Locations and Languages for DataForSEO Clickstream Data API
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/clickstream_data/locations_and_languages Using this endpoint you can get the full list of locations and languages supported in DataForSEO Clickstream Data API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘DataForSEO Trends Demography’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/dataforseo_trends/demography/liveThis endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. You can check keyword trends for Google Search, Google News, and Google Shopping. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘DataForSEO Trends Explore’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/dataforseo_trends/explore/liveThis endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of DataForSEO Trends Locations
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/dataforseo_trends/locationsYou will receive the list of DataForSEO Trends locations by calling this API. You can filter the list of locations by country when setting a task. Please note that the minimum geographic scope supported for the DataForSEO Trends API is country level. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘DataForSEO Trends Merged Data’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/dataforseo_trends/merged_data/liveThis endpoint will provide you with the keyword popularity data from DataForSEO Trends. In addition to keyword popularity rate over the given time range, you will get location-specific keyword popularity data, and a demographic breakdown of keyword popularity per each specified term along with comparative values. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘DataForSEO Trends Subregion Interests’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/dataforseo_trends/subregion_interests/liveThis endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Keywords Data Google Ads Ad Traffic By Keywords
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/liveDataForSEO POST /v3/keywords_data/google_ads/ad_traffic_by_keywords/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Ads Traffic By Keywords’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_get/{id}<!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Ad Traffic By Keywords’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/ad_traffic_by_keywords/task_post<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Keywords For Keywords’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/liveNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Keywords For Keywords’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/task_get/{id}Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will select relevant keywords for the specified terms. Set up to 20 keywords and get the results, which are suggested by Google Ads for your query. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Keywords For Keywords’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_keywords/task_postNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide relevant keywords for the specified terms. Set up to 20 keywords in the keywords array and get keyword suggestions from Google Ads. You can get up to 20,000 keyword suggestions with all essential keyword data in response to one request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Keywords For Site’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/liveNote that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get ‘Keywords For Site’ Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/task_get/{id} Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. This endpoint will provide you with a list of keywords relevant to the specified domain along with their bids, search volumes for the last month, search volume trends for the last year (for estimating search volume dynamics), and competition levels. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting ‘Keywords For Site’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/keywords_for_site/task_post <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Live ‘Google Ads Search Volume’ Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/search_volume/live Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Search Volume Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/search_volume/task_get/{id} Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. If you’re using DataForSEO Google AdWords API, you need to upgrade to DataForSEO Google Ads API. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Keywords Data Google Ads Search Volume Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/search_volume/task_postDataForSEO POST /v3/keywords_data/google_ads/search_volume/task_post <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.09 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Google Ads Status
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_ads/status By calling this endpoint, you will know if Google updated keyword data for the previous month. Generally, Google updates keyword data in the middle of the month. So, if Google updated its data in October, you would be able to see the actual search volume, cost-per-click, competition, and other metrics for September. If Google didn’t update its data in October, the latest information would be available for August. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Trends Categories
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_trends/categoriesBy calling this API you will receive the list of categories supported by Google Trends API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available categories. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Keywords Data Google Trends Explore
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_trends/explore/liveDataForSEO POST /v3/keywords_data/google_trends/explore/live <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Keywords Data Google Trends Explore Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/keywords_data/google_trends/explore/task_get/{id}DataForSEO GET /v3/keywords_data/google_trends/explore/task_get/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Keywords Data Google Trends Explore Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/keywords_data/google_trends/explore/task_postDataForSEO POST /v3/keywords_data/google_trends/explore/task_post <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Asin Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/live/advancedDataForSEO POST /v3/merchant/amazon/asin/live/advanced <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Asin Html
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/live/htmlDataForSEO POST /v3/merchant/amazon/asin/live/html <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon ASIN Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/task_get/advanced/{id}This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon ASIN HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Amazon ASIN Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/task_post This endpoint will provide you with a full list of ASINs assigned to different modifications of a product. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon ASIN Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/asin/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Amazon Languages for Merchant API
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/languagesYou will receive the list of supported Amazon languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Amazon Locations for Merchant API
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/locationsYou will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Products Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/live/advancedDataForSEO POST /v3/merchant/amazon/products/live/advanced <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Products Html
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/live/htmlDataForSEO POST /v3/merchant/amazon/products/live/html <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Products Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Products HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Amazon Products Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/task_post This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Products Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/products/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Sellers Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/live/advancedDataForSEO POST /v3/merchant/amazon/sellers/live/advanced <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Merchant Amazon Sellers Html
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/live/htmlDataForSEO POST /v3/merchant/amazon/sellers/live/html <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Sellers Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/task_get/advanced/{id}This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Sellers HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Amazon Sellers Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/task_post This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Amazon Sellers Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/amazon/sellers/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Shopping Languages for Merchant API
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/languagesYou will receive the list of supported Google Shopping languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Shopping Locations for Merchant API
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/locations<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Product Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/product_info/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Shopping Product Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/google/product_info/task_post This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields: product_id, data_docid, or gid. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Product Info Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/product_info/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Products Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/products/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Products HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/products/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Shopping Products Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/google/products/task_post Google Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. The results include product title, description in Google Shopping SERP, product rank, price, reviews and rating as well as the related domain. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Products Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/products/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Reviews Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/reviews/task_get/advanced/{id}Buyer reviews for one Google Shopping product, from a task queued by `post_dataforseo_merchant_google_reviews_submit`: rating, text, author and date per review. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. For the product's own specification and sellers use `get_dataforseo_merchant_google_product_info_fetch`. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Shopping Reviews Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/google/reviews/task_postQueues the reviews of one Google Shopping product, returning a task `id`. Identify the product with `product_id` plus `gid` or `data_docid` from a products result. This family is asynchronous throughout: submit returns a task `id` in `tasks[0].id`, and the fetch tool returns the result once it is ready. fetching is free, and re-fetching costs nothing. Retrieve with `get_dataforseo_merchant_google_reviews_fetch`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Reviews Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/reviews/tasks_readyLists finished Google Shopping review tasks awaiting collection. Free. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. A caller that holds its own task `id` can fetch directly and skip this. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Sellers Ad URL
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/sellers/ad_urlIntended to return the full advertisement URL for a seller, with the parameters that seller attached. ⚠️ **Not usable as specified**: this spec declares no parameters for it, and calling it as written answers `status_code` 40400, `Not Found.`, with a null `tasks` array. Upstream expects identifiers this document does not describe. Withheld from the MCP server for that reason - an endpoint that always fails is worse than an absent one. Use the `check_url` on a `get_dataforseo_merchant_google_sellers_fetch` result instead. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Sellers Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/sellers/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Shopping Sellers Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/merchant/google/sellers/task_post Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Shopping Sellers Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/merchant/google/sellers/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Filters and customizable thresholds at DataForSEO OnPage API
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/available_filtersOnPage API supports plenty of customizable crawling parameters that allow you to adapt the extraction of website data to your requirements and modify the thresholds for various performance indicators. Here you will find all the necessary information about filters and thresholds that can be used with DataForSEO OnPage API endpoints. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Content Parsing
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/content_parsing This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live OnPage API Content Parsing
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/content_parsing/live This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0001 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Duplicate Content
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/duplicate_content This endpoint returns a list of pages that have content similar to the page specified in the request. The response also contains data related to page performance and the similarity index that indicates how similar the compared pages are. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Duplicate Tags
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/duplicate_tags This endpoint returns a list of pages that contain duplicate title or description tags. The response also contains data related to page performance. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Force Stop
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/force_stop This endpoint is designed to force stop the crawl process of websites you specified in a task. The execution of all the tasks associated with the IDs indicated in your request to this endpoint will be stopped. You will still be able to obtain the data on pages that have been scanned until the crawling process was stopped. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Instant Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/instant_pagesUsing this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search. for more info please visit 'https://docs.dataforseo.com/v3/on_page/instant_pages/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0051 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Density
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/keyword_density This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with this API call. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Audits in OnPage Lighthouse API
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/auditsThe OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Languages for OnPage Lighthouse API
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/languagesYou will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live OnPage Lighthouse JSON
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/live/jsonThe OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.005 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Lighthouse Results by ID
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_get/json/{id} The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. This endpoint will provide you with the results of Lighthouse Audit. Use the id received in the response of your Task POST request to get the results. The response will include data about all categories and audits specified in the Task POST. By default, the response will include all available data about the webpage including its performance, accessibility, progressive web apps, SEO, and compliance with best practices. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Lighthouse Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/task_postThe OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0051 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get OnPage Lighthouse Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Lighthouse versions supported in OnPage API
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/lighthouse/versionsOnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Links
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/links This endpoint will provide you with a list of internal and external links detected on a target website. The following link types are supported: anchor – links that point to a specific portion of a webpage; image – links that point to an image; canonical – links that point to a canonical page; meta – links with meta http-equiv=refresh ; alternate – links with link rel="alternate" pointing to an alternative version of a webpage ; redirect – links with redirect status. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Microdata
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/microdata This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation. To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Non-indexable Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/non_indexable This endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Page Screenshot
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/page_screenshot Using this endpoint, you can capture a full high-quality screenshot of any webpage. In this way, you can review the target page as the DataForSEO crawler and Googlebot see it. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0051 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Pages
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/pagesThis endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance. Using this function you will get page-specific data with detailed information on how well your pages are optimized for search. for more info please visit 'https://docs.dataforseo.com/v3/on_page/pages/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
On Page Pages By Resource
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/pages_by_resourceDataForSEO POST /v3/on_page/pages_by_resource <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Raw HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/raw_html This endpoint returns the HTML of a page you indicate in the request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
On Page Redirect Chains
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/redirect_chainsDataForSEO POST /v3/on_page/redirect_chains <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Resources
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/resources This endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements. You will get a detailed overview of every resource found on the crawled pages. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Summary
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/summary/{id} Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. As a result, you will know what functions to use for receiving detailed data for each of the found issues. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting OnPage Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/task_post OnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. It checks meta tags, duplicate content, image tags, response codes, and other parameters on every page. You can find the full list of OnPage API check-up parameters in the Pages section. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
On-Page Tasks Ready
$MeteredGET https://aisa.one/apis/v1/dataforseo/on_page/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks, which results haven’t been collected yet. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Uncrawlable Resources
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/uncrawlable_resourcesThis endpoint returns a list of resources detected on the target website that could not be crawled due to a content type inconsistency. A resource is considered uncrawlable when the content type returned in the server response does not match the content type expected based on how the resource is referenced in the page HTML. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OnPage API Waterfall
$MeteredPOST https://aisa.one/apis/v1/dataforseo/on_page/waterfall This endpoint is designed to provide you with the page speed insights. Using this function you can get detailed information about the page loading time, time to secure connection, the time it takes to load page resources, and so on. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SERP API AI Summary
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/ai_summary The purpose of the Live SERP API AI Summary endpoint is to provide a summary of the content found on any SERP and generate a response based on the user’s specified prompt. To obtain results, you have to specify task_id, which you can find in the response to the POST request. Learn more in our Help Center. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Baidu Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/languagesYou will receive the list of languages by calling this API. You can also download the full list of supported languages in the CSV format (last updated 2026-04-06). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Baidu Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Baidu Organic SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Baidu Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Baidu Organic SERP Results by id(regular)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Baidu Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/baidu/organic/task_postBaidu SERP API provides top 10 search engine results. These results are specific to the selected location (see the List of Locations) and other settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/baidu/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Bing Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Bing Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Bing Organic SERP Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/bing/organic/live/advancedLive SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Bing Organic SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/bing/organic/live/htmlLive SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Bing Organic SERP Regular
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/bing/organic/live/regularLive SERP provides real-time data on search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Bing Organic SERP Results by id(advanced)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Bing Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Bing Organic SERP Results by id(regular)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Bing Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/bing/organic/task_postSERP API provides search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/bing/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Ads Advertisers Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ads_advertisers/live/advancedReturns the advertisers matching a query in Google's ads transparency data on Google, synchronously. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: `regular` measured 4.8 KB, `advanced` 57 KB, and `html` **2.4 MB**. `advanced` is the default choice; take `regular` when only the ranked list matters and `html` only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Ads Advertisers Locations for SERP API
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_advertisers/locations As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Ads Advertisers Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_advertisers/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Ads Advertisers SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ads_advertisers/task_postGoogle Ads Advertisers provides information on advertisers that run campaigns on Google Ads based on the Ads Transparency platform. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Ads Advertisers SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_advertisers/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Ads Search Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ads_search/live/advancedReturns the ads running against a keyword on Google, synchronously. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: `regular` measured 4.8 KB, `advanced` 57 KB, and `html` **2.4 MB**. `advanced` is the default choice; take `regular` when only the ranked list matters and `html` only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Ads Search Locations for SERP API
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_search/locations<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Ads Search Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Ads Search SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ads_search/task_postGoogle Ads Search provides information on ads that are run by advertisers on Google Ads. Information is based on the Ads Transparency platform and adapted for the convenience of DataForSEO users. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Ads Search SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ads_search/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google AI Mode Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/languagesYou will receive the list of languages by calling this API. As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google AI Mode SERP
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/live/advanced Google AI Mode SERP API provides search results from the AI Mode feature of Google Search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.004 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Ai Mode SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/live/html Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google AI Mode SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Ai Mode HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google AI Mode SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/task_post Google AI Mode SERP API provides search results from the AI Mode feature of Google Search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Ai Mode SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/ai_mode/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Autocomplete Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/autocomplete/live/advanced Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Autocomplete Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Autocomplete Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/autocomplete/task_post Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. DataForSEO SERP API will provide you with all the suggestions Google Autocomplete offers for a particular keyword, the position of the cursor pointer, and the search client. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Autocomplete SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/autocomplete/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Dataset Info Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/dataset_info/live/advanced Live Google Dataset Info provides real-time data on the dataset you specify in the request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Dataset Info Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/dataset_info/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Dataset Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/dataset_info/task_post Google Dataset Info API provides detailed information about the dataset you specify in the POST request. You will get data from a page of the dataset displayed separately from the SERP. It contains information about dataset content, authors, licenses, and description on the SERP. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Dataset Info SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/dataset_info/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Dataset Search Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/dataset_search/live/advanced Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Dataset Search Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Dataset Search Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/dataset_search/task_post Google Dataset Search API provides top 20 Google Dataset search engine results. These results are specific to the indicated keyword. You can specify other parameters optionally. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Dataset Search SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/dataset_search/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Events SERP Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/events/live/advancedReturns the events Google surfaces for a query on Google, synchronously. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Measured at 57 KB for a ten-result Google query. ⚠️ Three result depths exist for the same query and differ by two orders of magnitude: `regular` measured 4.8 KB, `advanced` 57 KB, and `html` **2.4 MB**. `advanced` is the default choice; take `regular` when only the ranked list matters and `html` only to check what the parser dropped. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Events Locations for SERP API
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/events/locationsReturns the events Google surfaces for a query on Google. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Events SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/events/task_get/advanced/{id}Retrieves a queued Google events result by `id`. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Events SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/events/task_postQueues the events Google surfaces for a query on Google, returning a task `id` in `tasks[0].id`. The charge lands here; fetching is free, including re-fetching. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. The live twin answers immediately and is simpler for a single query; queue when the batch would outlast a tool call. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Events SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/events/tasks_readyLists finished Google events tasks awaiting collection. Free. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. ⚠️ Rarely needed: a caller holds the `id` its own submit returned and can fetch directly. This answers what is ready across the whole account. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Explore Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/live/advanced Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Explore SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/live/html Live SERP HTML provides raw HTML page from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Explore Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/task_get/advanced/{id} Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Explore HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Finance Explore SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/task_post Google Finance Explore API provides real-time data from the ‘Explore’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Finance Explore SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_explore/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Markets Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/live/advanced Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Markets SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/live/html Live SERP HTML provides raw HTML from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Markets Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/task_get/advanced/{id} Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Markets HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Finance Markets SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/task_post Google Finance Markets API provides real-time data from the ‘Markets’ tab of Google Finance. These results are specific to the parameters you specify in the request: location, language, and market_type. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Finance Markets SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_markets/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Quote Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/live/advanced Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Quote SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/live/html Live SERP HTML provides raw HTML from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Quote Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/task_get/advanced/{id} Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Quote HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Finance Quote SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/task_post Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. These results are specific to the parameters you specify in the request: ticker in the keyword field, location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Finance Quote SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_quote/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Finance Ticker Search Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_ticker_search/live/advanced Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Finance Ticker Search Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_ticker_search/task_get/advanced/{id} Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Finance Ticker Search Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/finance_ticker_search/task_post Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. The result is specific to the parameters you specify in the request: keyword (name of a company or financial instrument) in the keyword field, location and language. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Finance Ticker Search SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/finance_ticker_search/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Images SERP
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/images/live/advanced Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Images SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/images/live/html Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Serp Google Images Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/images/task_get/advanced/{id}DataForSEO GET /v3/serp/google/images/task_get/advanced/{id} <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Images HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/images/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Images SERP Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/images/task_get/regular/{id}Retrieves a queued Google images result by `id`, lightly parsed - measured at 4.8 KB against 57 KB for the advanced form. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Images SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/images/task_post SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Images SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/images/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Jobs Locations for SERP API
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/jobs/locationsReturns the job listings Google surfaces for a query on Google. Returns `keyword`, `type`, `se_domain`, `location_code`, `language_code`, `check_url`, `datetime`, `spell`, `refinement_chips`, `item_types`, `items_count` and `items`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Jobs Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/jobs/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Jobs HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/jobs/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Jobs Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/jobs/task_post This endpoint will provide you with SERP data from the Google Jobs search engine. The returned results are specific to the keyword as well as the language and location parameters of the POST request. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Jobs SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/jobs/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Local Finder SERP
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/live/advanced Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Local Finder SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/live/html Live Google Local Finder SERP HTML provides a raw HTML page of the search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Local Finder SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Local Finder HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Local Finder SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/task_post Google Local Finder SERP API provides top search engine results specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Local Finder SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/local_finder/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Google Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Maps SERP
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/maps/live/advanced Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Maps SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/maps/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Maps SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/maps/task_post SERP API provides top 100 search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Maps SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/maps/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google News SERP
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/news/live/advanced Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google News SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/news/live/html Live SERP HTML provides a raw HTML page of 10 search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google News SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/news/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google News HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/news/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google News SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/news/task_post SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get News SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/news/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Organic SERP Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/organic/live/advancedLive SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs. for more info please visit 'https://docs.dataforseo.com/v3/serp/google/organic/live/advanced/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0175 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Organic SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/organic/live/html Live SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Google Organic SERP Regular
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/organic/live/regularLive SERP provides real-time data on search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.008 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Organic SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Organic SERP Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/organic/task_post SERP API provides top 10 search engine results by default. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Search By Image SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/search_by_image/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Google Search By Image HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/search_by_image/task_get/html/{id}Retrieves a queued Google search by image result by `id` as raw HTML. 🔴 Measured at 2.4 MB against 57 KB parsed on the Google organic pair. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Google Search By Image SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/google/search_by_image/task_post Google Search By Image SERP API provides up to top 100 search engine results based on the image you specified. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Search By Image SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/google/search_by_image/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Naver Organic SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/naver/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Naver Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/naver/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Naver Organic SERP Results by id(regular)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/naver/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Naver Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/naver/organic/task_post Naver SERP API provides top 15 search engine results. Naver search results do not vary by location and language, and the search parameters for this search engine do not contain language and location variables. However, you can specify a keyword in any language, and the search engine results may vary depending on the language you used for specifying the search query. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/naver/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SERP API Page Screenshot
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/screenshot Using the Live Page Screenshot endpoint, you can capture a screenshot of any SERP page. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Seznam Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Seznam Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Seznam Organic SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Seznam Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Seznam Organic SERP Results by id(regular)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Seznam Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/seznam/organic/task_post Seznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Seznam is focused on the local search market, and thus supports the Czech language only. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/seznam/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Yahoo Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Yahoo Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Yahoo Organic SERP Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/live/advancedLive SERP provides real-time data on top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Yahoo Organic SERP HTML
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/live/htmlLive SERP HTML provides a raw HTML page of search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live Yahoo Organic SERP Regular
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/live/regularLive Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Yahoo Organic SERP Advanced Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Yahoo Organic HTML Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/task_get/html/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Yahoo Organic SERP Results by id(regular)
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/task_get/regular/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting Yahoo Organic SERP Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/task_post SERP API provides top search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/yahoo/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Youtube Languages for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/languagesYou will receive the list of languages by calling this API. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List of Youtube Locations for SERP
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/locationsYou will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live YouTube Organic Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/organic/live/advancedLive SERP provides real-time data on the top 20 blocks of YouTube search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/live/advanced/' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get YouTube Organic Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/organic/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting YouTube Organic Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/organic/task_postYouTube Organic API provides the top 20 blocks of search engine results. These results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/organic/task_post/' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Organic SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/organic/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live YouTube Comments Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_comments/live/advanced Live YouTube Comments provides real-time data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.004 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get YouTube Comments Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_comments/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting YouTube Comments Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_comments/task_postYouTube Comments API provides data on comments on the video you specify in the request. You will get the top 20 comments on the video as well as information about the author, and key comment metrics. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_comments/task_post/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Video Comments SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_comments/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live YouTube Video Info Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_info/live/advancedLive YouTube Video Info provides real-time data on the video you specify in the request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/live/advanced/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.006 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get YouTube Video Info Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_info/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting YouTube Video Info Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_info/task_postYouTube Video Info API provides detailed information about the video you specify in the POST request. You will get data from the watching page containing key video and content metrics as well as the channel where the video is published. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_info/task_post/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Video Info SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_info/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Live YouTube Subtitles Advanced
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_subtitles/live/advancedLive YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. You will get data from the watching page containing subtitled text, its language, and duration in the video. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/live/advanced/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get YouTube Subtitles Results by id
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_subtitles/task_get/advanced/{id}Description of the fields for sending a request: <!-- aisa-pricing:start --> Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Setting YouTube Subtitles Tasks
$MeteredPOST https://aisa.one/apis/v1/dataforseo/serp/youtube/video_subtitles/task_postYouTube Subtitles API provides data on all subtitles in the video you specify in the POST request. You will get data from the watching page containing subtitled text, its language, and duration in the video. for more info please visit 'https://docs.dataforseo.com/v3/serp/youtube/video_subtitles/task_post/?bash' <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Video Subtitles SERP Completed Tasks
$MeteredGET https://aisa.one/apis/v1/dataforseo/serp/youtube/video_subtitles/tasks_ready The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. Learn more about task completion and obtaining a list of completed tasks in this help center article. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Flight Search
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/offer-requests/createSearch flights: submit slices and passengers, returns offers <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Flight Searches
$MeteredGET https://aisa.one/apis/v1/duffel/flights/offer-requests/listList offer requests (paginated) <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Flight Search
$MeteredGET https://aisa.one/apis/v1/duffel/flights/offer-requests/{id}Retrieve a single offer request by id <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Flight Offers
$MeteredGET https://aisa.one/apis/v1/duffel/flights/offers/listList offers across searches (paginated) <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Flight Offer
$MeteredGET https://aisa.one/apis/v1/duffel/flights/offers/{id}Refresh a single offer; authoritative price before ordering <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Order Cancellation
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/order-cancellations/createFetch the refund quote for an order <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Order Cancellation
$MeteredGET https://aisa.one/apis/v1/duffel/flights/order-cancellations/{id}Retrieve an order cancellation quote <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Confirm Order Cancellation
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/order-cancellations/{id}/confirmConfirm the most recent cancellation quote <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Order Change Request
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/order-change-requests/createFetch change offers for a paid order <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Order Change Request
$MeteredGET https://aisa.one/apis/v1/duffel/flights/order-change-requests/{id}Retrieve an order change request with change offers <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Confirm Order Change
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/order-changes/createExecute a selected change offer <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $315 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Flight Order
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/orders/createBook the selected offer; response includes booking reference and documents <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $315 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Hold Flight Order
$MeteredPOST https://aisa.one/apis/v1/duffel/flights/orders/hold-createHold the selected order without paying (body type:hold) <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Flight Order
$MeteredGET https://aisa.one/apis/v1/duffel/flights/orders/{id}Retrieve an existing flight order with full details (passengers, slices, payment status, documents). <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Seat Maps
$MeteredGET https://aisa.one/apis/v1/duffel/flights/seat-mapsSeat map per segment for an offer <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Stay Booking
$MeteredPOST https://aisa.one/apis/v1/duffel/stays/bookings/createCreate Stay Booking via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $2 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Stay Bookings
$MeteredGET https://aisa.one/apis/v1/duffel/stays/bookings/listList Stay Bookings via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Stay Booking
$MeteredGET https://aisa.one/apis/v1/duffel/stays/bookings/{id}Get Stay Booking via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Cancel Stay Booking
$MeteredPOST https://aisa.one/apis/v1/duffel/stays/bookings/{id}/cancelCancel Stay Booking via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Loyalty Programmes
$MeteredGET https://aisa.one/apis/v1/duffel/stays/loyalty-programmes/listList Loyalty Programmes via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Stay Quote
$MeteredPOST https://aisa.one/apis/v1/duffel/stays/quotes/createCreate Stay Quote via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Stay Quote
$MeteredGET https://aisa.one/apis/v1/duffel/stays/quotes/{id}Get Stay Quote via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Stay Search Result
$MeteredGET https://aisa.one/apis/v1/duffel/stays/search-results/{id}Get Stay Search Result via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Stay Search Result Rates
$MeteredGET https://aisa.one/apis/v1/duffel/stays/search-results/{id}/ratesList Stay Search Result Rates via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Stay Search
$MeteredPOST https://aisa.one/apis/v1/duffel/stays/search/createCreate Stay Search via the Duffel Stays API <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
eBay Search API -test
$MeteredGET https://aisa.one/apis/v1/ebay/search<!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Document List API
$MeteredGET https://aisa.one/apis/v1/edinet/documents.json{"methods":[{"methodType":"GET","methodDesc":"Query the EDINET filing list for a given file date. Returns metadata only when type=1, or metadata plus filing results when type=2.","requestParams":[{"paramName":"date","paramType":"query","required":true,"desc":"File date in YYYY-MM-DD format."},{"paramName":"type","paramType":"query","desc":"Response mode: 1 for metadata only, 2 for metadata plus filing list. Defaults to 1 when omitted."},{"paramName":"Subscription-Key","paramType":"query","required":true,"desc":"EDINET API key passed as a query parameter."}],"responseParams":[{"paramName":"metadata","desc":"Metadata object with title, request parameter echo, result count, processDateTime, status, and message."},{"paramName":"results","desc":"Array of filing document objects when type=2, including fields such as seqNumber, docID, filerName, docTypeCode, submitDateTime, and file availability flags."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Document Download API
$MeteredGET https://aisa.one/apis/v1/edinet/documents/{docID}{"methods":[{"methodType":"GET","methodDesc":"Download a specific EDINET document by docID. The returned file type is selected by the type query parameter and the actual success payload must be interpreted from Content-Type.","requestParams":[{"paramName":"docID","paramType":"path","required":true,"desc":"Document management identifier from the document list API, for example S1234567."},{"paramName":"type","paramType":"query","required":true,"desc":"File type to download: 1 for filing body and audit report ZIP, 2 for PDF, 3 for alternate document and attachments ZIP, 4 for English document ZIP, 5 for CSV ZIP converted from XBRL."},{"paramName":"Subscription-Key","paramType":"query","required":true,"desc":"EDINET API key passed as a query parameter."}],"responseParams":[{"paramName":"Content-Type","desc":"Response MIME type. application/octet-stream indicates ZIP, application/pdf indicates PDF, and application/json; charset=utf-8 indicates an error JSON response."},{"paramName":"content","desc":"Binary ZIP or PDF file content on success."},{"paramName":"message","desc":"Error message when the response body is JSON."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exa Agent Runs list
$MeteredGET https://aisa.one/apis/v1/exa/agent/runsOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exa Agent Runs submit
$MeteredPOST https://aisa.one/apis/v1/exa/agent/runsOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> Default request estimate: $0.1 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exa Agent Runs detail
$MeteredGET https://aisa.one/apis/v1/exa/agent/runs/{jobId}Owner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Exa Agent Runs cancel
$MeteredPOST https://aisa.one/apis/v1/exa/agent/runs/{jobId}/cancelOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Answer
$MeteredPOST https://aisa.one/apis/v1/exa/answerAsk a question and get a written answer with citations. `query` is required; `text` includes the source text and `outputSchema` shapes a structured reply. Returns `requestId`, `answer` as prose, `citations[]` with `id`, `title` and `url`, and `costDollars`. Measured at 2.1 seconds with 8 citations. Use current endpoint pricing and a fresh quote for this request. It sits between a search and a research run: faster and cheaper than `post_exa_agent_runs`, and more direct than reading `post_exa_search` results yourself. Reach for Exa when the retrieval needs to be semantic; compare current quotes when choosing a provider. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.005 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Contents
$MeteredPOST https://aisa.one/apis/v1/exa/contentsFetch page text and metadata for URLs you already have. `ids` is required and takes the `id` values from `post_exa_search` — which are plain URLs, so any URL works. Toggle `text`, `highlights`, `summary`, `subpages` and `livecrawl`. Returns `results[]` with `id`, `title`, `url`, `author` and `text`, plus a **`statuses[]` array giving per-URL `status` and `source`** — read it, because a URL that could not be fetched is reported there rather than raising. Cached results are served instantly; a miss falls back to a live crawl. Measured at 1.2 seconds. Use current endpoint pricing and a fresh quote for this request. For a whole site rather than a URL list, `post_firecrawl_crawl`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search
$MeteredPOST https://aisa.one/apis/v1/exa/searchSearch the web by meaning rather than by keyword. `query` is required; narrow with `category`, `includeDomains`, `excludeDomains`, `startPublishedDate`, `endPublishedDate`, and set `numResults`. Returns `requestId`, `resolvedSearchType`, `searchTime`, `costDollars` and `results[]` with `id`, `title` and `url`. **`id` is the URL**, and it is what `post_exa_contents` takes. Measured at 1.4 seconds — the fastest search here. Use current endpoint pricing and a fresh quote for this request. ⚠️ Results carry **no page text** unless you ask: pass `contents`, or follow up with `post_exa_contents`. Choose it over `post_tavily_search` when the query is a description rather than keywords; choose Tavily when you want the text in the same call, and `post_exa_answer` when you want a written answer rather than a list. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.017 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Analyst Estimates
$MeteredGET https://aisa.one/apis/v1/financial/analyst-estimates<!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Company Facts
$MeteredGET https://aisa.one/apis/v1/financial/company/factsGet company facts for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Company Facts
$MeteredGET https://aisa.one/apis/v1/financial/company/facts/tickerGet company facts for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Earnings Data
$MeteredGET https://aisa.one/apis/v1/financial/earningsGet the most recent earnings snapshot for a ticker. Optional change fields are returned only when available. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Company SEC Filings
$MeteredGET https://aisa.one/apis/v1/financial/filingsGet SEC filings for a company. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get SEC Filing Items
$MeteredGET https://aisa.one/apis/v1/financial/filings/itemsGet the raw text Items from an SEC filing. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Financial Metrics
$MeteredGET https://aisa.one/apis/v1/financial/financial-metricsGet financial metrics for a ticker, including valuation, profitability, efficiency, liquidity, leverage, growth, and per share metrics. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Financial Metrics Snapshot
$MeteredGET https://aisa.one/apis/v1/financial/financial-metrics/snapshotGet the real-time financial metrics snapshot for a stock, including valuation ratios, profitability, efficiency, liquidity, leverage, growth, and per share metrics. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Financial Statements
$MeteredGET https://aisa.one/apis/v1/financial/financialsGet all financial statements for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Balance Sheets
$MeteredGET https://aisa.one/apis/v1/financial/financials/balance-sheetsGet balance sheets for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Cash Flow Statements
$MeteredGET https://aisa.one/apis/v1/financial/financials/cash-flow-statementsGet cash flow statements for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Income Statements
$MeteredGET https://aisa.one/apis/v1/financial/financials/income-statementsGet income statements for a ticker. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Financial Line Items
$MeteredPOST https://aisa.one/apis/v1/financial/financials/search/line-itemsSearch for specific financial metrics across income statements, balance sheets, and cash flow statements for a list of tickers. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Stock Financials
$MeteredPOST https://aisa.one/apis/v1/financial/financials/search/screenerSearch for stocks by filtering across financial metrics from income statements, balance sheets, and cash flow statements. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Insider Trades
$MeteredGET https://aisa.one/apis/v1/financial/insider-tradesGet insider trades like buys and sells for a ticker by a company insider. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Guidance
$MeteredGET https://aisa.one/apis/v1/financial/kpi/guidanceGet structured forward guidance from earnings releases. Returns ranges, point estimates, and directional signals. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Metrics
$MeteredGET https://aisa.one/apis/v1/financial/kpi/metricsGet sector-specific operational KPIs for a ticker. Includes metrics like load factor, CET1 ratio, same-store sales, FFO per share, and more. Sourced from SEC 8-K earnings releases. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Non-GAAP Metrics
$MeteredGET https://aisa.one/apis/v1/financial/kpi/non-gaapGet non-GAAP financial metrics with GAAP equivalents and key adjustments. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Historical Interest Rates
$MeteredGET https://aisa.one/apis/v1/financial/macro/interest-ratesThe daily policy rate of one central bank: one row per calendar day, newest first, 10 rows per page. A rate change appears on the first day the new rate is in effect. For the Federal Reserve the rate is the midpoint of the target range. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Latest Interest Rates
$MeteredGET https://aisa.one/apis/v1/financial/macro/interest-rates/snapshotThe newest published policy rate of every central bank we cover, one row per bank with the date it is in effect. Pass bank to get one bank only. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Company News
$MeteredGET https://aisa.one/apis/v1/financial/newsGet recent news articles for a specific company or the broad market. Pass a ticker for company-specific news, or omit the ticker for general market news. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Historical Stock Prices
$MeteredGET https://aisa.one/apis/v1/financial/pricesGet end-of-day (EOD) historical price data for stocks. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Stock Price Snapshot
$MeteredGET https://aisa.one/apis/v1/financial/prices/snapshotGet the real-time price snapshot for a stock, including the current price, day change, and day change percent. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Batch Scrape list
$MeteredGET https://aisa.one/apis/v1/firecrawl/batch-scrapeOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Batch Scrape submit
$MeteredPOST https://aisa.one/apis/v1/firecrawl/batch-scrapeOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Batch Scrape detail
$MeteredGET https://aisa.one/apis/v1/firecrawl/batch-scrape/{jobId}Owner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Batch Scrape cancel
$MeteredPOST https://aisa.one/apis/v1/firecrawl/batch-scrape/{jobId}/cancelOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Crawl list
$MeteredGET https://aisa.one/apis/v1/firecrawl/crawlOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Crawl submit
$MeteredPOST https://aisa.one/apis/v1/firecrawl/crawlOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Crawl detail
$MeteredGET https://aisa.one/apis/v1/firecrawl/crawl/{jobId}Owner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Crawl cancel
$MeteredPOST https://aisa.one/apis/v1/firecrawl/crawl/{jobId}/cancelOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Map
$MeteredPOST https://aisa.one/apis/v1/firecrawl/map<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.001071 USD (not a fixed price). Declared unit rate: $0.001071 USD per firecrawl_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Parse
$MeteredPOST https://aisa.one/apis/v1/firecrawl/parse<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.001071 USD (not a fixed price). Declared unit rate: $0.001071 USD per firecrawl_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Scrape
$MeteredPOST https://aisa.one/apis/v1/firecrawl/scrape<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.001071 USD (not a fixed price). Declared unit rate: $0.001071 USD per firecrawl_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Firecrawl Search
$MeteredPOST https://aisa.one/apis/v1/firecrawl/search<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.002142 USD (not a fixed price). Declared unit rate: $0.001071 USD per firecrawl_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Brand Analytics
$MeteredGET https://aisa.one/apis/v1/foreplay/brand/analyticsGet analytics for a brand (running-ads distribution, creative velocity) as a series of analytics rows. A successful call returns **one row per day** (`date`, `active_count`, `inactive_count`, and per-format counts). **Important:** the `id` parameter must be a page_id / `ad_library_id` (obtained from the `getBrandsByDomain` response), NOT a Foreplay `brand_id`. Passing a `brand_id` returns HTTP 406. Flow: `getBrandsByDomain(domain)` -> `ad_library_id` -> `brand/analytics(id=ad_library_id)`. **Date window:** the window between `start_date` and `end_date` must be ≤ 30 days. A larger range returns HTTP 406 `Date range too large`. **Cost estimation:** each returned row is 1 billed item . Because the response is one row per day, a 30-day window can bill up to ~30 items. empty results and 4xx/5xx errors are not charged. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.875 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Ads By Brand Id
$MeteredGET https://aisa.one/apis/v1/foreplay/brand/getAdsByBrandIdRetrieve ads for one or more Foreplay brand IDs, applying the supplied filters. Each result in `data[]` is a full ad object. **Accepts `brand_ids` only.** `page_id` lookup is NOT supported on the AIsa gateway — resolve a domain to its `ad_library_id` / brand id via `getBrandsByDomain` first. Passing a page id in `brand_ids` returns HTTP 200 with `count: 0` (silently treated as an unknown brand). This is intentional P0 scoping, documented as a known limitation. empty results and 4xx/5xx errors are not charged. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.875 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Brands By Domain
$MeteredGET https://aisa.one/apis/v1/foreplay/brand/getBrandsByDomainDiscover brands that advertise from a given domain. Returns brand records including the Foreplay `brand_id` and the `ad_library_id` (page_id). Use the returned `ad_library_id` as the `id` input to `brand/analytics`. empty results and 4xx/5xx errors are not charged. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.875 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Discovery Ads
$MeteredGET https://aisa.one/apis/v1/foreplay/discovery/adsSearch across the Foreplay ad index (100M+ ads) with a text query plus filters. Each result in `data[]` is a full ad object (image/video URLs, transcription, brand metadata, targeting, and more). empty results and 4xx/5xx errors are not charged. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.875 USD (not a fixed price). Declared unit rate: $0 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
category
$MeteredGET https://aisa.one/apis/v1/fred/categoryGet a category. <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Category Children
$MeteredGET https://aisa.one/apis/v1/fred/category/children{"methods":[{"methodType":"GET","methodDesc":"Get the child categories for a specified parent category.","requestParams":[{"name":"category_id","type":"integer","required":false,"description":"The id for a category. Default: 0 (root category)."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: today's date."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: today's date."}],"responseParams":[{"name":"categories","type":"array","description":"Array of category objects with id, name, parent_id."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Category Related
$MeteredGET https://aisa.one/apis/v1/fred/category/related{"methods":[{"methodType":"GET","methodDesc":"Get the related categories for a category. A related category is a one-way relation between 2 categories that is not part of a parent-child category hierarchy.","requestParams":[{"name":"category_id","type":"integer","required":true,"description":"The id for a category."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: today's date."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: today's date."}],"responseParams":[{"name":"categories","type":"array","description":"Array of related category objects with id, name, parent_id."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Category Related Tags
$MeteredGET https://aisa.one/apis/v1/fred/category/related_tags{"methods":[{"methodType":"GET","methodDesc":"Get the related FRED tags for one or more FRED tags within a category.","requestParams":[{"name":"category_id","type":"integer","required":true,"description":"The id for a category."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":true,"description":"Semicolon delimited list of tag names that series match all of."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of related tag objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Category Series
$MeteredGET https://aisa.one/apis/v1/fred/category/series{"methods":[{"methodType":"GET","methodDesc":"Get the series in a category.","requestParams":[{"name":"category_id","type":"integer","required":true,"description":"The id for a category."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"filter_variable","type":"string","required":false,"description":"The attribute to filter results by. One of: frequency, units, seasonal_adjustment."},{"name":"filter_value","type":"string","required":false,"description":"The value of the filter_variable attribute to filter by."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to filter by."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"Tag group id to filter by. One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching series."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Offset. Default: 0."},{"name":"order_by","type":"string","required":false,"description":"Order by: series_id, title, units, frequency, seasonal_adjustment, popularity, observation_start, observation_end, last_updated. Default: series_id."},{"name":"sort_order","type":"string","required":false,"description":"Sort order: asc or desc. Default: asc."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Category Tags
$MeteredGET https://aisa.one/apis/v1/fred/category/tags{"methods":[{"methodType":"GET","methodDesc":"Get the FRED tags for a category. Optionally filter by tag name, tag group, or search.","requestParams":[{"name":"category_id","type":"integer","required":true,"description":"The id for a category."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to include."},{"name":"tag_group_id","type":"string","required":false,"description":"Tag group id. One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of tag objects with name, group_id, notes, created, popularity, series_count."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Related Tags
$MeteredGET https://aisa.one/apis/v1/fred/related_tags{"methods":[{"methodType":"GET","methodDesc":"Get the related FRED tags for one or more FRED tags.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":true,"description":"Semicolon delimited list of tag names that series match all of."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of related tag objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release
$MeteredGET https://aisa.one/apis/v1/fred/release{"methods":[{"methodType":"GET","methodDesc":"Get a release of economic data.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"releases","type":"array","description":"Array of release objects with id, name, link, press_release."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Dates
$MeteredGET https://aisa.one/apis/v1/fred/release/dates{"methods":[{"methodType":"GET","methodDesc":"Get release dates for a release of economic data.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 1776-07-04."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-10000, default: 10000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."},{"name":"include_release_dates_with_no_data","type":"string","required":false,"description":"true or false. Default: false."}],"responseParams":[{"name":"release_dates","type":"array","description":"Array of release_date objects with release_id, date."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Related Tags
$MeteredGET https://aisa.one/apis/v1/fred/release/related_tags{"methods":[{"methodType":"GET","methodDesc":"Get the related FRED tags for one or more FRED tags within a release.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":true,"description":"Semicolon delimited list of tag names that series match all of."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of related tag objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Series
$MeteredGET https://aisa.one/apis/v1/fred/release/series{"methods":[{"methodType":"GET","methodDesc":"Get the series on a release of economic data.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_id, title, units, frequency, seasonal_adjustment, popularity, observation_start, observation_end, last_updated. Default: series_id."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."},{"name":"filter_variable","type":"string","required":false,"description":"Filter by: frequency, units, seasonal_adjustment."},{"name":"filter_value","type":"string","required":false,"description":"Value of the filter_variable."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to filter by."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to exclude."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching series."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Sources
$MeteredGET https://aisa.one/apis/v1/fred/release/sources{"methods":[{"methodType":"GET","methodDesc":"Get the sources for a release of economic data.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"sources","type":"array","description":"Array of source objects with id, name, link."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Tables
$MeteredGET https://aisa.one/apis/v1/fred/release/tables{"methods":[{"methodType":"GET","methodDesc":"Get release table trees for a given release. Supports drill-down via element_id.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"element_id","type":"integer","required":false,"description":"The release table element id to retrieve. When not passed, the root element is returned."},{"name":"include_observation_values","type":"string","required":false,"description":"true or false. Default: false. Include observation value and date for series type elements."},{"name":"observation_date","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."}],"responseParams":[{"name":"elements","type":"object","description":"Tree structure of release table elements with element_id, series_id, parent_id, name, level, children."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Release Tags
$MeteredGET https://aisa.one/apis/v1/fred/release/tags{"methods":[{"methodType":"GET","methodDesc":"Get the FRED tags for a release. Optionally filter by tag name, tag group, or search.","requestParams":[{"name":"release_id","type":"integer","required":true,"description":"The id for a release."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to include."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of tag objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Releases
$MeteredGET https://aisa.one/apis/v1/fred/releases{"methods":[{"methodType":"GET","methodDesc":"Get all releases of economic data.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"releases","type":"array","description":"Array of release objects with id, name, link, press_release, realtime_start, realtime_end."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Releases Dates
$MeteredGET https://aisa.one/apis/v1/fred/releases/dates{"methods":[{"methodType":"GET","methodDesc":"Get release dates for all releases of economic data.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: first day of current year."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: release_date, release_id, release_name. Default: release_date."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: desc."},{"name":"include_release_dates_with_no_data","type":"string","required":false,"description":"true or false. Default: false."}],"responseParams":[{"name":"release_dates","type":"array","description":"Array of release_date objects with release_id, release_name, date."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series
$MeteredGET https://aisa.one/apis/v1/fred/series{"methods":[{"methodType":"GET","methodDesc":"Get an economic data series.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects with id, title, observation_start, observation_end, frequency, units, seasonal_adjustment, last_updated, popularity, notes."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Categories
$MeteredGET https://aisa.one/apis/v1/fred/series/categories{"methods":[{"methodType":"GET","methodDesc":"Get the categories for an economic data series.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"categories","type":"array","description":"Array of category objects with id, name, parent_id."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Observations
$MeteredGET https://aisa.one/apis/v1/fred/series/observations{"methods":[{"methodType":"GET","methodDesc":"Get the observations or data values for an economic data series.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: today."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-100000, default: 100000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."},{"name":"observation_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"observation_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"units","type":"string","required":false,"description":"Results in specific units: pc1, pca, pch, pcha, pcda, pcla, log."},{"name":"frequency","type":"string","required":false,"description":"Frequency to convert values: d, w, bw, m, q, sa, a."},{"name":"aggregation_method","type":"string","required":false,"description":"avg, sum, eop. Default: eop."},{"name":"output_type","type":"integer","required":false,"description":"1-4. Observations by real-time period."}],"responseParams":[{"name":"observations","type":"array","description":"Array of observation objects with date, value, realtime_start, realtime_end."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Release
$MeteredGET https://aisa.one/apis/v1/fred/series/release{"methods":[{"methodType":"GET","methodDesc":"Get the release for an economic data series.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"releases","type":"array","description":"Array of release objects with id, name, link, press_release."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Series
$MeteredGET https://aisa.one/apis/v1/fred/series/search{"methods":[{"methodType":"GET","methodDesc":"Get economic data series that match keywords.","requestParams":[{"name":"search_text","type":"string","required":true,"description":"The words to match against economic data series."},{"name":"search_type","type":"string","required":false,"description":"full_text or series_id. Default: full_text."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: search_rank, series_id, title, units, frequency, seasonal_adjustment, popularity, observation_start, observation_end, last_updated. Default: search_rank."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: desc."},{"name":"filter_variable","type":"string","required":false,"description":"Filter by: frequency, units, seasonal_adjustment."},{"name":"filter_value","type":"string","required":false,"description":"Value of the filter_variable."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to filter by."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to exclude."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects matching search."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Series Related Tags
$MeteredGET https://aisa.one/apis/v1/fred/series/search/related_tags{"methods":[{"methodType":"GET","methodDesc":"Get the related FRED tags for one or more FRED tags matching a series search.","requestParams":[{"name":"series_search_text","type":"string","required":true,"description":"Words to match against economic data series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":true,"description":"Semicolon delimited tag names that series match all of."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"tag_search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of related tag objects."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Series Tags
$MeteredGET https://aisa.one/apis/v1/fred/series/search/tags{"methods":[{"methodType":"GET","methodDesc":"Get the FRED tags for a series search.","requestParams":[{"name":"series_search_text","type":"string","required":true,"description":"Words to match against economic data series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to include."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"tag_search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of tag objects for matched series."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Tags
$MeteredGET https://aisa.one/apis/v1/fred/series/tags{"methods":[{"methodType":"GET","methodDesc":"Get the FRED tags for a series.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of tag objects for the series."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Updates
$MeteredGET https://aisa.one/apis/v1/fred/series/updates{"methods":[{"methodType":"GET","methodDesc":"Get economic data series sorted by when observations were updated on the FRED server.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-100, default: 100."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"filter_value","type":"string","required":false,"description":"Deprecated. Use filter_variable and filter_value instead."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to filter by."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited tag names to exclude."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects sorted by update time."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Series Vintage Dates
$MeteredGET https://aisa.one/apis/v1/fred/series/vintagedates{"methods":[{"methodType":"GET","methodDesc":"Get the dates in history when a series data values were revised or new data values were released.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The id for a series."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 1776-07-04."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Default: 9999-12-31."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-10000, default: 10000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"vintage_dates","type":"array","description":"Array of vintage date strings (YYYY-MM-DD)."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Source
$MeteredGET https://aisa.one/apis/v1/fred/source{"methods":[{"methodType":"GET","methodDesc":"Get a source of economic data.","requestParams":[{"name":"source_id","type":"integer","required":true,"description":"The id for a source."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"sources","type":"array","description":"Array of source objects with id, name, link."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Source Releases
$MeteredGET https://aisa.one/apis/v1/fred/source/releases{"methods":[{"methodType":"GET","methodDesc":"Get the releases for a source.","requestParams":[{"name":"source_id","type":"integer","required":true,"description":"The id for a source."},{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"releases","type":"array","description":"Array of release objects for the source."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Sources
$MeteredGET https://aisa.one/apis/v1/fred/sources{"methods":[{"methodType":"GET","methodDesc":"Get all sources of economic data.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."}],"responseParams":[{"name":"sources","type":"array","description":"Array of source objects with id, name, link."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tags
$MeteredGET https://aisa.one/apis/v1/fred/tags{"methods":[{"methodType":"GET","methodDesc":"Get FRED tags. Optionally filter by tag name, tag group, or search.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to include."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src, cc."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching tags."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_count, popularity, created, name, group_id. Default: series_count."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"tags","type":"array","description":"Array of tag objects with name, group_id, notes, created, popularity, series_count."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tags Series
$MeteredGET https://aisa.one/apis/v1/fred/tags/series{"methods":[{"methodType":"GET","methodDesc":"Get the series matching all tags, no excluded tags, and matching search text.","requestParams":[{"name":"realtime_start","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"realtime_end","type":"string","required":false,"description":"YYYY-MM-DD formatted string."},{"name":"tag_names","type":"string","required":true,"description":"Semicolon delimited list of tag names that series match all of."},{"name":"exclude_tag_names","type":"string","required":false,"description":"Semicolon delimited list of tag names to exclude."},{"name":"tag_group_id","type":"string","required":false,"description":"One of: freq, gen, geo, geot, rls, seas, src."},{"name":"search_text","type":"string","required":false,"description":"Words to find matching series."},{"name":"limit","type":"integer","required":false,"description":"Max results. 1-1000, default: 1000."},{"name":"offset","type":"integer","required":false,"description":"Default: 0."},{"name":"order_by","type":"string","required":false,"description":"One of: series_id, title, units, frequency, seasonal_adjustment, popularity, observation_start, observation_end, last_updated. Default: series_id."},{"name":"sort_order","type":"string","required":false,"description":"asc or desc. Default: asc."}],"responseParams":[{"name":"seriess","type":"array","description":"Array of series objects matching the tags."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
GeoFRED Regional Data
$MeteredGET https://aisa.one/apis/v1/geofred/regional/data{"methods":[{"methodType":"GET","methodDesc":"Returns a cross section of regional data for a series group.","requestParams":[{"name":"series_group","type":"string","required":true,"description":"The ID for a group of series in FRED."},{"name":"region_type","type":"string","required":true,"description":"The region type. One of: bea, msa, frb, necta, state, country, county, censusregion."},{"name":"date","type":"string","required":true,"description":"YYYY-MM-DD formatted string. The date to pull data from."},{"name":"start_date","type":"string","required":false,"description":"YYYY-MM-DD formatted string. Start date for a data range."},{"name":"season","type":"string","required":true,"description":"Seasonality. One of: SA, NSA, SSA, SAAR, NSAAR."},{"name":"units","type":"string","required":true,"description":"Units of the series."},{"name":"transformation","type":"string","required":false,"description":"Data transformation. One of: lin, chg, ch1, pch, pc1, pca, cch, cca, log. Default: lin."},{"name":"frequency","type":"string","required":true,"description":"Frequency: d, w, bw, m, q, sa, a, wef, weth, wew, wetu, wem, wesu, wesa, bwew, bwem."},{"name":"aggregation_method","type":"string","required":false,"description":"Aggregation method. One of: avg, sum, eop. Default: avg."}],"responseParams":[{"name":"series_data","type":"object","description":"Object with title, region, seasonality, units, frequency, and observations array (date, region, code, value, series_id)."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
GeoFRED Series Data
$MeteredGET https://aisa.one/apis/v1/geofred/series/data{"methods":[{"methodType":"GET","methodDesc":"Returns a cross section of regional data for a specified release date. If no date is specified, the most recent data available are returned.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The FRED series_id to request maps data for."},{"name":"date","type":"string","required":false,"description":"YYYY-MM-DD formatted string. The date to request data from."},{"name":"start_date","type":"string","required":false,"description":"YYYY-MM-DD formatted string. The start date to pull a range of data."}],"responseParams":[{"name":"series_data","type":"object","description":"Object with title, region, seasonality, units, frequency, and observations array (date, region, code, value, series_id)."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
GeoFRED Series Group
$MeteredGET https://aisa.one/apis/v1/geofred/series/group{"methods":[{"methodType":"GET","methodDesc":"Returns the meta information needed to make requests for FRED map data. Includes min/max date and data range.","requestParams":[{"name":"series_id","type":"string","required":true,"description":"The FRED series id to request maps meta information for. Not all series have geographical data."}],"responseParams":[{"name":"series_group","type":"object","description":"Object with title, region_type, series_group, season, units, frequency, min_date, max_date."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
GeoFRED Shape Files
$MeteredGET https://aisa.one/apis/v1/geofred/shapes/file{"methods":[{"methodType":"GET","methodDesc":"Returns shape files from FRED in GeoJSON format.","requestParams":[{"name":"shape","type":"string","required":true,"description":"The type of shape to pull GeoJSON data for. One of: bea, msa, frb, necta, state, country, county, censusregion, censusdivision."}],"responseParams":[{"name":"type","type":"string","description":"GeoJSON type, e.g. FeatureCollection."},{"name":"features","type":"array","description":"Array of GeoJSON Feature objects with geometry and properties."}]}]} <!-- aisa-pricing:start --> Published reference price: $0.00001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
basic-profile
$MeteredGET https://aisa.one/apis/v1/instagram/basic-profileReturns a compact public profile for a numeric Instagram user id, about 4 KB against the 380 KB of get_instagram_profile. Flat, already-normalised fields: username, full_name, biography, follower_count, following_count, is_verified, is_private, category, profile_pic_url, hd_profile_pic_url_info, bio_links, external_url and pk. Prefer this endpoint whenever the id is in hand; obtain it from data.user.id in get_instagram_profile, from id in get_instagram_search_profiles, or from the owner of any post. Use get_instagram_profile only when a handle is all that is available. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
transcript
$MeteredGET https://aisa.one/apis/v1/instagram/media/transcriptTranscribes the speech in a public Instagram video or reel and returns transcripts, each with id, shortcode and the transcribed text. The target must be a video under two minutes long: a photo post returns 400 bad_request, so when the URL's type is unknown check is_video with get_instagram_post first. Measured at 13 seconds, the slowest call in this API, for about 1 KB back. For the caption the author wrote rather than the words spoken in the video, read edge_media_to_caption from get_instagram_post. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
post
$MeteredGET https://aisa.one/apis/v1/instagram/postReturns full metadata for one public post or reel identified by its URL, under data.xdt_shortcode_media: shortcode, is_video, video_url, video_duration, has_audio, display_url, dimensions, accessibility_caption, edge_media_to_caption for the caption text, and owner. Measured at about 197 KB. Setting download_media=true also mirrors the media to permanent storage and costs ten credits rather than one, so leave it off unless the files are needed. For the comment thread call get_instagram_post_comments with the same URL, and for the spoken words in a video call get_instagram_media_transcript. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
comments
$MeteredGET https://aisa.one/apis/v1/instagram/post/commentsReturns the comments on a public post or reel by URL in an already-normalised shape: comments, each with id, text, comment_like_count, child_comment_count, created_at and a nested user, plus cursor to page. Measured at about 10 KB, one of the few small responses in this API. Only top-level comments are returned; child_comment_count reports how many replies a comment has but the replies themselves are not included, and there is no endpoint that expands them. For the post itself, its caption, view counts and video URL, call get_instagram_post with the same URL. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
profile
$MeteredGET https://aisa.one/apis/v1/instagram/profileReturns the full public profile for an Instagram handle, forwarded from Instagram's own web API. Counts sit under data.user.edge_followed_by.count and data.user.edge_follow.count, alongside biography, bio_links, external_url, full_name, is_verified, is_private, highlight_reel_count, the numeric id, and the twelve most recent posts under data.user.edge_owner_to_timeline_media.edges. Measured at about 380 KB; trim=true saves under one percent, so do not rely on it to shrink the payload. When the numeric id is already known, get_instagram_basic_profile returns the same headline numbers in about 4 KB. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search
$MeteredGET https://aisa.one/apis/v1/instagram/reels/searchSearches reels by keyword through Google rather than Instagram's login-gated search, returning reels with shortcode, url, caption, video_url, video_duration, video_play_count, video_view_count, like_count, comment_count, owner, location and taken_at, plus next_page. Because the index is Google's, coverage is what Google has indexed publicly, not everything on Instagram, and date_posted narrows to a relative window. Measured at about 87 KB and 8 seconds, with all four engagement counts populated. Use get_instagram_search_hashtag to search a specific hashtag, and get_instagram_reels_trending for what is popular right now with no query at all. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reels-trending
$MeteredGET https://aisa.one/apis/v1/instagram/reels/trendingReturns the reels Instagram publishes on its public instagram.com/reels page, in a normalised shape: reels, each with shortcode, url, caption, like_count, comment_count, video_url, image_url, media_type, taken_at and the owning user. Instagram serves a small batch at a time and successive batches overlap, so call repeatedly and de-duplicate on shortcode. Measured at 30 reels and about 411 KB, where play_count and ig_play_count came back null on every item, unlike get_instagram_reels_search which populates them. Takes no parameters and cannot be filtered; to search by topic use get_instagram_reels_search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search-hashtag
$MeteredGET https://aisa.one/apis/v1/instagram/search/hashtagFinds public posts carrying a hashtag through Google, returning hashtag, media_type, cursor and posts in the same normalised shape as get_instagram_reels_search: shortcode, url, caption, like_count, comment_count, video_play_count, video_view_count, owner, location and taken_at. The leading # is optional. Set media_type=reels to narrow to reels, or all for posts and reels together. Note that cursor here is the next Google results page number rather than an Instagram cursor. Measured at about 78 KB for ten posts. To search caption keywords rather than a hashtag, use get_instagram_reels_search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search-profiles
$MeteredGET https://aisa.one/apis/v1/instagram/search/profilesSearches Google for public Instagram profiles matching a keyword or bio phrase and returns profiles with username, full_name, biography, follower_count, following_count, media_count, is_verified, is_private, category_name, external_url, bio_links, url, the numeric id, and matched_from, which records whether the hit came from a profile page or from a post. google_title and google_description carry the underlying search result. Measured at about 18 KB and 13 seconds. The numeric id feeds get_instagram_basic_profile directly. To search posts rather than people, use get_instagram_search_hashtag or get_instagram_reels_search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reels
$MeteredGET https://aisa.one/apis/v1/instagram/song/reelsReturns the reels that use one audio track, as raw Instagram media objects under reels, with cursor and has_more for paging. There are two confirmed ways to obtain audio_id: the number in an instagram.com/reels/audio/<id>/ URL, and clips_metadata.original_sound_info.audio_asset_id on any reel returned by get_instagram_user_reels. Measured at about 177 KB for five reels, in the same raw shape as get_instagram_user_reels rather than the normalised shape of the search endpoints. To find reels by keyword instead of by sound, use get_instagram_reels_search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
embed
$MeteredGET https://aisa.one/apis/v1/instagram/user/embedReturns Instagram's official profile embed widget for a handle as a single html string, ready to drop into a web page. Measured at about 206 KB, nearly all of it inlined markup and styling, so treat the result as something to store or render rather than something to read. It carries no structured profile data at all: for follower counts, biography or bio links use get_instagram_basic_profile when the numeric id is known, or get_instagram_profile when only the handle is. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
detail
$MeteredGET https://aisa.one/apis/v1/instagram/user/highlight/detailReturns the stories inside one highlight album: reel_type, latest_reel_media, the owning user, and items, each a raw Instagram story media object. Pass the bare numeric id from get_instagram_user_highlights. The response echoes that id back in the prefixed form highlight:<id>, and feeding the prefixed form to this endpoint returns 404 with a message blaming deletion or a private account, which points at the wrong cause; send the bare number. Measured at 630 KB for an album of 38 stories, so size scales with the album. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
highlights
$MeteredGET https://aisa.one/apis/v1/instagram/user/highlightsLists the story highlight albums on a public profile. Returns highlights, each with the numeric id, title, cover_media.thumbnail_src, cover_media_cropped_thumbnail and owner. Small and quick at about 6 KB, which makes it a cheap way to see whether an account keeps highlights at all. This is the only source of a highlight id, and get_instagram_user_highlight_detail requires the bare numeric id exactly as returned here. Pass user_id rather than handle for a faster response. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
posts
$MeteredGET https://aisa.one/apis/v1/instagram/user/postsReturns one page of a public account's timeline, reels and photos and carousels alike, as raw Instagram media objects under items. Page with next_max_id and stop on more_available; num_results reports the page size. Each item carries media_type, code, caption, like_count, comment_count, taken_at, image_versions2 and video_versions among roughly two hundred internal flags. Measured at 632 KB per page, the largest response in this API, and trim=true only reduces it to 523 KB. For reels alone use get_instagram_user_reels, and for one known post use get_instagram_post; both return the same raw shape, so neither is a way to get a smaller payload. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reels
$MeteredGET https://aisa.one/apis/v1/instagram/user/reelsReturns one page of a public account's reels as raw Instagram media objects under items[].media, with paging_info.max_id for the following page. Each reel carries code, caption, like_count, comment_count, video_versions, image_versions2 and clips_metadata, whose original_sound_info.audio_asset_id is exactly the id that get_instagram_song_reels expects. Pass user_id rather than handle for a faster response. Measured at 594 KB per page. Use get_instagram_user_posts for the whole timeline including photos and carousels. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Kalshi Markets
$MeteredGET https://aisa.one/apis/v1/kalshi/markets默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Market Price
$MeteredGET https://aisa.one/apis/v1/kalshi/markets/{ticker}默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Kalshi Market OrderBook
$MeteredGET https://aisa.one/apis/v1/kalshi/markets/{ticker}/orderbook默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Kalshi Trades
$MeteredGET https://aisa.one/apis/v1/kalshi/trades默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OpenAI Web Search
$MeteredPOST https://aisa.one/apis/v1/openai-websearch/searchAsk a question and get an answer that an OpenAI model wrote after searching the live web. Send a Responses request — an `input` string (or message array) — and the endpoint injects a fixed, server-pinned model and the `web_search` tool for you; the model, tool and per-request search cap are server-controlled to keep cost bounded. The reply is a standard OpenAI Responses object: `output[]` contains `web_search_call` items (each a search that ran) and a `message` item with the answer text and URL citations, and the billed search count equals the number of `web_search_call` items. Use this when you want a written, cited answer grounded in current web content from an OpenAI model — for the Anthropic-model equivalent see [`post_anthropic_websearch_search`](/api-reference/search/post_anthropic-websearch-search), and for raw ranked links with extracted page text use [`post_tavily_search`](/api-reference/search/post_tavily-search). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.3 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Air Quality
$MeteredGET https://aisa.one/apis/v1/openmeteo/air-qualityOpen-Meteo Air Quality (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Historical Weather (ERA5)
$MeteredGET https://aisa.one/apis/v1/openmeteo/archiveOpen-Meteo Historical Weather (ERA5) (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Climate (CMIP6)
$MeteredGET https://aisa.one/apis/v1/openmeteo/climateOpen-Meteo Climate (CMIP6) (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Elevation
$MeteredGET https://aisa.one/apis/v1/openmeteo/elevationTerrain elevation (DEM) by coordinates. <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Ensemble
$MeteredGET https://aisa.one/apis/v1/openmeteo/ensembleOpen-Meteo Ensemble (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Flood
$MeteredGET https://aisa.one/apis/v1/openmeteo/floodOpen-Meteo Flood (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Forecast
$MeteredGET https://aisa.one/apis/v1/openmeteo/forecast16-day hourly/daily/current weather forecast by coordinates. <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Geocoding
$MeteredGET https://aisa.one/apis/v1/openmeteo/geocodingOpen-Meteo Geocoding (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Historical Forecast
$MeteredGET https://aisa.one/apis/v1/openmeteo/historical-forecastOpen-Meteo Historical Forecast (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Marine
$MeteredGET https://aisa.one/apis/v1/openmeteo/marineOpen-Meteo Marine (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Previous Runs
$MeteredGET https://aisa.one/apis/v1/openmeteo/previous-runsOpen-Meteo Previous Runs (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Open-Meteo Seasonal Forecast
$MeteredGET https://aisa.one/apis/v1/openmeteo/seasonalOpen-Meteo Seasonal Forecast (Open-Meteo). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Oxylabs AI-search (Realtime, passthrough)
$MeteredPOST https://aisa.one/apis/v1/oxylabs/ai-search透传 AI 搜索 source: chatgpt/gemini/perplexity/google_search/google_ai_mode;返回 答案+引用+来源URL。Caller 传完整 body(含 source),原样转发 POST /v1/queries。 <!-- aisa-pricing:start --> Published reference price: $0.00145 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Oxylabs LLM (Push-Pull async) list
$MeteredGET https://aisa.one/apis/v1/oxylabs/llmOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Oxylabs LLM (Push-Pull async) submit
$MeteredPOST https://aisa.one/apis/v1/oxylabs/llmOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> Default request estimate: $0.00145 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Oxylabs LLM (Push-Pull async) detail
$MeteredGET https://aisa.one/apis/v1/oxylabs/llm/{jobId}Owner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Oxylabs LLM (Push-Pull async) cancel
$MeteredPOST https://aisa.one/apis/v1/oxylabs/llm/{jobId}/cancelOwner-scoped local asynchronous job lifecycle. Disabling new admission does not disable existing job reads or cancellation. Runtime availability and access policy also apply. <!-- aisa-pricing:start --> A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Chat Completions
$MeteredPOST https://aisa.one/apis/v1/parallel/chat/completionsChat completions. This endpoint can be used to get realtime chat completions. It can also be used with the Task API processors to get structured, research outputs via a chat interface. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
extract
$MeteredPOST https://aisa.one/apis/v1/parallel/extractExtracts relevant content from specific web URLs. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ingest FindAll Run
$MeteredPOST https://aisa.one/apis/v1/parallel/findall/ingestConvert a natural-language FindAll objective into a structured schema. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve FindAll Run Status
$MeteredGET https://aisa.one/apis/v1/parallel/findall/runs/{findall_id}Retrieve a FindAll run. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Cancel FindAll Run
$MeteredPOST https://aisa.one/apis/v1/parallel/findall/runs/{findall_id}/cancelCancel a FindAll run. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Stream FindAll Events
$MeteredGET https://aisa.one/apis/v1/parallel/findall/runs/{findall_id}/eventsStream events from a FindAll run. Args: request: The Shapi request。findall_id: The FindAll run ID.last_event_id: Optional event ID to resume from.timeout: Optional timeout in seconds. If None, keep connection alive as long as the run is going. If set, stop after specified duration. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
FindAll Run Result
$MeteredGET https://aisa.one/apis/v1/parallel/findall/runs/{findall_id}/resultRetrieve the FindAll run result at the time of the request. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get FindAll Run Schema
$MeteredGET https://aisa.one/apis/v1/parallel/findall/runs/{findall_id}/schemaGet FindAll Run Schema <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Monitor
$MeteredGET https://aisa.one/apis/v1/parallel/monitors/{monitor_id}Retrieve a monitor. Retrieves a specific monitor by monitor_id. Returns the monitor configuration including status, frequency, query, and webhook settings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Cancel Monitor
$MeteredPOST https://aisa.one/apis/v1/parallel/monitors/{monitor_id}/cancelCancel a monitor. Permanently stops the monitor from running. Cancellation is irreversible; create a new monitor to resume monitoring. Cancelling an already-cancelled monitor is a no-op. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Monitor Events
$MeteredGET https://aisa.one/apis/v1/parallel/monitors/{monitor_id}/eventsList events for a monitor, newest first. Pass event_group_id to narrow results to a single execution. Use next_cursor for pagination. Set include_completions=true to include no-change executions. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Update Monitor
$MeteredPOST https://aisa.one/apis/v1/parallel/monitors/{monitor_id}/updateUpdate a monitor. Only explicit fields are changed; pass null to clear webhook/metadata. At least one field required. Cancelled monitors cannot be updated. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create Task Group
$MeteredPOST https://aisa.one/apis/v1/parallel/tasks/groupsInitiates a TaskGroup to group and track multiple runs. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Task Group
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/groups/{taskgroup_id}Retrieves aggregated status across runs in a TaskGroup. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Stream Task Group Events
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/groups/{taskgroup_id}/eventsStreams events from a TaskGroup: status updates and run completions.The connection will remain open for up to an hour as long as at least one run in the group is still active. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Task Group Run
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/groups/{taskgroup_id}/runs/{run_id}Retrieves run status by run_id.This endpiont is equivalent to fetching run status directly using the`retrieve()` method or the `tasks/runs` GET endpoint.The run result is available from the `/result` endpoint. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Task Run
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/runs/{run_id}Retrieves run status by run_id.The run result is available from the `/result` endpoint. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Stream Task Run Events
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/runs/{run_id}/eventsStreams events for a task run.Returns a stream of events showing progress updates and state changes for the task run. For task runs that did not have enable_events set to true during creation, the frequency of events will be reduced. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Task Run Input
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/runs/{run_id}/inputRetrieves the input of a run by run_id. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Retrieve Task Run Result
$MeteredGET https://aisa.one/apis/v1/parallel/tasks/runs/{run_id}/resultRetrieves a run result by run_id, blocking until the run is completed. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Stream Task Run Events
$MeteredGET https://aisa.one/apis/v1/parallel/v1beta/tasks/runs/{run_id}/eventsStreams events for a task run.Returns a stream of events showing progress updates and state changes for the task run.For task runs that did not have enable_events set to true during creation, the frequency of events will be reduced. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Sonar
$MeteredPOST https://aisa.one/apis/v1/perplexity/sonarAsk a question and get a written answer with web citations, rather than a list of links to read yourself. Body is OpenAI chat-completions shaped: `model` (required, `sonar`) and `messages`. Returns `choices[0].message.content` as prose, plus `citations` (an array of URL strings) and `search_results[]` with `title`, `url`, `snippet`, `date` and `source`, and a `usage` block. Measured at about 3 seconds. This is the cheapest and fastest of the four Perplexity endpoints — use it for a single factual question. Step up to `post_perplexity_sonar_pro` for multi-part questions, or `post_perplexity_sonar_reasoning_pro` when the answer requires working through steps. If you need results you can iterate over rather than prose, use `post_tavily_search`; <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.12783 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Sonar Deep Research
$MeteredPOST https://aisa.one/apis/v1/perplexity/sonar-deep-researchCommission a report: this endpoint runs many searches and writes a long, cited document. `model` (required, `sonar-deep-research`) and `messages` in; `choices[0].message.content`, `citations`, `search_results[]` and `usage` out, where `usage` also reports `num_search_queries` and `reasoning_tokens`. Many clients time out well before it answers, so call it only when a report is genuinely the deliverable, and never in a loop. For anything you would read in one sitting, the other three Perplexity endpoints answer in seconds. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.23932 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Sonar Pro
$MeteredPOST https://aisa.one/apis/v1/perplexity/sonar-proAsk a question that needs more than one search pass and get a written answer with citations. Same request and response shape as `post_perplexity_sonar` — `model` (required, `sonar-pro`) and `messages` in, `choices[0].message.content`, `citations`, `search_results[]` and `usage` out. Use it for questions with several parts or follow-ups. For a single lookup `sonar` answers in a third of the time at the same price; when the difficulty is reasoning rather than retrieval, `post_perplexity_sonar_reasoning_pro` shows its working. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.11273 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Sonar Reasoning Pro
$MeteredPOST https://aisa.one/apis/v1/perplexity/sonar-reasoning-proAsk a question that has to be worked through, not just looked up, and get a step-by-step answer backed by web search. Same shape as the other Perplexity endpoints — `model` (required, `sonar-reasoning-pro`) and `messages` in; `choices[0].message.content`, `citations`, `search_results[]` and `usage` out. Use it for comparison, causation and analysis. When the question is simply what is the case, `post_perplexity_sonar` is faster; when you need a long report over many sources rather than an answer, `post_perplexity_sonar_deep_research`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.03499 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
board
$MeteredGET https://aisa.one/apis/v1/pinterest/boardReturns one page of pins from a board URL, with a cursor to page. Board pins carry a third field subset, different from both search results and pin detail: node_id, link, domain, rich_summary, seo_url, board and auto_alt_text among them. Measured at 104 KB for 16 pins; trim=true cuts it to 28 KB, keeping per pin id, title, description, link, domain, board, pinner, alt_text, rich_summary and reaction_counts. Board URLs come from board.url on search results — relative, like /agkelsey/the-apartment/, so prefix https://www.pinterest.com — or from get_pinterest_user_boards. For a user's board list rather than one board's pins, use get_pinterest_user_boards. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pin
$MeteredGET https://aisa.one/apis/v1/pinterest/pinFetches one pin by URL, of the form pinterest.com/pin/<id>. The response is a different shape from search results: camelCase fields including entityId, description, category, totalReactionCount, aggregatedPinData, richMetadata, pinner, originPinner and genAiTopics. Measured at 12.5 KB, the smallest full response in this API; trim=true reduces it to 1.6 KB, keeping entityId, description, createdAt, pinner, originPinner, nativeCreator, shareCount, repinCount and totalReactionCount while dropping richMetadata and category. To find pins by keyword use get_pinterest_search; to page through the board a pin sits on use get_pinterest_board. Only standard numeric pin URLs resolve: of 12 search results fed straight back, the 3 whose URL ended in a shortcode (dwA0UYrl style) all answered 404 and one numeric id did too, so check for a numeric trailing id before calling and expect occasional 404s on deleted pins. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search
$MeteredGET https://aisa.one/apis/v1/pinterest/searchSearches Pinterest for pins matching a keyword and returns pins plus a cursor to page. Each pin carries id, url, title, description, grid_title, created_at, images in five sizes (170x, 236x, 474x, 736x, orig), link, domain, board (name, url, pin_count) and pinner (username). Measured at about 110 KB for 17 pins; trim=true cuts that to 28 KB and keeps six fields per pin — id, url, description, created_at, images and pinner — dropping title, link, board and domain, so only skip trim when you need those. The board.url on each result feeds get_pinterest_board; for one pin's engagement counts use get_pinterest_pin. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
boards
$MeteredGET https://aisa.one/apis/v1/pinterest/user/boardsLists a user's public boards by username, with a cursor to page. Each board carries id, name, url, description, pin_count, follower_count, section_count, collaborator_count, privacy, owner, created_at, cover_pin and cover_images. Measured at 59 KB for 10 boards; trim=true collapses it to 3.3 KB — the largest trim ratio in this API — keeping id, name, url, description, pin_count, follower_count, created_at and image_cover_hd_url. The handle is the bare username as it appears in a profile URL (agkelsey, not a full URL). Feed each board's url to get_pinterest_board to read its pins; to search across all of Pinterest use get_pinterest_search. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get user activity
$MeteredGET https://aisa.one/apis/v1/polymarket/activityReturns user activity with pagination and filtering. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get batch prices history
$MeteredPOST https://aisa.one/apis/v1/polymarket/batch-prices-historyRetrieve historical price data for multiple markets in a single request. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get order book
$MeteredGET https://aisa.one/apis/v1/polymarket/bookRetrieves the order book summary for a specific token ID. Includes bids, asks, market details, and last trade price. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get order books (request body)
$MeteredGET https://aisa.one/apis/v1/polymarket/booksRetrieves order book summaries for multiple token IDs using a request body. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get order books (request body)
$MeteredPOST https://aisa.one/apis/v1/polymarket/booksRetrieves order book summaries for multiple token IDs using a request body. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get builder trades
$MeteredGET https://aisa.one/apis/v1/polymarket/builder/tradesRetrieves trades attributed to a builder code. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Cancel all orders
$MeteredGET https://aisa.one/apis/v1/polymarket/cancel-allCancel all open orders for the authenticated user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Cancel orders for a market
$MeteredGET https://aisa.one/apis/v1/polymarket/cancel-market-ordersCancel orders for a specific market, optionally scoped to an asset ID. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get CLOB market info
$MeteredGET https://aisa.one/apis/v1/polymarket/clob-markets/{condition_id}Returns all CLOB-level parameters for a market in a single call — tokens, tick size, base fees, rewards, RFQ status, and fee details. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get closed positions for a user
$MeteredGET https://aisa.one/apis/v1/polymarket/closed-positionsReturns closed positions for a user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List comments
$MeteredGET https://aisa.one/apis/v1/polymarket/commentsList comments. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get comments by user address
$MeteredGET https://aisa.one/apis/v1/polymarket/comments/user_address/{user_address}Get comments by user address. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get comments by comment id
$MeteredGET https://aisa.one/apis/v1/polymarket/comments/{id}Get comments by comment id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get user orders
$MeteredGET https://aisa.one/apis/v1/polymarket/data/ordersRetrieve open orders for the authenticated user. Returns paginated results and supports filtering by order, market, asset, and cursor. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Check if a safe is deployed
$MeteredGET https://aisa.one/apis/v1/polymarket/deployedReturns a payload that determines if a safe is deployed. Takes in the user's Polymarket proxy address. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create deposit addresses
$MeteredPOST https://aisa.one/apis/v1/polymarket/depositCreate deposit addresses for bridging assets into Polymarket. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List events
$MeteredGET https://aisa.one/apis/v1/polymarket/eventsList events with offset based pagination and filter parameters. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List events (keyset pagination)
$MeteredGET https://aisa.one/apis/v1/polymarket/events/keysetList events with cursor based keyset pagination. Use next_cursor as after_cursor to fetch the next page. The offset parameter is rejected. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get event by slug
$MeteredGET https://aisa.one/apis/v1/polymarket/events/slug/{slug}Get a single event by slug. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get event by id
$MeteredGET https://aisa.one/apis/v1/polymarket/events/{id}Get a single event by numeric id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get event tags
$MeteredGET https://aisa.one/apis/v1/polymarket/events/{id}/tagsGet tags attached to an event. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get fee rate
$MeteredGET https://aisa.one/apis/v1/polymarket/fee-rateRetrieves the base fee rate for a specific token ID. The fee rate can be provided either as a query parameter or as a path parameter. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get fee rate by path parameter
$MeteredGET https://aisa.one/apis/v1/polymarket/fee-rate/{token_id}Retrieves the base fee rate for a specific token ID using the token ID as a path parameter. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Send heartbeat
$MeteredPOST https://aisa.one/apis/v1/polymarket/heartbeatsSend a heartbeat to maintain active session status. If heartbeats are not sent regularly, all open orders for the user are automatically canceled. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get top holders for markets
$MeteredGET https://aisa.one/apis/v1/polymarket/holdersGet top holders for one or more markets. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get last trade price
$MeteredGET https://aisa.one/apis/v1/polymarket/last-trade-priceRetrieves the last trade price and side for a specific token ID. Returns default values of 0.5 for price and empty string for side if no trades found. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get last trade prices (query parameters)
$MeteredGET https://aisa.one/apis/v1/polymarket/last-trades-pricesRetrieves last trade prices for multiple token IDs using query parameters. Maximum 500 token IDs can be requested per call. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get last trade prices (query parameters)
$MeteredPOST https://aisa.one/apis/v1/polymarket/last-trades-pricesRetrieves last trade prices for multiple token IDs using query parameters. Maximum 500 token IDs can be requested per call. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get live volume for an event
$MeteredGET https://aisa.one/apis/v1/polymarket/live-volumeGet live volume for an event. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List markets
$MeteredGET https://aisa.one/apis/v1/polymarket/marketsList markets with offset based pagination and filters. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market by token
$MeteredGET https://aisa.one/apis/v1/polymarket/markets-by-token/{token_id}Return the parent market for a given token id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List markets (keyset pagination)
$MeteredGET https://aisa.one/apis/v1/polymarket/markets/keysetList markets with cursor based keyset pagination. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market by slug
$MeteredGET https://aisa.one/apis/v1/polymarket/markets/slug/{slug}Get a market by slug. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market by id
$MeteredGET https://aisa.one/apis/v1/polymarket/markets/{id}Get a market by numeric id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market tags by id
$MeteredGET https://aisa.one/apis/v1/polymarket/markets/{id}/tagsGet tags attached to a market. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get midpoint price
$MeteredGET https://aisa.one/apis/v1/polymarket/midpointRetrieves the midpoint price for a specific token ID. The midpoint is calculated as the average of the best bid and best ask prices. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get midpoint prices (query parameters)
$MeteredGET https://aisa.one/apis/v1/polymarket/midpointsRetrieves midpoint prices for multiple token IDs using query parameters. The midpoint is calculated as the average of the best bid and best ask prices. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get midpoint prices (query parameters)
$MeteredPOST https://aisa.one/apis/v1/polymarket/midpointsRetrieves midpoint prices for multiple token IDs using query parameters. The midpoint is calculated as the average of the best bid and best ask prices. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get current nonce for a user
$MeteredGET https://aisa.one/apis/v1/polymarket/nonceGets the current Proxy or Safe nonce for a user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get open interest
$MeteredGET https://aisa.one/apis/v1/polymarket/oiGet open interest for one or more markets. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Post a new order
$MeteredPOST https://aisa.one/apis/v1/polymarket/orderSubmit a new order to the CLOB API. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Post a new order
$MeteredGET https://aisa.one/apis/v1/polymarket/orderSubmit a new order to the CLOB API. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get order scoring status
$MeteredGET https://aisa.one/apis/v1/polymarket/order-scoringCheck whether a specific order is currently scoring for rewards. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Post multiple orders
$MeteredPOST https://aisa.one/apis/v1/polymarket/ordersSubmit multiple orders to the CLOB API in a single request. Maximum array length is 15. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Post multiple orders
$MeteredGET https://aisa.one/apis/v1/polymarket/ordersSubmit multiple orders to the CLOB API in a single request. Maximum array length is 15. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get current positions for a user
$MeteredGET https://aisa.one/apis/v1/polymarket/positionsReturns current positions for a user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market price
$MeteredGET https://aisa.one/apis/v1/polymarket/priceRetrieves the best market price for a specific token ID and side (bid or ask). Returns the best bid price for BUY side or best ask price for SELL side. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market prices (query parameters)
$MeteredGET https://aisa.one/apis/v1/polymarket/pricesRetrieves market prices for multiple token IDs and sides using query parameters. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get market prices (query parameters)
$MeteredPOST https://aisa.one/apis/v1/polymarket/pricesRetrieves market prices for multiple token IDs and sides using query parameters. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get prices history
$MeteredGET https://aisa.one/apis/v1/polymarket/prices-historyRetrieve historical price data for a market. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get public profile by wallet address
$MeteredGET https://aisa.one/apis/v1/polymarket/public-profileReturns the public profile for a wallet address. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search markets, events, and profiles
$MeteredGET https://aisa.one/apis/v1/polymarket/public-searchSearches markets, events, and profiles. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a quote
$MeteredPOST https://aisa.one/apis/v1/polymarket/quoteGet a bridge quote for a deposit or withdrawal. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get current rebated fees for a maker
$MeteredGET https://aisa.one/apis/v1/polymarket/rebates/currentReturns the current rebated fees for a maker address on a given date. Each entry includes the condition ID, asset address, and the USDC amount rebated. This endpoint does not require authentication. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get relayer address and nonce
$MeteredGET https://aisa.one/apis/v1/polymarket/relay-payloadFetches the relayer address and nonce for a specific user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get all relayer API keys
$MeteredGET https://aisa.one/apis/v1/polymarket/relayer/api/keysReturns all relayer API keys for the authenticated address. Auth allowed: Gamma auth or Relayer API key auth (RELAYER_API_KEY and RELAYER_API_KEY_ADDRESS). <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get current active rewards configurations
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/markets/currentReturns the current active rewards configurations for markets. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get multiple markets with rewards
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/markets/multiReturns multiple markets with rewards and supports filtering and sorting. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get raw rewards for a specific market
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/markets/{condition_id}Returns raw rewards configuration for a specific market. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get earnings for user by date
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/userReturns earnings for a user on a given date. Requires API key auth headers. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get user earnings and markets configuration
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/user/marketsReturns user earnings together with market configurations. Requires API key auth headers. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get reward percentages for user
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/user/percentagesReturns reward percentages for a maker address. Requires API key auth headers. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get total earnings for user by date
$MeteredGET https://aisa.one/apis/v1/polymarket/rewards/user/totalReturns total earnings for a user on a given date. Requires API key auth headers. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get sampling markets
$MeteredGET https://aisa.one/apis/v1/polymarket/sampling-marketsReturns sampling markets with richer descriptive metadata, token summaries, and tags. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get sampling simplified markets
$MeteredGET https://aisa.one/apis/v1/polymarket/sampling-simplified-marketsReturns sampling simplified markets with reward and token summaries. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List series
$MeteredGET https://aisa.one/apis/v1/polymarket/seriesLists series with filters and pagination. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get series by id
$MeteredGET https://aisa.one/apis/v1/polymarket/series/{id}Gets a series by numeric id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get simplified markets
$MeteredGET https://aisa.one/apis/v1/polymarket/simplified-marketsReturns simplified CLOB markets with token and reward summaries. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get sports metadata information
$MeteredGET https://aisa.one/apis/v1/polymarket/sportsGet sports metadata information. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get valid sports market types
$MeteredGET https://aisa.one/apis/v1/polymarket/sports/market-typesGet valid sports market types. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get spread
$MeteredGET https://aisa.one/apis/v1/polymarket/spreadRetrieves the spread for a specific token ID. The spread is the difference between the best ask and best bid prices. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get spreads
$MeteredPOST https://aisa.one/apis/v1/polymarket/spreadsRetrieves spreads for multiple token IDs. The spread is the difference between the best ask and best bid prices. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get transaction status
$MeteredGET https://aisa.one/apis/v1/polymarket/status/{address}Get transaction status for bridge activity associated with an address. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Submit a transaction
$MeteredPOST https://aisa.one/apis/v1/polymarket/submitSubmit a transaction request to the Relayer. Authenticated using Builder API Keys or Relayer API Keys. Returns immediately with the transactionID and a state of STATE_NEW. Poll GET /transaction with the returned transactionID to retrieve the transactionHash once broadcast. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get supported assets
$MeteredGET https://aisa.one/apis/v1/polymarket/supported-assetsGet supported assets for deposits and withdrawals on the bridge. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List tags
$MeteredGET https://aisa.one/apis/v1/polymarket/tagsLists tags with optional filters. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tag by slug
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/slug/{slug}Gets a tag by slug. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get related tags (relationships) by tag slug
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/slug/{slug}/related-tagsGets related tag relationships by tag slug. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tags related to a tag slug
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/slug/{slug}/related-tags/tagsGets tags related to a tag slug. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tag by id
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/{id}Gets a tag by numeric id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get related tags (relationships) by tag id
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/{id}/related-tagsGets related tag relationships by tag id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tags related to a tag id
$MeteredGET https://aisa.one/apis/v1/polymarket/tags/{id}/related-tags/tagsGets tags related to a tag id. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List teams
$MeteredGET https://aisa.one/apis/v1/polymarket/teamsList teams. <!-- aisa-pricing:start --> Published reference price: $0.00044 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tick size
$MeteredGET https://aisa.one/apis/v1/polymarket/tick-sizeRetrieves the minimum tick size (price increment) for a specific token ID. The tick size can be provided either as a query parameter or as a path parameter. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get tick size by path parameter
$MeteredGET https://aisa.one/apis/v1/polymarket/tick-size/{token_id}Retrieves the minimum tick size (price increment) for a specific token ID using the token ID as a path parameter. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get server time
$MeteredGET https://aisa.one/apis/v1/polymarket/timeReturns the current Unix timestamp of the server. This can be used to synchronize client time with server time. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get total markets a user has traded
$MeteredGET https://aisa.one/apis/v1/polymarket/tradedReturns the total number of markets a user has traded. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get a transaction by ID
$MeteredGET https://aisa.one/apis/v1/polymarket/transactionGets a transaction submitted to the Relayer. Poll this endpoint with the transactionID returned from POST /submit to retrieve the onchain transactionHash once the transaction has been broadcast. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get recent transactions for a user
$MeteredGET https://aisa.one/apis/v1/polymarket/transactionsGets the most recent transactions submitted to the Relayer, owned by a specific user. Authenticated using Builder API Keys or Relayer API Keys. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Download an accounting snapshot (ZIP of CSVs)
$MeteredGET https://aisa.one/apis/v1/polymarket/v1/accounting/snapshotDownloads an accounting snapshot as a ZIP archive of CSV files. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get aggregated builder leaderboard
$MeteredGET https://aisa.one/apis/v1/polymarket/v1/builders/leaderboardReturns aggregated builder leaderboard rankings. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get daily builder volume time-series
$MeteredGET https://aisa.one/apis/v1/polymarket/v1/builders/volumeReturns daily builder volume time-series data. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get trader leaderboard rankings
$MeteredGET https://aisa.one/apis/v1/polymarket/v1/leaderboardReturns trader leaderboard rankings for a selected category and time period. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get positions for a market
$MeteredGET https://aisa.one/apis/v1/polymarket/v1/market-positionsReturns positions for a market, optionally filtered to a single user. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get total value of a user's positions
$MeteredGET https://aisa.one/apis/v1/polymarket/valueReturns the total value of a user's positions. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create withdrawal addresses
$MeteredPOST https://aisa.one/apis/v1/polymarket/withdrawCreate withdrawal addresses for bridging pUSD out of Polymarket. <!-- aisa-pricing:start --> Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search AI Data
$MeteredPOST https://aisa.one/apis/v1/querit/searchPerform a search query using AI to retrieve relevant information based on the provided criteria. <!-- aisa-pricing:start --> Published reference price: $0.0048 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
comments
$MeteredGET https://aisa.one/apis/v1/reddit/post/commentsReturns one post and its discussion from a post URL: post with title, author, selftext, score, ups, upvote_ratio, num_comments, created_utc, permalink, archived and locked, then comments, each with author, body, score, ups, downs, created_utc, parent_id, permalink and a nested replies object holding items and more. Paging is a third shape again: the top level carries more.has_more and more.cursor rather than the after of get_reddit_search or the cursor of get_reddit_subreddit_search. Measured at about 21 KB for 19 top-level comments. To find posts worth opening, start from get_reddit_search or get_reddit_subreddit. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search
$MeteredGET https://aisa.one/apis/v1/reddit/searchSearches every public subreddit for posts matching a query and returns posts plus an after token to page. Each post carries title, author, selftext, selftext_html, subreddit, score, ups, downs, upvote_ratio, num_comments, created_utc, created_at_iso, url, permalink, subreddit_subscribers, is_video, over_18 and spoiler. sort accepts relevance, new, top and comment_count, and timeframe narrows the window. Measured at 8 to 16 seconds and 8 to 26 KB, the slowest endpoint here. To stay inside one community use get_reddit_subreddit_search, which is faster and pages with cursor rather than after; to read one post's discussion use get_reddit_post_comments. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
subreddit
$MeteredGET https://aisa.one/apis/v1/reddit/subredditReturns the post stream of one subreddit with an after token to page. Posts carry the same fields as get_reddit_search, including title, author, selftext, score, ups, upvote_ratio, num_comments, created_utc, created_at_iso, url, permalink and subreddit_subscribers. sort accepts best, hot, new, top and rising. Important: timeframe is only accepted together with sort=top, and any other combination returns 400 rather than ignoring the parameter. Subreddit names are case-sensitive. Measured at about 18 KB for 24 posts. To search inside the same subreddit use get_reddit_subreddit_search, and for its metadata use get_reddit_subreddit_details. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
details
$MeteredGET https://aisa.one/apis/v1/reddit/subreddit/detailsReturns metadata about one subreddit, by name or by URL: subreddit_id, display_name, subscribers, weekly_active_users, weekly_contributions, description, rules, icon_img, header_img, advertiser_category, submit_text and created_at. Use it to size a community or read its rules before posting anything elsewhere. The name is case-sensitive, so AskReddit resolves and askreddit does not. Measured at about 5 KB, the smallest response here. It returns no posts at all: for those call get_reddit_subreddit, or get_reddit_subreddit_search to query within the community. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
search
$MeteredGET https://aisa.one/apis/v1/reddit/subreddit/searchSearches inside one subreddit and returns matching posts with a cursor token to page. Posts carry title, author, selftext, score, ups, upvote_ratio, num_comments, created_utc, created_at_iso, url, permalink and is_video. Despite what sort suggests, every sort value returns posts and only posts: comments and media were confirmed absent from all five. Measured at about 5 KB and 2 seconds, faster than get_reddit_search, which searches all of Reddit and pages with after instead of cursor. For the replies under a result, pass its url to get_reddit_post_comments. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00188 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Explain Search Results
$MeteredPOST https://aisa.one/apis/v1/scholar/search/explainExplain a result set you already fetched. Unlike the three search endpoints this one takes a **JSON body**: `search_id` (required — the `id` returned by `post_scholar_search_web`, `post_scholar_search_scholar` or `post_scholar_search_mixed`), plus `detail_level` (BRIEF / MODERATE / DETAILED), `language`, and `response_mode`. ⚠️ Use `response_mode: NON_STREAMING`. It returns `{"message": "…"}` as JSON, measured at about 2 KB. The COMPLETE and INCREMENTAL modes emit server-sent events in which **each event repeats the whole answer so far** — the identical explanation measured 177 KB that way, roughly 90 times larger, and a tool call cannot consume a stream incrementally anyway. It only ever explains an existing search; it cannot run one. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Mixed Content
$MeteredPOST https://aisa.one/apis/v1/scholar/search/mixedSearch the web and academic sources together, for questions that straddle both. ⚠️ Parameters go in the **query string**: `query` (required), `max_num_results`, `as_ylo`/`as_yhi`. Returns a search `id` and `results[]`; **the entry shape varies by source** — every result has `title`, `link` and `snippet`, and academic ones additionally carry `authors` and `number_of_citations`, so treat those two as optional rather than assuming they are there. Measured at about 3 seconds. Use it when you do not know in advance which kind of source will answer. When you do, `post_scholar_search_web` or `post_scholar_search_scholar` is more predictable. Keep the `id` for `post_scholar_search_explain`. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Scholarly Articles
$MeteredPOST https://aisa.one/apis/v1/scholar/search/scholarSearch academic literature. ⚠️ Parameters go in the **query string**, not a body: `query` (required), `max_num_results`, and `as_ylo`/`as_yhi` to bound publication years. Returns a search `id` and `results[]` with `title`, `link`, `snippet`, `authors` and `number_of_citations` — that last field is what a general web search cannot give you. Measured at under 2 seconds. Use it when the question calls for peer-reviewed sources or when citation counts matter. For current events and product pages a general engine is better: `post_tavily_search`. To cover both at once, `post_scholar_search_mixed`. Keep the `id` for `post_scholar_search_explain`. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Web Content
$MeteredPOST https://aisa.one/apis/v1/scholar/search/webSearch the open web and get back a lean result list. ⚠️ Despite being a POST, parameters go in the **query string** — `query` (required), `max_num_results` (default 10, max 100), and `as_ylo`/`as_yhi` for a year range. A JSON body is not accepted. Returns a search `id` and `results[]` carrying only `title`, `link` and `snippet`. Measured at about 4 seconds for a roughly 600-byte response. Its virtue is how little it returns, which suits an agent that only needs to know what exists. It gives you no page text — if you need the content, `post_tavily_search` returns it in the same call. Keep the `id`: it is what `post_scholar_search_explain` needs. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Perform Full Text Search
$MeteredGET https://aisa.one/apis/v1/search/fullSearchfor web content and retrieve full text content with advanced filtering optionsincluding freshness, market, and safety filters <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Perform Smart Search
$MeteredGET https://aisa.one/apis/v1/search/smart<!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlink Anchors
$MeteredGET https://aisa.one/apis/v1/semrush/backlink-anchors<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlink Competitors
$MeteredGET https://aisa.one/apis/v1/semrush/backlink-competitors<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Backlinks
$MeteredGET https://aisa.one/apis/v1/semrush/backlinks<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Semrush Backlinks Overview
$MeteredGET https://aisa.one/apis/v1/semrush/backlinks-overview<!-- aisa-pricing:start --> Published reference price: $0.004 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Broad Match Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/broad-match-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.04 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Organic Competitors
$MeteredGET https://aisa.one/apis/v1/semrush/domain-organic-competitors<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Organic Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/domain-organic-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Semrush Domain Overview
$MeteredGET https://aisa.one/apis/v1/semrush/domain-overview<!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Paid Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/domain-paid-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.04 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain Rank History
$MeteredGET https://aisa.one/apis/v1/semrush/domain-rank-history<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Domain vs Domain
$MeteredGET https://aisa.one/apis/v1/semrush/domain-vs-domain<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.16 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Indexed Pages
$MeteredGET https://aisa.one/apis/v1/semrush/indexed-pages<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Difficulty
$MeteredGET https://aisa.one/apis/v1/semrush/keyword-difficulty<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.005 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Organic Results
$MeteredGET https://aisa.one/apis/v1/semrush/keyword-organic-results<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Semrush Keyword Overview
$MeteredGET https://aisa.one/apis/v1/semrush/keyword-overview<!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Paid Results
$MeteredGET https://aisa.one/apis/v1/semrush/keyword-paid-results<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.04 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Question Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/question-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Referring Domains
$MeteredGET https://aisa.one/apis/v1/semrush/referring-domains<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.08 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Related Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/related-keywordsSemrush 相关关键词:给定种子关键词返回语义相关扩展词(搜索量/CPC/竞争度/结果数/趋势)。按返回行计费。 <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
URL Organic Keywords
$MeteredGET https://aisa.one/apis/v1/semrush/url-organic-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.02 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keywords Overview
$MeteredGET https://aisa.one/apis/v1/similarweb/keyword-analysis/keywords/overview<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $1.275 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Keyword Competitors
$MeteredGET https://aisa.one/apis/v1/similarweb/search/keyword-competitors<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Landing Pages
$MeteredGET https://aisa.one/apis/v1/similarweb/search/landing-pages<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SERP Players - Aggregated
$MeteredGET https://aisa.one/apis/v1/similarweb/search/serp-players-aggregated<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SERP Players - Clicks over time
$MeteredGET https://aisa.one/apis/v1/similarweb/search/serp-players-timeseries<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Keywords
$MeteredGET https://aisa.one/apis/v1/similarweb/search/website-keywords<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Segments Analysis
$MeteredGET https://aisa.one/apis/v1/similarweb/segment-analysis/segments/traffic-and-engagement<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Segments Marketing Channels
$MeteredGET https://aisa.one/apis/v1/similarweb/segment-analysis/segments/traffic-sources<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Conversion Rates Over Time
$MeteredGET https://aisa.one/apis/v1/similarweb/website-analysis/websites/conversion-rates<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.375 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Conversion Rates Aggregated
$MeteredGET https://aisa.one/apis/v1/similarweb/website-analysis/websites/conversion-rates/aggregated<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.375 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Demographics - Specific Groups
$MeteredGET https://aisa.one/apis/v1/similarweb/website-analysis/websites/traffic-by-demographics/aggregated<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.45 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Top Geographies
$MeteredGET https://aisa.one/apis/v1/similarweb/website-top-geographies<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $2.25 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Traffic Snapshot
$MeteredGET https://aisa.one/apis/v1/similarweb/website-traffic-snapshot<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.3 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Traffic Trend
$MeteredGET https://aisa.one/apis/v1/similarweb/website-traffic-trend<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.45 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Ad Networks
$MeteredGET https://aisa.one/apis/v1/similarweb/website/ad-networks<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.225 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Audience Interest
$MeteredGET https://aisa.one/apis/v1/similarweb/website/audience-interest<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.375 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Audience Overlap
$MeteredGET https://aisa.one/apis/v1/similarweb/website/audience-overlap<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.75 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Deduplicated Audience
$MeteredGET https://aisa.one/apis/v1/similarweb/website/deduplicated-audience<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.525 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Demographics
$MeteredGET https://aisa.one/apis/v1/similarweb/website/demographics<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.6 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Folders
$MeteredGET https://aisa.one/apis/v1/similarweb/website/folders{"methods":[{"methodType":"GET","methodDesc":"Returns a list of leading folders for a domain and share per folder","requestParams":[{"name":"domain","type":"string","required":true,"paramType":"query","desc":"Website domain without 'www.' (e.g., 'example.com')"},{"name":"start_date","type":"string","required":false,"paramType":"query","desc":"Start date in 'YYYY-MM' or 'YYYY-MM-DD' format"},{"name":"end_date","type":"string","required":false,"paramType":"query","desc":"End date in 'YYYY-MM' or 'YYYY-MM-DD' format"},{"name":"granularity","type":"string","required":false,"paramType":"query","desc":"Time granularity"},{"name":"web_source","type":"string","required":false,"paramType":"query","desc":"Specifies the web source device type"},{"name":"country","type":"string","required":false,"paramType":"query","desc":"Two-letter country code (e.g., 'us', 'gb', 'ww')"},{"name":"main_domain_only","type":"boolean","required":false,"paramType":"query","desc":"'true' to include only the main domain, 'false' to include subdomains. Defaul..."},{"name":"format","type":"string","required":false,"paramType":"query","desc":"Format in which the reply should be returned."},{"name":"limit","type":"integer","required":false,"paramType":"query","desc":"Number of items per page for pagination, default is 100"},{"name":"offset","type":"integer","required":false,"paramType":"query","desc":"Page number for pagination, starting from 1"},{"name":"asc","type":"boolean","required":false,"paramType":"query","desc":"Sort order direction, 'true' for ascending, 'false' for descending. Default i..."},{"name":"sort","type":"string","required":false,"paramType":"query","desc":"Sort order for the results, applied on the properties of the returned record"},{"name":"api-key","type":"string","required":false,"paramType":"header","desc":""}],"responseParams":[{"name":"meta","type":"object","desc":""},{"name":"data","type":"array","desc":""}]}]} <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.3 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Marketing Channel Sources
$MeteredGET https://aisa.one/apis/v1/similarweb/website/marketing-channel-sources-legacy<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.525 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Popular Pages
$MeteredGET https://aisa.one/apis/v1/similarweb/website/popular-pages<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.225 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
PPC Spend
$MeteredGET https://aisa.one/apis/v1/similarweb/website/ppc-spend<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Ranking
$MeteredGET https://aisa.one/apis/v1/similarweb/website/ranking<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.15 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Referrals
$MeteredGET https://aisa.one/apis/v1/similarweb/website/referrals<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.3 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
SimilarSites
$MeteredGET https://aisa.one/apis/v1/similarweb/website/similar-sites<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.375 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Subdomains
$MeteredGET https://aisa.one/apis/v1/similarweb/website/subdomains<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.15 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Website Technologies
$MeteredGET https://aisa.one/apis/v1/similarweb/website/technologies<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.75 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Top Sites Ranking
$MeteredGET https://aisa.one/apis/v1/similarweb/website/top-sites-ranking<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Traffic & Engagement
$MeteredGET https://aisa.one/apis/v1/similarweb/website/traffic-engagement<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.075 USD (not a fixed price). Declared unit rate: $0.075 USD per similarweb_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Start Crawl Process
$MeteredPOST https://aisa.one/apis/v1/tavily/crawlWalk a site from a root `url` and return the content of the pages it finds. Steer it with natural-language `instructions` plus regex path and domain filters, and bound it with `max_depth`, `max_breadth` and `limit`. Returns `base_url` and `results[]` with `url` and `raw_content`. Measured at about 4.5 seconds for a 3-page limit; cost and time grow with the bounds you set, so set them. Use it for broad coverage of one site — documentation, a catalogue, a competitor's blog. It answers synchronously, which `post_firecrawl_crawl` does not: that one runs as a background job and suits crawls too large to wait on. For a handful of known pages `post_tavily_extract` is far cheaper; to size a site before paying to crawl it, run `post_tavily_map` first. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Declared unit rate: $0.008 USD per tavily_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Extract Data
$MeteredPOST https://aisa.one/apis/v1/tavily/extractFetch clean, parsed content for URLs you already have — from a search result, a sitemap, or a user. `urls` is required and takes several at once. Returns `results[]` with `url`, `title`, `raw_content` and `images`, plus a `failed_results[]` array — **read that one**, because a page that could not be fetched is reported there rather than raising an error. Choose `format` (markdown or text) and `extract_depth`. Measured at about 1 second for one page. Use this instead of `post_tavily_search` whenever you can already name the pages; searching for pages you can name costs more and may not return them. For a long list that can wait, `post_firecrawl_batch_scrape` runs it as a background job. To discover the URLs of a whole site first, use `post_tavily_map`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.024 USD (not a fixed price). Declared unit rate: $0.008 USD per tavily_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Map Data
$MeteredPOST https://aisa.one/apis/v1/tavily/mapList a site's URLs from a root `url` without fetching any page content. Steer it with natural-language `instructions` and regex `select_paths` / `exclude_paths` / `select_domains` filters. Returns `base_url` and `results` — **a flat array of URL strings, not objects** — with `response_time` and `request_id`. Fast and cheap: measured at about 1.5 seconds. Use it to size a site before committing to a crawl, then fetch only the parts that matter with `post_tavily_extract`. When you want the content rather than the shape, `post_tavily_crawl` does both in one call. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.064 USD (not a fixed price). Declared unit rate: $0.008 USD per tavily_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Tavily Data
$MeteredPOST https://aisa.one/apis/v1/tavily/searchSearch the web and get back ranked results with the page text already extracted, so there is no second call to fetch content. `query` is required. Returns `results[]` with `url`, `title`, `content` (the extracted excerpt), `score` and optionally `raw_content`, alongside `query`, `images`, `response_time` and `request_id`; set `include_answer` to also get a one-paragraph `answer`. Filter with `topic` (general/news/finance), `time_range` or explicit `start_date`/`end_date`, and trade cost against depth with `search_depth`. Measured at roughly 6 seconds for 2 results. This is the default choice for open-web research, and the only search here that returns ranked results and page text in one call. Reach past it when: you already know the URLs — `post_tavily_extract` is cheaper and exact; the query is a description rather than keywords — `post_exa_search` matches on meaning; you want a written answer rather than a list to iterate — `post_perplexity_sonar`; you want peer-reviewed papers — `post_scholar_search_scholar`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.016 USD (not a fixed price). Declared unit rate: $0.008 USD per tavily_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_bangumi_tab
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_bangumi_tabBilibili (app). ### Purpose: - Get bangumi tab (anime recommendations) ### Return: - Bangumi tab data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_cinema_tab
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_cinema_tabBilibili (app). ### Purpose: - Get cinema tab (movies/TV recommendations) ### Return: - Cinema tab data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_home_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_home_feedBilibili (app). ### Purpose: - Get home feed (recommended videos) ### Parameters: - idx: Page index, defaults to current timestamp - flush: Flush flag (0=normal load, 1=refresh) - pull: Pull to refresh ### Return: - Home feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_one_videoBilibili (app). ### Purpose: - Get single video data (APP API) ### Parameters: - av_id: AV ID (choose one of av_id or bv_id) - bv_id: BV ID (choose one of av_id or bv_id) ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_popular_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_popular_feedBilibili (app). ### Purpose: - Get popular feed ### Parameters: - idx: Page index (starting from 1) - last_param: Last video ID from previous page (for pagination) ### Return: - Popular feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_reply_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_reply_detailBilibili (app). ### Purpose: - Get reply detail (second level comments) ### Parameters: - root: Root comment ID (required) - av_id: AV ID (choose one of av_id or bv_id) - bv_id: BV ID (choose one of av_id or bv_id) - next_offset: Next page cursor - ps: Page size ### Return: - Reply data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_search_all
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_search_allBilibili (app). ### Purpose: - search all (returns all types of search results) ### Parameters: - keyword: Search keyword (required) - cursor: Pagination cursor. Leave empty for the first page; for the next page pass back `data.pagination.next` from the previous response. This endpoint uses cursor pagination and does not support random access by page number. - page_size: Results per page - order: Sort order (0=comprehensive) ### Return: - Search results including nav (category navigation), item (results), pagination, etc. - Next-page cursor: `$.data.data.pagination.next`; pass it back as `cursor` on the next request. When this field is absent (pagination is omitted on the last page) or empty, there is no more data and you should stop paginating. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_search_by_type
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_search_by_typeBilibili (app). ### Purpose: - search by type ### Parameters: - keyword: Search keyword (required) - search_type: Search type - video: Videos - bangumi: Anime - pgc: Movies/TV - live: Live streams - article: Articles - user: Users - cursor: Pagination cursor. Leave empty for the first page; for the next page pass back `data.pagination.next` from the previous response. This endpoint uses cursor pagination and does not support random access by page number. - page_size: Results per page - order: Sort order - 0: Comprehensive - 1: Latest - 2: Play count - 3: Danmaku count ### Return: - Search results - Next-page cursor: `$.data.data.pagination.next`; pass it back as `cursor` on the next request. When this field is absent (pagination is omitted on the last page) or empty, there is no more data and you should stop paginating. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_user_infoBilibili (app). ### Purpose: - Get user info ### Parameters: - user_id: User ID (required) ### Return: - User info (including followers, following, videos count, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_user_videosBilibili (app). ### Purpose: - Get user uploaded videos ### Parameters: - user_id: User ID (required) - post_filter: Filter type (archive/season/contribute) - page: Page number - ps: Page size ### Return: - User videos data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/app/fetch_video_commentsBilibili (app). ### Purpose: - Get video comments ### Parameters: - av_id: AV ID (choose one of av_id or bv_id) - bv_id: BV ID (choose one of av_id or bv_id) - mode: Sort mode (3=hot, 2=time) - next_offset: Pagination cursor ### Return: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili account_session_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/account_session_infoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve the current advertiser's identity and role information to identify the business account associated with the returned data. ### Parameters - None. ### Returns - Advertiser ID, user ID, username, operator type, UID name, MID, and related account fields. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili cooperate_experience_industry
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/cooperate_experience_industryBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve detailed industries used by collaboration-experience filters on non-general strategy panels. For the general panel (`panel_type=0`), use `square_static_info.data.industry_tree` instead. ### Parameters - `industry_type`: Required business industry: `1` gaming, `2` personal care/small appliances, `3` digital appliances, `4` automotive, `5` food and beverage, or `6` internet services. ### Returns - Put selected IDs in `search_upper.cooperate_experience_industry_ids`. - Also set `search_upper.cooperate_experience_type`: without selected industries, use `3`=no experience in the current industry, `1`=some current- industry experience, `2`=extensive current-industry experience, or `4`=other- industry experience. With selected industries, use only `1` or `2`. ### Example `GET /tikhub/bilibili/huahuo/cooperate_experience_industry?industry_type=1` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`); `square_static_info` = `GET /tikhub/bilibili/huahuo/square_static_info` (operationId: `get_tikhub_bilibili_huahuo_square_static_info`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili dmp_pkg_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/dmp_pkg_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve custom audience packages available to the current advertiser for audience-matching filters. ### Parameters - None. ### Returns - Audience package IDs, names, labels, and available matching metrics. Put the selected custom package ID in `search_upper.dmp_group_id`. ### Example `GET /tikhub/bilibili/huahuo/dmp_pkg_list` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili effect_goods_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/effect_goods_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve product categories supported by content-commerce filters. ### Parameters - None. ### Returns - Product category IDs, names, and hierarchy. Put selected first- and second- level IDs in `search_upper.goods_category_first_ids` and `goods_category_second_ids`. ### Example `GET /tikhub/bilibili/huahuo/effect_goods_drop` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili industry_tags
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/industry_tagsBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve industry tags used in advertiser and content collaboration scenarios. ### Parameters - None. ### Returns - Industry tag IDs, names, and category information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili label_char_style
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/label_char_styleBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve tags describing creators' content presentation and visual style. ### Parameters - None. ### Returns - Content-style tag IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_area_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_area_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve live content categories used by live creator marketplace filters. ### Parameters - None. ### Returns - First- and second-level live category IDs, names, and hierarchy. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_commerce_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_commerce_infoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Query a creator's live-commerce capabilities and recent commercial performance. ### Parameters - `upper_mid`: Required creator UID. ### Returns - Live-commerce sessions, product categories, transaction performance, audience, engagement, and related commercial metrics. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_good_category
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_good_categoryBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve primary live-commerce product categories for filtering creators with relevant category experience. ### Parameters - None. ### Returns - Live-commerce category IDs, names, and display order. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_guild_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_guild_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve live-streaming guilds available as marketplace filters. ### Parameters - `name`: Optional partial guild name. An empty string returns all available results. ### Returns - Live guild IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_parent_tag
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_parent_tagBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve persona labels describing live creators' style and content positioning. ### Parameters - None. ### Returns - Live creator persona tag IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili live_upper_portrait
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/live_upper_portraitBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve a creator's live-streaming profile for evaluating branded-live collaboration capabilities. ### Parameters - `mcn_id`: Required MCN organization ID, available from marketplace results or `upper_base_info`. - `upper_mid`: Optional creator UID used to narrow the target creator. ### Returns - Creator profile, live performance, audience size, engagement metrics, live tags, and collaboration-capability information. ### Billing API references: `upper_base_info` = `GET /tikhub/bilibili/huahuo/upper_base_info` (operationId: `get_tikhub_bilibili_huahuo_upper_base_info`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili mcn_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/mcn_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve MCN organizations available for creator search filters. ### Parameters - `name`: Optional partial MCN name. An empty string returns all available results. ### Returns - MCN organization IDs, names, and display information. Put selected IDs in the `search_upper.mcn_ids` array. ### Example `GET /tikhub/bilibili/huahuo/mcn_drop?name=` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili partition_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/partition_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve video content categories used to filter creators or content by topic. ### Parameters - None. ### Returns - First- and second-level video category IDs, names, and hierarchy. Put the selected first-level ID in `search_upper.partition_id` and second-level IDs in `search_upper.second_partition_id`. ### Example `GET /tikhub/bilibili/huahuo/partition_drop` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_avid_category_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_avid_category_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get industry names supported by the Huahuo video ranking endpoint. ### Parameters - None. ### Returns - Available video-ranking industry names and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_avid_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_avid_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve Huahuo video rankings for a selected industry or all industries. ### Parameters - `category`: Industry name from `popular_avid_category_drop`; an empty string means all industries. - `page`: One-based page number. ### Returns - Video ranks, identifiers, titles, covers, creator profiles, playback and engagement metrics, and pagination information. ### Billing API references: `popular_avid_category_drop` = `GET /tikhub/bilibili/huahuo/popular_avid_category_drop` (operationId: `get_tikhub_bilibili_huahuo_popular_avid_category_drop`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_goods_industry_up_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_goods_industry_up_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Find creators with strong commerce performance in a selected product industry. ### Parameters - `x_huo_industry_id`: Required product-ranking industry ID from `x_huo_industry_drop?scene=2`. - `page`: One-based page number. ### Returns - Industry commerce creator ranks, profiles, performance metrics, and pagination information. ### Billing API references: `x_huo_industry_drop` = `GET /tikhub/bilibili/huahuo/x_huo_industry_drop` (operationId: `get_tikhub_bilibili_huahuo_x_huo_industry_drop`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_goods_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_goods_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve X-Huo product rankings for an industry and analyze popular products and their content-commerce performance. ### Parameters - `x_huo_industry_id`: Required product-ranking industry ID from `x_huo_industry_drop?scene=2`. - `page`: One-based page number. - `rank_type`, `data_cycle`: Optional ranking mode and data period. - `min_goods_price`, `max_goods_price`: Optional product price range. ### Returns - Product ranks, product details, pricing, industry, commerce-performance metrics, and pagination information. ### Billing API references: `x_huo_industry_drop` = `GET /tikhub/bilibili/huahuo/x_huo_industry_drop` (operationId: `get_tikhub_bilibili_huahuo_x_huo_industry_drop`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_goods_up_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_goods_up_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Find creators with strong commerce performance for a specific product. ### Parameters - `goods_id`: Required product ID from `popular_goods_list`. - `page`: One-based page number. ### Returns - Creator ranks, profiles, product-specific commerce metrics, and pagination information. ### Billing API references: `popular_goods_list` = `GET /tikhub/bilibili/huahuo/popular_goods_list` (operationId: `get_tikhub_bilibili_huahuo_popular_goods_list`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_up_list
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_up_listBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve breakout, high-value, or top-tier creator rankings for rapid discovery. ### Parameters - `rank_cate`: Ranking type: `1` breakout creators, `2` high-value creators, or `3` top-tier creators. - `tid_name`: Ranking category from `popular_up_tid_drop`; an empty string means all. - `page`: One-based page number. ### Returns - Creator ranks, profiles, and category-specific metrics. Breakout rankings emphasize follower growth, high-value rankings emphasize median playback and engagement, and top-tier rankings emphasize average metrics. ### Billing API references: `popular_up_tid_drop` = `GET /tikhub/bilibili/huahuo/popular_up_tid_drop` (operationId: `get_tikhub_bilibili_huahuo_popular_up_tid_drop`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_up_tid_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_up_tid_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get content categories accepted by `popular_up_list` as `tid_name` values. ### Parameters - None. ### Returns - Available ranking category names and display information. ### Billing API references: `popular_up_list` = `GET /tikhub/bilibili/huahuo/popular_up_list` (operationId: `get_tikhub_bilibili_huahuo_popular_up_list`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili popular_up_x_huo
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/popular_up_x_huoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve X-Huo creator rankings for a selected industry and period for creator selection and industry trend analysis. ### Parameters - `x_huo_industry_id`: Required industry ID from `x_huo_industry_drop?scene=1`; prefer the second-level ID when available. - `rank_date_type`: `1` monthly or `2` quarterly. - `rank_date`: Ranking period in `YYYY-MM` format from `x_huo_date_options`; omit it to use the latest completed period. - `page`: One-based page number. ### Returns - Creator ranks, profiles, industry relevance, content-influence metrics, and pagination information. ### Billing API references: `x_huo_date_options` = `GET /tikhub/bilibili/huahuo/x_huo_date_options` (operationId: `get_tikhub_bilibili_huahuo_x_huo_date_options`); `x_huo_industry_drop` = `GET /tikhub/bilibili/huahuo/x_huo_industry_drop` (operationId: `get_tikhub_bilibili_huahuo_x_huo_industry_drop`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili region_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/region_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve the province/city hierarchy used by creator residence filters. ### Parameters - None. ### Returns - Put selected primary-node `value`s in `search_upper.region_id`, and selected `children[].value`s in `search_upper.second_region_id`. - For multiple selections, collect all values in their respective arrays. For example: `{"region_id":[4,5,23],"second_region_id":[51,50]}`. ### Example `GET /tikhub/bilibili/huahuo/region_drop` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili search_live_upper
$MeteredPOST https://aisa.one/apis/v1/tikhub/bilibili/huahuo/search_live_upperBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search live creators for branded-content or live-commerce collaborations. - Filter by creator attributes, audience demographics, live categories, performance, guild, primary commerce category, and GMV. ### Parameters - `is_brand_live`: Live mode. Use `1` for branded-content live streams and `0` for commerce live streams. - Branded-content mode supports popularity peak, hourly viewers, hourly comments, guild, and onboarding-status filters. - Commerce mode supports primary category and 90-day GMV filters. - `page`: One-based page number. Each page contains 20 records. ### Returns - `total_count`: Total number of matching creators. - `data`: Creator records containing profile, audience, live performance, and collaboration-capability metrics. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili search_upper
$MeteredPOST https://aisa.one/apis/v1/tikhub/bilibili/huahuo/search_upperBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search creators by nickname, UID, or content keyword in the Huahuo marketplace. - Combine profile, audience, pricing, performance, DMP, industry, cooperation-experience, and commerce filters. - `nickname_or_mids` and `main_search` correspond to creator search and content search respectively; normally choose one per request. ### Parameters #### Basic search parameters: - `nickname_or_mids`: Creator nickname or UID query; separate multiple terms with commas. - `main_search`: Content-keyword query with matched videos included in the result. Normally use either this field or `nickname_or_mids`. - `mids`: Exact UID list; `upper_mid`: One exact UID; `folder_id`: Saved-creator folder ID. - `marketing_target`: `1`=brand awareness, `2`=consideration, `3`=conversion. - `panel_type`: `0`=general, `1`=gaming, `2`=beauty, `3`=digital, `4`=automotive, `5`=performance, `6`=food, `8`=internet services. - `order_by`: Sort field; `sort`: `desc` or `asc`; `page`: One-based page number with 20 results per page; `request_id`: Optional search-session ID that can be reused across pages with the same filters. #### Creator profile and affiliation parameters: - `gender`: Value from `square_static_info.gender_info`. - `min_fans_num` / `max_fans_num`: Inclusive follower-count range. - `region_id` / `second_region_id`: Primary and secondary residence-region IDs from `region_drop`. The Beijing, Shanghai, Fujian, Xiamen, and Fuzhou selection is `{"region_id":[4,5,23],"second_region_id":[51,50]}`. - `partition_id` / `second_partition_id`: Primary and secondary content-category IDs. - `mcn_ids`: MCN IDs; `provider_id`: Service-provider IDs. - `upper_types`: `1` or `4`=MCN-affiliated, `3`=independent. - `only_contract`: `1`=contract-eligible creators only, `0`=all. - `is_painter_order`: Require illustration-commission capability. #### Audience and DMP parameters: - `fans_age_tag`, `fans_gender_tag`, `fans_region_tag`: Audience age, gender, and region affinity tags; `fans_stick`: Follower-loyalty tier. - `av_active`: Enable recent-publishing filtering; `av_active_tag`: Activity tier. - `dmp_group_id`: Custom DMP package ID; `category_dmp_group_id` and `category_dmp_label`: Category-package ID and display label. - `dmp_pkg_name`: Special-audience package name query. - `dmp_pkg_vertical_rate_gte` / `dmp_pkg_vertical_rate_lte`: DMP verticality range, measured as matching videos divided by all videos in the last 180 days. - `dmp_pkg_effect_rate_gte` / `dmp_pkg_effect_rate_lte`: DMP influence range, measured as recent matching viewers divided by that audience population. - `dmp_pkg_fan_rate_gte` / `dmp_pkg_fan_rate_lte`: DMP attention range, measured as matching audience members divided by all followers. #### Pricing and performance parameters: - `min_task_price` / `max_task_price`: Standard cooperation quote range in RMB. - `price_info`: Cooperation-specific pricing array; the current UI submits one selected cooperation type per search. Each item contains: - `cooperation_type`: Video cooperation uses `1`=embedded video, `2`=custom video, and `22`=deep customization; podcast cooperation uses `23`=custom podcast and `24`=podcast brand placement; dynamic cooperation uses `3`=direct post and `4`=repost. Placement formats embed brand material in the content, custom formats are produced for the client's marketing needs, and dynamic formats publish or repost the requested commercial post. - `price_min` / `price_max`: Quote range in RMB for that cooperation type. - `creative_skill`: Deep-customization skill IDs `1-9`, covering overseas filming, technical analysis, microfilm, live-action challenge, renovation/DIY, interview, TVC filming, special editing, and other. - `include_content`: Included-content IDs for custom video, deep customization, or custom podcast: `1`=secondary creation/distribution license, `2`=bonus preview, `3`=custom content. - `price_right`: Cooperation-right codes. Types `1/2/23/24` support `show_in_video_first_1p3` and `show_in_video_gte_30s`; type `22` supports `brand_over_30_percent`, `auth_secondary_creation`, `multi_cooperation_discount`, `give_preview`, and `give_poster`. Types `3/4` do not support this field and use `[]`. - Every `price_info` item contains all six fields. Send `[]` for an unavailable or unselected `creative_skill`, `include_content`, or `price_right`. “RMB 100,000 or more” is `"price_min":100000,"price_max":""`. - Deep-custom example: `{"price_info":[{"cooperation_type":22,"creative_skill":[1,2,3],` `"include_content":[1,2,3],"price_min":100000,"price_max":"",` `"price_right":[]}]}`. - Embedded-video example: `{"price_info":[{"cooperation_type":1,"creative_skill":[],` `"include_content":[],"price_min":100000,"price_max":"","price_right":[]}]}`. - Custom-podcast example: `{"price_info":[{"cooperation_type":23,"creative_skill":[],` `"include_content":[1],"price_min":100000,"price_max":"","price_right":[]}]}`. - Direct-post example: `{"price_info":[{"cooperation_type":3,"creative_skill":[],` `"include_content":[],"price_min":100000,"price_max":"","price_right":[]}]}`. - Call `GET /tikhub/bilibili/huahuo/square_static_info` first and read `data.price_info_options` for cooperation types, price ranges, rights, included content, and creative skills. Each item in `cooperation_type` declares its usable request fields in `supported_fields`. - `last_7_days_set_price`, `last_14_days_set_price`, `last_30_days_set_price`: `1` requires a quote set in the selected period; `0` means unrestricted. - `min_interact_rate` / `max_interact_rate`: Engagement-rate range for eligible original videos in the last 180 days. - `blue_url_ctr_gte` / `blue_url_ctr_lt`: Blue-link CTR range; `blue_url_click_cost_gte` / `blue_url_click_cost_lt`: Blue-link click-cost range. - `min_play_median` / `max_play_median`: Median-view range for eligible original videos published at least seven days ago. - `play_median_traffic_type`: `1`=all, `2`=organic; `play_median_cycle`: `1/2/3`=7/15/30 days. Example for “300,000-500,000, 15 days, organic”: `{"min_play_median":"300000","max_play_median":"500000",` `"play_median_traffic_type":2,"play_median_cycle":2}`. - `min_cpm` / `max_cpm`: CPM range; `cpm_type`: `1`=all, `2`=organic; `cpm_cycle`: `1/2/3`=7/15/30 days. - `min_cpc` / `max_cpc`: CPC range; `cpc_traffic_type`: `1`=all, `2`=organic; `cpc_cycle`: `1/2/3`=7/15/30 days. - `cpe_gte` / `cpe_lt`: CPE range; `cpe_traffic_type`: `1`=all, `2`=organic; `cpe_cycle`: `1`=7 days, `3`=30 days. #### Content and cooperation parameters: - `draft_duration`: Dominant video duration: `1`=0-30s, `2`=30-60s, `3`=1-3m, `4`=3-5m, `5`=5-10m, `6`=over 10m. - `min_avid_cnt` / `max_avid_cnt`: Eligible original-video count range over 90 days. - `min_hot_avid_rate` / `max_hot_avid_rate`: Viral-video ratio range over 90 days. - `half_min_hot_avid_cnt` / `half_max_hot_avid_cnt`: Viral-video count range over six months. - `entry_cost_min` / `entry_cost_max`: Store-entry cost range over the last year. - `av_honor`: Honor filter containing a multi-select `honor_type` array (`HOT`, `MZBK`, and/or `QZPHB`), `time_period` (`0/30/90/180` days), and `honor_count` (`0/1/2/3`, where 3 means 3+). Multi-select example: `{"av_honor":{"honor_type":["HOT","QZPHB"],"time_period":90,` `"honor_count":2}}`. - The general panel's cooperation-count filter uses `spark_tag`: `cooperate`=experienced or `coo_frequent`=extensive experience; choose one. Cooperation industries come from `square_static_info.industry_tree`; send selected paths in `huahuo_first_industry_ids`, `huahuo_second_industry_ids`, and `huahuo_third_industry_ids`. For “real estate/all with experience”: `{"spark_tag":["cooperate"],"huahuo_first_industry_ids":["388"],` `"huahuo_second_industry_ids":["389","393","399","401","403"],` `"huahuo_third_industry_ids":["390","394","395","396","398",` `"400","402","404"]}`. Merge IDs from all selected paths for a multi-industry request. - Non-general strategy panels use `cooperate_experience_industry_ids` with `cooperate_experience_type`. Without selected industries, the type options are `3`=no current-industry experience, `1`=experienced, `2`=extensive experience, and `4`=experience in other industries. With selected industries, use `1` or `2`. `cooperate_experience_industry` supplies those strategy-panel industry values. #### Labels and industry parameters: - `special_tags`: Feature tags; `spark_tag`: Capability tags such as `cooperate`, `grow`, and `hot_frequent`; `square_tag_in`: Marketplace scenario tags. - `label_array`: Contains only selected node `value`s from the “Content type” group returned by `upper_label_tree`. Put all selected content types in one inner array without parent-path values. Single “Outdoor adventure” selection: `{"label_array":[[794]]}`; multiple “Outdoor adventure, AI short film, AI entertainment” selections: `{"label_array":[[794,747,748]]}`. - `bdata_tag_lv5`: Bilibili level-five content-tag values. - `huahuo_first_industry_ids`, `huahuo_second_industry_ids`, `huahuo_third_industry_ids`: Primary, secondary, and tertiary Huahuo industry IDs. #### Commerce parameters: - `goods_permission`: `1`=require commerce permission, `0`=all; `goods_up_levels`: Commerce-creator levels. - `goods_category_first_ids` / `goods_category_second_ids`: Commerce-category IDs. - `goods_gpm_min` / `goods_gpm_max`: 30-day paid GMV per 1,000 commerce-video views. - `goods_ctr_min` / `goods_ctr_max`: Component CTR range; `goods_ctr_type`: `1`=all components, `2`=comment component. - `goods_avg_price_min` / `goods_avg_price_max`: 30-day average product-price range in RMB. - `goods_is_high_video_play_permeate`: Require high video-view penetration; `goods_is_high_fans_play_permeate`: Require high follower-view penetration. #### Status and high-potential parameters: - `is_boosting`: Require currently boosted creators; `is_treasure_up`: Treasure creators; `is_timely_response`: Timely-response creators; `is_new_enter`: Newly onboarded creators. - `custom_video_pricing_set`: Require configured custom-video pricing; `is_x_plan_better_up`: X Plan preferred creators. - `high_potential_type`: `0`=all, `1`=onboarded, `2`=not onboarded. #### Filter value sources: - Content types: call `GET /tikhub/bilibili/huahuo/upper_label_tree?panel_type=0`, read node `value`s from the Content type group, and build `label_array`. - Residence regions: call `GET /tikhub/bilibili/huahuo/region_drop`; use primary `value`s in `region_id` and selected child `value`s in `second_region_id`. - General-panel cooperation industries: call `GET /tikhub/bilibili/huahuo/square_static_info`, read the three-level `data.industry_tree`, and fill the matching `huahuo_*_industry_ids` arrays. Use `spark_tag` with `cooperate` or `coo_frequent` for cooperation count. - Non-general-panel cooperation experience: call `GET /tikhub/bilibili/huahuo/cooperate_experience_industry?industry_type=<TYPE>`, then set `cooperate_experience_industry_ids` and `cooperate_experience_type`. - Cooperation pricing: call `GET /tikhub/bilibili/huahuo/square_static_info`, read `data.price_info_options`, and build `price_info`. Median views and video honors use the fixed enums and Request Payload Examples documented here. - Other dynamic sources: call `GET /tikhub/bilibili/huahuo/square_static_info` for audience, gender, activity, and feature tags; `GET /tikhub/bilibili/huahuo/partition_drop` for first- and second-level video categories; `GET /tikhub/bilibili/huahuo/mcn_drop?name=` for MCNs; `GET /tikhub/bilibili/huahuo/dmp_pkg_list` for custom DMP packages; and `GET /tikhub/bilibili/huahuo/effect_goods_drop` for commerce categories. ### Returns - `page`: Current page number. - `total_count`: Total matching records, displayed up to 10,000. - `data`: Creator records commonly containing `upper_mid`, `nickname`, `fans_num`, `play_median`, `interactive_rate`, pricing, content and industry labels, DMP measurements, and commerce metrics. Content-search results also include matched videos. ### Billing API references: `cooperate_experience_industry` = `GET /tikhub/bilibili/huahuo/cooperate_experience_industry` (operationId: `get_tikhub_bilibili_huahuo_cooperate_experience_industry`); `dmp_pkg_list` = `GET /tikhub/bilibili/huahuo/dmp_pkg_list` (operationId: `get_tikhub_bilibili_huahuo_dmp_pkg_list`); `effect_goods_drop` = `GET /tikhub/bilibili/huahuo/effect_goods_drop` (operationId: `get_tikhub_bilibili_huahuo_effect_goods_drop`); `mcn_drop` = `GET /tikhub/bilibili/huahuo/mcn_drop` (operationId: `get_tikhub_bilibili_huahuo_mcn_drop`); `partition_drop` = `GET /tikhub/bilibili/huahuo/partition_drop` (operationId: `get_tikhub_bilibili_huahuo_partition_drop`); `region_drop` = `GET /tikhub/bilibili/huahuo/region_drop` (operationId: `get_tikhub_bilibili_huahuo_region_drop`); `square_static_info` = `GET /tikhub/bilibili/huahuo/square_static_info` (operationId: `get_tikhub_bilibili_huahuo_square_static_info`); `upper_label_tree` = `GET /tikhub/bilibili/huahuo/upper_label_tree` (operationId: `get_tikhub_bilibili_huahuo_upper_label_tree`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili search_upper_suggest
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/search_upper_suggestBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Return creator suggestions for a nickname fragment or UID, suitable for autocomplete fields and creator selection. ### Parameters - `nickname_or_mids`: Required nickname fragment or creator UID. - `page`: One-based page number. - `panel_type`: Industry strategy panel, using the same values as `search_upper`. - `marketing_target`: Marketing objective, using the same values as `search_upper`. - `cpm_type` / `play_median_traffic_type`: Metric traffic scope; 1=all traffic and 2=organic traffic. - `cpm_cycle` / `play_median_cycle`: Measurement window; 1=7 days, 2=15 days, and 3=30 days. ### Returns - Suggested creators and pagination information, typically including UID, nickname, avatar, and basic account details. ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili square_static_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/square_static_infoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve the primary filter dictionaries used to build creator marketplace search forms. ### Parameters - None. ### Returns - `fans_age_tag`, `fans_gender_tag`, and `fans_region_tag`: Audience-profile options. - `gender_info`: Creator-gender options. - `av_active_tag`: Recent-publishing activity options. - Feature labels with child options and the three-level cooperation-industry tree at `data.industry_tree`. - `data.price_info_options`: Cooperation-pricing dictionaries for `search_upper.price_info`. `cooperation_type` includes each type's `supported_fields`; `price_range` supplies ready-to-use `price_min` and `price_max`; values from `price_right`, `include_content`, and `creative_skill` go into the matching arrays. Each option's `cooperation_types` lists the types for which it is valid. - For the general panel (`panel_type=0`), put the selected path's first-, second-, and third-level IDs into `search_upper.huahuo_first_industry_ids`, `huahuo_second_industry_ids`, and `huahuo_third_industry_ids`. Send `spark_tag=["cooperate"]` for any experience or `spark_tag=["coo_frequent"]` for extensive experience. - For non-general panels, use `cooperate_experience_industry` instead of `industry_tree`. ### Example `GET /tikhub/bilibili/huahuo/square_static_info` ### Billing API references: `cooperate_experience_industry` = `GET /tikhub/bilibili/huahuo/cooperate_experience_industry` (operationId: `get_tikhub_bilibili_huahuo_cooperate_experience_industry`); `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili tag_character
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/tag_characterBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve persona tags describing a creator's image and account positioning. ### Parameters - None. ### Returns - Persona tag IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili tag_commercial
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/tag_commercialBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve tags describing creators' commercial collaboration characteristics and capabilities. ### Parameters - None. ### Returns - Commercial tag IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili tag_occupation
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/tag_occupationBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve occupation tags used for creator profiling and filtering. ### Parameters - None. ### Returns - Occupation tag IDs, names, and display information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_archive_highlights
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_archive_highlightsBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Review video highlights within a selected period and identify high-potential content. ### Parameters - `upper_mid`: Required creator UID. - `day_range`: Period: `1` last 30 days, `2` last 90 days, or `3` last 180 days. Defaults to `3`. ### Returns - Highlight labels and aggregate statistics such as site-wide top videos, popular videos, and high-value videos. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_base_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_base_infoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve a creator's basic identity and supported collaboration formats. ### Parameters - `mid`: Required creator UID. ### Returns - UID, nickname, avatar, MCN organization, and supported collaboration types in `state_types`. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_busy_time
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_busy_timeBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Check a creator's unavailable dates when planning a collaboration schedule. ### Parameters - `mid`: Required creator UID. ### Returns - Occupied or unavailable dates and related schedule information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_by_nickname
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_by_nicknameBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Find creators by full or partial nickname and resolve their UID and basic profile. ### Parameters - `nickname`: Required creator nickname or nickname fragment. ### Returns - Matching creators with UID, nickname, avatar, and basic account information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_detailBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve a complete commercial profile for creator evaluation, campaign selection, and collaboration pricing analysis. ### Parameters - `upper_mid`: Required creator UID. ### Returns - Basic profile, collaboration prices in `upper_prices`, overview metrics in `overview_v3`, and content/persona labels. - Video category and duration distributions, follower demographics in `*_distributions`, and viewer demographics in `*_distributions_audience`. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_draft_performance
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_draft_performanceBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Summarize a creator's content mix and traffic performance over a selected period. ### Parameters - `upper_mid`: Required creator UID. - `day_range`: Period: `1` last 30 days, `2` last 90 days, or `3` last 180 days. Defaults to `3`. ### Returns - Video-category distribution, duration distribution, traffic-source distribution, and related aggregate metrics. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_draft_trend
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_draft_trendBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Analyze changes in a creator's video views, engagement, or watch-time metrics. ### Parameters - `upper_mid`: Required creator UID. - `trend_type`: Metric type: `3` views, `4` likes, `5` comments, `6` danmaku comments, or `7` watch time. Defaults to `3`. ### Returns - Metric trend series, median, minimum and maximum values, plus per-video details. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_fans_trend
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_fans_trendBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Review follower size and growth velocity to evaluate account momentum and stability. ### Parameters - `upper_mid`: Required creator UID. - `query_type`: Data mode: `1` total followers or `2` follower growth. Defaults to `1`. ### Returns - Daily follower trend data and growth amount/rate for the last 7, 30, 90, 180, and 365 days. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_label_tree
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_label_treeBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve the creator-filter configuration for a selected industry strategy panel. ### Parameters - `panel_type`: Strategy panel: `0` general, `1` gaming, `2` beauty, `3` digital products, `4` automotive, `5` performance, `6` food and beverage, or `8` internet services. ### Returns - A configuration tree containing filter groups, fields, labels, option values, and display order. - `search_upper.label_array` uses only node `value`s from the “Content type” group, with every selected content type in one inner array. A single Outdoor adventure selection is `[[794]]`; Outdoor adventure, AI short film, and AI entertainment together are `[[794,747,748]]`. - `label_array` is only for content types. Cooperation-pricing options are returned at `data.price_info_options` by `square_static_info`. ### Example `GET /tikhub/bilibili/huahuo/upper_label_tree?panel_type=0` ### Billing API references: `search_upper` = `POST /tikhub/bilibili/huahuo/search_upper` (operationId: `post_tikhub_bilibili_huahuo_search_upper`); `square_static_info` = `GET /tikhub/bilibili/huahuo/square_static_info` (operationId: `get_tikhub_bilibili_huahuo_square_static_info`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_overlap_uppers
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_overlap_uppersBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Find creators whose audiences overlap with the target creator for competitor analysis and creator discovery. ### Parameters - `upper_mid`: Required target creator UID. - `fans_range`: Follower-size tier, from `9` for more than two million followers down to `2` for 10,000–50,000 followers. - `page`: One-based page number. ### Returns - Overlapping creators, audience-overlap metrics, creator profile fields, and pagination information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_representative
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_representativeBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve a creator's representative personal or sponsored videos to assess content quality and commercial experience. ### Parameters - `upper_mid`: Required creator UID. - `type`: Video type: `1` personal work or `2` commercial work. Defaults to `2`. ### Returns - Representative videos with identifiers, titles, covers, duration, view counts, and highlight labels. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_seek_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_seek_infoBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Query the collaboration inquiry types and capability settings available for a creator. ### Parameters - `mid`: Required creator UID. ### Returns - Inquiry status, supported collaboration types, and related settings. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili upper_similar
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/upper_similarBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Discover creators with content similar to the target creator and expand a campaign's comparable-creator shortlist. ### Parameters - `upper_mid`: Required target creator UID. ### Returns - An array of similar creators with UID, nickname, avatar, and similarity information. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili x_huo_date_options
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/x_huo_date_optionsBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get valid monthly or quarterly X-Huo periods for `popular_up_x_huo` requests. ### Parameters - `rank_date_type`: Ranking period type: `1` monthly or `2` quarterly. ### Returns - An ascending list of `YYYY-MM` periods. The final item is the latest completed period; the current incomplete period is excluded. ### Billing API references: `popular_up_x_huo` = `GET /tikhub/bilibili/huahuo/popular_up_x_huo` (operationId: `get_tikhub_bilibili_huahuo_popular_up_x_huo`). <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili x_huo_industry_drop
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/huahuo/x_huo_industry_dropBilibili (huahuo). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Retrieve the two-level X-Huo industry tree used by creator and product rankings. ### Parameters - `scene`: Ranking scene: `1` creator ranking or `2` product ranking. The industry ID sets are different between scenes. ### Returns - A two-level industry list whose node `id` values can be passed as `x_huo_industry_id` to the matching ranking endpoints. ### Billing <!-- aisa-pricing:start --> Published reference price: $0.006 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili bv_to_aid
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/bv_to_aidBilibili (web). ### Purpose: - Generate aid by bvid ### Parameters: - bv_id: Video id ### Return: - Video aid <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_all_live_areas
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_all_live_areasBilibili (web). ### Purpose - Get a list of all live areas ### Return - list of all live areas <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_collect_folders
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_collect_foldersBilibili (web). ### Purpose: - Get user collection folders ### Parameters: - uid: User UID ### Return: - user collection folders <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_com_popular
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_com_popularBilibili (web). ### Purpose: - Get comprehensive popular video information ### Parameters: - pn: Page number ### Return: - comprehensive popular video information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_comment_reply
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_comment_replyBilibili (web). ### Purpose: - Get reply to the specified comment ### Parameters: - bv_id: Video id - pn: Page number - rpid: Reply id ### Return: - Reply of the specified comment <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_dynamic_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_dynamic_detail_v2Bilibili (web). ### Purpose: - Get detail information of specified dynamic (v2 API) - Use this endpoint for video dynamics (DYNAMIC_TYPE_AV) - module_stat only contains comment / forward / like; for favorite / coin on image / text / article dynamics use the v1 endpoint ### Parameters: - dynamic_id: Dynamic id ### Return: - Dynamic detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_general_search
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_general_searchBilibili (web). ### Purpose: - Get general search data ### Parameters: - keyword: Search keyword - order: Order method - totalrank Comprehensive sorting - click Most played - pubdate Latest release - dm Most barrage - stow Most collection - page: Page number - page_size: Number per page - duration: Duration filter - 0 All durations - 1 Under 10 minutes - 2 10-30 minutes - 3 30-60 minutes - 4 Over 60 minutes - pubtime_begin_s: Start date, 10-digit timestamp, must be less than end date - pubtime_end_s: End date, 10-digit timestamp, must be greater than start date ### Return: - General search data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_get_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_get_user_idBilibili (web). ### Purpose: - Extract user ID ### Parameters: - share_link: User share link ### Return: - User ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_hot_search
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_hot_searchBilibili (web). ### Purpose: - Get hot search data ### Parameters: - limit: Return number ### Return: - Hot search data ### Note: - Send `limit` explicitly as an integer no greater than 50; use 10 for the documented default result size. The query parameter is required. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_live_room_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_live_room_detailBilibili (web). ### Purpose: - Get information of specified live room ### Parameters: - room_id: Live room ID ### Return: - information of specified live room <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_live_streamers
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_live_streamersBilibili (web). ### Purpose: - Get live streamers of specified live area ### Parameters: - area_id: Live area ID - pn: Page number ### Return: - live streamers of specified live area <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_live_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_live_videosBilibili (web). ### Purpose: - Get live video data of specified room ### Parameters: - room_id: Live room ID ### Return: - live video data of specified room <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_one_videoBilibili (web). ### Purpose: - Get single video data ### Parameters: - bv_id: Video id ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_collection_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_collection_videosBilibili (web). ### Purpose: - Gets video data from a collection folder ### Parameters: - folder_id: collection folder id - pn: Page number ### Return: - video data from collection folder <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_dynamic
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_dynamicBilibili (web). ### Purpose: - Get dynamic information of specified user ### Parameters: - uid: User UID - offset: offset ### Return: - dynamic information of specified user <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_post_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_post_videos_v2Bilibili (web). ### Purpose - Get user post video data, optionally searching by keyword within that user's works. - See "Differences from V1" below for how this compares to the upstream V1 endpoint, which is not exposed in this specification. ### Parameters - uid: User UID - pn: Page number, no cap; past the last page `data.archives` comes back empty - ps: Page size, 1~100 - keyword: Keyword, empty returns all works of the user - Single word only; do not include spaces. ### Differences from V1 - **No pagination cap**: V1 reaches at most 5000 works; this endpoint pages all the way back to the user's earliest upload. Use this one when a user has more than 5000 works. - **Keyword works**: this endpoint supports searching within the user's works; V1 does not. - **Leaner fields**: returns `aid`/`bvid`/`title`/`pubdate`/`pic`/`duration`/`desc`/`stat.view` and similar; no comment count or category fields. Use V1 for those, or fill them in per `bvid` via `/tikhub/bilibili/web/fetch_one_video`. - Ordering is fixed to newest-first by publish time; no `order` parameter. ### Return - User posted video data; the list is in `data.archives`, the total in `data.page.total` API references: `fetch_one_video` = `GET /tikhub/bilibili/web/fetch_one_video` (operationId: `get_tikhub_bilibili_web_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_profileBilibili (web). ### Purpose: - Get information of specified user ### Parameters: - uid: User UID ### Return: - information of specified user <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_relation_stat
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_relation_statBilibili (web). ### Purpose: - Get user relation stat (following count and follower count) ### Parameters: - uid: User UID ### Return: - User relation stat data - following: Following count - follower: Follower count <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_user_up_stat
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_user_up_statBilibili (web). ### Purpose: - Get UP stat (total video views and total likes) ### Parameters: - uid: User UID ### Return: - UP stat data - archive.view: Total video views - likes: Total likes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_commentsBilibili (web). ### Purpose: - Get comments on the specified video ### Parameters: - bv_id: Video id - pn: Page number ### Return: - comments of the specified video <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_danmaku
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_danmakuBilibili (web). ### Purpose: - Get Video Danmaku ### Parameters: - cid: Video cid ### Return: - Video Danmaku <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_detailBilibili (web). ### Purpose: - Get single video detail ### Parameters: - aid: Video id ### Return: - Video detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_parts
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_partsBilibili (web). ### Purpose: - Get Video Parts By bvid ### Parameters: - bv_id: Video id ### Return: - Video Parts <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_play_info
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_play_infoBilibili (web). ### Purpose: - Get single video play info ### Parameters: - url: Video URL ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_playurl
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_playurlBilibili (web). ### Purpose: - Get video playurl ### Parameters: - bv_id: Video id - cid: Video cid ### Return: - Video playurl <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_video_subtitle
$MeteredGET https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_video_subtitleBilibili (web). ### Purpose: - Get video subtitle info ### Parameters: - a_id: Video id - c_id: Video cid ### Return: - Video subtitle info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
bilibili fetch_vip_video_playurl
$MeteredPOST https://aisa.one/apis/v1/tikhub/bilibili/web/fetch_vip_video_playurlBilibili (web). ### Purpose: - Get VIP video playurl ### Parameters: - bv_id: Video id - cid: Video cid - cookie: VIP User Cookie ### Return: - VIP video playurl <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_hot_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_brand_hot_search_listDouyin (app/v3). ### Purpose: - Get Douyin brand hot search category data ### Return: - Hot brand search category data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_hot_search_list_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_brand_hot_search_list_detailDouyin (app/v3). ### Purpose: - Get Douyin brand hot search list detail data ### Parameters: - category_id: Category id ### Return: - Hot brand search list detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hashtag_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_hashtag_detailDouyin (app/v3). ### Purpose: - Get details of specified hashtag ### Parameters: - ch_id: Hashtag id ### Return: - Hashtag details data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hashtag_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_hashtag_video_listDouyin (app/v3). ### Purpose: - Get video list of specified hashtag ### Parameters: - ch_id: Hashtag id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - sort_type: 0: Comprehensive sorting 1: Most likes 2: Latest release - count: Number Please keep the default, otherwise there will be BUG. ### Return: - Hashtag video list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_hot_search_listDouyin (app/v3). ### Purpose: - Get Douyin hot search list data, including: - Hot search list - Seeding list - Entertainment list - Social list - Challenge list ### Parameters: - board_type: - 0: Hot search list (default) - 2: Other lists, such as seeding list, etc., need to pass in the corresponding board_sub_type parameter. - board_sub_type: - Empty string: Hot search list (default) - seeding: Seeding list - 2: Entertainment list - 4: Social list - hotspot_challenge: Challenge list ### Return: - Hot search list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_live_hot_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_live_hot_search_listDouyin (app/v3). ### Purpose: - Get Douyin live hot search list data ### Return: - Live hot search list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_video
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_multi_videoDouyin (app/v3). ### Purpose - Batch Get Video Information, support photo, video, etc., up to 10 videos at a time. ### Parameters - Root JSON body: List of video ids, up to 10 video ids are supported. ### Return - Video data ### Note - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to: - JSON PATH: $.data.filter_list[0].reason - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.) - 8: The video does not exist or has been deleted - 5: This content is marked as private content and does not have public display permissions - 10: This content is marked as partially visible, only visible to some users chosen by the author - For more status codes, please submit them to our customer support for supplementation. ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_video_high_quality_play_url
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_multi_video_high_quality_play_urlDouyin (app/v3). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose If there are less than 50 videos, they will be charged as 50 videos. - Batch get the highest quality (original upload quality) play URL of videos - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata. - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface. - This interface is very suitable for batch obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc. - Use concurrent requests to improve batch acquisition efficiency. - Support up to 50 video IDs. ### Parameters - aweme_ids: Video id list, separated by commas, for example: "123,456,789", up to 50. ### Return - total: Total count - success_count: Success count - failed_count: Failed count - videos: Video list, each video contains the following fields: - video_id: Video id - original_video_url: Highest quality (original upload quality) play URL - file_size: File size (bytes) - file_size_in_mb: File size (MB) - content_type: Content type - success: Whether successful - error: Error message (if failed) ### Note - Due to the large number, the processing time may be slightly longer, please increase the waiting time. <!-- aisa-pricing:start --> Published reference price: $0.25 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_video_statistics
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_multi_video_statisticsDouyin (app/v3). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the statistical data of the Post according to the video ID, support multiple video ids, up to 50 videos at a time. - Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface. - List of statistics that can be obtained: - Like count (digg_count) - Download count (download_count) - Play count (play_count) - Share count (share_count) ### Parameters - aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 50, single is also possible, no need for commas. ### Return - Post statistics data <!-- aisa-pricing:start --> Published reference price: $0.025 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_music_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_music_detailDouyin (app/v3). ### Purpose: - Get details of specified music ### Parameters: - music_id: Music id ### Return: - Music details data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_music_hot_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_music_hot_search_listDouyin (app/v3). ### Purpose: - Get Douyin music hot search list data ### Parameters: - chart_type: Chart type, default value is 'hot', supports the following values: - 'hot': Hot chart - 'trending': Trending chart - 'original': Original chart - cursor: Cursor, default value is '0', used for paginating data retrieval. After each request, the next cursor value will be returned, and the `has_more` field indicates whether there is more data available. ### Return: - Music hot search list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_music_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_music_video_listDouyin (app/v3). ### Purpose: - Get video list of specified music ### Parameters: - music_id: Music id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number Please keep the default, otherwise there will be BUG. ### Return: - Music video list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_one_videoDouyin (app/v3). ### Purpose: - Get single video data, support photo, video, etc. ### Parameters: - aweme_id: Video id ### Return: - Video data ### Note: - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to: - JSON PATH: $.data.filter_list[0].reason - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.) - 8: The video does not exist or has been deleted - 5: This content is marked as private content and does not have public display permissions - 10: This content is marked as partially visible, only visible to some users chosen by the author - For more status codes, please submit them to our customer support for supplementation. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_one_video_by_share_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_one_video_by_share_urlDouyin (app/v3). ### Purpose: - Get single video data by sharing link ### Parameters: - share_url: Share link ### Return: - Video data ### Note: - If the interface returns empty, please use the same parameters to request the Web version interface. The specific response status code refers to: - JSON PATH: $.data.filter_list[0].reason - 8: This content is temporarily unavailable for viewing due to overseas copyright restrictions (short dramas, movie clips, etc.) - 8: The video does not exist or has been deleted - 5: This content is marked as private content and does not have public display permissions - 10: This content is marked as partially visible, only visible to some users chosen by the author - For more status codes, please submit them to our customer support for supplementation. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_series_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_series_detailDouyin (app/v3). ### Purpose: - Get series/playlet detail information ### Parameters: - series_id: Series id ### Return: - Series detail data ### Note: - This interface returns detailed information of the series, including: - Series name, description, cover - Author information - Total episodes, update status - Play count, collection count and other statistics - Payment information (if any) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_series_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_series_video_listDouyin (app/v3). ### Purpose: - Get series/playlet video list ### Parameters: - series_id: Series id - cursor: Cursor, used for paging, the first page is 0, the second page is usually the value of count (e.g., 15). ### Return: - Series video list data ### Note: - This interface returns all video list in the series - The aweme_list in the response contains video information of each episode - The has_more field indicates whether there is more data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_share_info_by_share_code
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_share_info_by_share_codeDouyin (app/v3). ### Purpose: - Get share info by share code, such as extracting sharer information and article ID from Douyin article share code, and then requesting a single video data interface to get the article content. ### Parameters: - share_code: Share code ### Return: - Share info, including sharer information and article ID, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_fans_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_user_fans_listDouyin (app/v3). ### Purpose: - Get user fans list ### Parameters: - sec_user_id: User sec_user_id - max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging. - count: Number, default is 20, it is recommended to keep it unchanged. ### Return: - Fans list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_like_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_user_like_videosDouyin (app/v3). ### Purpose - Get user like video data ### Parameters - sec_user_id: User sec_user_id - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response. - counts: Maximum count number ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_post_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_user_post_videosDouyin (app/v3). ### Purpose: - Get user homepage video data ### Parameters: - sec_user_id: User sec_user_id - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response. - count: Maximum count number, do not exceed 20, it is recommended to keep it unchanged. - sort_type: Sort type, optional values are as follows: - `0`: Latest sorting - default - `1`: Hottest sorting - channel: Douyin channel version, optional values are as follows: - `normal`: Normal Douyin - default - `lite`: Douyin Lite - Note: The normal Douyin may fail to show the latest videos on certain user homepages. In that case, switch to the Lite channel to get the user's latest posted videos. ### Return: - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_series_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_user_series_listDouyin (app/v3). ### Purpose: - Get user's series/playlet collection list ### Parameters: - user_id: User id - sec_user_id: User encrypted id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. ### Return: - User series list data ### Note: - This interface returns all series collections published by the user - The series_id in the response can be used to get series details and video list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_comment_repliesDouyin (app/v3). ### Purpose: - Get comment replies data of specified video ### Parameters: - item_id: Video id - comment_id: Comment id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number Please keep the default, otherwise there will be BUG. ### Return: - Comment replies data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_commentsDouyin (app/v3). ### Purpose: - Get single video comments data ### Parameters: - aweme_id: Video id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number Please keep the default, otherwise there will be BUG. ### Return: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_high_quality_play_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_high_quality_play_urlDouyin (app/v3). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the highest quality (original upload quality) play URL of the video - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata. - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface. - This interface is very suitable for obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc. - Generally, it can be played online, if not, you can try to download it using IDM or a browser and then play it. ### Parameters - aweme_id: Video id, prefer to use aweme_id, if not available, use share_url. - share_url: Optional, share link, if the video id is provided, this parameter can be omitted. - region: Optional, ISO country code (e.g. "CN" / "US" / "HK") used as the request exit region. - Douyin returns CDN URLs based on the request IP. Pass `region="CN"` for users located in mainland China to get China-region CDN URLs, which are significantly faster than overseas CDNs. - If omitted, the request uses the service's own exit IP (typically overseas). ### Return - video_id: Video id - original_video_url: Highest quality (original upload quality) play URL - video_data: Video data, including metadata such as duration, size, etc. <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_mix_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_mix_detailDouyin (app/v3). ### Purpose: - Get Douyin video mix detail data ### Parameters: - mix_id: Mix id ### Return: - Video mix detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_mix_post_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_mix_post_listDouyin (app/v3). ### Purpose: - Get Douyin video mix post list data ### Parameters: - mix_id: Mix id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number Please keep the default, otherwise there will be BUG. ### Return: - Video mix post list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_statistics
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/fetch_video_statisticsDouyin (app/v3). ### Purpose: - Get the statistical data of the Post according to the video ID - Most of the Douyin interfaces no longer return the number of plays of the Post, and can only be obtained through this interface. - List of statistics that can be obtained: - Like count (digg_count) - Download count (download_count) - Play count (play_count) - Share count (share_count) ### Parameters: - aweme_ids: Video id, supports multiple video ids, separated by commas, no more than 2, single is also possible, no need for commas. ### Return: - Post statistics data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin generate_douyin_short_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/generate_douyin_short_urlDouyin (app/v3). ### Purpose: - Generate Douyin short link ### Parameters: - url: Douyin link ### Return: - Short link data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin generate_douyin_video_share_qrcode
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/generate_douyin_video_share_qrcodeDouyin (app/v3). ### Purpose: - Generate Douyin video share QR code ### Parameters: - object_id: Video id or author uid ### Return: - QR code data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin handler_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/handler_user_profileDouyin (app/v3). ### Purpose: - Get information of specified user ### Parameters: - sec_user_id: User sec_user_id ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin open_douyin_app_to_keyword_search
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/open_douyin_app_to_keyword_searchDouyin (app/v3). ### Purpose: - Generate Douyin share link, call Douyin APP, and jump to the specified keyword search result ### Parameters: - keyword: Keyword ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin open_douyin_app_to_send_private_message
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/open_douyin_app_to_send_private_messageDouyin (app/v3). ### Purpose - Generate Douyin share link, call Douyin APP, and send private messages to specified users ### Parameters - uid: User id - sec_uid: User sec_uid - Note: Please make sure that both uid and sec_uid have values, otherwise you cannot send private messages to the specified user. ### Return - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin open_douyin_app_to_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/open_douyin_app_to_user_profileDouyin (app/v3). ### Purpose - Generate Douyin share link, call Douyin APP, and jump to the specified user profile ### Parameters - uid: User id - sec_uid: User sec_uid - Note: Please make sure that both uid and sec_uid have values, otherwise you cannot jump to the specified user profile. ### Return - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin open_douyin_app_to_video_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/open_douyin_app_to_video_detailDouyin (app/v3). ### Purpose: - Generate Douyin share link, call Douyin APP, and jump to the specified video ### Parameters: - aweme_id: Video id ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin register_device
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/app/v3/register_deviceDouyin (app/v3). ### Purpose: - Register device in Douyin APP, retrieve device information and device cookies. ### Parameters: - proxy: Proxy, with http:// or https://, only supports http proxies. - Format: username:password@ip:port ### Return: - Device information and device cookies. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_city_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_city_listDouyin (billboard). ### Purpose: - Get city list ### Parameters: - None ### Return: - Chinese city list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_tag
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_content_tagDouyin (billboard). ### Purpose: - Get vertical content tags ### Parameters: - None ### Return: - Vertical content tags ### Note: - This interface is used to obtain vertical content tags, used to construct the tags/query_tag parameters ### Example: Given the top-level vertical content tag `Food`, its top-level vertical id is `628`; `Food`'s sub-vertical tag `Wine Tasting`, its sub-vertical id is `62802`. Then the constructed tag query parameter is `{"value": 628, "children": [{"value": 62802}]}` If you need multiple sub-vertical tags, all food sub-vertical tags are `{"value":628,"children":[{"value":62808},{"value":62804},{"value":62806},{"value":62803},{"value":62802},{"value":62801},{"value":62811},{"value":62807},{"value":62805},{"value":62810}]}` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_fans_interest_account_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_fans_interest_account_listDouyin (billboard). ### Purpose: - Get the fan interest author 20 users ### Parameters: - sec_uid: User sec_id ### Return: - Fan interest author 20 users <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_fans_interest_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_fans_interest_search_listDouyin (billboard). ### Purpose: - Get the fan interest search term in the last 3 days 10 search terms ### Parameters: - sec_uid: User sec_id ### Return: - Fan interest search term in the last 3 days 10 search terms <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_fans_interest_topic_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_fans_interest_topic_listDouyin (billboard). ### Purpose: - Get the fan interest topic in the last 3 days 10 topics ### Parameters: - sec_uid: User sec_id ### Return: - Fan interest topic in the last 3 days 10 topics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_fans_portrait_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_fans_portrait_listDouyin (billboard). ### Purpose: - Get the fan portrait ### Parameters: - sec_uid: User sec_id - option: Option - 1 Mobile price - 2 Gender distribution - 3 Age distribution - 4 Regional distribution - province - 5 Regional distribution - city - 6 City level - 7 Mobile brand distribution - 8 Interest tag analysis percentage ### Return: - Fan portrait <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_item_analysis_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_item_analysis_listDouyin (billboard). ### Purpose - Get the account work analysis ### Parameters - sec_uid: User sec_id ### Return - Account work analysis <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_listDouyin (billboard). ### Purpose: - Get the hot account ### Parameters: - date_window: Time window in hours, one of 24/72/168 (last 1 day / 3 days / 7 days), default 24 - page_num: Page number, default 1 - page_size: Number of items per page, default 10 - query_tag: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "date_window": 24, "page_num": 1, "page_size": 10, "query_tag": {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} } ``` ### Return: - Hot account API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_search_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_search_listDouyin (billboard). ### Purpose: - Get the search username or Douyin number ### Parameters: - keyword: Search username or Douyin number - cursor: Cursor, default empty ### Return: - Search result <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_account_trends_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_account_trends_listDouyin (billboard). ### Purpose: - Get the account fan data trend ### Parameters: - sec_uid: User sec_id - option: Option, 2 New like 3 New work 4 New comment 5 New share - date_window: Data point granularity in hours, one of 1/24 (one point per hour / per day), default 24 ### Return: - Account fan data trend <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_calendar_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_calendar_detailDouyin (billboard). ### Purpose: - Get the activity calendar details ### Parameters: - calendar_id: Activity id ### Return: - Activity calendar details <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_calendar_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_calendar_listDouyin (billboard). ### Purpose: - Get the activity calendar ### Parameters: - city_code: City code, get from city list, empty for all - category_code: Hot list category code, get from hot list category, empty for all - end_date: Snapshot end time format 10 digit timestamp - start_date: Snapshot start time format 10 digit timestamp ### Return: - Activity calendar <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_category_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_category_listDouyin (billboard). ### Purpose: - Get the id and popularity of the hot list category - Note: Using start_date and end_date parameters requires removing the snapshot_time parameter - Note: snapshot_time and start_date, end_date parameters cannot be empty at the same time ### Parameters: - billboard_type: Billboard type - rise Rising hot list - city City hot list - total Total hot list - snapshot_time: Snapshot time - start_date: Snapshot start time - end_date: Snapshot end time - keyword: Hot search term ### Return: - Hot category list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_challenge_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_challenge_listDouyin (billboard). ### Purpose: - Get the challenge list ### Parameters: - page: Page number - page_size: Number of items per page - keyword: Hot search term ### Return: - Challenge list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_city_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_city_listDouyin (billboard). ### Purpose: - Get the city hot list ### Parameters: - page: Page number - page_size: Number of items per page - order: Sorting method - rank Sort by popularity - rank_diff Sort by ranking change - city_code: City code, get from city list, empty for all - sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all - keyword: Hot search term ### Return: - City hot list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_comment_word_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_comment_word_listDouyin (billboard). ### Purpose: - Get the work comment analysis word cloud weight ### Parameters: - aweme_id: Work id ### Return: - Work comment analysis word cloud weight <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_item_trends_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_item_trends_listDouyin (billboard). ### Purpose: - Get the work data trend ### Parameters: - aweme_id: Work id - option: Option, 7 Like 8 Share 9 Comment - date_window: Data point granularity, one of 1/2 (by hour / by day), default 1 ### Return: - Work data trend <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_rise_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_rise_listDouyin (billboard). ### Purpose: - Get the rising hot list ### Parameters: - page: Page number - page_size: Number of items per page - order: Sorting method - rank Sort by popularity - rank_diff Sort by ranking change - sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all - keyword: Hot search term ### Return: - Rising hot list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_high_fan_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_high_fan_listDouyin (billboard). ### Purpose: - Get the high fan rate list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - High fan rate list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_high_like_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_high_like_listDouyin (billboard). ### Purpose: - Get the high like rate list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - High like rate list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_high_play_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_high_play_listDouyin (billboard). ### Purpose: - Get the high completion rate list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - High completion rate list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_high_search_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_high_search_listDouyin (billboard). ### Purpose - Get the search list with rising popularity ### Parameters - page_num: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword ### Request Example ```json { "page_num": 1, "page_size": 10, "date_window": 24, "keyword": "Douyin" } ``` ### Return - Search list with rising popularity <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_high_topic_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_high_topic_listDouyin (billboard). ### Purpose: - Get the topic list with rising popularity ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - Topic list with rising popularity API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_hot_word_detail_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_hot_word_detail_listDouyin (billboard). ### Purpose: - Get the details of content words ### Parameters: - keyword: Search keyword - word_id: Content word id - query_day: Query date, format is YYYYMMDD ### Return: - Details of content words <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_hot_word_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_hot_word_listDouyin (billboard). ### Purpose - Get the list of all content words ### Parameters - page_num: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 24/72/168 (last 1 day / 3 days / 7 days), default 24 - keyword: Search keyword ### Request Example ```json { "page_num": 1, "page_size": 10, "date_window": 24, "keyword": "Douyin" } ``` ### Return - List of all content words <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_listDouyin (billboard). ### Purpose: - Get the total hot list ### Parameters: - page: Page number - page_size: Number of items per page - type: Snapshot type snapshot view by time range view by time range. - Note: snapshot_time is valid when snapshot, start_date and end_date are valid when range - snapshot_time: Snapshot time format yyyyMMddHHmmss - start_date: Snapshot start time format yyyyMMdd - end_date: Snapshot end time format yyyyMMdd - sentence_tag: Hot category tag, get from hot list category, multiple categories separated by commas, empty for all - keyword: Hot search term ### Return: - Total hot list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_low_fan_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_low_fan_listDouyin (billboard). ### Purpose: - Get the low fan explosion list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - Low fan explosion list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_search_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_search_listDouyin (billboard). ### Purpose - Get the search list ### Parameters - page_num: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword ### Request Example ```json { "page_num": 1, "page_size": 10, "date_window": 24, "keyword": "Douyin" } ``` ### Return - Search list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_topic_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_topic_listDouyin (billboard). ### Purpose: - Get the topic list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - Topic list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_total_video_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_total_video_listDouyin (billboard). ### Purpose: - Get the video list ### Parameters: - page: Page number - page_size: Number of items per page - date_window: Time window in hours, one of 1/24/72/168 (last 1 hour / 1 day / 3 days / 7 days), default 24 - sub_type: List category, 1001 Video total list 1002 Low fan explosion 1003 High completion rate 1004 High fan growth rate 1005 High like rate - keyword: Search keyword to filter the billboard, empty for all - tags: Vertical category tag filter, empty for all, tag ids come from the fetch_content_tag endpoint ### Request Example: ```json { "page": 1, "page_size": 10, "date_window": 24, "sub_type": 1001, "keyword": "", "tags": [ {"value": 628, "children": [{"value": 62808}, {"value": 62804}]} ] } ``` ### Return: - Video list API references: `fetch_content_tag` = `GET /tikhub/douyin/billboard/fetch_content_tag` (operationId: `get_tikhub_douyin_billboard_fetch_content_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_user_portrait_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/billboard/fetch_hot_user_portrait_listDouyin (billboard). ### Purpose: - Get the work like audience portrait ### Parameters: - aweme_id: Work id - option: Option - 1 Mobile price - 2 Gender distribution - 3 Age distribution - 4 Regional distribution - province - 5 Regional distribution - city - 6 City level - 7 Mobile brand distribution ### Return: - Work like audience portrait <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_activity_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_activity_detailDouyin (creator). ### Purpose: - Get Douyin creator activity detail data ### Parameters: - activity_id: Activity ID (obtained from activity list interface) ### Return: - Creator activity detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_activity_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_activity_listDouyin (creator). ### Purpose: - Get Douyin creator activity list data ### Parameters: - start_time: Start timestamp - end_time: End timestamp ### Return: - Creator activity list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_content_category
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_content_categoryDouyin (creator). ### Purpose: - Get Douyin creator platform content creation category list ### Parameters: - No additional parameters required ### Return: - Content creation category data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_content_course
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_content_courseDouyin (creator). ### Purpose: - Get Douyin creator platform content creation courses for specified category ### Parameters: - category_id: Category ID (for more category IDs, please refer to the content creation category interface) Common category ID examples: - 184: Video Creation - 185: Live Streaming Creation - 186: Image & Text Creation - 188: Food Video Creation - 180: Content Creation Basics - order: Order type (1=recommended order, 2=most popular, 3=latest upload) - limit: Items per page (recommended 24, range 1-100) - offset: Offset (starting position) ### Return: - Content creation course data for specified category <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_challenge_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_challenge_billboardDouyin (creator). ### Purpose: - Get Douyin creator platform hot challenge billboard data ### Return: - Hot challenge billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_course
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_courseDouyin (creator). ### Purpose: - Get Douyin creator platform hot course data or selected topic courses ### Parameters: - order: Order type (1=recommended order, 2=most popular, 3=latest upload) - limit: Items per page (recommended 24, range 1-100) - offset: Offset (starting position) - category_id: Selected topic category ID (empty for hot courses, specific ID for selected topics) Available values: - 6976547830546582816: Knowledge Category - 6976547923849006336: Life Category - 6976547940311633165: Entertainment Category - 6976547972108635404: Food Category - 6980288134957272352: Positive Energy - 6980288181744766219: Gaming Category - 6980288219548011776: General ### Return: - Hot course data or selected topic course data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_music_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_music_billboardDouyin (creator). ### Purpose: - Get Douyin creator platform hot music billboard data ### Parameters: - billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface - order_key: Order key (1=highest views, 2=most likes, 4=highest popularity, 5=most submissions) - time_filter: Time filter (1=24 hours, 2=7 days, 3=30 days) ### Return: - Hot music billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_props_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_props_billboardDouyin (creator). ### Purpose: - Get Douyin creator hot props billboard data ### Parameters: - billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface - 0: All - 333: Food - 334: Travel - 299: Lifestyle - 335: Automotive - 336: Technology - 302: Gaming - 296: Anime - 337: Entertainment - 311: Celebrity - 298: Sports - 300: Culture & Education - 301: Campus - 297: Government - 305: Fashion - 306: Talent Show - 669: Finance - 314: Random - 307: Animals & Plants - 309: Graphics & Text - 308: Drama - 315: Parenting - 718: Agriculture - 310: Creative - 312: Outdoor - 926: Public Welfare - order_key: Order key - 1: Highest views - 5: Most submissions - 6: Highest exposure - 7: Most favorites - time_filter: Time filter - 1: 24 hours - 2: 7 days - 3: 30 days ### Return: - Creator hot props billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_spot_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_spot_billboardDouyin (creator). ### Purpose: - Get Douyin creator hot spot billboard data ### Parameters: - billboard_tag: Hot spot tag - multiple tags separated by comma Available values: - Platform Features: 1004,1000,1002,1003,1001 - Topic Interaction: 20001,20006,20000,20003,20005,20002,20 - Entertainment: 2007,2000,2011,2012,2009,2010,2004,2005,2003,2008,2001,2002,2006 - Society: 4005,4006,4007,4003,4004,4000 - Anime: 13000 - Transportation: 23000 - Parenting: 19000 - Sports: 5002,5000,5001 - Military: 21000 - Drama: 18000 - Animals & Pets: 8000 - Weather: 22001,22002 - Talent Show: 17000 - Culture & Education: 14000 - Travel: 10000 - Fashion: 16000 - Politics: 3000,3001,3002 - Campus: 15000 - Automotive: 11000 - Gaming: 12000,12001 - Technology: 6000 - Food: 9000 - Finance: 7000 - hot_search_type: Hot search type - 1: Hot Spot Overall Ranking - 2: Local Hot Spot Ranking - 3: Rising Hot Spot Ranking - city_code: City code - required when hot_search_type=2 ### Return: - Creator hot spot billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_hot_topic_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_hot_topic_billboardDouyin (creator). ### Purpose: - Get Douyin creator hot topic billboard data ### Parameters: - billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface - 0: All - 333: Food - 334: Travel - 299: Lifestyle - 335: Automotive - 336: Technology - 302: Gaming - 296: Anime - 337: Entertainment - 311: Celebrity - 298: Sports - 300: Culture & Education - 301: Campus - 297: Government - 305: Fashion - 306: Talent Show - 669: Finance - 314: Random - 307: Animals & Plants - 309: Graphics & Text - 308: Drama - 315: Parenting - 718: Agriculture - 310: Creative - 312: Outdoor - 926: Public Welfare - order_key: Order key - 1: Highest views - 2: Most likes - 3: Most comments - 4: Most submissions - time_filter: Time filter - 1: 24 hours - 2: 7 days - 3: 30 days ### Return: - Creator hot topic billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_material_center_billboard
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_material_center_billboardDouyin (creator). ### Purpose: - Get Douyin creator material center billboard data ### Parameters: - billboard_tag: Billboard tag, 0=all, other values can be obtained through config interface - 0: All - 333: Food - 334: Travel - 299: Lifestyle - 335: Automotive - 336: Technology - 302: Gaming - 296: Anime - 337: Entertainment - 311: Celebrity - 298: Sports - 300: Culture & Education - 301: Campus - 297: Government - 305: Fashion - 306: Talent Show - 669: Finance - 314: Random - 307: Animals & Plants - 309: Graphics & Text - 308: Drama - 315: Parenting - 718: Agriculture - 310: Creative - 312: Outdoor - 926: Public Welfare - order_key: Order key - 1: Highest views - 2: Most likes - 3: Most comments - 4: Highest popularity - time_filter: Time filter - 1: 24 hours - 2: 7 days - 3: 30 days ### Return: - Creator material center billboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_material_center_config
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_material_center_configDouyin (creator). ### Purpose: - Get Douyin creator material center configuration ### Return: - Creator material center config data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_creator_material_center_related
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_creator_material_center_relatedDouyin (creator). ### Purpose: - Get related videos for a topic/hot spot/prop/music item in Douyin creator material center - Retrieve query_id from upstream billboard endpoints first, then call this API to fetch related videos ### Parameters: - query_id: Query ID (topic_id / hot_id obtained from billboard endpoints) - billboard_type: Billboard type - 2: Hot spot - 3: Topic - 4: Props - 5: Music - limit: Items per page (default 20, range 1-100) - offset: Offset (starting position for pagination) ### Return: - Related videos list data for the given query_id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_industry_category_config
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_industry_category_configDouyin (creator). ### Purpose: - Get industry category configuration from Douyin Creator platform - Returns all available industry classification hierarchy - **Recommend calling this API first before using mission task list API to get complete industry classification info** ### Important Notes: - This API is optimized with Redis caching, data will be cached for 30 days after first call - Cache key: `douyin_creator:industry_categories` - Data structure contains complete mapping relationship between primary and secondary industries ### Data Structure: ```json { "status_code": 0, "status_msg": "success", "data": { "industry_categories": [ {"key": "-1", "label": "All"}, {"key": 1901, "label": "3C & Electronics"}, {"key": 1913, "label": "Gaming"}, ... ], "industry_subcategories": { 1913: [ {"key": "-1", "label": "All"}, {"key": 191301, "label": "Casual Games"}, {"key": 191302, "label": "Board Games"}, ... ], ... } } } ``` ### Usage in Mission Task Filtering: 1. **Get all industry tasks**: `industry_lv1=-1` (industry_lv2 not needed) 2. **Get specific primary industry**: `industry_lv1=1913` (Gaming industry) 3. **Get specific secondary industry**: `industry_lv1=1913&industry_lv2=191301` (Gaming-Casual Games) ### Performance Optimization: - First call reads from local JSON file and caches to Redis - Subsequent calls read directly from Redis cache, significantly improving response speed - Cache validity period of 30 days ensures data timeliness ### Return: - Returns complete industry classification tree structure - Contains 32 primary industry categories and corresponding secondary industry categories - Each category contains category ID(key) and name(label) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_mission_task_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_mission_task_listDouyin (creator). ### Purpose - Get mission task list from Douyin Creator platform - Supports multiple filtering conditions including industry classification, payment type, platform channel, etc. ### Important Parameter Usage Guidelines #### Industry Classification Combination Rules: - **industry_lv1=-1 (All)**: When selecting all primary industries, industry_lv2 parameter will be ignored, no need to set - **industry_lv1=specific value**: When selecting specific primary industry, can be combined with industry_lv2 for secondary filtering - industry_lv2=-1: All secondary categories under the primary industry - industry_lv2=specific value: Specific secondary category under the primary industry #### Optional Parameters (No need to pass when selecting "All"): - **platform_channel**: Not passing means all platform channels - **pay_type**: Not passing means all payment types - **greater_than_cost_progress**: Not passing means no cost progress restriction - **publish_time_start**: Not passing means no publish time restriction - **quick_selector_scene**: Not passing means no quick filtering - **keyword**: Not passing means no keyword search ### Parameter Details - cursor: Cursor for pagination, 0 for first page - limit: Number of tasks per page, recommended 24 - mission_type: Mission type, usually 1 - tab_scene: Scene type - 1: Submittable (tasks that can be submitted directly) - 2: Registrable (tasks that require registration and approval) - 3: Product Review (product evaluation tasks) - industry_lv1/lv2: Industry classification (recommend calling fetch_industry_category_config first) - -1: All industries - Specific values: Corresponding to specific industry categories (e.g., 1913=Gaming, 1903=Food&Beverage) - platform_channel: Platform channel (optional) - 1: Douyin Video - 2: Douyin Live - 3: Douyin Image&Text - pay_type: Payment type (optional) - 1: Video Level (pricing by follower level) - 2: Custom (merchant custom pricing) - 3: Conversion-based (pay by conversion effect) - 4: Valid Views (pay by view count) - 5: Sales Volume (pay by product sales) - 9: Verification Volume (pay by verification count) - 14: Commission-based (pay by commission ratio) - greater_than_cost_progress: Cost progress filter (optional) - 20: Tasks with more than 20% cost progress - 50: Tasks with more than 50% cost progress - 80: Tasks with more than 80% cost progress - publish_time_start: Publish start time filter (optional, timestamp format) - quick_selector_scene: Quick filter scene (optional) - 1: High revenue tasks - 4: Guaranteed income tasks - 5: Previously collaborated merchants - keyword: Keyword search (optional, supports task name or task ID) ### Usage Examples ``` # Get submittable tasks from all industries GET /tikhub/douyin/creator/fetch_mission_task_list?industry_lv1=-1&tab_scene=1 # Get tasks from gaming industry casual games category with view-based payment GET /tikhub/douyin/creator/fetch_mission_task_list?industry_lv1=1913&industry_lv2=191301&pay_type=4 # Get high-revenue Douyin video tasks GET /tikhub/douyin/creator/fetch_mission_task_list?platform_channel=1&quick_selector_scene=1 ``` ### Return - Returns mission task list matching the conditions - Contains task details, compensation info, requirements, etc. API references: `fetch_industry_category_config` = `GET /tikhub/douyin/creator/fetch_industry_category_config` (operationId: `get_tikhub_douyin_creator_fetch_industry_category_config`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_search
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_user_searchDouyin (creator). ### Purpose - Search Douyin users by Douyin ID or nickname ### Parameters - user_name: Username (supports Douyin ID and nickname) - Douyin ID: e.g., "rmrbxmt" - Nickname: e.g., "Y", "People's Daily" ### Return - Returns up to 20 matching user information - Contains basic user info like avatar, nickname, Douyin ID, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_danmaku_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/creator/fetch_video_danmaku_listDouyin (creator). ### Purpose: - Get danmaku list for specified video, supports management and filtering ### Parameters: - item_id: Video item ID (required, get from video link or API) - count: Items per page (recommended 20, range 1-100) - offset: Offset (for pagination, starting position) - order_type: Order type (1=time order, 2=other order) - is_blocked: Whether to get blocked danmaku (false=normal, true=blocked) ### Return: - Video danmaku list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_author_diagnosis
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_author_diagnosisDouyin (creator_v2). ### Purpose: - Get Douyin creator account diagnosis data and optimization suggestions - Automatically analyze account performance for the past 7 days - Provide assessment and improvement suggestions for key metrics - Help creators understand account health and optimize content strategy - **This API requires valid Douyin Creator Platform Cookie** - **Use POST method, Cookie transmitted in request body, more secure** - **No need to specify time range, system automatically fetches data for past 7 days** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required) ### Data Update Time: - **Update Cycle**: Yesterday's video data is updated at 12:00 noon the next day - **Example**: Video data from October 10, 2025 will be updated at 12:00 on October 11, 2025 - **Time Range**: Automatically fetches data for the past 7 days - **First Use**: Data generation starts from the next day after obtaining permission ### Data Metrics Definition: **Term Definitions**: - **Similar Creators**: Creators with similar creation fields or fan levels - **Time Granularity**: The period for data update calculations - **Douyin Featured**: Data performance including Featured APP + Douyin Desktop + Douyin APP Featured Tab **Account Diagnosis Metrics**: - **Submission Count**: Number of works published during the statistical period - **Engagement Index**: Comprehensive score of views, likes, comments, and shares - **Video Views**: Number of times the work has been viewed - **Video Completion Rate**: Proportion of complete playbacks - Daily completion rate: Ratio of daily complete views to total views - 10-minute completion rate: Ratio of cumulative complete views to cumulative views - **Net Fan Growth**: Net increase in account followers (new followers minus unfollowers) ### Return Data Description: Account diagnosis data including five core dimensions: **1. Engagement Index (Interact)**: - **OwnValue**: Account's own engagement index value (comprehensive score of views, likes, comments, shares) - **SimilarCount**: Total number of similar creators - **AuthorRank**: Ranking percentile in account's historical data (0-1, higher means better current performance) - **SimilarRank**: Ranking percentile among similar creators (0-1, higher means better ranking) - **SimilarValue**: Average engagement index value of similar creators - **Interpretation**: AuthorRank=0.26 means current engagement exceeds 26% of own history - **Interpretation**: SimilarRank=0.52 means ranking exceeds 52% of similar creators **2. Net Fan Growth (NewFans)**: - **OwnValue**: Net increase in followers during the period (new followers - unfollowers) - **SimilarCount**: Total number of similar creators - **AuthorRank**: Ranking percentile in account's historical fan growth data - **SimilarRank**: Fan growth ranking percentile among similar creators - **SimilarValue**: Average net fan growth of similar creators - **Interpretation**: OwnValue=2 means net gain of 2 followers in this period **3. Video Views (PlayCnt)**: - **OwnValue**: Total number of times works were viewed during the period - **SimilarCount**: Total number of similar creators - **AuthorRank**: Ranking percentile in account's historical view count - **SimilarRank**: View count ranking percentile among similar creators - **SimilarValue**: Average view count of similar creators - **Interpretation**: OwnValue=192 means total views of 192 in this period **4. Video Completion Rate (PlayFinishRatio)**: - **OwnValue**: Proportion of complete playbacks (decimal between 0-1) - **SimilarCount**: Total number of similar creators - **AuthorRank**: Ranking percentile in account's historical completion rate - **SimilarRank**: Completion rate ranking percentile among similar creators - **SimilarValue**: Average completion rate of similar creators - **Interpretation**: OwnValue=0.15 means 15% completion rate - **Tip**: Focus on first 3 seconds to improve retention **5. Publishing Activity (PublishActivation)**: - **OwnValue**: Number of works published during the period - **SimilarCount**: Total number of similar creators - **AuthorRank**: Ranking percentile in account's historical publishing data - **SimilarRank**: Publishing activity ranking percentile among similar creators - **SimilarValue**: Average number of submissions by similar creators - **Interpretation**: OwnValue=2 means published 2 works in this period ### Return Data Structure Example: ```json { "code": 0, "data": { "Interact": { "OwnValue": 0.0052, "SimilarCount": 1494654282, "AuthorRank": 0.2633, "SimilarRank": 0.5169, "SimilarValue": 0.0909 }, "NewFans": { "OwnValue": 2, "AuthorRank": 0.7924, "SimilarRank": 0.6343 }, "PlayCnt": { "OwnValue": 192, "AuthorRank": 0.8427, "SimilarRank": 0.5132 }, "PlayFinishRatio": { "OwnValue": 0.1545, "AuthorRank": 0.3851, "SimilarRank": 0.5086 }, "PublishActivation": { "OwnValue": 2, "AuthorRank": 0.7345, "SimilarRank": 0.5675 } } } ``` ### Data Interpretation Tips: - **OwnValue**: Check actual values to understand current account performance - **AuthorRank**: Compare with own past, higher value means better current status - **SimilarRank**: Compare with peers, higher value means better ranking among similar creators - **Recommendation**: Focus on optimizing metrics when both AuthorRank and SimilarRank are below 0.5 ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_analysis_involved_vertical
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_analysis_involved_verticalDouyin (creator_v2). ### Purpose: - Get the vertical tags involved in submitted items within the specified time period - Used as parameters for subsequent calls to the submission analysis interface - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - start_date: Start date in YYYYMMDD format (required) - end_date: End date in YYYYMMDD format (required) - **Note: Date range maximum 90 days** ### Return Data Description: - primary_verticals: List of vertical tags - Returns the verticals involved in items published during the specified time period - Example: ["Animals", "Food", "Travel"] ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_analysis_item_performance
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_analysis_item_performanceDouyin (creator_v2). ### Purpose: - Get performance data for submitted items, including views, likes, comments, shares, etc. - Analyze content performance across different genres and verticals - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** - **Recommend calling fetch_item_analysis_involved_vertical first to get vertical tags** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - start_date: Start date in YYYYMMDD format (required) - end_date: End date in YYYYMMDD format (required) - genres: Genre type list (optional, defaults to all genres) - 1: Videos under 1 minute - 2: 1-3 minute videos - 3: 3-5 minute videos - 4: Videos over 5 minutes - 5: Photo posts - 8: Long photo posts - primary_verticals: Vertical tag list (required, obtained from fetch_item_analysis_involved_vertical) - metric_type: Metric type (optional, defaults to 1) - 1: Views - 2: Likes - 3: Comments - 4: Shares - **Note: Date range maximum 90 days** ### Return Data Description: - Contains performance data for selected metrics across different genres and verticals - Trend analysis and comparison data - Helps understand content performance across various dimensions ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value API references: `fetch_item_analysis_involved_vertical` = `POST /tikhub/douyin/creator_v2/fetch_item_analysis_involved_vertical` (operationId: `post_tikhub_douyin_creator_v2_fetch_item_analysis_involved_vertical`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_analysis_overview
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_analysis_overviewDouyin (creator_v2). ### Purpose: - Get comprehensive analysis data for account submitted items - Including submission performance statistics for different genres and verticals - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** - **Recommend calling fetch_item_analysis_involved_vertical first to get vertical tags** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - start_date: Start date in YYYYMMDD format (required) - end_date: End date in YYYYMMDD format (required) - genres: Genre type list (optional, defaults to all genres) - 1: Videos under 1 minute - 2: 1-3 minute videos - 3: 3-5 minute videos - 4: Videos over 5 minutes - 5: Photo posts - 8: Long photo posts - primary_verticals: Vertical tag list (required, obtained from fetch_item_analysis_involved_vertical) - **Note: Date range maximum 90 days** ### Return Data Description: - Contains submission data analysis for different genres and verticals - Metrics including views, likes, comments, shares, etc. - Performance comparison of different genres ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value API references: `fetch_item_analysis_involved_vertical` = `POST /tikhub/douyin/creator_v2/fetch_item_analysis_involved_vertical` (operationId: `post_tikhub_douyin_creator_v2_fetch_item_analysis_involved_vertical`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_audience_others
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_audience_othersDouyin (creator_v2). ### Purpose: - Get Douyin item audience other data analysis, including audience distribution and audience keywords - Understand whether the audience are fans and what topics they are interested in - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) ### Return Data Description: - **audience_distribution (Audience Distribution)**: - fan_list: Fan proportion list - key: "1"=Fan, "0"=Non-fan - value: Proportion (decimal between 0-1) - **audience_keyword (Audience Keywords)**: - keyword_list: List of topics/keywords that audiences are interested in - keyword: Keyword content - value: Interest proportion for this keyword ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_audience_portrait
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_audience_portraitDouyin (creator_v2). ### Purpose - Get Douyin item audience portrait data - Understand viewer demographic characteristics - Includes active distribution, gender distribution, region distribution, age distribution - Help creators precisely target audiences and optimize content strategy - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) ### Return Data Description Returns audience portrait data with multiple dimensions: **1. Active Distribution (active)**: - key: Time period identifier ("2"=morning, "3"=afternoon, "4"=evening, "-1"=other) - value: Active user ratio in this period (decimal between 0-1) **2. Gender Distribution (gender)**: - ratio_list: Gender ratio list - key: "male" or "female" - value: Gender user ratio (decimal between 0-1) - tgi_list: Gender TGI index list (Target Group Index) - key: Gender identifier - value: TGI value (100=average, >100=above average) **3. Region Distribution (province)**: - ratio_list: Province ratio list - key: Province name (e.g., "浙江", "广东", "北京") - value: Province user ratio (decimal between 0-1) - tgi_list: Province TGI index list - key: Province name - value: TGI value (reflects regional user activity) **4. Age Distribution (age)**: - ratio_list: Age range ratio list - key: Age range ("-18", "18-23", "24-30", "31-40", "41-50", "50-") - value: Age range user ratio (decimal between 0-1) - tgi_list: Age range TGI index list - key: Age range - value: TGI value (reflects age group preference) **5. Other Dimensions**: - career: Career distribution (may be empty) - city_level: City level distribution (contains ratio_list and tgi_list) - new_user: New user ratio (may be empty) **TGI Index Explanation**: - TGI = 100: Group performance matches platform average - TGI > 100: Group ratio is higher than platform average, core audience - TGI < 100: Group ratio is lower than platform average - Higher TGI indicates greater interest in this content type **Note**: If some data is empty or zero, possible reasons: - Item just published with insufficient sample size - No data available for this dimension or below statistical threshold - Few users in certain regions or age groups ### Data Value - **Precise Targeting**: Understand core audience characteristics - **Content Optimization**: Adjust content style based on audience traits - **Publishing Timing**: Optimize publish time based on active periods - **Regional Strategy**: Customize content for main regional users - **Age Adaptation**: Adjust content depth and expression - **Gender Preference**: Understand content preferences by gender ### Application Scenarios 1. **Content Positioning**: Adjust content direction based on main audience 2. **Publishing Optimization**: Publish during target audience active hours 3. **Regional Marketing**: Create localized content for main regions 4. **Age Strategy**: Adjust content complexity based on age distribution 5. **Gender Marketing**: Balance or focus on specific gender audiences 6. **Audience Expansion**: Identify potential audience groups to expand influence ### How to get Cookie 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_danmaku_analysis
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_danmaku_analysisDouyin (creator_v2). ### Purpose: - Get Douyin item bullet (danmaku) analysis data - Understand audience bullet interaction at various video time points - Help creators identify hot segments and audience reactions - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) ### Return Data Description: Returns item bullet analysis data, including: - bullet_distribution: Bullet distribution data - time_point: Time point (seconds) - count: Number of bullets at this time point - percentage: Percentage of bullets at this time point - hot_words: Popular bullet words - word: Bullet word - count: Occurrence count - sentiment: Sentiment orientation (positive/negative/neutral) - total_count: Total bullet count - peak_time: Peak time point for bullets **Note**: If empty data or zero bullets returned, it means there is currently no bullet data for this item, possible reasons: - Item was just published and no viewers have sent bullets yet - Item type is not suitable for bullet interaction - Bullet feature is not enabled ### Data Value: - **Hot Spot Identification**: Identify video segments with highest audience interest - **Sentiment Analysis**: Understand audience emotional reactions to content - **Interaction Optimization**: Optimize content presentation in high-bullet areas - **Content Improvement**: Adjust future content based on bullet feedback ### Application Scenarios: 1. **Content Optimization**: Find favorite segments and reinforce similar content 2. **Pacing Adjustment**: Dense bullet areas indicate engaging content, extend similar segments 3. **Emotion Control**: Understand genuine audience reactions through bullet sentiment 4. **Interaction Design**: Design interactive elements at bullet peaks to boost engagement ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_listDouyin (creator_v2). ### Purpose - Get all published items within the specified time range - Support pagination query, maximum 100 items per request - Data update description: - **Views, likes, comments, shares, favorites update in real-time** - **Other metrics update hourly** - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - start_time: Start timestamp in milliseconds (required) - end_time: End timestamp in milliseconds (required) - count: Number of items per page, default 10, max 100 (optional) - order_by: Sort method, supports 26 types (optional, default 1) - fields: Fields to return, default "metrics,review,visibility" (optional) - metrics: Traffic metrics (views, likes, comments, shares, favorites, etc.) - review: Review status - visibility: Visibility status - need_cooperation: Need cooperation info, default true (optional) - need_long_article: Include long articles, default true (optional) - cursor: Pagination cursor, don't pass for first request, use returned cursor for pagination (optional) ### Sort Options (order_by) | Value | Sort Field | Direction | Update Freq | Description | |-------|-----------|-----------|-------------|-------------| | 1 | Publish Time | Desc ↓ | - | Default, newest first | | 2 | Publish Time | Asc ↑ | - | Oldest first | | 3 | Views | Desc ↓ | Real-time | Video views count | | 4 | Views | Asc ↑ | Real-time | Least views first | | 5 | Likes | Desc ↓ | Real-time | Likes count | | 6 | Likes | Asc ↑ | Real-time | Least likes first | | 7 | Comments | Desc ↓ | Real-time | Comments count | | 8 | Comments | Asc ↑ | Real-time | Least comments first | | 9 | Shares | Desc ↓ | Real-time | Shares count | | 10 | Shares | Asc ↑ | Real-time | Least shares first | | 11 | Favorites | Desc ↓ | Real-time | Favorites count | | 12 | Favorites | Asc ↑ | Real-time | Least favorites first | | 13 | 2s Bounce Rate | Desc ↓ | Hourly | Views bounced within 2s / total views | | 14 | 2s Bounce Rate | Asc ↑ | Hourly | Lowest bounce rate first | | 15 | 5s Completion | Desc ↓ | Hourly | Views over 5s / total views | | 16 | 5s Completion | Asc ↑ | Hourly | Lowest 5s completion first | | 17 | Completion Rate | Desc ↓ | Hourly | Full plays / total views | | 18 | Completion Rate | Asc ↑ | Hourly | Lowest completion rate first | | 19 | Cover CTR | Desc ↓ | Hourly | Cover clicks / cover impressions | | 20 | Cover CTR | Asc ↑ | Hourly | Lowest CTR first | | 21 | Avg Play Duration | Desc ↓ | Hourly | Average video play duration | | 22 | Avg Play Duration | Asc ↑ | Hourly | Shortest duration first | | 23 | Profile Visits | Desc ↓ | Daily | Profile visits after watching | | 24 | Profile Visits | Asc ↑ | Daily | Least profile visits first | | 25 | Follower Growth | Desc ↓ | Hourly | New followers from this video | | 26 | Follower Growth | Asc ↑ | Hourly | Least follower growth first | ### Sort Usage Tips - **Find Hits**: Use order_by=3 (Views↓) or order_by=5 (Likes↓) - **Content Optimization**: Use order_by=13 (Bounce Rate↓) to find videos to improve - **Improve Completion**: Use order_by=17 (Completion↓) to analyze high-completion videos - **Follower Analysis**: Use order_by=25 (Follower Growth↓) to find best performing videos - **Cover Optimization**: Use order_by=19 (Cover CTR↓) to analyze cover attractiveness ### Return - Item list data with detailed metric information - has_more: Whether there are more items - cursor: Cursor for next page, used for pagination - items: Array of items ### Usage Flow 1. **First request**: Don't pass cursor parameter, get first page 2. **Check has_more**: If true, there are more items 3. **Paginate**: Use returned cursor value as cursor parameter for next request 4. **Repeat steps 2-3**: Until has_more is false ### Limitations - Only supports filtering: Top 100 items by genre in selected period - For exporting more data, use `/tikhub/douyin/creator_v2/fetch_item_list_download` API (supports top 1000 items) ### Timestamp Conversion - JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000 - Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000 ### How to get Cookie 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value API references: `fetch_item_list_download` = `POST /tikhub/douyin/creator_v2/fetch_item_list_download` (operationId: `post_tikhub_douyin_creator_v2_fetch_item_list_download`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_list_download
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_list_downloadDouyin (creator_v2). ### Purpose - Export detailed data of top 1000 items within the specified time range - Support filtering export content by genre types - **This API is for batch export, not suitable for real-time queries** - **Export tasks are processed asynchronously, need to wait for server to generate file** - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - min_cursor: Min cursor, i.e., start timestamp in milliseconds (required) - max_cursor: Max cursor, i.e., end timestamp in milliseconds (required) - type_filters: Genre type filter list, default all [1,2,3,4,5,8] (optional) - **1**: Videos under 1 minute - **2**: 1-3 minute videos - **3**: 3-5 minute videos - **4**: Videos over 5 minutes - **5**: Image posts - **8**: Long image posts - need_long_article: Include long articles, default true (optional) ### Return - **Directly returns Excel file stream**, browser will auto-download - File: Excel workbook (.xlsx); use the filename supplied by the response - File Format: Excel (.xlsx) - Content-Type: application/vnd.ms-excel ### Usage Flow 1. **Initiate export request**: Submit time range and filter conditions 2. **Receive file**: API returns Excel file stream directly 3. **Auto download**: Browser automatically triggers file download 4. **Data analysis**: Open Excel file for data analysis ### Limitations - Only supports exporting: Top 1000 items in selected period - Support filtering by genre types (can select any combination of 1-6 genres) - Not suitable for real-time queries, designed for batch data analysis ### Genre Type Description | Type | Genre Name | Description | Use Case | |------|-----------|-------------|----------| | 1 | <1min video | Short video | Fast spread, high engagement | | 2 | 1-3min video | Medium-short video | Balance content & duration | | 3 | 3-5min video | Medium-long video | Deep content presentation | | 4 | 5min+ video | Long video | Professional content, deep analysis | | 5 | Image post | Image post | Picture + text format | | 8 | Long image post | Long image post | Deep image-text content | ### Export Data Includes - Item basic info (ID, title, publish time, etc.) - Traffic metrics (views, likes, comments, shares, favorites) - Review status - Visibility settings - Other creator-related data ### Timestamp Conversion - JavaScript: `new Date('2025-07-01').getTime()` -> 1719763200000 - Python: `int(datetime(2025, 7, 1).timestamp() * 1000)` -> 1719763200000 ### How to get Cookie 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_overview_data
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_overview_dataDouyin (creator_v2). ### Purpose: - Get Douyin item overview data, including traffic metrics, review status, play info, etc. - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - ids: Item ID list, separated by comma (e.g., "7559536212910853422,7559536212910853423") - fields: Fields to return, default is "metrics,review,play_info,dou_plus,integrated_incentive,incentive_life,content_analysis" - Available fields (comma-separated, customizable): - metrics: Traffic metrics data (views, likes, comments, etc.) - review: Review status information - play_info: Play related information - dou_plus: DOU+ promotion information - integrated_incentive: Integrated incentive data - incentive_life: Incentive lifecycle information - content_analysis: Content analysis data ### Return: - Item overview data, returns corresponding fields based on the fields parameter ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_play_source
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_play_sourceDouyin (creator_v2). ### Purpose: - Get Douyin item play source statistics - Statistics of the proportion of item views from different sources - **If a channel is not shown, it means there are no views from that channel yet** - **For newly published items, the recommended page traffic may be low initially, please wait for system distribution** - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) ### Return Data Description: - play_source: List of traffic sources with play proportion for each channel - key: Traffic source channel identifier - value: Current proportion (decimal between 0-1, e.g., 0.85 means 85%) - history_difference: Difference from historical data - app_id: Application ID ### Traffic Source Channel Description: - **homepage_hot**: Recommended page (system recommendation traffic) - **familiar**: Friends page (followed people, friend recommendations) - **search**: Search (user active search) - **homepage**: Personal homepage (views from homepage visits) - **message**: Message page (through message entry) - **other**: Other (other sources) ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_search_keyword
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_search_keywordDouyin (creator_v2). ### Purpose: - Get Douyin item search keywords statistics - Understand which search keywords users used to find and watch the item - Help creators optimize content titles, tags, and descriptions to improve search exposure - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) ### Return Data Description: Returns a list of keywords users searched for to find this item, including: - keyword: Search keyword - count: Number of times this keyword was searched - percentage: Percentage of this keyword in total searches **Note**: If an empty list is returned, it means there is currently no search keyword data for this item, possible reasons: - Item was just published and no users have searched for it yet - Item is mainly spread through recommendations, follows, etc., not through search - No search behavior during the statistics period ### Data Value: - **Optimize Title**: Adjust item title based on popular keywords - **Optimize Tags**: Add relevant popular search terms as tags - **Content Planning**: Understand user interests and create more relevant content - **SEO Optimization**: Improve item ranking in search results ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_watch_trend
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_item_watch_trendDouyin (creator_v2). ### Purpose: - Get Douyin item watch trend analysis data - Understand user behavior patterns while watching the item - Help creators optimize video content structure and pacing - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - item_id: Item ID (required) - analysis_type: Analysis type (optional, default is 1) - **1**: Retention Analysis - Shows user retention at each time point - **2**: Like Analysis - Shows user like behavior at each time point - **7**: Bounce Analysis - Shows user bounce rate at each time point ### Analysis Type Description: - **Retention Analysis (analysis_type=1)**: - Shows viewer retention rate at various video time points - Higher retention means more engaging content at that moment - **Note**: Data is more accurate when views exceed 200 - Good for: Identifying which segments keep viewers watching - **Like Analysis (analysis_type=2)**: - Shows viewer like rate at various video time points - Higher like rate indicates particularly popular segments - Good for: Identifying segments that drive user engagement - **Bounce Analysis (analysis_type=7)**: - Shows viewer bounce rate at various video time points - High bounce rate indicates potential content issues - Good for: Identifying segments that cause viewers to leave ### Return Data Description: - analysis_trend: Trend analysis data - current_item: Data points for current item - key: Time point (format: mm:ss, e.g., "00:05" for 5 seconds) - value: Proportion at this time point (decimal between 0-1) - similar_author: Average data from similar authors (for comparison) - key: Time point - value: Average proportion at this time point ### Data Value: - **Content Optimization**: Identify key drop-off points - **Pacing Adjustment**: Optimize video rhythm and flow - **Comparative Analysis**: Compare with similar creators to find gaps - **A/B Testing**: Test different content versions ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_live_room_history_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/creator_v2/fetch_live_room_history_listDouyin (creator_v2). ### Purpose: - Get Douyin creator's live room history list - View all live session data within a specified time range - Support querying ongoing and historical live sessions - **This API requires users to provide valid Douyin Creator Platform Cookie** - **Use POST method, Cookie is transmitted in request body, more secure** ### Request Body Parameters: - cookie: User's Douyin Creator Platform Cookie (required, transmitted in request body) - start_date: Start date in YYYY-MM-DD format (required, e.g., "2025-09-11") - end_date: End date in YYYY-MM-DD format (required, e.g., "2025-10-11") - limit: Limit per page, default 400, max 400 - need_living: Include ongoing live sessions (0=No, 1=Yes, default 1) - download: Download flag (0=No download, 1=Download, default 0) ### Return Data Description: Returns a list of live session history, data is located in `data.data.series` array, each session includes: **Basic Info**: - roomID: Live room ID - roomTitle: Live title - coverUri: Live cover image URL - startTime: Start time (format: "YYYY-MM-DD HH:mm:ss") - endTime: End time (format: "YYYY-MM-DD HH:mm:ss") - liveDurationWithoutPause: Duration without pause (format: "1 minute 5 seconds") - playStatus: Play status (4=Ended) **Traffic Data**: - watchCnt: Total watch count - serverWatchUcntTdDirect: Direct watch user count (from server statistics) - pcu: Peak Concurrent Users - liveServerWatchDurationTdPavg: Average watch duration **Engagement Data**: - serverLikeCntTd: Likes count - clientCommentUcntTd: Comment user count - liveNewFollowUcnt: New followers count **Consumption/Conversion Data**: - liveConsumeUcnt: Consuming user count - liveFansConsumeUcntTd: Fan consuming user count - roomLiveEarnScore: Live room earn score ### Data Value: - **History Review**: View complete records of all live sessions - **Data Comparison**: Compare performance across sessions - **Trend Analysis**: Analyze changes in live performance - **Optimization**: Identify common traits of high-conversion sessions - **Time Planning**: Optimize live timing based on historical data - **Content Strategy**: Adjust content based on theme performance ### Use Cases: 1. **Regular Review**: Weekly/monthly live data summary 2. **Effect Evaluation**: Evaluate performance by time and theme 3. **Data Reports**: Generate reports for team analysis 4. **Strategy Optimization**: Develop strategies based on data 5. **KPI Tracking**: Track live-related KPIs 6. **Trend Prediction**: Predict future live performance ### Notes: 1. **Time Range**: Recommended not to exceed 3 months 2. **Quantity Limit**: Max 400 records per request 3. **Data Delay**: 1-2 hours delay possible 4. **Ongoing Live**: Set need_living=1 to include current live 5. **Cookie Validity**: Ensure Cookie is not expired 6. **Date Format**: Must use YYYY-MM-DD format ### How to get Cookie: 1. Login to Douyin Creator Platform (https://creator.douyin.com) 2. Open browser developer tools (F12) 3. Switch to Network tab 4. Refresh page or perform operations 5. Find any request and copy the Cookie header value <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin calculate_cost
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/calculate_costDouyin (douplus). ### Purpose: - DOU+ cost estimation: given delivery account + item(s) + target, return budget combos / price / estimate - **Requires a valid www.douyin.com web Cookie** ### Parameters: - cookie: User's www.douyin.com web Cookie (required) - sec_uid: sec_uid of the delivery account (required) - item_ids: Item id(s), comma separated (required) - target_id: Promotion target id, default 31. 31=likes&comments, 32=fans, 33=homepage views, 37=video plays, 45=comment-link clicks, 78=high-quality interaction ### Return: - Budget combos / price / estimated results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_analyse_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_analyse_detailDouyin (douplus). ### Purpose - DOU+ delivery analysis detail (per-order / per-item metric list with paging & sorting); account/video/live by query.analysisType - **Requires a valid www.douyin.com web Cookie** ### Parameters (query passthrough) - Same fields as overview, plus page, limit, orderByMetric (e.g. create_time), orderByType ### Return - Detail list data (with pagination) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_analyse_graph
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_analyse_graphDouyin (douplus). ### Purpose - DOU+ delivery analysis trend graph (metric curves over time); account/video/live by query.analysisType - **Requires a valid www.douyin.com web Cookie** ### Parameters (query passthrough) - Same fields as overview, plus dimension (time aggregation, e.g. 1) ### Return - Trend graph data (metric values per time point) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_analyse_overview
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_analyse_overviewDouyin (douplus). ### Purpose: - DOU+ delivery analysis overview for account / video / live (query.analysisType: 1=account, 2=video, 3=live) - Filter by account, delivery status, target and time range - **Requires a valid www.douyin.com web Cookie** ### Parameters (query passthrough, key fields): - startTime / endTime: second timestamp strings (period) - analysisType: 1=account, 2=video, 3=live - authorSecIdList: list of account sec_uid (empty = all) - statusList: delivery status filter (empty = all) - metrics: requested metrics ### Return: - Overview statistics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_delivery_effect_estimate
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_delivery_effect_estimateDouyin (douplus). ### Purpose: - Get estimated delivery results for specified items, promotion target, budget and duration - Useful for comparing budget and duration options before creating a DOU+ order ### Parameters: - item_ids: Item id(s), comma separated (required). Normally use schema=0 for one item and schema=3 for multiple items - external_action: Optimization action code; must match target_id. Default 44 (NativeAction); common values: 45=like, 46=follow, 47=comment, 51=link click, 102=multiple native actions, 181=homepage visit - target_id: Promotion target id, default 31 (likes and comments). Common values: 32=followers, 33=homepage visits, 37=video plays, 40=live popularity, 45=comment-link clicks, 63=show to followers, 78=natural promotion, 81=high interaction frequency - schema: Delivery scene code. 0=single-item Default, 3=multi-item BatchDelivery; selected from the item count - is_max_cv: Whether to estimate in MaxCV (maximum-conversion-volume) mode; derived from target capability, item count, budget and manual-bid state by the official client - pay_type: Payment channel. 0=CashDesk, 1=IAP, 2=Caijing, 3=CgTradeCash; the official estimate request uses 1 - cost_int: Delivery budget in li (CNY 1/1000), default 30000 (CNY 30) - duration_seconds: Delivery duration in seconds, default 21600 (6 hours) ### Return: - Estimated delivery results for the selected budget, duration and promotion target <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_promotable_item_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_promotable_item_listDouyin (douplus). ### Purpose: - Get the promotable item (video) list for a given Douyin account on the DOU+ delivery page, including like / comment / play counts per item ### Parameters: - sec_uid: sec_uid of the delivery account (required) - count: Number of items, default 30 - target_id: Promotion target (the goal card on the DOU+ page), default 31 (likes & comments). 31=likes&comments, 32=fans, 33=homepage views, 37=video plays, 40=live popularity, 45=comment-link clicks, 63=show-to-fans, 78=high-quality interaction. **Keep 31 for a plain video list** - aim_ids: Optional advanced parameter — optimization objective code(s), comma separated. **Leave empty** — auto-derived from target_id when omitted; set manually only for advanced cases ### Return: - Promotable item list (item id, title, cover, like / comment / play counts, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_promoted_accounts
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_promoted_accountsDouyin (douplus). ### Purpose: - Get the list of Douyin accounts that have been promoted (have orders) under the current DOU+ account, with cursor pagination - **Requires a valid www.douyin.com web Cookie** ### Parameters: - cookie: User's www.douyin.com web Cookie (required) - limit: Number of accounts per page, default 20 - cursor: Pagination cursor, empty for first page, then pass the `sortID` value from the previous response ### Return: - List of promoted accounts (nickname, sec_uid, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_sec_token
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_sec_tokenDouyin (douplus). ### Purpose: - Get the sec_token required by DOU+ authenticated POST endpoints (e.g. cost estimation) - **Requires a valid www.douyin.com web Cookie** ### Parameters: - cookie: User's www.douyin.com web Cookie (required) ### Return: - Data containing the sec_token, used for subsequent DOU+ authenticated POST endpoints <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_talent_categories
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_talent_categoriesDouyin (douplus). ### Purpose: - Get the DOU+ talent category list; a category name can be used as the `name` of the talent search endpoint ### Return: - Talent category list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_talents_by_category
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_talents_by_categoryDouyin (douplus). ### Purpose - Search & filter DOU+ talents by category ### Parameters - name: Category name or keyword (from the talent category endpoint); empty for all - page: Page index from 0, default 0 - limit: Page size, default 20 ### Return - Talent list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_posts
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_user_postsDouyin (douplus). ### Purpose: - Get a user's homepage works (concise endpoint, cursor pagination) ### Parameters: - sec_uid: User sec_uid (required) - cursor: Pagination cursor (string), "0" for first page, then pass the cursor from the previous response - count: Page size, default 10 ### Return: - User's works list plus pagination info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_video_detailDouyin (douplus). ### Purpose: - Get a video's detail by its ID or share link/text ### Parameters: - video: Video ID, or share link/text (required). e.g. `7651708301280906538`, or a share caption containing a v.douyin.com link ### Return: - Matched video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_ranking
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/fetch_video_rankingDouyin (douplus). ### Purpose: - Get the DOU+ video ranking board, filterable by time range, category and dimension ### Parameters: - time_range: Time range, 1 / 2 / 3, default 2 - tag_id: Category id, default 634 (Entertainment). Full map: 601 Plot, 602 Star, 606 Music, 607 ACGN, 608 Game, 609 CurrentAffairs, 612 Dance, 614 Agriculture, 615 Sci-Tech, 616 Finance, 617 ParentChild, 619 Life, 621 Health, 623 Emotion, 624 Culture, 625 Office, 626 Education, 627 Photography, 628 Food, 629 Travel, 631 Fashion, 633 Sport, 634 Entertainment, 635 Car - dim_type: Ranking dimension, default 5. 1=low-fan hits, 2=high completion, 3=high like-rate, 4=high follower-growth, 5=hotness index - adv_id: Advertiser id, optional ### Return: - Video ranking data (items, authors, metrics, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_live_room
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/search_live_roomDouyin (douplus). ### Purpose: - Search DOU+ live rooms by Douyin ID or nickname, with cursor pagination ### Parameters: - keyword: Douyin ID or nickname (required) - cursor: Pagination cursor, 0 for first page, then pass the cursor from the previous response - count: Page size, default 10 ### Return: - Matched live room list plus pagination info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_user
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/search_user_v2Douyin (douplus). ### Purpose: - DOU+ user search V2, with cursor pagination and a search scope ### Parameters: - keyword: Search keyword (required) - cursor: Pagination cursor, 0 for first page, then pass the cursor from the previous response - count: Page size, default 10 - scope: Search scope, default 1 ### Return: - Matched result list plus pagination info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_video
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/douplus/search_videoDouyin (douplus). ### Purpose: - Search DOU+ videos by title/keyword, with cursor pagination ### Parameters: - keyword: Video title or keyword (required) - cursor: Pagination cursor, 0 for first page, then pass the cursor from the previous response - count: Page size, default 12 ### Return: - Matched video list plus pagination info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_all_area
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_all_areaDouyin (index). ### Purpose: - Get all supported area list for Douyin Index ### Return: - Hierarchical list of provinces and cities, used as region filter parameter in keyword index APIs <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_all_valid_date
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_all_valid_dateDouyin (index). ### Purpose: - Get the latest valid dates for each data type in Douyin Index ### Return: - Contains latest available daily/weekly/monthly dates for keyword, brand, topic dimensions <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_cycles
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_cyclesDouyin (index). ### Purpose: - Get brand cycles data (periodic popularity analysis) ### Parameters: - brand_name: Brand info - start_date/end_date: Date range in YYYYMMDD - app_name: Platform ### Return: - Brand periodic popularity data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_hot_videos_time_scope
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_hot_videos_time_scopeDouyin (index). ### Purpose: - Get the queryable time scope for the brand hot videos feature - Used to determine valid date boundaries before calling other brand endpoints ### Parameters: - None ### Return: - Time scope info (start/end dates, period units, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_initiative_rank_weekly
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_initiative_rank_weeklyDouyin (index). ### Purpose - Get brand initiative rank weekly data ### Parameters - brand_name/: Brand info - start_date/end_date: Date range in YYYYMMDD - app_name: Platform ### Return - Brand initiative ranking data for the week <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_lines
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_linesDouyin (index). ### Purpose: - Get brand trend lines data (popularity over time) ### Parameters: - brand_name: Brand info - start_date/end_date: Date range in YYYYMMDD - app_name: Platform ### Return: - Brand popularity trend line data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_radar_chart
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_radar_chartDouyin (index). ### Purpose: - Get brand radar chart data (multi-dimensional scores) ### Parameters: - brand_name: Brand name - start_date/end_date: Date range in YYYYMMDD - app_name: Platform selection ### Return: - Brand multi-dimensional radar chart data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_suggest
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_suggestDouyin (index). ### Purpose: - Get brand search auto-complete suggestion list ### Parameters: - keyword: Brand name keyword ### Return: - Matched brand list (brand name, category ID, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_brand_valid_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_brand_valid_infoDouyin (index). ### Purpose: - Get brand valid info and brand index data ### Parameters: - keyword_list: Brand name list, comma separated ### Return: - Brand index, available date range, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_author_portrait
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_author_portraitDouyin (index). ### Purpose: - Get **creator (author) portrait** for a category (i.e. profile of users who post in this category) - Used to understand creator demographics: gender, age, region, active time ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - period: "week" (end_date must be a Sunday) or "month" (end_date must be month-end, e.g. 20260331) - end_date: End date YYYYMMDD, must align with period ### Return: - Creator portrait: gender, age group, region, device, active time distributions <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_consume_trend
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_consume_trendDouyin (index). ### Purpose: - Get consumption (play count, watch duration) trend over time for a category - Measures actual viewing heat for content in this category ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - start_date: Start date YYYYMMDD (inclusive) - end_date: End date YYYYMMDD (inclusive) ### Return: - Daily aggregated consumption data: total play count, watch duration, unique viewers per day <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_consumer_portrait
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_consumer_portraitDouyin (index). ### Purpose: - Get **consumer (viewer) portrait** for a category (i.e. profile of users who watch videos in this category) - Counterpart to fetch_content_author_portrait: one for creators, one for viewers ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - period: "week" (end_date must be a Sunday) or "month" (end_date must be month-end, e.g. 20260331) - end_date: End date YYYYMMDD, must align with period ### Return: - Consumer portrait: gender, age group, region, interest, device distributions API references: `fetch_content_author_portrait` = `POST /tikhub/douyin/index/fetch_content_author_portrait` (operationId: `post_tikhub_douyin_index_fetch_content_author_portrait`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_creative_duration
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_creative_durationDouyin (index). ### Purpose: - Get video duration distribution for a category - Helps understand creators' preferred video lengths in this category ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - period: "week" (end_date must be a Sunday) or "month" (end_date must be month-end) - end_date: End date YYYYMMDD, must align with period ### Return: - Video count and ratio per duration bucket (e.g. 0-15s, 15-60s, 60-180s, >180s) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_creative_keyword_items
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_creative_keyword_itemsDouyin (index). ### Purpose: - Get videos related to a specific hot keyword in a category - Used to inspect which videos contribute to a hot keyword ### Parameters: - tag_id: Category ID (same as category_id in fetch_item_query) - period: "1" / "3" / "7" days - end_date: End date YYYYMMDD. **Must be a Sunday only when period=7**; any day for period=1/3 - keyword: Hot keyword (typically from fetch_content_creative_keywords) ### Return: - List of videos related to the keyword API references: `fetch_content_creative_keywords` = `POST /tikhub/douyin/index/fetch_content_creative_keywords` (operationId: `post_tikhub_douyin_index_fetch_content_creative_keywords`); `fetch_item_query` = `POST /tikhub/douyin/index/fetch_item_query` (operationId: `post_tikhub_douyin_index_fetch_item_query`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_creative_keywords
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_creative_keywordsDouyin (index). ### Purpose - Get creative hot keywords for a category ### Parameters - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - **This endpoint does NOT support "0=all", you must pass a specific category ID** (e.g. "601"=Drama, "628"=Food) - Full list via fetch_item_filter_options - period: "1"=last 1 day, "3"=last 3 days, "7"=last 7 days - end_date: End date YYYYMMDD. **Must be a Sunday only when period=7**; any day for period=1/3 API references: `fetch_item_filter_options` = `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`); `fetch_item_query` = `POST /tikhub/douyin/index/fetch_item_query` (operationId: `post_tikhub_douyin_index_fetch_item_query`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_creative_topic
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_creative_topicDouyin (index). ### Purpose - Get creative hot topics for a category ### Parameters - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - **This endpoint does NOT support "0=all", you must pass a specific category ID** (e.g. "601"=Drama, "628"=Food) - Full list via fetch_item_filter_options - period: "1" / "3" / "7" - end_date: End date YYYYMMDD. **Must be a Sunday only when period=7**; any day for period=1/3 - rank_type: "index" or "rise" API references: `fetch_item_filter_options` = `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`); `fetch_item_query` = `POST /tikhub/douyin/index/fetch_item_query` (operationId: `post_tikhub_douyin_index_fetch_item_query`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_interact_trend
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_interact_trendDouyin (index). ### Purpose: - Get interaction (like/comment/share/favorite) trend over time for a category - Measures user engagement intensity for content in this category ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - start_date: Start date YYYYMMDD (inclusive) - end_date: End date YYYYMMDD (inclusive) ### Return: - Daily aggregated interaction data: like / comment / share / favorite totals per day <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_publish_trend
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_publish_trendDouyin (index). ### Purpose: - Get the content publish volume trend over time for a category - Helps understand content supply heat changes for a category ### Parameters: - tag_id: Required category ID as a string, excluding "0" (all categories). Obtain an entry's `id` from the `categories` list returned by `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`). - start_date: Start date YYYYMMDD (inclusive) - end_date: End date YYYYMMDD (inclusive) ### Return: - Daily aggregated publish volume (date + count of items published that day) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_content_valid_date
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_content_valid_dateDouyin (index). ### Purpose: - Get valid date range for the creation guide section <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_current_hot_topic
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_current_hot_topicDouyin (index). ### Purpose: - Get Douyin real-time hot topics and trending topics leaderboard ### Return: - Topic name, topic index, rank change and other information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_compare_users_stable
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_compare_users_stableDouyin (index). ### Purpose: - Compare trend data of multiple daren/creators (follower growth, engagement, etc.) ### Parameters: - user_list: Daren uid list, comma separated, **max 5** - days: Comparison period, only 7 or 30 ### Return: - Trend data comparison for each daren in the specified period <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_great_item_mile_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_great_item_mile_infoDouyin (index). ### Purpose: - Get daren core metrics data ### Parameters: - user_id: Douyin uid (numeric, e.g. "3100268042915212") ### Return: - Follower count, like count, video count, engagement rate and other core metrics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_great_user_fans_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_great_user_fans_infoDouyin (index). ### Purpose: - Get daren fans analysis data ### Parameters: - user_id: Douyin uid (numeric, e.g. "3100268042915212") ### Return: - Fans gender, age, region distribution, active time, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_great_user_top_video
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_great_user_top_videoDouyin (index). ### Purpose: - Get daren's top video list in a specified time range ### Parameters: - user_id: Douyin uid (numeric, e.g. "3100268042915212") - start_date: Start date, format YYYYMMDD - end_date: End date, format YYYYMMDD ### Note: - **Date range must not exceed 30 days**, otherwise the API will return an error ### Return: - Daren's top video list (play count, like count, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_similar_users
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_similar_usersDouyin (index). ### Purpose: - Get similar daren/creators to a specified user ### Parameters: - user_id: Douyin uid (numeric, e.g. "3100268042915212") ### Return: - List of similar daren <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_daren_sug_great_user_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_daren_sug_great_user_listDouyin (index). ### Purpose: - Search for daren/creators, get suggestion list ### Parameters: - keyword: Daren nickname keyword - total: Return count, default 20 ### Return: - Matched daren list (includes user ID, nickname, avatar, follower count, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_encrypt_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_encrypt_user_idDouyin (index). ### Purpose: - Convert a Douyin uid (numeric) to the encrypted user_id used internally by Douyin Index API - The daren-related endpoints already handle this conversion automatically, so you usually do NOT need to call this endpoint manually - Only useful for debugging or when you need the encrypted user_id directly ### Parameters: - uid: Douyin uid, numeric string ### Return: - uid: Original input uid - user_id: Encrypted user_id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_get_user_sub_word
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_get_user_sub_wordDouyin (index). ### Purpose: - Get subscribed keyword list for the current logged-in user in Douyin Index ### Return: - List of keywords subscribed by the user <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_hot_detailDouyin (index). ### Purpose: - Get full analysis of a single hot topic; one request covers every module of the hot topic detail page ### Parameters: - topic_name: Hot topic name, obtained from fetch_current_hot_topic results ### Return: - trend_item: Hot index trend (index value per timestamp) - content_item: Hot content list (video title, url, cover, author, digg/comment counts) - play_rank_author_item: Related creators ranked by play count - digg_rank_author_item: Related creators ranked by digg count - fans_rank_author_item: Related creators ranked by fans count - comment_rank_author_item: Related creators ranked by comment count - portrait: Audience portrait with four dimensions - province, city, gender, age; each label value is a percentage in decimal form API references: `fetch_current_hot_topic` = `GET /tikhub/douyin/index/fetch_current_hot_topic` (operationId: `get_tikhub_douyin_index_fetch_current_hot_topic`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_trend_word
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_hot_trend_wordDouyin (index). ### Purpose: - Get hot trend words suggested in the keyword index search box, used as input suggestions for keyword index analysis - Note: This is NOT the real-time hot topic leaderboard. For real-time and rocketing hot topics use fetch_current_hot_topic ### Parameters: - app_name: Platform, aweme=Douyin, toutiao=Toutiao (toutiao currently returns empty) - type: Word type, 0=search words (plain words, id is always "0"), 1=content words (with topic id) ### Return: - update_time: Data update date (updated daily, not real-time) - trend_words: Word list with id and word API references: `fetch_current_hot_topic` = `GET /tikhub/douyin/index/fetch_current_hot_topic` (operationId: `get_tikhub_douyin_index_fetch_current_hot_topic`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_words
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_hot_wordsDouyin (index). ### Purpose: - Get current hot search keywords list ### Parameters: - app_name: Platform, aweme=Douyin, toutiao=Toutiao ### Return: - Keyword name, search index, growth rate, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_insight_get_rec
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_insight_get_recDouyin (index). ### Purpose: - Get related insight recommendations based on a current report ID - Typically used for the "Related" module on a report detail page ### Parameters: - report_id: ID of the report currently being viewed (from fetch_report_search or fetch_insight_recommend) ### Return: - List of related recommended reports (id, title, cover, publish time, etc.) API references: `fetch_insight_recommend` = `GET /tikhub/douyin/index/fetch_insight_recommend` (operationId: `get_tikhub_douyin_index_fetch_insight_recommend`); `fetch_report_search` = `POST /tikhub/douyin/index/fetch_report_search` (operationId: `post_tikhub_douyin_index_fetch_report_search`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_insight_recommend
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_insight_recommendDouyin (index). ### Purpose: - Get the list of recommended trend insight reports on the home page <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_analysis
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_analysisDouyin (index). ### Purpose - Get comparison analysis for a video (performance vs. similar videos / benchmark) ### Parameters - item_id: Video ID (Douyin aweme id, numeric string) - start_date/end_date: Date range in YYYYMMDD ### Return - Comparison analysis of the video against reference targets across dimensions <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_base
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_baseDouyin (index). ### Purpose: - Get the basic detail of a video in Douyin Index video analysis ### Parameters: - item_id: Video ID (Douyin aweme id, numeric string) ### Return: - Video title, cover, duration, publish time, author info and basic metrics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_filter_options
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_filter_optionsDouyin (index). ### Purpose: - Get all supported filter values for the `POST /tikhub/douyin/index/fetch_item_query` (operationId: `post_tikhub_douyin_index_fetch_item_query`) video search endpoint - Returns: categories, duration_types, label_types, date_types - Use this endpoint to discover valid IDs before calling `POST /tikhub/douyin/index/fetch_item_query` (operationId: `post_tikhub_douyin_index_fetch_item_query`) ### Return: - categories: Category list (id / name / name_en), id is used for category_id parameter - duration_types: Duration list (id / name / name_en), id is used for duration_type parameter - label_types: Label/type list (id / name / name_en), id is used for label_type parameter - date_types: Publish date list (id / name / name_en), id is used for date_type parameter <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_index
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_indexDouyin (index). ### Purpose - Get the video index trend for a video over a date range ### Parameters - item_id: Video ID (Douyin aweme id, numeric string) - start_date/end_date: Date range in YYYYMMDD ### Return - Video index (composite / spread / interaction, etc.) trend data over time <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_index_interpret
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_index_interpretDouyin (index). ### Purpose - Get the interpretation of a video's index (breakdown of each sub-index) - Recommended to use together with fetch_item_index ### Parameters - item_id: Video ID (Douyin aweme id, numeric string) - start_date/end_date: Date range in YYYYMMDD ### Return - Interpretation of composite / spread / interaction sub-indices API references: `fetch_item_index` = `POST /tikhub/douyin/index/fetch_item_index` (operationId: `post_tikhub_douyin_index_fetch_item_index`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_query
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_queryDouyin (index). ### Purpose - Search the Douyin Index video library with 4-dimensional filters: category, duration, label type, publish date - Results contain basic video info plus core metrics (plays, likes, followers, etc.) ### Parameters - query: Search keyword (required), e.g. "food" - category_id: Category ID (string), default "0"=all - Common examples: 601=Drama, 602=Celebrity, 603=Variety, 604=Movie, 605=TV Series, 606=Music, 607=Anime, 608=Games, 615=Tech, 628=Food, 629=Travel, 631=Fashion - Full list available via `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`); use the id of a categories entry - date_type: Publish date filter, default 0=any - Valid values: 0=any, 3=last 3 days, 7=last 7 days, 30=last 30 days - label_type: Video type (quality tag), default 0=any - Valid values: 0=any, 1=low-follower hit, 2=high completion rate, 3=high follower growth, 4=high like rate - duration_type: Duration filter, default 0=any - Valid values: 0=any, 1=0-15s, 6=15-60s, 7=60-120s, 8=120-180s, 9=over 180s ### Note - All filter values can be fetched dynamically via `GET /tikhub/douyin/index/fetch_item_filter_options` (operationId: `get_tikhub_douyin_index_fetch_item_filter_options`) to avoid hard-coded outdated data. ### Return - Video list. Each item contains: itemId, itemTitle, cover, duration, publish time, play count, like count, comment count, share count, author id/nickname/followers, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_sug
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_sugDouyin (index). ### Purpose: - Get keyword auto-complete suggestions for video search ### Parameters: - query: Search keyword ### Return: - Matched keyword suggestion list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_item_user_profile
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_item_user_profileDouyin (index). ### Purpose - Get the audience portrait for a video ### Parameters - item_id: Video ID (Douyin aweme id, numeric string) - start_date/end_date: Date range in YYYYMMDD ### Return - Audience gender, age, region, interest distributions and other portrait data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_keyword_valid_date
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_keyword_valid_dateDouyin (index). ### Purpose - Get valid date range for specified keywords in Douyin Index ### Parameters - keyword_list: Keyword list, comma separated, e.g. "food,travel" ### Return - Queryable start and end dates for each keyword <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_keyword_hot_trend
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_multi_keyword_hot_trendDouyin (index). ### Purpose - Get hot trend data for multiple keywords in a specified time range - Compare hot trend changes of multiple keywords ### Parameters - keyword_list: Comma separated keywords, e.g. "food,travel" - start_date: Start date, format YYYYMMDD - end_date: End date, format YYYYMMDD - app_name: Platform, aweme=Douyin, toutiao=Toutiao - region: Region filter, comma separated (e.g. "云南,上海"), empty for all ### Return - Daily hot trend data Region names are protocol values; use the original Chinese names. <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_keyword_interpretation
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_multi_keyword_interpretationDouyin (index). ### Purpose - Get interpretation data for multiple keywords (composite index, search index, content index, etc.) - Recommended to use together with fetch_multi_keyword_hot_trend ### Parameters - keyword_list: Comma separated keywords - start_date/end_date: Date range in YYYYMMDD - app_name: Platform, aweme=Douyin, toutiao=Toutiao - region: Region filter, comma separated, empty for all ### Return - Keyword composite index, search index, content index interpretation API references: `fetch_multi_keyword_hot_trend` = `POST /tikhub/douyin/index/fetch_multi_keyword_hot_trend` (operationId: `post_tikhub_douyin_index_fetch_multi_keyword_hot_trend`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_portrait
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_portraitDouyin (index). ### Purpose - Get crowd portrait analysis for a keyword ### Parameters - keyword: The keyword to analyze - start_date/end_date: Date range in YYYYMMDD - app_name: Platform, aweme=Douyin, toutiao=Toutiao ### Return - Gender, age, region, interest distributions and other portrait data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_relation_word
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_relation_wordDouyin (index). ### Purpose: - Get relation word analysis for a keyword, including search and content relation words - Shows relation word graph and ranking ### Parameters: - keyword: The keyword to analyze - start_date: Start date (recommend Monday), format YYYYMMDD - end_date: End date (**must be a Sunday**), format YYYYMMDD - app_name: Platform, aweme=Douyin, toutiao=Toutiao ### Note: - **The end_date must be a Sunday**, e.g. start_date=20260330, end_date=20260405 (Sunday) - If end_date is not a Sunday, the API may return empty data ### Return: - Search relation words, content relation words, relation word graph data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_report_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_report_detailDouyin (index). ### Purpose: - Get full detail of a trend insight report - Includes title, cover, publish time, business tags, content body, image assets, and PDF download links ### Parameters: - report_id: Report ID (string), obtained from fetch_report_search or fetch_insight_recommend results ### Return: - Full report data: title, cover, publish_time, business, content, images, pdf_url, etc. API references: `fetch_insight_recommend` = `GET /tikhub/douyin/index/fetch_insight_recommend` (operationId: `get_tikhub_douyin_index_fetch_insight_recommend`); `fetch_report_search` = `POST /tikhub/douyin/index/fetch_report_search` (operationId: `post_tikhub_douyin_index_fetch_report_search`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_report_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_report_searchDouyin (index). ### Purpose - Search trend insight reports under Douyin Index ### Parameters - current_page / page_size: pagination (string) - type: report type, empty for all - business: comma-separated product list - report_time: comma-separated year list, e.g. "2024,2023" - search: keyword search - category: top-level category ID, default "6" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_topic_query
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_topic_queryDouyin (index). ### Purpose - Search topics, get topic details and related data ### Parameters - keyword: Topic keyword - start_date/end_date: Date range in YYYYMMDD - app_name: Platform ### Return - Topic details, topic popularity, related video count, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_topic_suggest
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/index/fetch_topic_suggestDouyin (index). ### Purpose: - Get topic search auto-complete suggestion list ### Parameters: - keyword: Topic keyword - app_name: Platform, aweme=Douyin, toutiao=Toutiao ### Return: - Matched topic list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_valid_date_for_relation
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/index/fetch_valid_date_for_relationDouyin (index). ### Purpose: - Get valid date range for the relation analysis feature ### Return: - Start and end available dates for relation analysis <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_challenge_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_challenge_search_v2Douyin (search). ### Purpose - Fetch hashtag/challenge search results from Douyin App using V2 API. - Supports searching by keyword and returns detailed challenge information, including name, cover image, view count, and participant count. ### Notes - This API focuses on searching challenges (hashtags), not including videos or live streams. - Set `cursor` to 0 and `search_id` to an empty string for the first request. For pagination, use the cursor and search_id from the last response. ### Parameters - keyword: Search keyword, e.g., "game" - cursor: Pagination cursor (0 for first request) - sort_type: Sorting method - `0`: Comprehensive - `1`: Most likes - `2`: Latest - publish_time: Publish time filter - `0`: Unlimited - `1`: Last day - `7`: Last week - `180`: Last half year - filter_duration: Video duration filter - `0`: Unlimited - `0-1`: Under 1 minute - `1-5`: 1-5 minutes - `5-10000`: Over 5 minutes - content_type: Content type filter - `0`: Unlimited - `1`: Video - `2`: Image - `3`: Article - search_id: Search ID for pagination ### Request Body Example ```json payload = { "keyword": "game", "cursor": 0, "sort_type": "0", "publish_time": "0", "filter_duration": "0", "content_type": "0", "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - `business_data` (list of hashtag search results) - `data_id`: Unique identifier for the result - `type`: Data type (fixed `2`) - `data.challenge_info`: - `cid`: Challenge ID - `cha_name`: Challenge name - `desc`: Challenge description - `schema`: Challenge detail schema link (aweme:// schema, used to deep link inside Douyin App) - `hashtag_profile`: URL of the hashtag cover image - `user_count`: Number of participants - `view_count`: Number of views - `challenge_status`: Status (1 = active, others = abnormal) - `author`: Creator info - `uid`: User ID - `nickname`: Nickname - `avatar_thumb.url_list`: Thumbnail avatar URLs - `is_verified`: Whether the creator is verified - `follower_count`: Number of followers - `share_info`: - `share_url`: Shareable URL - `share_title`: Title for sharing - `share_desc`: Description for sharing <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_challenge_suggest
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_challenge_suggestDouyin (search). ### Purpose - Fetch hashtag/challenge suggestions from Douyin App based on the input keyword. - Returns a list of related hashtags including name and view count. ### Notes - Suitable for implementing keyword suggestion features in search bars. - Set `cursor` to 0 and `search_id` to an empty string for the first request. ### Parameters - keyword: Search keyword, e.g., "game" ### Request Body Example ```json payload = { "keyword": "game" } ``` ### Response (common fields, actual response may contain more fields) - `sug_list[]`: List of suggested hashtags - `cha_name`: Hashtag name (e.g., "#game") - `view_count`: Total view count - `cid`: Challenge ID - `group_id`: Associated group ID - `tag`: Tag category (0=normal, 1=hot trend) - `status_code`: Status code (0=success) - `status_msg`: Status message (usually empty) - `rid`: Request ID - `words_query_record`: - `info`: Additional info (currently empty) - `words_source`: Words source ("sug") - `query_id`: Query ID (usually empty) - `extra`: - `now`: Server timestamp - `logid`: Log ID - `fatal_item_ids`: List of fatal item IDs (usually empty) - `search_request_id`: Search request ID (usually empty) - `log_pb`: - `impr_id`: Impression ID (for logging) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_discuss_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_discuss_searchDouyin (search). ### Purpose - Fetch discussion/Q&A search results from Douyin App. - Supports filtering by keyword, sort type, publish time, content type, etc. ### Notes - This API focuses on discussion and Q&A content, not including other content types. - Set `cursor` to 0 and `search_id` to an empty string for the first request. - The response includes video details, author info, playback info, statistics, hashtags, etc. ### Parameters - keyword: Search keyword, e.g., "study abroad" - cursor: Pagination cursor (0 for first page, use the last response cursor for subsequent pages) - sort_type: Sorting method - `0`: Comprehensive - `1`: Most likes - `2`: Latest - publish_time: Publish time filter - `0`: Unlimited - `1`: Last day - `7`: Last week - `180`: Last half year - filter_duration: Video duration filter - `0`: Unlimited - `0-1`: Within 1 minute - `1-5`: 1 to 5 minutes - `5-10000`: More than 5 minutes - content_type: Content type filter - `0`: Unlimited - `1`: Video - `2`: Picture - `3`: Article - search_id: Search ID used for pagination ### Request Body Example ```json payload = { "keyword": "study abroad", "cursor": 0, "sort_type": "0", "publish_time": "0", "filter_duration": "0", "content_type": "0", "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - `data`: List of search result items - `type`: Result type (usually `1`) - `aweme_info`: Video information - `aweme_id`: Video ID - `desc`: Description - `author`: - `uid`: User ID - `nickname`: User nickname - `is_verified`: Verified user or not - `region`: User region - `avatar_thumb.url_list`: Thumbnail avatar URLs - `avatar_medium.url_list`: Medium avatar URLs - `avatar_larger.url_list`: Large avatar URLs - `video`: - `play_addr.url_list`: Video playback URLs - `cover.url_list`: Video cover URLs - `dynamic_cover.url_list`: Dynamic cover URLs - `origin_cover.url_list`: Original cover URLs - `width`: Width in pixels - `height`: Height in pixels - `ratio`: Resolution ratio (e.g., 540p) - `duration`: Duration in milliseconds - `download_addr.url_list`: Download URLs with watermark - `statistics`: - `comment_count`: Number of comments - `digg_count`: Number of likes - `share_count`: Number of shares - `play_count`: Number of plays - `collect_count`: Number of collections - `cha_list`: - `cha_name`: Hashtag name - `share_url`: Hashtag share link - `music`: - `id_str`: Music ID - `title`: Music title - `author`: Music creator name - `play_url.url_list`: List of music playback URLs - `status`: - `is_delete`: Whether deleted - `is_private`: Whether private - `allow_share`: Allow sharing - `allow_comment`: Allow commenting - `share_url`: External video share link <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_experience_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_experience_searchDouyin (search). ### Purpose - Fetch experience (knowledge/tutorial) content search results from Douyin App. - Retrieves video results related to knowledge sharing, tutorials, or tips based on the input keyword. ### Notes - This API focuses on experience-related videos and does not include other content types. - Set `cursor` to 0 and `search_id` to an empty string for the first request; for pagination, use the previous cursor and search_id. - The response includes rich information such as video details, author profile, background music, hashtags, video URLs, and engagement statistics. ### Parameters - keyword: Search keyword, e.g., "gaming guide" - cursor: Pagination cursor (0 for first page) - sort_type: Sorting method - `0`: Comprehensive - `1`: Most likes - `2`: Latest - publish_time: Publish time filter - `0`: Unlimited - `1`: Last day - `7`: Last week - `180`: Last half year - filter_duration: Video duration filter - `0`: Unlimited - `0-1`: Within 1 minute - `1-5`: 1 to 5 minutes - `5-10000`: More than 5 minutes - content_type: Content type filter (usually fixed to video) - search_id: Search ID for pagination ### Request Body Example ```json payload = { "keyword": "gaming guide", "cursor": 0, "sort_type": 0, "publish_time": 0, "filter_duration": 0, "content_type": 1, "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - business_data: List of business data blocks - data_id: Data block ID - type: Data type (e.g., 999 for content list) - data: - height: Display height - aweme_list: List of videos - aweme_id: Video ID - desc: Video description - create_time: Creation timestamp - author: Author profile - uid: User ID - nickname: User nickname - avatar_thumb.url_list: Thumbnail avatar URLs - is_verified: Whether the author is verified - follower_count: Number of followers - music: Background music information - id_str: Music ID - title: Music title - author: Music author's name - cha_list: Associated hashtags - cha_name: Hashtag name - video: Video playback info - play_addr.url_list: List of video play URLs - cover.url_list: List of video cover image URLs - width: Video width - height: Video height - duration: Video duration in milliseconds - statistics: Video engagement data - digg_count: Number of likes - comment_count: Number of comments - share_count: Number of shares - play_count: Number of plays - status: Video status information - is_delete: Whether the video was deleted - is_private: Whether the video is private - share_url: External share link of the video <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_general_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_general_search_v3Douyin (search). ### Purpose - Fetch Douyin general search results (V3), returning mixed cards: videos, users, related words, etc. - Compared with V1/V2 it has no sorting or filtering options, but pagination is simpler and the response structure is unified (`config` + `items` + `pagination`). ### Notes - For the first request set `offset` to 0, `page` to 1, and `search_id` / `backtrace` to empty strings. - For pagination, pass back `offset`, `search_id` and `backtrace` from `data.pagination` of the previous response, and increment `page` by 1. - `data.pagination.has_more` = 0 means the last page has been reached. - Page size is fixed at 10 and cannot be changed. `page` is capped at 200; exceeding it returns a parameter error. ### Parameters - keyword: Search keyword, e.g., "cat" - offset: Offset cursor (0 for the first request) - page: Page number, 1-200 (1 for the first request) - search_id: Search ID (empty for the first request) - backtrace: Backtrace identifier (empty for the first request) ### Request Body Example ```json payload = { "keyword": "cat", "offset": 0, "page": 1, "search_id": "", "backtrace": "" } ``` ### Response (common fields, actual response may contain more fields) - `config`: Search configuration returned by the upstream (passed through) - `items[]`: Result cards (already unwrapped by card type) - Video card: - `aweme_id`: Video ID - `desc`: Video description - `create_time`: Publish timestamp - `author`: Author info (`uid`, `sec_uid`, `nickname`, `avatar_thumb.url_list`, etc.) - `video`: Playback info (`play_addr.url_list`, `cover.url_list`, `duration`, etc.) - `statistics`: Interaction data (`digg_count`, `comment_count`, `share_count`, `play_count`) - `share_url`: External share link - Related-words card: list of suggested keywords - Unknown card types are passed through as-is - `pagination`: Pagination info - `offset`: Offset cursor for the next page (pass back as-is) - `cursor`: Same as `offset` - `search_id`: Search ID for the next page (pass back as-is) - `backtrace`: Backtrace for the next page (pass back as-is) - `has_more`: Whether more results are available (1=Yes, 0=No) - `next_page`: Next page number (`null` when there are no more results) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_image_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_image_search_v3Douyin (search). ### Purpose - Fetch image-text content search results from Douyin App. - Returns posts with multiple images (aweme_type=68), suitable for gallery-style applications. ### Notes - This endpoint uses a different data source than `fetch_image_search`, results may vary. - Recommended for scenarios requiring high-quality image-text content. - For the first request, set `cursor` to 0 and `search_id` to an empty string. - For pagination, use the `cursor` and `search_id` from the last response. - Returns approximately 12 items per page. ### Parameters - keyword: Search keyword, e.g., "food" - cursor: Pagination cursor (0 for first request) - search_id: Search ID for pagination (use value from previous response) ### Request Body Example ```json payload = { "keyword": "food", "cursor": 0, "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - `status_code`: Status code (0=success) - `business_data[]`: Image-text content list - `data`: - `aweme_list[]`: Content list - `aweme_id`: Content ID - `aweme_type`: Content type (68=image-text) - `desc`: Post description - `create_time`: Creation timestamp - `author`: - `uid`: Author ID - `nickname`: Nickname - `avatar_thumb.url_list`: Thumbnail avatar URLs - `image_post_info`: - `images[]`: Image list - `url_list`: Image URLs array - `width`: Width (pixels) - `height`: Height (pixels) - `statistics`: - `comment_count`: Comment count - `digg_count`: Like count - `share_count`: Share count - `collect_count`: Collect count - `share_url`: Shareable external link - `extra`: - `now`: Current server timestamp - `logid`: Request log ID Upstream-only reference: `fetch_image_search` is `POST /api/v1/douyin/search/fetch_image_search` in the official API. It is not exposed as an operation in this specification. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_live_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_live_search_v2Douyin (search). ### Purpose - Search live rooms by Douyin ID or nickname (V2), with cursor pagination. - Best suited for locating a specific streamer's live room rather than searching live content by topic keyword. ### Notes - `keyword` matches the streamer's Douyin ID or nickname; a content keyword (e.g., "games") usually returns no result. - This endpoint has no sorting, publish time or duration filters. - Page size is fixed at 10 and cannot be changed. - Set `cursor` to 0 for the first request, then pass the `cursor` from the previous response. ### Parameters - keyword: Douyin ID or nickname (required), e.g., "Little Ears" - cursor: Pagination cursor (0 for the first request) ### Request Body Example ```json payload = { "keyword": "Little Ears", "cursor": 0 } ``` ### Response (common fields, actual response may contain more fields) - Matched live room list; each item contains the streamer's nickname, Douyin ID, avatar, room ID and live status - Pagination info (next `cursor`, whether more results are available) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_multi_searchDouyin (search). ### Purpose - Fetch multiple types of search results (videos, users, music, hashtags, etc.) from Douyin App. ### Notes - Set `cursor` to 0 and `search_id` to an empty string for the first request. - Suitable for search aggregation pages, discovery modules, and recommendations. ### Parameters - keyword: Search keyword, e.g., "Artificial Intelligence" - cursor: Pagination cursor (0 for the first page, use the last response cursor for subsequent pages) - sort_type: Sorting method - `0`: Comprehensive - `1`: Most likes - `2`: Latest - publish_time: Publish time filter - `0`: Unlimited - `1`: Last day - `7`: Last week - `180`: Last half year - filter_duration: Video duration filter - `0`: Unlimited - `0-1`: Within 1 minute - `1-5`: 1 to 5 minutes - `5-10000`: More than 5 minutes - content_type: Content type filter - `0`: Unlimited - `1`: Video - `2`: Picture - `3`: Article - search_id: Search ID used for pagination ### Request Body Example ```json payload = { "keyword": "Artificial Intelligence", "cursor": 0, "sort_type": "0", "publish_time": "0", "filter_duration": "0", "content_type": "0", "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - `cursor`: Cursor for the next page - `has_more`: Whether there are more results (1=Yes, 0=No) - `business_data[]`: List of search result items - `data_id`: Data ID - `type`: Result type - `1`: Video (aweme_info) - `2`: User (user_info) - `4`: Music (music_info) - `6`: Hashtag (cha_info) - `data`: Content depending on `type` - if type = 1 (video): - `aweme_info`: Detailed video info - if type = 2 (user): - `user_info`: Detailed user info - if type = 4 (music): - `music_info`: Music details - if type = 6 (hashtag): - `cha_info`: Hashtag details - `extra`: - `now`: Current server timestamp - `logid`: Request log ID <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_music_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_music_searchDouyin (search). ### Purpose - Fetch music content search results from Douyin App. - Supports filtering by keyword, sort type, etc. ### Notes - This API focuses on music content search, excluding other types. - Set `cursor` to 0 and `search_id` to an empty string for the first request. - Response includes music basic info, artist info, covers, play URLs, tags, etc. ### Parameters - keyword: Search keyword, e.g., "game background music" - cursor: Pagination cursor (0 for first request) - sort_type: Sorting method - `0`: Comprehensive - `1`: Most likes - `2`: Latest - publish_time: Publish time filter - `0`: Unlimited - `1`: Last day - `7`: Last week - `180`: Last half year - filter_duration: Video duration filter - `0`: Unlimited - `0-1`: Under 1 minute - `1-5`: 1 to 5 minutes - `5-10000`: Over 5 minutes - content_type: Content type filter - `0`: Unlimited - `1`: Video - `2`: Image - `3`: Article - search_id: Search ID for pagination ### Request Body Example ```json payload = { "keyword": "game background music", "cursor": 0, "sort_type": "0", "publish_time": "0", "filter_duration": "0", "content_type": "0", "search_id": "" } ``` ### Response (common fields, actual response may contain more fields) - `music`: List of music search results - `id_str`: Music ID (as string) - `title`: Music title - `author`: Music author's nickname - `album`: Album name (if any) - `play_url.url_list`: List of music play URLs - `duration`: Duration in seconds - `cover_thumb.url_list`: List of thumbnail cover URLs - `cover_medium.url_list`: List of medium-sized cover URLs - `cover_large.url_list`: List of large-sized cover URLs - `user_count`: Number of videos using this music - `is_original`: Whether it is original music - `is_commerce_music`: Whether it is commercial music - `lyric_url`: Lyrics file URL (if available) - `strong_beat_url.url_list`: Beat timing file URLs - `tags`: Music tags - Themes (e.g., Game, Vlog), Moods (e.g., Funny), Genres (e.g., 8-bit, Electronic) - `artists`: List of associated artists (if any) - `artist_name`: Artist name - `uid`: Artist UID - `cover_color_hsv`: Dominant HSV color of the cover - `can_background_play`: Whether background playback is supported <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_school_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_school_searchDouyin (search). ### Purpose - Fetch school information search results from Douyin App. - Returns a list of school names based on the input keyword, useful for user profile settings, school recommendations, etc. ### Notes - This API focuses on school information search, and only returns school names. - Set `cursor` to 0 for the first request; for pagination, use the cursor from the last response. - The response structure is simple and lightweight for fast lookup. ### Parameters - keyword: Search keyword, e.g., school name "Peking University" or city "Beijing" ### Example Request Body ```json payload = { "keyword": "Peking University" } ``` ### Response (common fields, actual response may contain more fields) - `schools[]`: List of schools - `name`: School name (e.g., "Peking University", "Beijing No.4 High School") - `extra`: - `now`: Server timestamp in milliseconds - `logid`: Log ID for request tracing - `fatal_item_ids`: List of fatal item IDs (usually empty) - `log_pb`: - `impr_id`: Impression ID for tracking - `status_code`: Status code (0=success) - `status_msg`: Status message (usually empty) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_search_suggest
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_search_suggestDouyin (search). ### Purpose - Fetch keyword suggestion results from Douyin App. - Based on the user's input, returns a list of recommended search keywords to improve search experience. ### Notes - Typically used for real-time keyword suggestions in the search box. - The returned suggestions are scored and sorted internally by Douyin's recommendation system. ### Parameters - keyword: Input keyword, e.g., "Artificial Intelligence" ### Request Body Example ```json payload = { "keyword": "Artificial Intelligence" } ``` ### Response (common fields, actual response may contain more fields) - `status_code`: Status code (0 means success) - `status_msg`: Response message (usually empty) - `rid`: Request ID - `sug_list[]`: List of suggested search keywords - `content`: Suggested keyword (e.g., "AI software free download") - `sug_type`: Suggestion type (usually empty, reserved field) - `pos[]`: Position marking - `begin`: Begin character position - `end`: End character position - `word_record`: - `group_id`: Suggestion group ID - `words_position`: Position in the current suggestion list - `words_content`: The word content (same as `content`) - `words_source`: Word source (typically "sug") - `extra_info`: - `client_server_extra`: Extra client-server config (JSON string) - `poi_id`: Related POI ID (usually empty) - `search_params`: Search parameters (with recommendation scores) - `words_query_record`: - `info`: Additional info (usually empty) - `words_source`: Source of suggestions - `query_id`: Suggestion query ID - `extra`: - `now`: Current server timestamp (milliseconds) - `logid`: Log ID - `fatal_item_ids`: List of fatal error items (usually empty) - `search_request_id`: Search request ID (usually empty) - `log_pb`: - `impr_id`: Impression log ID - `time_cost`: - `stream_inner`: Internal stream processing time (milliseconds) - `server_engine_cost`: Server search engine processing time (milliseconds) - `cache_conf`: - `enable`: Whether cache was hit (boolean) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_user_search_v2Douyin (search). ### Purpose - Fetch a list of users from Douyin App based on search keywords. - Supports filtering by fan count and user type. ### Notes - Set `cursor` to 0. - Only user information is returned. No videos, music, or hashtags. ### Parameters - keyword: Search keyword, e.g., "AI" - cursor: Pagination cursor (0 for first page) ### Request Body Example ```json payload = { "keyword": "AI", "cursor": 0 } ``` ### Response (common fields, actual response may contain more fields) - `cursor`: Cursor for next page - `has_more`: Whether more data is available (1=Yes, 0=No) - `user_list[]`: List of users - `user_info`: - `uid`: User ID - `nickname`: Nickname - `gender`: Gender (0=Unknown, 1=Male, 2=Female) - `unique_id`: Douyin ID - `sec_uid`: Secured UID - `signature`: Personal bio - `follower_count`: Number of followers - `avatar_thumb.url_list`: List of thumbnail avatar URLs - `avatar_medium.url_list`: List of medium avatar URLs - `avatar_larger.url_list`: List of large avatar URLs - `follow_status`: Whether followed - `live_status`: Whether live - `enterprise_verify_reason`: Enterprise verification info (if any) - `versatile_display`: Display text (e.g., "Douyin ID: xxx") - `extra`: - `now`: Current server timestamp - `logid`: Request log ID - `search_request_id`: Search request ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/search/fetch_video_search_v5Douyin (search). ### Purpose - Search videos by keyword (V5), returning video content only. - Pagination parameters match general search V3, and the response structure is unified (`config` + `items` + `pagination`). ### Notes - For the first request set `offset` to 0, `page` to 1, and `search_id` / `backtrace` to empty strings. - For pagination, pass back `offset`, `search_id` and `backtrace` from `data.pagination` of the previous response, and increment `page` by 1. - `data.pagination.has_more` = 0 means the last page has been reached. - Page size is fixed at 10 and cannot be changed. `page` is capped at 200; exceeding it returns a parameter error. ### Parameters - keyword: Search keyword, e.g., "cat" - offset: Offset cursor (0 for the first request) - page: Page number, 1-200 (1 for the first request) - search_id: Search ID (empty for the first request) - backtrace: Backtrace identifier (empty for the first request) ### Request Body Example ```json payload = { "keyword": "cat", "offset": 0, "page": 1, "search_id": "", "backtrace": "" } ``` ### Response (common fields, actual response may contain more fields) - `config`: Search configuration returned by the upstream (passed through) - `items[]`: Video list (already unwrapped by card type) - `aweme_id`: Video ID - `desc`: Video description - `create_time`: Publish timestamp - `author`: Author info (`uid`, `sec_uid`, `nickname`, `avatar_thumb.url_list`, etc.) - `video`: Playback info (`play_addr.url_list`, `cover.url_list`, `duration`, etc.) - `statistics`: Interaction data (`digg_count`, `comment_count`, `share_count`, `play_count`) - `share_url`: External share link - `pagination`: Pagination info - `offset`: Offset cursor for the next page (pass back as-is) - `cursor`: Same as `offset` - `search_id`: Search ID for the next page (pass back as-is) - `backtrace`: Backtrace for the next page (pass back as-is) - `has_more`: Whether more results are available (1=Yes, 0=No) - `next_page`: Next page number (`null` when there are no more results) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin encrypt_uid_to_sec_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/encrypt_uid_to_sec_user_idDouyin (web). ### Purpose: - Encrypt user uid to sec_user_id ### Parameters: - uid: User uid, which is the short_id of the Douyin number ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_batch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_batch_user_profile_v2Douyin (web). ### Purpose: - Get batch user profile, up to 50 users ### Parameters: - sec_user_ids: User sec_user_id list, separated by commas, up to 50 ### Return: - Batch user profile <!-- aisa-pricing:start --> Published reference price: $0.15 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_cartoon_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_cartoon_awemeDouyin (web). ### Purpose: - Cartoon Video ### Parameters: - count: Number per page, default is 16 - refresh_index: Paging index, default is 1 - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Cartoon Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_challenge_posts
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_challenge_postsDouyin (web). ### Purpose: - Challenge Posts ### Parameters: - challenge_id: Challenge id - sort_type: Sort type - 0: Comprehensive sorting 1: Hottest sorting 2: Latest sorting - cursor: Cursor - count: Number - cookie: User provided Cookie, used to get more data ### Return: - Challenge Posts <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_douyin_web_guest_cookie
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_douyin_web_guest_cookieDouyin (web). ### Purpose: - Get the guest Cookie of Douyin Web - Can be used to crawl data of Douyin Web, such as user videos, mix videos, etc. - Can fix identity to avoid duplicate data for some interfaces. - Please note: Guest Cookie cannot crawl all data, there are certain restrictions. - Can be used with open source projects to implement data crawling of Douyin Web using this interface. ### Parameters: - user_agent: User browser agent ### Return: - Guest Cookie <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_food_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_food_awemeDouyin (web). ### Purpose: - Food Video ### Parameters: - count: Number per page, default is 16 - refresh_index: Paging index, default is 1 - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Food Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_game_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_game_awemeDouyin (web). ### Purpose: - Knowledge Video ### Parameters: - count: Number per page, default is 16 - refresh_index: Paging index, default is 1 - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Game Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_home_feed
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_home_feedDouyin (web). ### Purpose: - Get home feed data ### Parameters: - count: Number, default is 10, it is recommended to keep it unchanged. - refresh_index: Refresh/paging index, start at 0 and +1 per page. - refresh_index=0: refresh (first entry / pull-to-refresh) - refresh_index>0: load-more (scroll down) - cookie: Optional, your web version of Douyin login Cookie. Returns a personalized feed for that account; uses the default Cookie if omitted. ### Return: - Feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_hot_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_hot_search_resultDouyin (web). ### Purpose: - Get Douyin hot search results ### Return: - Hot search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_knowledge_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_knowledge_awemeDouyin (web). ### Purpose: - Knowledge Video ### Parameters: - count: Number per page, default is 16 - refresh_index: Paging index, default is 1 - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Knowledge Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_live_gift_ranking
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_live_gift_rankingDouyin (web). ### Purpose: - Get live room gift user ranking ### Parameters: - room_id: Room room_id - rank_type: Leaderboard type, default is 30, no need to modify. ### Return: - Leaderboard data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_live_im_fetch
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_live_im_fetchDouyin (web). ### Purpose: - Douyin live room danmaku parameters ### Parameters: - room_id: Live room id - user_unique_id: User unique ID ### Return: - Danmaku parameter data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_video
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_multi_videoDouyin (web). ### Purpose - Batch Get Video Information, support photo, video, etc., up to 50 videos at a time. - If this interface fails, please use the APP interface instead. ### Parameters - Root JSON body: List of video ids, up to 50 video ids are supported. ### Return - Video data ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_multi_video_high_quality_play_url
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_multi_video_high_quality_play_urlDouyin (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose If there are less than 50 videos, they will be charged as 50 videos. - Batch get the highest quality (original upload quality) play URL of videos - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata. - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface. - This interface is very suitable for batch obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc. - Use concurrent requests to improve batch acquisition efficiency. - Support up to 50 video IDs. ### Parameters - aweme_ids: Video id list, separated by commas, for example: "123,456,789", up to 50. ### Return - total: Total count - success_count: Success count - failed_count: Failed count - videos: Video list, each video contains the following fields: - video_id: Video id - original_video_url: Highest quality (original upload quality) play URL - file_size: File size (bytes) - file_size_in_mb: File size (MB) - content_type: Content type - success: Whether successful - error: Error message (if failed) ### Note - Due to the large number, the processing time may be slightly longer, please increase the waiting time. <!-- aisa-pricing:start --> Published reference price: $0.25 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_music_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_music_awemeDouyin (web). ### Purpose: - Music Video ### Parameters: - count: Number per page, default is 16 - refresh_index: Paging index, default is 1 - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Music Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_one_videoDouyin (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get single video data V1. If this endpoint fails, try /tikhub/douyin/app/v3/fetch_one_video. ### Parameters - aweme_id: Video id - need_anchor_info: Whether anchor information is needed, default is False, enabling it will show some anchor information about the video, such as location, merchant information, product showcase, etc., which may increase the interface response time. - If anchor information is not needed, it is recommended to keep the default value False, if the interface reports an error, you can try to turn off this parameter. ### Return - Video data - Unavailable video results (including deleted or restricted videos) return HTTP 200 with `filter_detail` and are charged normally. API references: `fetch_one_video` = `GET /tikhub/douyin/app/v3/fetch_one_video` (operationId: `get_tikhub_douyin_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_one_video_by_share_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_one_video_by_share_urlDouyin (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get single video data by sharing link (Essentially implemented based on the `/tikhub/douyin/web/fetch_one_video` interface, it is recommended to obtain the video ID by yourself to improve the interface response speed) - The returned video quality is higher than the APP interface, but the response fields are not as many as the APP interface. ### Parameters - share_url: Share link ### Return - Video data - Unavailable video results (including deleted or restricted videos) return HTTP 200 with `filter_detail` and are charged normally. API references: `fetch_one_video` = `GET /tikhub/douyin/web/fetch_one_video` (operationId: `get_tikhub_douyin_web_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_one_video_danmaku
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_one_video_danmakuDouyin (web). ### Purpose: - Get single video danmaku data ### Parameters: - item_id: Video id - duration: Video total duration - end_time: End time - start_time: Start time ### Return: - Video danmaku data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_query_user
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_query_userDouyin (web). ### Purpose - Query Douyin user basic information ### Parameters - Root JSON body: User ttwid Cookie, acquisition method: call `/tikhub/douyin/web/generate_ttwid` interface to get. ### Return - User basic information ### Request body Send the cookie value as a JSON string at the root of the request body. API references: `generate_ttwid` = `GET /tikhub/douyin/web/generate_ttwid` (operationId: `get_tikhub_douyin_web_generate_ttwid`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_related_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_related_postsDouyin (web). ### Purpose: - Get related posts recommendation data ### Parameters: - aweme_id: Video id - refresh_index: Paging index, default is 1, then increase by 1 each time for paging. - count: Number, default is 20, it is recommended to keep it unchanged. ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_series_aweme
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_series_awemeDouyin (web). ### Purpose: - Series Video ### Parameters: - offset: Page number, default is 0 - count: Number per page, default is 16 - content_type: Subtype, default is 0 - 0: Hot list - 101: Sweet pet - 102: Funny - 104: Positive energy - 105: Growth - 106: Suspense - 109: Family - 110: Urban - 112: Fantasy - 113: Fantasy - 114: Workplace - 115: Youth - 116: Ancient costume - 117: Action - 119: Counterattack - 124: Other - cookie: User provided Cookie, it is recommended to use your own Douyin Cookie, otherwise there may be a problem of data duplication when paging - Guest cookie acquisition interface: https://api.tikhub.io/api/v1/douyin/web/fetch_douyin_web_guest_cookie ### Return: - Series Video data API references: `fetch_douyin_web_guest_cookie` = `GET /tikhub/douyin/web/fetch_douyin_web_guest_cookie` (operationId: `get_tikhub_douyin_web_fetch_douyin_web_guest_cookie`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_collection_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_collection_videosDouyin (web). ### Purpose - Get user collection video data ### Parameters - cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie) - max_cursor: Maximum cursor - counts: Maximum number ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_collects
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_collectsDouyin (web). ### Purpose - Get user collection ### Parameters - max_cursor: Maximum cursor - counts: Maximum number - cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie) ### Return - User collection data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_collects_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_collects_videosDouyin (web). ### Purpose - Get user collection data ### Parameters - collects_id: Collection id - max_cursor: Maximum cursor - counts: Maximum number ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_fans_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_fans_listDouyin (web). ### Purpose: - Get user fans list - When requesting for the first time, pass `0` for max_time, pass `2` for source_type, and an empty fans list will be returned, which contains max_time, then pass the max_time returned by the previous request for paging each time, pass `1` for source_type, you can get the fans list. - If you do not request according to the above method, it may cause the returned data to contain duplicate data. ### Parameters: - sec_user_id: User sec_user_id - max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging. - count: Number, default is 20, it is recommended to keep it unchanged. - source_type: Source type, default is `1`, use `2` as the source type for the first request, and then use `1` as the source type for the subsequent request. ### Return: - Fans list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_following_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_following_listDouyin (web). ### Purpose: - Get user following list - When requesting for the first time, pass `0` for max_time, pass `2` for source_type, and an empty fans list will be returned, which contains max_time, then pass the max_time returned by the previous request for paging each time, pass `1` for source_type, you can get the fans list. - If you do not request according to the above method, it may cause the returned data to contain duplicate data. ### Parameters: - sec_user_id: User sec_user_id - max_time: Maximum timestamp, default is 0, get from the returned data later, used for paging. - count: Number, default is 20, it is recommended to keep it unchanged. - source_type: Source type, default is `1`, use `2` as the source type for the first request, and then use `1` as the source type for the subsequent request. ### Return: - Following list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_like_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_like_videosDouyin (web). ### Purpose - Get user like video data ### Parameters - sec_user_id: User sec_user_id - max_cursor: Maximum cursor - counts: Maximum count number - cookie: User's web version of Douyin Cookie (This interface requires users to provide their own Cookie) ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_live_info_by_uid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_live_info_by_uidDouyin (web). ### Purpose: - Get user live information by UID ### Parameters: - uid: User UID ### Return: - User live information, including room_id and live_status <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_live_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_live_videosDouyin (web). ### Purpose: - Get user live video data ### Parameters: - webcast_id: Room webcast_id - Acquisition method: - Assuming your live room link is: https://www.douyin.com/root/live/376034101029 - Then the live room webcast_id is: 376034101029 - The webcast_id is the last number of the live room link, which is different from the room_id. ### Return: - Live stream data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_live_videos_by_room_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_live_videos_by_room_id_v2Douyin (web). ### Purpose: - Gets the live stream data of the specified user V2 ### Parameters: - room_id: Room room_id ### Return: - Live stream data ### Note: The modify_time field is the last update time of the live room, which is equivalent to the start time. If the live stream is offline, it will not be reset to 0, but will always maintain the last update time. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_live_videos_by_sec_uid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_live_videos_by_sec_uidDouyin (web). ### Purpose - Get live video data of specified user by sec_uid ### Parameters - sec_uid: User sec_uid, also called sec_user_id, can be found in the user's homepage link. ### Return - Live stream data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_mix_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_mix_videosDouyin (web). ### Purpose - Get user mix video data ### Parameters - mix_id: Mix id - max_cursor: Maximum cursor - counts: Maximum number ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_post_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_post_videosDouyin (web). ### Purpose: - Get user homepage video data - Note: Please try to use the APP interface instead of the WEB API, because the WEB API may be unstable. ### Parameters: - sec_user_id: User sec_user_id - max_cursor: Paging cursor, pass 0 for the first request, and then pass the max_cursor returned by the previous request for paging each time. - count: Maximum count number, it is recommended not to exceed 20 - filter_type: Filter type, optional parameters are as follows: - 0: Default sorting - 3: Sort by popularity - cookie: User's web version of Douyin Cookie (This interface can accept users to provide their own Cookie) ### Return: - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_profile_by_short_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_profile_by_short_idDouyin (web). ### Purpose: - Get user information by Short ID ### Parameters: - short_id: User Short ID ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_user_profile_by_uid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_user_profile_by_uidDouyin (web). ### Purpose: - Get user information by UID ### Parameters: - uid: User UID ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_channel_result
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_video_channel_resultDouyin (web). ### Purpose: - Douyin video channel data - https://www.douyin.com/channel/300205 ### Parameters: - tag_id: Tag id, get from the URL - count: Number - refresh_index: Refresh index ### Return: - Video channel data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_video_comment_repliesDouyin (web). ### Purpose: - Get comment replies data of specified video ### Parameters: - item_id: Video id - comment_id: Comment id - cursor: Cursor - count: Number ### Return: - Comment replies data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_video_commentsDouyin (web). ### Purpose: - Get single video comments data ### Parameters: - aweme_id: Video id - cursor: Cursor - count: Number ### Return: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin fetch_video_high_quality_play_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/fetch_video_high_quality_play_urlDouyin (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the highest quality (original upload quality) play URL of the video - This interface will return the highest quality play URL, the original upload quality refers to the quality of the video when the user uploads it, usually the highest quality video has an uncompressed bitrate and the file header contains metadata. - The highest quality video link cannot be obtained directly from the Douyin APP or web version, and must be obtained through this interface. - This interface is very suitable for obtaining high-definition, watermark-free video links, suitable for scenarios that require high-quality videos, such as video editing, archiving, training models, etc. - Generally, it can be played online, if not, you can try to download it using IDM or a browser and then play it. ### Parameters - aweme_id: Video id, prefer to use aweme_id, if not available, use share_url. - share_url: Optional, share link, if the video id is provided, this parameter can be omitted. - region: Optional, ISO country code (e.g. "CN" / "US" / "HK") used as the request exit region. - Douyin returns CDN URLs based on the request IP. Pass `region="CN"` for users located in mainland China to get China-region CDN URLs, which are significantly faster than overseas CDNs. - If omitted, the request uses the service's own exit IP (typically overseas). ### Return - video_id: Video id - original_video_url: Highest quality (original upload quality) play URL - video_data: Video data, including metadata such as duration, size, etc. <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin generate_ttwid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/generate_ttwidDouyin (web). ### Purpose: - Generate ttwid ### Return: - ttwid <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin generate_wss_xb_signature
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/generate_wss_xb_signatureDouyin (web). ### Purpose: - Generate danmu xb signature ### Parameters: - user_agent: User browser agent - room_id: Room ID - user_unique_id: User unique ID ### Return: - Danmu xb signature <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_all_aweme_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/get_all_aweme_idDouyin (web). ### Purpose - Extract list video id (supports up to 20 links) ### Parameters - Root JSON body: Video link list ### Return - Video id list ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_all_sec_user_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/get_all_sec_user_idDouyin (web). ### Purpose - Extract list user id ### Parameters - Root JSON body: User homepage link list (supports up to 10 links) ### Return - If the sec_user_id is successfully obtained from the link, the sec_user_id is returned, otherwise the original input link is returned, and the reason why the sec_user_id cannot be obtained can be manually verified later. ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_all_webcast_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/web/get_all_webcast_idDouyin (web). ### Purpose - Extract list webcast id ### Parameters - Root JSON body: Room link list (supports up to 20 links) ### Return - Room id list ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_aweme_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/get_aweme_idDouyin (web). ### Purpose: - Extract single video id ### Parameters: - url: Video link ### Return: - Video id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_sec_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/get_sec_user_idDouyin (web). ### Purpose: - Extract single user id ### Parameters: - url: User homepage link ### Return: - User sec_user_id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_webcast_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/get_webcast_idDouyin (web). ### Purpose: - Extract list webcast id ### Parameters: - url: Room link ### Return: - Room id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin handler_shorten_url
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/handler_shorten_urlHandler Shorten Url <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin handler_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/handler_user_profileDouyin (web). ### Purpose: - Get information of specified user ### Parameters: - sec_user_id: User sec_user_id ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin webcast_id_2_room_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/web/webcast_id_2_room_idDouyin (web). ### Purpose: - Webcast id to room id ### Parameters: - webcast_id: Webcast id ### Return: - Room id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin author_content_hot_comment_keywords
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/author_content_hot_comment_keywords_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Author Content Hot Comment Keywords V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - Author Content Hot Comment Keywords API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin author_hot_comment_tokens
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/author_hot_comment_tokens_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Author Hot Comment Tokens V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - Author Hot Comment Tokens API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_sign_image
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/get_sign_imageDouyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Parse encrypted XingTu image and get accessible image URL ### Parameters - uri: Image URI, usually obtained from other XingTu API responses - Example: `tos-cn-i-0813c000-ce/oMKzDA3A9QGAuebfsDIAwlDoAfCFEEzSEw8FQZ` - durationTS: Duration in seconds, default 86400 (24 hours) - format: Image format, default webp, supports: webp, jpg, png, etc. ### Return - Parsed image data with accessible image URL <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_sec_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_idDouyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu kolid by Douyin sec_user_id ### Parameters - sec_user_id: sec_user_id, can be obtained from the following interfaces: - `/tikhub/douyin/web/handler_user_profile` - `/tikhub/douyin/app/v3/handler_user_profile` ### Return - XingTu kolid API references: `handler_user_profile` = `GET /tikhub/douyin/app/v3/handler_user_profile` (operationId: `get_tikhub_douyin_app_v3_handler_user_profile`); `handler_user_profile` = `GET /tikhub/douyin/web/handler_user_profile` (operationId: `get_tikhub_douyin_web_handler_user_profile`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_uid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/get_xingtu_kolid_by_uidDouyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu kolid by Douyin User ID ### Parameters - uid: User ID, can be obtained from the following interfaces: - `/tikhub/douyin/web/fetch_user_profile_by_uid` - `/tikhub/douyin/web/fetch_user_profile_by_short_id` - `/tikhub/douyin/web/handler_user_profile` - `/tikhub/douyin/app/v3/handler_user_profile` ### Return - XingTu kolid API references: `fetch_user_profile_by_short_id` = `GET /tikhub/douyin/web/fetch_user_profile_by_short_id` (operationId: `get_tikhub_douyin_web_fetch_user_profile_by_short_id`); `fetch_user_profile_by_uid` = `GET /tikhub/douyin/web/fetch_user_profile_by_uid` (operationId: `get_tikhub_douyin_web_fetch_user_profile_by_uid`); `handler_user_profile` = `GET /tikhub/douyin/app/v3/handler_user_profile` (operationId: `get_tikhub_douyin_app_v3_handler_user_profile`); `handler_user_profile` = `GET /tikhub/douyin/web/handler_user_profile` (operationId: `get_tikhub_douyin_web_handler_user_profile`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_unique_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_idDouyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu kolid by Douyin unique_id ### Parameters - unique_id: unique_id, can be obtained from the following interfaces: - `/tikhub/douyin/web/handler_user_profile` - `/tikhub/douyin/app/v3/handler_user_profile` ### Return - XingTu kolid API references: `handler_user_profile` = `GET /tikhub/douyin/app/v3/handler_user_profile` (operationId: `get_tikhub_douyin_app_v3_handler_user_profile`); `handler_user_profile` = `GET /tikhub/douyin/web/handler_user_profile` (operationId: `get_tikhub_douyin_web_handler_user_profile`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_audience_portrait
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_audience_portrait_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Audience Portrait V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Audience Portrait API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_base_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_base_info_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Base Info V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - platformChannel: - Platform channel, supports the following parameters: - _1 :Douyin Video - _10 :Douyin Live ### Return - kol Base Info API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_conversion_ability_analysis
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_conversion_ability_analysis_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Conversion Ability Analysis V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - _range: Time range, supports the following parameters: - _1 :Last 7 days - _2 :Last 30 days - _3 :Last 90 days ### Return - kol Conversion Ability Analysis API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_convert_video_display
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_convert_video_display_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Convert Video Display V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - detailType: Detail type, supports the following parameters: - _1 :Video Data - _2 :Product Data - page: Page number, starting from 1 ### Return - kol Convert Video Display API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_cp_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_cp_info_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Cp Info V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Cp Info API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_daily_fans
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_daily_fans_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Daily Fans V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - startDate: Start date, format: yyyy-MM-dd - endDate: End date, format: yyyy-MM-dd ### Return - kol Daily Fans API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_data_overview
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_data_overview_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Data Overview V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - _type: Type, supports the following parameters: - _1 :Personal Video - _2 :Xingtu Video - _range: Range, supports the following parameters: - _2 :Last 30 days - _3 :Last 90 days - flowType: Flow Type, supports the following parameters: - 1 : Default - onlyAssign (optional): Whether assigned, the specific parameters are as follows: - Not provided : Use API default behavior - false : All data - true : Only assigned data ### Return - kol Data Overview API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_fans_portrait
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_fans_portrait_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Fans Portrait V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - fansType: Fans Type, supports the following parameters: - _1: Fans Portrait - Default - _2: Fans Group Portrait - _5: Iron Fans Portrait ### Return - kol Fans Portrait API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_link_struct
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_link_struct_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Link Struct V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Link Struct API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_rec_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_rec_videos_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Rec Videos V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Rec Videos API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_service_price
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_service_price_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Service Price V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - platformChannel: - Platform channel, supports the following parameters: - _1: Douyin Video - _10: Douyin Live ### Return - kol Service Price API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_touch_distribution
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_touch_distribution_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Touch Distribution V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Touch Distribution API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_video_performance
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_video_performance_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Video Performance V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` - onlyAssign: Whether to display only assigned works, the specific parameters are as follows: - false : Show all, including personal works and assigned works, default value. - true : Only display assigned works from XingTu. ### Return - kol Video Performance API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin kol_xingtu_index
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/kol_xingtu_index_v1Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get kol Xingtu Index V1 - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - kolId: User kolId, can be obtained from the following interfaces: - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` - `/tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` ### Return - kol Xingtu Index API references: `get_xingtu_kolid_by_sec_user_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_sec_user_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_sec_user_id`); `get_xingtu_kolid_by_uid` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_uid` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_uid`); `get_xingtu_kolid_by_unique_id` = `GET /tikhub/douyin/xingtu/get_xingtu_kolid_by_unique_id` (operationId: `get_tikhub_douyin_xingtu_get_xingtu_kolid_by_unique_id`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_kol
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu/search_kol_v2Douyin (xingtu). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Advanced Search Kol V2, supports follower range and content tag filtering - The interface data is requested using an enterprise account, which is more expensive. ### Parameters - keyword: Keyword - followerRange (optional): Follower range, format: min-max - Example: 10-100 indicates follower range between 100,000 and 1,000,000 - Do not pass this parameter to not limit the follower range - contentTag (optional): Content tag, supports the following formats: - tag-{id}: First-level tag, e.g., tag-1 (Beauty) - tag_level_two-{id}: Second-level tag, e.g., tag_level_two-7 (Outfit) - Refer to the contentTag mapping table in the documentation - Do not pass this parameter to not limit content tags ### Return - Kol List (with advanced filtering) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_audience_distribution
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_audience_distributionDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator audience profile distribution ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - link_type: Audience profile link type, required; example: `5`. Omitting it prevents valid profile data from being returned ### Return - Audience distribution data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_base_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_base_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author base information ### Parameters - o_author_id: Creator/author ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - recommend: Whether to return recommendation info, default True - need_sec_uid: Whether to return sec_uid, default True - need_linkage_info: Whether to return linkage info, default True ### Return - Creator base info data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_business_card_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_business_card_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author business card information ### Parameters - o_author_id: Creator/author ID ### Return - Creator business card info data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_commerce_spread_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_commerce_spread_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get cost-effectiveness and performance estimates for a creator's short-video collaborations, including CPM and CPE - Supports evaluation of content performance with marketing traffic excluded ### Parameters - o_author_id: Creator ID ### Return - Product-placement video: `cpm_20_60`, `cpe_20_60` - Custom video: `cpm_60`, `cpe_60` - Other estimated commerce-spread performance data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_content_hot_keywords
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_content_hot_keywordsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author content hot keywords ### Parameters - author_id: Creator/author ID - keyword_type: Keyword type, default 0 ### Return - Creator content hot keywords data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_convert_ability
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_convert_abilityDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator conversion ability data (GMV, clicks, conversion-rate ranges) ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - industry_id: Industry ID, 0=unlimited, default 0 - time_range: Time range tier, default 2 ### Return - Conversion ability data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_convert_videos_or_products
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_convert_videos_or_productsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator conversion video/product details, with pagination ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - detail_type: Detail type, 1=videos, 2=products, default 1 - industry_id: Industry ID, 0=unlimited, default 0 - time_range: Time range tier, default 2 - page: Page number, default 1 ### Return - Conversion video/product detail data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_cp_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_cp_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator CP (cooperation) info ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 ### Return - CP cooperation info data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_daily_fans
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_daily_fansDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator daily fans trend, with optional date range ### Parameters - author_id: Creator ID - platform_source: Platform source, default 1 - start_date: Start date, format YYYYMMDD, optional - end_date: End date, format YYYYMMDD, optional - author_type: Author type, optional ### Return - Daily fans trend data (daily / delta, etc.) <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_daily_link
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_daily_linkDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's daily link-metric trend over a date range ### Required - o_author_id, link_type, start_date, end_date ### Return - Daily link-metric trend data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_daily_link_score
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_daily_link_scoreDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's daily link-score trend over a date range ### Required - o_author_id, link_score_type, start_date, end_date ### Return - Daily link-score trend data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_fans_distribution
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_fans_distributionDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator fans profile distribution (gender, age, region, interests, etc.) ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 ### Return - Fans distribution data (distributions: multi-dimension distribution array) <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_homepage_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_homepage_videosDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator homepage video list with pagination, including interaction rate, finish rate and content theme labels per item - Can filter by star(sponsored) items and publish time range - Differs from `get_author_show_items`: paginated and filterable, returns total count ### Parameters - o_author_id: Creator ID - page: Page number, default 1 - is_star_item: 1=star items only, 0=non-star only, omit=all - start_time: Publish start time, unix seconds, optional - end_time: Publish end time, unix seconds, optional ### Return - Video list data (items + pagination with total_count / has_more) API references: `get_author_show_items` = `GET /tikhub/douyin/xingtu_v2/get_author_show_items` (operationId: `get_tikhub_douyin_xingtu_v2_get_author_show_items`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_hot_comment_tokens
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_hot_comment_tokensDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author hot comment tokens/keywords ### Parameters - author_id: Creator/author ID - num: Number of hot tokens, default 10 - without_emoji: Whether to exclude emoji, default True ### Return - Creator hot comment tokens data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_link_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_link_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator Xingtu link indices (cooperation / CP / conversion / shopping index) ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - industy_tag: Industry tag, 0=unlimited, default 0 ### Return - Link index data (cooperate_index / cp_index / link_convert_index / link_shopping_index) <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_local_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_local_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author location information ### Parameters - o_author_id: Creator/author ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - time_range: Time range in days, default 30 ### Return - Creator location info data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_market_fields
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_market_fieldsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get all filter field options for the creator marketplace ### Parameters - market_scene: Market scene, 1=default ### Return - Creator marketplace filter fields data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_rec_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_rec_videos_v2Douyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's recommended videos for representative content and recent performance ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 ### Return - Recommended video list and related performance data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_show_items
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_show_itemsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author video list ### Parameters - o_author_id: Creator/author ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - only_assign: Only show assigned videos (only for XingTu videos), default False - flow_type: Flow type, default 0 ### Return - Creator video list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_spread_info
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_spread_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator/author spread value information (commercial capability) ### Parameters - o_author_id: Creator/author ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 - type: Video type, 1=personal video - flow_type: Flow type, default 0 - only_assign: Only assigned videos, default False - range: Time range, 2=last 30 days, 3=last 90 days ### Return - Creator spread value data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_spread_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_spread_videosDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get representative videos for evaluating a creator's content-spread performance ### Return - Creator spread-video data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_touch_distribution
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_touch_distributionDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get creator video touch (reach) distribution data ### Parameters - o_author_id: Creator ID - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 ### Return - Video touch distribution data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_author_video_distribution
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_author_video_distributionDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's video-content distribution ### Parameters - o_author_id: Creator ID - platform_source: Platform source, 1 for Douyin - platform_channel: Platform channel, 1 for short video ### Return - Creator video-content distribution data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_content_trend_guide
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_content_trend_guideDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get content trend guide data (CDN static JSON, no cookie needed) ### Return - Content trend guide data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_demander_mcn_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_demander_mcn_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search MCN organization list ### Parameters - mcn_name: MCN name, supports fuzzy search - page: Page number, default 1 - order_by: Sort by, `platform_scores`=platform scores ### Return - MCN organization list data <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_excellent_case_category_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_excellent_case_category_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the excellent case category list in the user connection funnel ### Parameters - platform_source: Platform source, default 1 ### Return - Excellent case category list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_ip_activity_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_ip_activity_detailDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu IP calendar activity detail ### Parameters - id: Activity ID, from `get_ip_activity_list` ### Return - IP activity detail data API references: `get_ip_activity_list` = `POST /tikhub/douyin/xingtu_v2/get_ip_activity_list` (operationId: `post_tikhub_douyin_xingtu_v2_get_ip_activity_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_ip_activity_industry_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_ip_activity_industry_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the industry list for XingTu IP calendar ### Return - Industry list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_ip_activity_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_ip_activity_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu IP calendar activity list ### Parameters - query_start_time: Query start timestamp, e.g. `1767196800` - query_end_time: Query end timestamp, e.g. `1774972799` - industry_id_list (optional): Industry ID list from `get_ip_activity_industry_list` - Example: `["1930"]`=Beauty, `["1901"]`=3C & Electronics, `["1903"]`=Food & Beverage - category_list (optional): IP category list - 1=XingTu Big Event, 2=E-commerce Node, 3=Emotion Node, 4=Creative Marketing, 5=Industry Activity - status_list (optional): IP status list - 40=Preparing, 50=Recruiting, 30=Resources Online, 20=Ended ### Return - IP calendar activity list data API references: `get_ip_activity_industry_list` = `GET /tikhub/douyin/xingtu_v2/get_ip_activity_industry_list` (operationId: `get_tikhub_douyin_xingtu_v2_get_ip_activity_industry_list`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_item_play_count
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_item_play_countDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get play count (watch_cnt) and full details of a single video (item); play count is surfaced at the top level for convenience - Note: watch_cnt is the total play count INCLUDING paid promotion (ad boost), returned with video details; for organic (non-promoted) play count, use Douyin App V3 `/tikhub/douyin/app/v3/fetch_video_statistics` ### Parameters - item_id: Video (item) ID - platform_source: Platform source, default 1 - need_cover_url: Whether to return cover URL, default true ### Return - exist: Whether the video exists (false if deleted / invalid ID) - watch_cnt: Play count (int), null if unavailable - stats: Full stats block (like/comment/share/favorite/interaction rate/avg watch duration) - item: Full video details (title/cover/duration/create time/author ID, etc.) API references: `fetch_video_statistics` = `GET /tikhub/douyin/app/v3/fetch_video_statistics` (operationId: `get_tikhub_douyin_app_v3_fetch_video_statistics`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_item_report_comments
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_item_report_commentsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get comment analysis for a video ### Parameters - item_id: Video (item) ID ### Return - Video comment analysis data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_item_report_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_item_report_detailDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a video's detail report and core performance metrics ### Parameters - item_id: Video (item) ID ### Return - Video information and detail-report data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_item_report_th_analysis
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_item_report_th_analysisDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get interaction analysis for a video ### Parameters - item_id: Video (item) ID ### Return - Video interaction analysis data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_item_report_trend
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_item_report_trendDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get overall performance and trend data for a video ### Parameters - item_id: Video (item) ID ### Return - Video performance trend data <!-- aisa-pricing:start --> Published reference price: $0.003 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_playlet_actor_rank_catalog
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_playlet_actor_rank_catalogDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu playlet actor ranking catalog ### Return - Playlet actor ranking catalog data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_playlet_actor_rank_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_playlet_actor_rank_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu playlet actor ranking list data ### Parameters - category: Category, default `playlet_actor_list` - name: Ranking name, `playlet_actor_composite_list`=composite list - qualifier: Actor type, empty=all - period: 7=weekly, 30=monthly - date: Date, format YYYYMMDD ### Return - Playlet actor ranking data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_ranking_list_catalog
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_ranking_list_catalogDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu hot ranking list catalog, returns qualifier_id and other category information ### Parameters - codes: Classification codes, default is empty string - biz_scene: Business scene - `douyin_flow_split_video_author_ranks`: Video creator ranking - `douyin_flow_split_live_author_ranks`: Live streamer ranking ### Return - Hot ranking catalog data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_ranking_list_data
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_ranking_list_dataDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get XingTu creator business ranking list data - qualifier can be obtained from `get_ranking_list_catalog` API ### Parameters - code: Ranking type code - Video business ranking: 1=Brand Premium, 2=A3 Seeding, 3=Search After Watch, 4=E-commerce, 5=Ad Flow, 6=High Potential - Video content ranking: 17=Follower Growth Dark Horse, 18=Top Must-Pick - Live streamer type: 23=Game Streamer, 30=Other Streamer, 37=E-commerce Streamer (version=base) - Live ranking type: 23=Game Brand Premium, 24=Non-game Brand Premium, 25=Component Click, 26=Download Conversion, 27=Lead Collection, 28=Ad Flow, 29=High Potential - qualifier: Category qualifier_id from `get_ranking_list_catalog` - version: `flow_split`=default for video rankings, `base`=commonly used for live rankings - period: 7=weekly, 30=monthly - date: Date, format YYYYMMDD ### Return - Creator business ranking data API references: `get_ranking_list_catalog` = `GET /tikhub/douyin/xingtu_v2/get_ranking_list_catalog` (operationId: `get_tikhub_douyin_xingtu_v2_get_ranking_list_catalog`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_recommend_for_star_authors
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_recommend_for_star_authorsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get similar creator recommendation ### Parameters - author_ids: List of creator/author IDs - similar_type: Similarity type - `comprehension`: Comprehensive similarity - `content`: Content similarity - `audience`: Audience similarity - `commercial`: Commercial capability similarity - page: Page number, default 1 ### Return - Similar creator recommendation data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_resource_list
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_resource_listDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get marketing activity resource list ### Parameters - resource_id: Resource ID ### Return - Marketing activity resource data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_search_field_options
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_search_field_optionsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get filter option values that vary by cooperation type (task_category), such as fans/audience crowd profiles for the creator marketplace - Complements get_author_market_fields (age/gender/region/device); the two together form the complete set of options ### Parameters - platform_source: Platform source, 1=Douyin, 2=Toutiao - task_category: Task category, 1=Douyin video, 6=Douyin live, 11=Toutiao article ### Return - service_options: a map of field name to option list; each value is a JSON string and needs to be parsed by the caller API references: `get_author_market_fields` = `GET /tikhub/douyin/xingtu_v2/get_author_market_fields` (operationId: `get_tikhub_douyin_xingtu_v2_get_author_market_fields`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_user_profile_qrcode
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_user_profile_qrcodeDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Generate user profile QR code - Either core_user_id or sec_uid is required ### Parameters - core_user_id: User core ID (pick one with sec_uid) - sec_uid: User sec_uid (pick one with core_user_id) ### Return - User profile QR code data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_sec_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_sec_user_idDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Xingtu author ID by Douyin sec_user_id ### Parameters - sec_user_id: Douyin user sec_user_id, obtainable from Douyin user-profile endpoints ### Return - Xingtu author ID data; returns exist=false if the user does not exist or has not joined Xingtu <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_uid
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_uidDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Xingtu author ID by Douyin user ID (uid) - The returned Xingtu author ID is the o_author_id required by other creator endpoints ### Parameters - uid: Douyin user ID, obtainable from Douyin user-profile endpoints ### Return - Xingtu author ID data; returns exist=false if the user does not exist or has not joined Xingtu <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin get_xingtu_kolid_by_unique_id
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/get_xingtu_kolid_by_unique_idDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Xingtu author ID by Douyin unique_id ### Parameters - unique_id: Douyin unique_id ### Return - Xingtu author ID data; returns exist=false if the user does not exist or has not joined Xingtu <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin multi_get_author_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/multi_get_author_infoDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get info for multiple creators in one call, saving request quota ### Parameters - author_ids: Creator ID list, up to 50 per call (exceeding returns an error) - platform_source: Platform source, default 1 - platform_channel: Platform channel, default 1 ### Return - Creator info data (authors: matched creators, not_exist_author_ids: unknown IDs) <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin multi_get_item_stats
$MeteredPOST https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/multi_get_item_statsDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Batch get play count and details for multiple videos (items), up to 20 per call - Each item has stats (watch_cnt/like_cnt/comment_cnt/share_cnt/favorite_cnt/ interact_rate/avg_watch_dura) and video details - Note: watch_cnt is the total play count INCLUDING paid promotion (ad boost), with video details; for organic (non-promoted) play count, use Douyin App V3 `/tikhub/douyin/app/v3/fetch_multi_video_statistics` - Upstream bills as 20 regardless (fewer than 20 still counts as 20); fill 20 for best value ### Parameters - item_ids: Video (item) ID list, up to 20 per call (exceeding returns an error); auto de-dup - platform_source: Platform source, default 1 - need_cover_url: Whether to return cover URL, default true ### Return - items: Matched video list, each with stats and video details (invalid/deleted IDs are dropped upstream) API references: `fetch_multi_video_statistics` = `GET /tikhub/douyin/app/v3/fetch_multi_video_statistics` (operationId: `get_tikhub_douyin_app_v3_fetch_multi_video_statistics`). <!-- aisa-pricing:start --> Published reference price: $0.04 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_anchor
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/search_anchorDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search Douyin live-stream anchors in the live marketplace by keyword, with full filtering ### Parameters - keyword: Search keyword: nickname, Douyin ID, Xingtu ID or live content word - page: Page number, default 1 - sort_field: Sort field, default `score` (comprehensive sort) - sort_type: Sort type, 1=asc, 2=desc, default 2 - Cooperation: task_category, marketing_target, first_industry_id - Match: tag (category), persona_tags, gender, fans_min/fans_max - Cost-performance: expected_play_min/max, cpm_min/max, cpe_min/max, interact_rate_min/max, play_over_rate_min/max, burst_text_rate_min/max - Price: price_type is fixed to `9` for live-stream pricing; price_min/price_max define the anchor-price range and require price_type when either bound is supplied - Featured: author_list_id - Profile filters `extra_filter`: for audience/fans profile, region, connected-users, etc. Pass a JSON-array string; each element is `{"field_name":"...","field_value":"..."}` (optional `rel_id`), Common fields: - Audience gender: `watcher_gender_female_rate_v2__ge` (female-ratio threshold 0.5/0.6/0.7/0.8), male uses `watcher_gender_male_rate_v2__ge` - Audience age: `watcher_age_most_new` (dominant audience age, encoded array, e.g. `[22]`=24-30) Example: `extra_filter=[{"field_name":"watcher_gender_female_rate_v2__ge","field_value":"0.5"}]` - Note: valid IDs for tag/persona_tags come from `get_author_market_fields`; dynamic profile fields and codes come from `get_search_field_options`; rate params are 0-1 decimals (0.02=2%) ### Return - Anchor search result data (anchor info, live price, ACU/PCU, avg viewers, etc.) API references: `get_author_market_fields` = `GET /tikhub/douyin/xingtu_v2/get_author_market_fields` (operationId: `get_tikhub_douyin_xingtu_v2_get_author_market_fields`); `get_search_field_options` = `GET /tikhub/douyin/xingtu_v2/get_search_field_options` (operationId: `get_tikhub_douyin_xingtu_v2_get_search_field_options`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_creator
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/search_creatorDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search or filter Douyin short-video creators with keyword, cooperation, creator profile, performance, price, content-theme, and audience-profile filters. - `keyword` may be empty for filter-only browsing. ### Basic search parameters - `keyword`: Optional search term; nickname text for `seach_type=2`, content text for `seach_type=3`. Leave empty to use filters only. - `seach_type`: `2`=nickname (default), `3`=content. - `time_range_days`: Content range of `30`, `90`, or `180` days; only applies to content search. - `page`: Page number starting from 1. - `sort_field`: Sort field; default `score`. - `sort_type`: `1`=ascending, `2`=descending. ### Cooperation and match parameters - `task_category`: Cooperation target or task category. - `marketing_target`: Marketing objective. - `first_industry_id`: First-level industry ID; `0` means unrestricted. - `author_list_id`: Featured creator-list ID. - `tag`: Creator-category IDs, comma-separated. - `persona_tags`: Persona/education/certification/style IDs. Commas mean OR within a group; semicolons separate groups that must all match. - `gender`: Creator gender, `1`=male, `2`=female. - `fans_min` / `fans_max`: Follower-count range. ### Performance and price parameters - `expected_play_min` / `expected_play_max`: Expected-play range. - `cpm_min` / `cpm_max`: Expected cost-per-thousand-play range. - `cpe_min` / `cpe_max`: Expected cost-per-engagement range. - `interact_rate_min` / `interact_rate_max`: Interaction-rate range as 0-1 decimals. - `play_over_rate_min` / `play_over_rate_max`: Completion-rate range as 0-1 decimals. - `burst_text_rate_min` / `burst_text_rate_max`: Viral-post-rate range as 0-1 decimals. - `price_type`: Video-length price tier: `1`=1-20s, `2`=21-60s, `3`=over 60s. - `price_min` / `price_max`: Creator-price range. `price_type` is required when either bound is supplied. Omitting both bounds disables price filtering. ### Extended profile filters - `extra_filter`: JSON-array string for content themes, audience/fan profiles, crowd segments, region, and other dynamic filters. Every item requires non-empty string `field_name` and `field_value`. - Common fields: `content_theme_labels_180d`, `watcher_gender_female_rate_v2__ge`, `watcher_gender_male_rate_v2__ge`, `watcher_age_most_new`, and `link_crowd_profile`. - Use `get_author_market_fields` for creator-field IDs and `get_search_field_options` for dynamic profile fields and codes. ### Return - Creator results, pagination information, and related metrics. ### Example 1: nickname search keyword = "airplane" seach_type = 2 ### Example 2: content search keyword = "airplane" seach_type = 3 time_range_days = 180 ### Example 3: filter-only search keyword = "" seach_type = 3 time_range_days = 180 page = 1 sort_field = "score" sort_type = 2 task_category = 1 marketing_target = 1 first_industry_id = 0 tag = "36" gender = 2 fans_min = 100000 fans_max = 200000 extra_filter = '[{"field_name":"content_theme_labels_180d","field_value":"[\"生活好物评测\"]"},{"field_name":"watcher_gender_female_rate_v2__ge","field_value":"0.6"},{"field_name":"link_crowd_profile","field_value":"[60,55,53,57]"}]' Copy content-theme labels in extra_filter verbatim from the filter options; Chinese labels are required wire values. API references: `get_author_market_fields` = `GET /tikhub/douyin/xingtu_v2/get_author_market_fields` (operationId: `get_tikhub_douyin_xingtu_v2_get_author_market_fields`); `get_search_field_options` = `GET /tikhub/douyin/xingtu_v2/get_search_field_options` (operationId: `get_tikhub_douyin_xingtu_v2_get_search_field_options`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
douyin search_toutiao_creator
$MeteredGET https://aisa.one/apis/v1/tikhub/douyin/xingtu_v2/search_toutiao_creatorDouyin (xingtu_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search Toutiao image-text creators in the image-text marketplace by keyword, with full filtering ### Parameters - keyword: Search keyword: nickname, Toutiao ID or content word - page: Page number, default 1 - sort_field: Sort field, default `score` (comprehensive sort) - sort_type: Sort type, 1=asc, 2=desc, default 2 - Cooperation: task_category, marketing_target, first_industry_id - Match: tag (category), persona_tags, gender, fans_min/fans_max - Cost-performance: expected_play_min/max, cpm_min/max, cpe_min/max, interact_rate_min/max, play_over_rate_min/max, burst_text_rate_min/max - Price: price_type is fixed to `11` for Toutiao image-text pricing; price_min/price_max define the price range and require price_type when either bound is supplied - Featured: author_list_id - Profile filters `extra_filter`: for audience/fans profile, region, connected-users, etc. Pass a JSON-array string; each element is `{"field_name":"...","field_value":"..."}` (optional `rel_id`), Common fields: - Audience gender: `watcher_gender_female_rate_v2__ge` (female-ratio threshold 0.5/0.6/0.7/0.8), male uses `watcher_gender_male_rate_v2__ge` - Audience age: `watcher_age_most_new` (dominant audience age, encoded array, e.g. `[22]`=24-30) Example: `extra_filter=[{"field_name":"watcher_gender_female_rate_v2__ge","field_value":"0.5"}]` - Note: valid IDs for tag/persona_tags come from `get_author_market_fields`; dynamic profile fields and codes come from `get_search_field_options`; rate params are 0-1 decimals (0.02=2%) ### Return - Toutiao creator search result data (creator info, price, followers, expected reads, etc.) API references: `get_author_market_fields` = `GET /tikhub/douyin/xingtu_v2/get_author_market_fields` (operationId: `get_tikhub_douyin_xingtu_v2_get_author_market_fields`); `get_search_field_options` = `GET /tikhub/douyin/xingtu_v2/get_search_field_options` (operationId: `get_tikhub_douyin_xingtu_v2_get_search_field_options`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
hybrid video_data
$MeteredGET https://aisa.one/apis/v1/tikhub/hybrid/video_dataDouyin / TikTok. ### Purpose: - This endpoint is used to parse data of a single Douyin/TikTok video. ### Parameters: - `url`: Video link, share link, or share text. ### Returns: - `data`: Video data. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_cities
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_citiesInstagram (v1). ### Purpose - Get cities/regions list of specified country ### Parameters - country_code: Country code, e.g. US, CN, JP - page: Page number, default 1 ### Return - `country_info`: Country info - `city_list`: Cities list - `next_page`: Next page number <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_explore_sections
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_explore_sectionsInstagram (v1). ### Purpose - Get all sections and subsections of Instagram explore page ### Return - `sections`: Sections list with names, subsections and recommended content <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_location_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_location_infoInstagram (v1). ### Purpose - Get detailed information of specified location ### Parameters - location_id: Location ID ### Return - `location_info`: Location info including name, address, coordinates etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_locations
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_locationsInstagram (v1). ### Purpose - Get Instagram locations list of specified city ### Parameters - city_id: City ID (from fetch_cities API) - page: Page number, default 1 ### Return - `country_info`: Country info - `city_info`: City info - `location_list`: Locations list - `next_page`: Next page number API references: `fetch_cities` = `GET /tikhub/instagram/v1/fetch_cities` (operationId: `get_tikhub_instagram_v1_fetch_cities`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_post_by_id
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_post_by_idInstagram (v1). ### Purpose - Get single post details by ID ### Parameters - post_id: Post ID ### Return - Post details object with media, likes, comments etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_post_by_url
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_post_by_urlInstagram (v1). ### Purpose - Get single post details by URL ### Parameters - post_url: Post URL ### Return - Post details object with media, likes, comments etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_related_profiles
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_related_profilesInstagram (v1). ### Purpose - Get related/similar user recommendations ### Parameters - user_id: Instagram user ID ### Return - GraphQL style response with `data.user.edge_related_profiles` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_search
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_searchInstagram (v1). ### Purpose - Search users, hashtags or places on Instagram ### Parameters - query: Search keyword - select: Filter type (optional) - `users`: Only return users - `hashtags`: Only return hashtags - `places`: Only return places - omit: Return all types ### Return - `users`: Users list - `hashtags`: Hashtags list - `places`: Places list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_section_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_section_postsInstagram (v1). ### Purpose - Get posts under specific explore section ### Parameters - section_id: Section ID (from fetch_explore_sections API) - count: Count per page, default 20 - max_id: Pagination cursor, omit for first request ### Return - `section_name`: Section name - `items`: Posts list - `subsections`: Subsections list - `max_id`: Next page cursor - `more_available`: Whether more data available API references: `fetch_explore_sections` = `GET /tikhub/instagram/v1/fetch_explore_sections` (operationId: `get_tikhub_instagram_v1_fetch_explore_sections`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_about_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_user_about_infoInstagram (v1). ### Purpose - Get user's "About This Account" information - Contains account creation date, location, verification status and more ### Parameters - user_id: Instagram user ID (numeric format) ### Return - `status`: Request status - `user_id`: User ID - `username`: Username - `profile_pic_url`: Profile picture URL - `is_verified`: Whether verified - `date_joined`: Account creation date (e.g., "June 2012") - `account_based_in`: Account location (e.g., "United States") - `verified_date`: Verification date (e.g., "August 2017", None if not verified) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_info_by_id
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_user_info_by_idInstagram (v1). ### Purpose - Get user data by Instagram user ID ### Parameters - user_id: Instagram user ID ### Return - User information object with timeline media, HD avatar and complete data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_info_by_username
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_user_info_by_usernameInstagram (v1). ### Purpose - Get user data by Instagram username ### Parameters - username: Instagram username ### Return - User information object with main fields: - `id`: User ID - `username`: Username - `full_name`: Full name - `biography`: Bio - `bio_links`: Bio links list - `edge_followed_by`: Followers count {count: xxx} - `edge_follow`: Following count {count: xxx} - `profile_pic_url`: Profile picture URL - `profile_pic_url_hd`: HD profile picture URL - `is_private`: Whether account is private - `is_verified`: Whether account is verified - `external_url`: External link - `is_business_account`: Whether business account - `is_professional_account`: Whether professional account - `highlight_reel_count`: Highlights count - `edge_owner_to_timeline_media`: Timeline media (contains recent posts) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_reposts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v1/fetch_user_repostsInstagram (v1). ### Purpose - Get user reposts/shares list with pagination ### Parameters - user_id: Instagram user ID - max_id: Pagination cursor, omit for first request ### Return - `items`: Reposts list - `more_available`: Whether more data available - `next_max_id`: Next page cursor <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_comment_repliesInstagram (v2). ### Purpose - Get list of replies to a comment - Need to get comment ID from fetch_post_comments first - Support pagination ### Parameters - code_or_url: Post shortcode or full URL - comment_id: Comment ID - pagination_token: Pagination token from previous response ### Return - `data.items`: List of replies - `pagination_token`: Next page token API references: `fetch_post_comments` = `GET /tikhub/instagram/v2/fetch_post_comments` (operationId: `get_tikhub_instagram_v2_fetch_post_comments`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_hashtag_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_hashtag_postsInstagram (v2). ### Purpose - Get posts under specified hashtag - Support filtering by top, recent, or reels only - Support pagination ### Parameters - keyword: Hashtag keyword (without #) - feed_type: Feed type "top", "recent", or "reels", default top - pagination_token: Pagination token from previous response ### Return - `data.items`: List of posts - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_highlight_stories
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_highlight_storiesInstagram (v2). ### Purpose - Get all stories in a specific highlight - Need to get highlight ID from fetch_user_highlights first ### Parameters - highlight_id: Highlight ID (with or without "highlight:" prefix) ### Return - `data.items`: List of stories with image/video URLs, publish time, etc. API references: `fetch_user_highlights` = `GET /tikhub/instagram/v2/fetch_user_highlights` (operationId: `get_tikhub_instagram_v2_fetch_user_highlights`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_location_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_location_postsInstagram (v2). ### Purpose - Get posts at specified location - Location ID can be obtained from search_locations - Support pagination ### Parameters - location_id: Location ID - pagination_token: Pagination token from previous response ### Return - `data.items`: List of posts - `pagination_token`: Next page token API references: `search_locations` = `GET /tikhub/instagram/v2/search_locations` (operationId: `get_tikhub_instagram_v2_search_locations`). <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_music_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_music_postsInstagram (v2). ### Purpose - Get posts using specified music - Audio ID can be obtained from post details - Support pagination ### Parameters - audio_canonical_id: Audio ID - pagination_token: Pagination token from previous response ### Return - `data.items`: List of posts - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_post_commentsInstagram (v2). ### Purpose - Get list of comments on the post - Support sorting by recent or popular - Support pagination ### Parameters - code_or_url: Post shortcode or full URL - sort_by: Sort by "recent" or "popular", default recent - pagination_token: Pagination token from previous response ### Return - `data.items`: List of comments - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_post_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_post_infoInstagram (v2). ### Purpose - Get detailed information of Instagram post - Support shortcode or full URL ### Parameters - code_or_url: Post shortcode or full URL ### Return - `data`: Post details including media, caption, likes, comments, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_post_likes
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_post_likesInstagram (v2). ### Purpose - Get list of users who liked the post - Support pagination ### Parameters - code_or_url: Post shortcode or full URL - end_cursor: Pagination cursor from previous response ### Return - `data.items`: List of users who liked - `end_cursor`: Next page cursor <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_similar_users
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_similar_usersInstagram (v2). ### Purpose - Get recommended similar users - Based on Instagram's recommendation algorithm ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) ### Return - `data.items`: List of similar users <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_followersInstagram (v2). ### Purpose - Get list of followers of Instagram user - Support pagination ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) - pagination_token: Pagination token from previous response ### Return - `data.items`: List of followers - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_following
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_followingInstagram (v2). ### Purpose - Get list of users that Instagram user is following - Support pagination ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) - pagination_token: Pagination token from previous response ### Return - `data.items`: List of following - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_highlights
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_highlightsInstagram (v2). ### Purpose - Get Instagram user's highlights list - Highlights are saved story collections ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) ### Return - `data.items`: List of highlights with ID, title, cover, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_infoInstagram (v2). ### Purpose - Get detailed Instagram user information - Support query by username or user ID ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) ### Return - `data`: User info including username, avatar, bio, followers, following, posts count, etc. - This endpoint returns user's about info including country, join date, verification status, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_postsInstagram (v2). ### Purpose - Get list of posts published by Instagram user - Support pagination ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) - pagination_token: Pagination token from previous response ### Return - `data.items`: List of posts - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_reels
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_reelsInstagram (v2). ### Purpose - Get list of Reels published by Instagram user - Support pagination ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) - pagination_token: Pagination token from previous response ### Return - `data.items`: List of reels - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_stories
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_storiesInstagram (v2). ### Purpose - Get current stories published by Instagram user - Stories expire after 24 hours ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) ### Return - `data.items`: List of stories with image/video URLs, publish time, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram fetch_user_tagged_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/fetch_user_tagged_postsInstagram (v2). ### Purpose - Get posts where the user is tagged by others - Support pagination ### Parameters - username: Username (either username or user_id required) - user_id: User ID (either username or user_id required) - pagination_token: Pagination token from previous response ### Return - `data.items`: List of posts - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_locations
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/search_locationsInstagram (v2). ### Purpose - Search Instagram locations by keyword ### Parameters - keyword: Search keyword (location name, city, etc.) ### Return - `data.items`: List of locations with name, address, coordinates, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_music
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/search_musicInstagram (v2). ### Purpose - Search available music on Instagram by keyword ### Parameters - keyword: Search keyword ### Return - `data.items`: List of music with title, artist, duration, audio ID, etc. <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_reels
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v2/search_reelsInstagram (v2). ### Purpose - Search Instagram Reels by keyword - Support pagination ### Parameters - keyword: Search keyword - pagination_token: Pagination token from previous response ### Return - `data.items`: List of reels - `pagination_token`: Next page token <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram bulk_translate_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/bulk_translate_commentsInstagram (v3). ### Purpose - Bulk translate Instagram comments - Support translating multiple comments at once for better efficiency - Comment IDs can be obtained from get_post_comments API ### Parameters - comment_ids: Comment ID list, separated by commas, **max 10 IDs** - Example: `18099342953509681` (single) - Example: `18099342953509681,18099342953509682,18099342953509683` (multiple) ### Note - Maximum 10 comment IDs per request, exceeding will return an error ### Return - `data.comment_translations`: Translation result mapping - key: Comment ID - value: Translated text ### Example ``` comment_ids = "18099342953509681" # comment_ids = "18099342953509681,18099342953509682" ``` API references: `get_post_comments` = `GET /tikhub/instagram/v3/get_post_comments` (operationId: `get_tikhub_instagram_v3_get_post_comments`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram extract_shortcode
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/extract_shortcodeInstagram (v3). ### Purpose: - Extract shortcode from full Instagram post URL - Supports /p/, /reel/, /reels/, /tv/ URL formats <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram general_search
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/general_searchInstagram (v3). ### Purpose - Instagram general search API (with pagination) - Support pagination via next_max_id to fetch more search results - Returns blended results of users, hashtags, places, etc. ### Parameters - query: Search keyword - next_max_id: Pagination ID, omit for first request, get from previous response `data.next_max_id` - rank_token: Rank token, omit for first request, get from previous response `data.rank_token` - enable_metadata: Enable metadata ### Return - `data.num_results`: Number of results - `data.users`: User search results - `data.places`: Place search results - `data.hashtags`: Hashtag search results - `data.next_max_id`: Next page pagination ID (use as next_max_id in next request) - `data.rank_token`: Rank token (use as rank_token in next request) - `data.has_more`: Whether has more results ### Notes - ⚠️ **Known Issue**: General search results may contain duplicate data, this is a known behavior of Instagram API - When searching for hashtags, `query` must include the `#` prefix, e.g., use `#fashion` to search for the fashion hashtag - The `#` character must be URL-encoded as `%23` in the URL, e.g., `?query=%23fashion` - If using an HTTP client library (e.g., requests/httpx), just pass `#fashion` directly and the library will handle encoding automatically ### Pagination usage 1. First request: Only pass `query` parameter 2. Get `next_max_id` and `rank_token` from response 3. Next request: Pass `query`, `next_max_id` and `rank_token` 4. Repeat steps 2-3 until `has_more` is false ### Example ``` query = "justin" ``` <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_comment_repliesInstagram (v3). ### Purpose - Get Instagram comment's child comments (replies) list - Support pagination to fetch all replies - Parent comment's comment_id can be obtained from get_post_comments API ### Parameters - media_id: Post media ID (numeric ID, required), can be obtained via `/tikhub/instagram/v3/shortcode_to_media_id` endpoint - comment_id: Parent comment ID (required, get `pk` field from get_post_comments response) - min_id: Pagination cursor, omit for first request, get from previous response `data.next_min_child_cursor` ### Return - `data.child_comments`: Child comments list - `user`: Commenter info - `text`: Comment text - `created_at`: Comment timestamp - `comment_like_count`: Comment likes count - `pk`: Comment ID - `data.next_min_child_cursor`: Next page cursor (use as min_id in next request) - `data.has_more_tail_child_comments`: Whether has more child comments - `data.num_tail_child_comments`: Remaining child comments count ### Pagination usage 1. First request: Pass `media_id` and `comment_id` parameters 2. Get `data.next_min_child_cursor` from response 3. Next request: Pass `next_min_child_cursor` as-is to `min_id` parameter (no pre-processing needed, the API handles unescaping automatically) 4. Repeat steps 2-3 until `data.has_more_tail_child_comments` is false ### Note - `min_id` may be an escaped JSON string (e.g. `{"key":"val"}`), just pass it as-is, the API handles unescaping internally ### Example media_id = "3829530490739515971" comment_id = "18065937092249736" API references: `get_post_comments` = `GET /tikhub/instagram/v3/get_post_comments` (operationId: `get_tikhub_instagram_v3_get_post_comments`); `shortcode_to_media_id` = `GET /tikhub/instagram/v3/shortcode_to_media_id` (operationId: `get_tikhub_instagram_v3_shortcode_to_media_id`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_explore
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_exploreInstagram (v3). ### Purpose - Get Instagram Explore/Discover page recommended posts - Returns personalized recommended post list - Support pagination to fetch more recommendations ### Parameters - max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id` ### Return - `data.sectional_items`: Recommended content section list - `layout_content.medias`: Media list - `media.id`: Post ID - `media.code`: Post shortcode - `media.media_type`: Media type (1=image, 2=video, 8=carousel) - `media.like_count`: Likes count - `media.comment_count`: Comments count - `media.caption.text`: Post caption text - `media.user`: Publisher info - `media.image_versions2`: Image version list - `media.video_versions`: Video version list (exists for videos) - `data.next_max_id`: Next page cursor (use as max_id in next request) - `data.more_available`: Whether has more content ### Pagination usage 1. First request: No parameters needed 2. Get `data.next_max_id` from response 3. Next request: Pass `max_id` (use next_max_id from previous) 4. Repeat steps 2-3 until `data.more_available` is false ### Example ``` # First page (no parameters) # Second page # max_id = "..." # Get from the first-page response ``` <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_hashtag_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_hashtag_postsInstagram (v3). ### Purpose - Get posts under a hashtag, with pagination ### Parameters - tag: Hashtag keyword (without #) - max_id: Pagination cursor from previous response, omit for first request ### Return - `data`: Hashtag posts list with pagination cursor ### Example tag = "cat" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_highlight_stories
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_highlight_storiesInstagram (v3). ### Purpose - Get Instagram Highlight's detailed story/post content - Returns all Stories media in the highlight collection ### Parameters - highlight_id: Highlight ID, format `highlight:xxx` (get from get_user_highlights API) - reel_ids: Highlight ID list, comma separated (optional, if not provided only queries the highlight_id) - Example: `highlight:18064916456320419,highlight:18155682898389765` - Can query multiple highlights at once - first: Items per page (default 3) - last: Get last N items (default 2) ### Return - `data.story_highlight_tray`: Highlight story collection - `id`: Highlight ID - `title`: Highlight title - `items`: Story list - `id`: Story ID - `pk`: Story PK - `taken_at`: Published timestamp - `media_type`: Media type (1=image, 2=video) - `image_versions2`: Image version list - `video_versions`: Video version list (exists for videos) - `user`: Publisher info ### Example ``` highlight_id = "highlight:18064916456320419" # reel_ids = "highlight:18064916456320419,highlight:18155682898389765" ``` API references: `get_user_highlights` = `GET /tikhub/instagram/v3/get_user_highlights` (operationId: `get_tikhub_instagram_v3_get_user_highlights`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_location_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_location_infoInstagram (v3). ### Purpose - Get Instagram location/place detail info - Including name, address, coordinates, nearby places, etc. - Location ID can be obtained from search API (search_places) or post details ### Parameters - location_id: Location ID (numeric) - show_nearby: Whether to show nearby places (default true) ### Return - `data.native_location_data`: Location basic info - `name`: Location name - `address`: Address - `city`: City - `lat`: Latitude - `lng`: Longitude - `website`: Website - `phone`: Phone - `category`: Category - `media_count`: Associated posts count - `data.ranked`: Top posts info - `data.recent`: Recent posts info - `data.nearby_locations`: Nearby locations list (when show_nearby=true) ### Example location_id = "1016248898" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_location_nearby
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_location_nearbyInstagram (v3). ### Purpose - Get nearby local content aggregation for a location, including nearby places and popular posts - Useful for discovering related content in a geographic area ### Parameters - location_id: Location ID, from post data `location.id` <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_location_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_location_postsInstagram (v3). ### Purpose - Get Instagram location-related posts - Support sorting by top or latest - Location ID can be obtained from search API (search_places) or post details ### Parameters - location_id: Location ID (numeric) - tab: Post sort order - `ranked`: Top posts (default) - `recent`: Latest posts - first: Posts per page (default 12, max 50) - after: Pagination cursor from previous response `page_info.end_cursor` - page_size_override: Posts per page (default 12) ### Return - `data.sections`: Post section list - `layout_content.medias`: Media list - `media.id`: Post ID - `media.code`: Post shortcode - `media.media_type`: Media type (1=image, 2=video, 8=carousel) - `media.like_count`: Likes count - `media.comment_count`: Comments count - `media.caption.text`: Post caption text - `media.user`: Publisher info - `data.next_max_id`: Next page cursor - `data.next_page`: Next page info - `data.more_available`: Whether has more content ### Example location_id = "1016248898" tab = "ranked" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_music_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_music_postsInstagram (v3). ### Purpose - Get Reels using a specific audio (background music), with pagination ### Parameters - audio_cluster_id: Audio ID, obtainable from Reels audio field - max_id: Pagination cursor from previous response, omit for first request ### Return - `data`: Reels list using the audio with pagination cursor ### Example audio_cluster_id = "18066165960103621" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_post_commentsInstagram (v3). ### Purpose - Get Instagram post comment list - Support pagination to fetch all comments - Support sorting by popular or newest ### Parameters - code: Post shortcode (e.g., DUajw4YkorV, required) - min_id: Pagination cursor, omit for first request, get from previous response `data.next_min_id` - sort_order: Sort order - `popular`: Sort by popular (default) - `newest`: Sort by newest ### Return - `data.comments`: Comment list - `user`: Commenter info - `text`: Comment text - `created_at`: Comment timestamp - `comment_like_count`: Comment likes count - `child_comment_count`: Child comments count - `data.next_min_id`: Next page cursor (use as min_id in next request) - `data.has_more_comments`: Whether has more comments - `data.comment_count`: Total comment count ### Pagination usage 1. First request: Pass `code` parameter 2. Get `data.next_min_id` from response 3. Next request: Pass `next_min_id` as-is to `min_id` parameter (no pre-processing needed, the API handles unescaping automatically) 4. Repeat steps 2-3 until `data.has_more_comments` is false ### Note - `min_id` is an escaped JSON string returned by the API (e.g., `"{"cached_comments_cursor":"xxx","bifilter_token":"xxx"}"`), just pass it as-is, the API handles unescaping internally ### Example code = "DUajw4YkorV" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_post_info
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_post_infoInstagram (v3). ### Purpose - Get post details by media ID or post URL - Returns complete post info including images/videos, likes, comments, author info, etc. ### Parameters - media_id: Post media ID (numeric ID), can be obtained via `/tikhub/instagram/v3/shortcode_to_media_id` endpoint - url: Post URL, e.g. `https://www.instagram.com/p/DUajw4YkorV/`, supports `/p`, `/reel`, `/reels`, `/tv` paths - **At least one of media_id or url is required; media_id wins if both provided** ### Return - `data.items`: Post info list (usually only one element) - `id`: Post ID - `code`: Post shortcode - `media_type`: Media type (1=image, 2=video, 8=carousel) - `like_count`: Likes count - `comment_count`: Comments count - `caption.text`: Post caption text - `user`: Publisher info - `image_versions2`: Image version list - `video_versions`: Video version list (exists for videos) - `carousel_media`: Carousel media list (exists for carousels) - `taken_at`: Published timestamp ### Example ``` # by media_id media_id = "3850699893338385742" # by url url = "https://www.instagram.com/p/DUajw4YkorV/" ``` API references: `shortcode_to_media_id` = `GET /tikhub/instagram/v3/shortcode_to_media_id` (operationId: `get_tikhub_instagram_v3_shortcode_to_media_id`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_post_info_by_code
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_post_info_by_codeInstagram (v3). ### Purpose - Get post details by shortcode - Shortcode is the identifier in the post URL, e.g., `DUajw4YkorV` from `https://www.instagram.com/p/DUajw4YkorV/` - Returns complete post info ### Parameters - code: Post shortcode (e.g., DUajw4YkorV, required) ### Return - `data.items`: Post info list - `id`: Post ID - `code`: Post shortcode - `media_type`: Media type (1=image, 2=video, 8=carousel) - `like_count`: Likes count - `comment_count`: Comments count - `caption.text`: Post caption text - `user`: Publisher info - `image_versions2`: Image version list - `video_versions`: Video version list (exists for videos) - `carousel_media`: Carousel media list (exists for carousels) - `taken_at`: Published timestamp ### Example code = "DUajw4YkorV" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_post_likes
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_post_likesInstagram (v3). ### Purpose - Get list of users who liked an Instagram post ### Parameters - code: Post shortcode (from post URL, e.g. instagram.com/p/{code}/) ### Return - `data.users`: List of users who liked ### Note - Web likes list is returned in one shot, no pagination ### Example code = "DavSf9yS6wy" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_post_oembed
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_post_oembedInstagram (v3). ### Purpose - Get Instagram post oEmbed embed info - Returns HTML code for embedding and post metadata - Suitable for embedding Instagram posts on third-party websites ### Parameters - url: Full Instagram post URL (e.g., `https://www.instagram.com/p/xxx/` or `https://www.instagram.com/reel/xxx/`) - hidecaption: Whether to hide caption (default false) - maxwidth: Max embed width in pixels (default 540) ### Return - `data.version`: oEmbed version - `data.title`: Post title - `data.author_name`: Author name - `data.author_url`: Author profile URL - `data.author_id`: Author ID - `data.media_id`: Media ID - `data.provider_name`: Provider name (Instagram) - `data.provider_url`: Provider URL - `data.type`: Type (rich) - `data.width`: Width - `data.html`: HTML embed code - `data.thumbnail_url`: Thumbnail URL - `data.thumbnail_width`: Thumbnail width - `data.thumbnail_height`: Thumbnail height ### Example url = "https://www.instagram.com/reel/DUlObENDmJD" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_recommended_reels
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_recommended_reelsInstagram (v3). ### Purpose - Get Instagram Reels recommendation feed - Support pagination to fetch more Reels ### Parameters - first: Number of Reels to fetch per request (default 12, max 50) - after: Pagination cursor, omit for first request, get from previous response `data.page_info.end_cursor` ### Return - `data.edges`: Reels list - `node.media`: Reels media info - `code`: Post shortcode - `pk`: Post ID - `like_count`: Likes count - `comment_count`: Comments count - `play_count`: Play count - `caption.text`: Description text - `user`: Publisher info - `video_versions`: Video version list - `image_versions2`: Cover image version list - `data.page_info`: Pagination info - `has_next_page`: Whether has next page - `end_cursor`: Next page cursor (use as after parameter in next request) ### Pagination usage 1. First request: Only pass `first` parameter 2. Get `data.page_info.end_cursor` from response 3. Next request: Pass `first` and `after` (use end_cursor from previous) 4. Repeat steps 2-3 until `data.page_info.has_next_page` is false ### Example first = 12 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_similar_users
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_similar_usersInstagram (v3). ### Purpose - Get recommended accounts similar to the given user ### Parameters - user_id: Target user ID (numeric), obtainable via get_user_id_by_username ### Return - `data.users`: List of similar accounts ### Example user_id = "25025320" API references: `get_user_id_by_username` = `GET /tikhub/instagram/v3/get_user_id_by_username` (operationId: `get_tikhub_instagram_v3_get_user_id_by_username`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_about
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_aboutInstagram (v3). ### Purpose - Get Instagram user's About This Account information - Including account creation date, location, etc. ### Parameters - username: Instagram username (required) ### Return - Account creation date - Account location/country - Use `get_user_former_usernames` to query the username change count; individual former usernames and change dates are not provided - Other account related info ### Example username = "instagram" API references: `get_user_former_usernames` = `GET /tikhub/instagram/v3/get_user_former_usernames` (operationId: `get_tikhub_instagram_v3_get_user_former_usernames`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_brief
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_briefInstagram (v3). ### Purpose - Get Instagram user brief/hover card info - Returns core user info, faster response than get_user_profile - Suitable for batch fetching user summary info ### Parameters - user_id: Instagram user ID (numeric, required) - username: Instagram username (required) ### Return - `data.id`: User ID - `data.username`: Username - `data.full_name`: Full name - `data.biography`: Biography - `data.profile_pic_url`: Profile picture URL - `data.is_verified`: Whether verified - `data.is_private`: Whether private account - `data.edge_followed_by.count`: Followers count - `data.edge_follow.count`: Following count - `data.edge_owner_to_timeline_media`: Recent posts preview ### Example user_id = "791258468" username = "99brasil" API references: `get_user_profile` = `GET /tikhub/instagram/v3/get_user_profile` (operationId: `get_tikhub_instagram_v3_get_user_profile`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_followersInstagram (v3). ### Purpose - Get Instagram user's followers list - Returns all accounts that follow this user - Support pagination ### Parameters - username: Instagram username (required) - count: Number of users to fetch per request (default 12, max 100) - max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id` ### Return - `data.users`: Followers user list - `pk`: User ID - `username`: Username - `full_name`: Full name - `is_private`: Whether private account - `is_verified`: Whether verified - `profile_pic_url`: Profile picture URL - `data.next_max_id`: Next page cursor (use as max_id in next request) - `data.big_list`: Whether has more data - `data.page_size`: Page size - `data.status`: Status ### Pagination usage 1. First request: Only pass `username` and `count` parameters 2. Get `data.next_max_id` from response 3. Next request: Pass `username`, `count`, and `max_id` (use next_max_id from previous) 4. Repeat steps 2-3 until response has no `next_max_id` field ### Example username = "instagram" count = 12 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_following
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_followingInstagram (v3). ### Purpose - Get Instagram user's following list - Returns all accounts the user follows - Support pagination ### Parameters - username: Instagram username (required) - count: Number of users to fetch per request (default 12, max 100) - max_id: Pagination cursor, omit for first request, get from previous response `data.next_max_id` ### Return - `data.users`: Following user list - `pk`: User ID - `username`: Username - `full_name`: Full name - `is_private`: Whether private account - `is_verified`: Whether verified - `profile_pic_url`: Profile picture URL - `data.next_max_id`: Next page cursor (use as max_id in next request) - `data.big_list`: Whether has more data - `data.page_size`: Page size - `data.status`: Status ### Pagination usage 1. First request: Only pass `username` and `count` parameters 2. Get `data.next_max_id` from response 3. Next request: Pass `username`, `count`, and `max_id` (use next_max_id from previous) 4. Repeat steps 2-3 until response has no `next_max_id` field ### Example username = "instagram" count = 12 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_former_usernames
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_former_usernamesInstagram (v3). ### Purpose - Get the number of times an Instagram user has changed their username ### Parameters - username: Instagram username (required) ### Return - username: Instagram username - former_username_count: Number of username changes (a non-negative integer) - has_former_usernames: Whether the username has changed; true when the count is greater than 0 and false when it is 0 ### Note - Only the change count is provided, not individual former usernames or change dates - A successfully retrieved count of 0 is still a billable result, not an empty list - An error is returned when the count cannot be retrieved; an unknown count is not treated as 0 ### Request example username = "presjek.me" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_highlights
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_highlightsInstagram (v3). ### Purpose - Get Instagram user's Highlights list - Returns all highlight collections created by the user - Support pagination ### Parameters - username: Instagram username (required) - first: Number of highlights per page (default 10, max 50) - after: Forward pagination cursor, from previous response `data.page_info.end_cursor` - before: Backward pagination cursor, from previous response `data.page_info.start_cursor` - last: Highlights per page for backward pagination, use with `before` ### Return - `data.edges`: Highlights list - `node.id`: Highlight ID (format: highlight:xxx) - `node.title`: Highlight title - `node.cover_media`: Cover media info - `node.cover_media_cropped_thumbnail`: Cropped cover thumbnail - `node.media_count`: Number of stories in highlight - `data.page_info`: Pagination info - `has_next_page`: Whether has next page - `end_cursor`: Next page cursor (use as after parameter in next request) ### Pagination usage 1. First request: Only pass `username` and `first` parameters 2. Get `data.page_info.end_cursor` from response 3. Next request: Pass `username`, `first`, and `after` (use end_cursor from previous) 4. Repeat steps 2-3 until `data.page_info.has_next_page` is false ### Example username = "instagram" first = 10 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_id_by_username
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_id_by_usernameInstagram (v3). ### Purpose - Get Instagram user ID by username - User ID is the unique identifier used internally by Instagram, usually a numeric string ### Parameters - username: Instagram username ### Return - `data.user_id`: User ID ### Example username = "liensue.talks" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_postsInstagram (v3). ### Purpose - Get user's post list with forward/backward pagination ### Parameters - **username**: Username string (e.g. `99brasil`), **NOT numeric user_id** - **first**: Posts per page for forward pagination (default 12, max 50) - **after**: Forward pagination cursor, from previous response `page_info.end_cursor` - **before**: Backward pagination cursor, from previous response `page_info.start_cursor` - **last**: Posts per page for backward pagination, use with `before` - **count**: Number of posts for first request (default 12) ### Pagination - **Forward**: Use `first` + `after` - **Backward**: Use `last` + `before` ### Example ``` # First page GET /tikhub/instagram/v3/get_user_posts?username=99brasil&first=12 # Second page (forward) GET /tikhub/instagram/v3/get_user_posts?username=99brasil&first=12&after=QVFCcmN1YlF... ``` <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_profileInstagram (v3). ### Purpose - Get complete Instagram user profile information - Including basic info, statistics, recent posts, etc. ### Parameters - username: Instagram username (required) ### Return - `data.user.id`: User ID - `data.user.username`: Username - `data.user.full_name`: Full name - `data.user.biography`: Biography - `data.user.external_url`: External URL - `data.user.profile_pic_url`: Profile picture URL (standard) - `data.user.profile_pic_url_hd`: Profile picture URL (HD) - `data.user.is_verified`: Whether verified - `data.user.is_private`: Whether private account - `data.user.edge_followed_by.count`: Followers count - `data.user.edge_follow.count`: Following count - `data.user.edge_owner_to_timeline_media.count`: Total posts count - `data.user.edge_felix_video_timeline.count`: Reels/videos count ### Example username = "instagram" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_reels
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_reelsInstagram (v3). ### Purpose - Get Instagram user's Reels list - Support pagination to fetch all user's Reels ### Parameters - username: Instagram username (required) - first: Reels per page for forward pagination (default 12, max 50) - after: Forward pagination cursor, from previous response `data.page_info.end_cursor` - before: Backward pagination cursor, from previous response `data.page_info.start_cursor` - last: Reels per page for backward pagination, use with `before` - page_size: Videos per page (default 12) ### Return - `data.edges`: Reels list - `node.media`: Reels media info - `code`: Post shortcode - `pk`: Post ID - `like_count`: Likes count - `comment_count`: Comments count - `play_count`: Play count - `caption.text`: Description text - `user`: Publisher info - `video_versions`: Video version list - `image_versions2`: Cover image version list - `data.page_info`: Pagination info - `has_next_page`: Whether has next page - `end_cursor`: Next page cursor (use as after parameter in next request) ### Pagination usage 1. First request: Only pass `username` and `first` parameters 2. Get `data.page_info.end_cursor` from response 3. Next request: Pass `username`, `first`, and `after` (use end_cursor from previous) 4. Repeat steps 2-3 until `data.page_info.has_next_page` is false ### Example username = "instagram" first = 12 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_stories
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_storiesInstagram (v3). ### Purpose - Get Instagram user's Stories list - Stories displayed when clicking on user's profile picture (published within 24 hours) ### Parameters - username: Instagram username (required) ### Return - `data.reels_media`: Stories list (grouped by user) - `id`: User ID - `user`: User info - `username`: Username - `full_name`: Full name - `profile_pic_url`: Profile picture URL - `items`: Stories item list - `id`: Story ID - `pk`: Story PK - `taken_at`: Published timestamp - `media_type`: Media type (1=image, 2=video) - `image_versions2`: Image version list - `video_versions`: Video version list (exists for videos) - `story_cta`: Story link (if any) - `data.reels`: Stories detailed info ### Note - Stories have a 24-hour expiration, cannot be fetched after expiration - Private account's Stories require following to view ### Example ``` username = "instagram" ``` <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram get_user_tagged_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/get_user_tagged_postsInstagram (v3). ### Purpose - Get Instagram user's tagged posts list - Posts where other users tagged this user - Support pagination ### Parameters - username: Instagram username (required) - first: Posts per page for forward pagination (default 12, max 50) - after: Forward pagination cursor, from previous response `data.page_info.end_cursor` - before: Backward pagination cursor, from previous response `data.page_info.start_cursor` - last: Posts per page for backward pagination, use with `before` - count: Number of posts for first request (default 12) ### Return - `data.edges`: Post list - `node.id`: Post ID - `node.code`: Post shortcode - `node.display_url`: Display image URL - `node.taken_at`: Published timestamp - `node.like_count`: Likes count - `node.comment_count`: Comments count - `node.caption.text`: Post caption text - `node.user`: Post author info - `data.page_info`: Pagination info - `has_next_page`: Whether has next page - `end_cursor`: Next page cursor (use as after parameter in next request) ### Pagination usage 1. First request: Only pass `username` and `first` parameters 2. Get `data.page_info.end_cursor` from response 3. Next request: Pass `username`, `first`, and `after` (use end_cursor from previous) 4. Repeat steps 2-3 until `data.page_info.has_next_page` is false ### Example username = "instagram" first = 12 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram media_id_to_shortcode
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/media_id_to_shortcodeInstagram (v3). ### Purpose - Convert numeric media_id to post shortcode - Shortcode can be used to construct post URL: instagram.com/p/{shortcode}/ ### Parameters - media_id: Post media ID (numeric ID) ### Return - `data.media_id`: Original media ID - `data.shortcode`: Converted shortcode <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_by_coordinates
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/search_by_coordinatesInstagram (v3). ### Purpose - Search nearby Instagram locations by GPS coordinates ### Parameters - latitude: Latitude - longitude: Longitude ### Return - `data`: List of nearby locations ### Example latitude = 40.7 longitude = -74 <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_hashtags
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/search_hashtagsInstagram (v3). ### Purpose - Instagram hashtag search API - Returns only hashtag search results ### Parameters - query: Search keyword - rank_token: Rank token from previous search response for pagination ### Return - `data.hashtags`: Hashtag search results - `data.rank_token`: Rank token - `data.see_more`: See more info - `data.inform_module`: Inform module ### Example query = "fashion" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram search_users
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/search_usersInstagram (v3). ### Purpose - Instagram user search API - Returns only user search results ### Parameters - query: Search keyword - rank_token: Rank token from previous search response for pagination ### Return - `data.users`: User search results - `data.rank_token`: Rank token - `data.see_more`: See more info - `data.inform_module`: Inform module ### Example query = "justin" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram shortcode_to_media_id
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/shortcode_to_media_idInstagram (v3). ### Purpose: - Convert post shortcode to numeric media_id <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram translate_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/translate_commentInstagram (v3). ### Purpose - Translate Instagram post caption - Internally forces is_caption=True, specifically for translating post captions ### Parameters - comment_id: Post media ID ### Return - `data.translation`: Translated text - `data.source_language`: Source language ### Note - The target translation language depends on the language setting of the account associated with the cookie used (usually English) - Cannot specify the target language, it is automatically determined by Instagram based on the account settings ### Example comment_id = "18191961100350646" <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
instagram user_id_to_username
$MeteredGET https://aisa.one/apis/v1/tikhub/instagram/v3/user_id_to_usernameInstagram (v3). ### Purpose - Get Instagram user info by user ID - Inverse operation of get_user_id_by_username (ID → user info) ### Parameters - user_id: Instagram user ID (numeric string) ### Return - `data.username`: Username - `data.full_name`: Full name - `data.pk` / `data.id`: User ID - `data.biography`: Biography - `data.profile_pic_url`: Profile picture URL - `data.follower_count`: Followers count - `data.is_private`: Whether private account - `data.is_verified`: Whether verified ### Example user_id = "25025320" API references: `get_user_id_by_username` = `GET /tikhub/instagram/v3/get_user_id_by_username` (operationId: `get_tikhub_instagram_v3_get_user_id_by_username`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_brand_top_list
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_brand_top_listKuaishou (app). ### Purpose Get brand rankings by category. ### Parameters Use the ID/name pair below. Chinese names are wire values and must be passed verbatim. | Category | subTabId | subTabName | |---|---|---| | Default list | 0 | Omit this optional parameter | | Apparel | 131 | `"服饰"` | | Automotive | 1 | `"汽车"` | | Gaming | 25 | `"游戏"` | | Healthcare | 24 | `"医疗健康"` | | Consumer electronics | 130 | `"3C数码"` | | Phones | 128 | `"手机"` | | Home appliances | 11 | `"家电"` | | Parenting | 4 | `"母婴"` | | Food and beverages | 2 | `"食品饮料"` | ### Return Ranking data. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_hot_board_categories
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_hot_board_categoriesKuaishou (app). ### Purpose: - Kuaishou hot categories ### Returns: - Categories data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_hot_board_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_hot_board_detailKuaishou (app). ### Purpose: - Kuaishou hot board detail ### Parameters: - boardType: Board type - boardId: Board ID - boardType and boardId can be obtained from the hot board categories interface. ### Returns: - Detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_hot_search_person
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_hot_search_personKuaishou (app). ### Purpose: - Kuaishou hot search person board ### Returns: - Board data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_live_top_list
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_live_top_listKuaishou (app). ### Purpose Get live-stream rankings by category. ### Parameters Use the ID/name pair below. Chinese names are wire values and must be passed verbatim. | Category | subTabId | subTabName | |---|---|---| | Default list | 0 | Omit this optional parameter | | Music | 102 | `"音乐"` | | Dance | 107 | `"舞蹈"` | | Beauty | 101 | `"颜值"` | | Traditional arts | 105 | `"国艺"` | | Dating | 111 | `"相亲"` | | Gaming | 106 | `"游戏"` | | Animation | 110 | `"二次元"` | | Stories | 104 | `"故事"` | | Group broadcasts | 113 | `"团播"` | | Grid broadcasts | 114 | `"九宫格"` | ### Return Ranking data. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_music_ranking
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_music_rankingKuaishou (app). ### Purpose: - Fetch music ranking (songs in musics[]), with cursor pagination. ### Parameters: - tab_id: 100002=hot songs (default), 100063=Pi-plan ranking - count: Page size, default 20, range 1-50 - pcursor: Cursor, empty for first page ### Returns: - Music ranking data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_user
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_one_user_v2Kuaishou (app). ### Purpose: - Fetch single user data V2 - This API is more expensive, but more stable, please check the price list in the user background for specific prices. ### Parameters: - user_id: Supports `eid` or `userId`, `eid` is part of the user profile link, and `user_id` can be obtained from different interfaces. - Both user IDs can be used, here are examples of the two user IDs, both of which point to the same user: - eid = "3xz63mn6fngqtiq" - userId = "228905802" ### Returns: - User data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_one_videoKuaishou (app). ### Purpose: - Fetch single video data API V1. ### Parameters: - photo_id: Photo ID, the photo ID can be extracted from the share link - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed. ### Returns: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video_by_url
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_one_video_by_urlKuaishou (app). ### Purpose: - Fetch single video by URL. ### Parameters: - share_text: Photo URL or share text ### Returns: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_selection_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_selection_feedKuaishou (app). ### Purpose: - Fetch the "Selection / Recommended" feed of the App home page. - The feed has no cursor pagination; call again for more content. ### Returns: - Recommended feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_shopping_top_list
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_shopping_top_listKuaishou (app). ### Purpose Get shopping rankings. ### Parameters Use the ID/name pair below. Chinese names are wire values and must be passed verbatim. | Category | subTabId | subTabName | |---|---|---| | Default list | 0 | Omit this optional parameter | | Best-selling products | 102 | `"热销商品"` | ### Return Ranking data. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_tag_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_tag_feedKuaishou (app). ### Purpose - Tag aggregation page: tagInfo + related feed (mixFeeds[]). Hashtag page has 4 sub tabs. ### Parameters - general_tag_id: Tag ID. Topic tag uses tag name or search_tag's numeric id; sound tag uses encoded id. - tab: hot / latest / image / live - tag_name: Tag display name (recommended for topic tags) - tag_type: 1=topic tag, 29=sound/music tag - tag_source: 2=from search, 3=sound tag from photo page - from_photo_id: Source photoId (optional) - pcursor: Cursor, empty for first page ### Returns - Tag info + feed data API references: `search_tag` = `GET /tikhub/kuaishou/app/search_tag` (operationId: `get_tikhub_kuaishou_app_search_tag`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_hot_post
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_user_hot_postKuaishou (app). ### Purpose: - Get user hot post data ### Parameters: - user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID. - user_id can be obtained from the get single user data interface. - pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. ### Returns: - Post data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_live_info
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_user_live_infoKuaishou (app). ### Purpose: - Get user live info ### Parameters: - user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID. - user_id can be obtained from the get single user data interface. ### Returns: - Live info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_post
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_user_post_v2Kuaishou (app). ### Purpose: - User video list V2 - This API is more expensive, but more stable, please check the price list in the user background for specific prices. ### Parameters: - user_id: User ID, this API only supports user ID, not user eid, that is, the input must be a pure digital ID. - user_id can be obtained from the get single user data interface. - pcursor: Video cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. - sort: Sort type, latest (default) / hot. ### Returns: - Videos data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_video_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_video_commentKuaishou (app). ### Purpose: - Fetch single video comment data ### Parameters: - photo_id: Photo ID - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed. - pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. ### Returns: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_video_sub_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_video_sub_commentsKuaishou (app). ### Purpose: - Fetch sub comments (replies) under a root comment, with cursor pagination. ### Parameters: - photo_id: Photo ID - root_comment_id: Root comment ID - pcursor: Cursor, empty for first page - count: Page size, default 8, range 1-20 ### Returns: - Sub comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_videos_batch
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/fetch_videos_batchKuaishou (app). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Batch fetch multiple video data, supports up to 40 video IDs per request. - If this API continuously fails, you can try to use the more expensive V2 API for redundant requests. ### Parameters - photo_ids: Photo ID list, multiple IDs separated by commas, max 40 per request - Format note: Supports both pure digital version IDs and short string version (eID) IDs, both types can be mixed. ### Returns - Video data list <!-- aisa-pricing:start --> Published reference price: $0.04 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou generate_kuaishou_share_link
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/generate_kuaishou_share_linkKuaishou (app). ### Purpose: - Generate Kuaishou share link ### Parameters: - shareObjectId: Photo ID ### Returns: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_comprehensive
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_comprehensiveKuaishou (app). ### Purpose: - Kuaishou comprehensive search API, supports searching videos, users, etc., and provides multi-dimensional filtering. ### Parameters: - keyword: Search keyword (required) - pcursor: Pagination cursor, empty for first request, use pcursor from response for subsequent pages - sort_type: Sort type - all: Comprehensive sort (default) - newest: Latest release - most_likes: Most likes - publish_time: Publish time filter - all: All time (default) - one_day: Last day - one_week: Last week - one_month: Last month - duration: Duration filter - all: All duration (default) - under_1_min: Under 1 minute - 1_to_5_min: 1-5 minutes - over_5_min: Over 5 minutes ### Returns: - Search result data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_image
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_imageKuaishou (app). ### Purpose: - Search image posts by keyword, with cursor pagination. ### Parameters: - keyword: Search keyword - pcursor: Cursor, empty for first page ### Returns: - Image search results <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_live
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_liveKuaishou (app). ### Purpose: - Search live rooms by keyword, with cursor pagination. ### Parameters: - keyword: Search keyword - pcursor: Cursor, empty for first page ### Returns: - Live search results <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_music
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_musicKuaishou (app). ### Purpose: - Search music by keyword (song / artist), with cursor pagination. ### Parameters: - keyword: Song / artist / keyword - pcursor: Cursor, empty for first page ### Returns: - Music search results <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_tag
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_tagKuaishou (app). ### Purpose - Search tags (hashtags) by keyword. Use /tikhub/kuaishou/app/fetch_tag_feed to browse a tag's feed. ### Parameters - keyword: Tag keyword - pcursor: Cursor, empty for first page ### Returns - Tag search results API references: `fetch_tag_feed` = `GET /tikhub/kuaishou/app/fetch_tag_feed` (operationId: `get_tikhub_kuaishou_app_fetch_tag_feed`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_user
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_user_v2Kuaishou (app). ### Purpose: - Search user V2 - This API is more expensive, but more stable, please check the price list in the user background for specific prices. ### Parameters: - keyword: Search keyword - pcursor: Pagination cursor, empty for first page, pass pcursor from previous response - user_relation: Relation filter, all / same_city / verified / live / following - user_gender: Gender filter, all / male / female - fans_sort: Fans sort, default / most_to_least / least_to_most ### Returns: - User data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou search_video
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/app/search_video_v2Kuaishou (app). ### Purpose: - Search video V2 - This API is more expensive, but more stable, please check the price list in the user background for specific prices. ### Parameters: - keyword: Search keyword - pcursor: Pagination cursor, empty for first page, pass pcursor from previous response ### Returns: - Videos data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_get_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_get_user_idKuaishou (web). ### Purpose: - Fetch user ID via user share link ### Parameters: - share_link: User share link ### Returns: - User ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_kuaishou_hot_list
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_kuaishou_hot_list_v2Kuaishou (web). ### Purpose: - Fetch Kuaishou Hot List V2 ### Parameters: - board_type: Board Type, default is 1: 1 - Hot List 2 - Entertainment 3 - Society 4 - Useful 5 - Challenge 6 - Search ### Returns: - Kuaishou Hot List V2 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_one_videoKuaishou (web). ### Purpose: - Fetch single video data, this interface does not support photo only posts. ### Parameters: - share_text: Photo share link ### Returns: - Video data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video_by_url
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_one_video_by_urlKuaishou (web). ### Purpose: - Fetch single video by URL ### Parameters: - url: Photo URL ### Returns: - Video data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_one_video_commentKuaishou (web). ### Purpose: - Fetch single video comment data ### Parameters: - photo_id: Photo ID - pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. ### Returns: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_one_video_sub_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_one_video_sub_commentKuaishou (web). ### Purpose: - Fetch single video comment data ### Parameters: - photo_id: Photo ID - pcursor: Comment cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. - root_comment_id: Root comment ID ### Returns: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_collect
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_user_collectKuaishou (web). ### Purpose: - Fetch user favorite - Note: This API requires the user's eid, which can be extracted from the user's profile URL. - For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq. - Note: Querying with uid (pure numeric user ID) is not supported. ### Parameters: - user_id: User ID - pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. ### Returns: - User favorite list <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_user_infoKuaishou (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Fetch user info - Note: This API requires the user's eid, which can be extracted from the user's profile URL. - For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq. - Note: Querying with uid (pure numeric user ID) is not supported. - Note: Please set the timeout to more than 30 seconds when making requests to this API, otherwise it may cause the client to not receive the response in time and result in billing. - Due to the special nature of risk control for this API, we try to keep it stable, but we still cannot guarantee 100% stability. If you encounter a request failure, please try again later. ### Parameters - user_id: User ID ### Returns - User info, including nickname, avatar, number of followers, number of followings, number <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou fetch_user_live_replay
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/fetch_user_live_replayKuaishou (web). ### Purpose: - Fetch user live replay - Note: This API requires the user's eid, which can be extracted from the user's profile URL. - For example: In the URL https://www.kuaishou.com/profile/3xz63mn6fngqtiq, the eid is 3xz63mn6fngqtiq. - Note: Querying with uid (pure numeric user ID) is not supported. ### Parameters: - user_id: User ID - pcursor: Post cursor, empty for the first request, and use the pcursor value in the returned response for subsequent requests. ### Returns: - User live replay list <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
kuaishou generate_share_short_url
$MeteredGET https://aisa.one/apis/v1/tikhub/kuaishou/web/generate_share_short_urlKuaishou (web). ### Purpose: - Generate share short URL ### Parameters: - photo_id: Photo ID ### Returns: - Short URL <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_discover_banners
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_discover_bannersLemon8 (app). ### Purpose: - Get banners of discover page ### Return: - Banners list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_discover_tab
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_discover_tabLemon8 (app). ### Purpose: - Get main content of discover page ### Return: - Main content <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_discover_tab_information_tabs
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_discover_tab_information_tabsLemon8 (app). ### Purpose: - Get Editor's Picks of discover page ### Return: - Editor's Picks <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_hot_search_keywords
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_hot_search_keywordsLemon8 (app). ### Purpose: - Get hot search keywords ### Return: - Hot search keywords list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_post_comment_list
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_post_comment_listLemon8 (app). ### Purpose - Get comments list of specified post ### Parameters - group_id: Post's group_id, can be obtained from the interface `/tikhub/lemon8/app/fetch_post_detail` - item_id: Post's item_id, can be obtained from the interface `/tikhub/lemon8/app/fetch_post_detail` or `/tikhub/lemon8/app/get_item_id` - media_id: Post's media_id, can be obtained from the interface `/tikhub/lemon8/app/fetch_post_detail` - offset: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the offset returned by the last request is used for subsequent requests. ### Return - Comments list API references: `fetch_post_detail` = `GET /tikhub/lemon8/app/fetch_post_detail` (operationId: `get_tikhub_lemon8_app_fetch_post_detail`); `get_item_id` = `GET /tikhub/lemon8/app/get_item_id` (operationId: `get_tikhub_lemon8_app_get_item_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_post_detailLemon8 (app). ### Purpose - Get information of specified post ### Parameters - item_id: Post ID, can be obtained from the interface `/tikhub/lemon8/app/get_item_id` ### Return - Post information API references: `get_item_id` = `GET /tikhub/lemon8/app/get_item_id` (operationId: `get_tikhub_lemon8_app_get_item_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_search
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_searchLemon8 (app). ### Purpose: - Search API ### Parameters: - query: Search keyword - max_cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the `max_cursor` returned by the last request is used for subsequent requests. You can judge whether there is more data by the `has_more` field in the return result. - filter_type: Search filter type, default is an empty string, optional values are as follows: - Empty string: All (default using this parameter to search) - video: Search only video - posts: Search only posts - order_by: Search sort type, default is an empty string, optional values are as follows: - Empty string: Relevance (default using this parameter to sort) - popular: Sort by popularity - recent: Sort from new to old - search_tab: Search type, default is `main`, optional values are as follows: - main: Display as `Top` in the APP (comprehensive search, default using this parameter to search) - user: Display as `Accounts` in the APP (search user accounts) - hashtag: Display as `Hashtags` in the APP (search hashtags) - article: Display as `Posts` in the APP (search articles) ### Return: - Search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_topic_info
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_topic_infoLemon8 (app). ### Purpose - Get topic information ### Parameters - forum_id: Topic ID, can be obtained from the following interfaces - Get information of specified post: `/tikhub/lemon8/app/fetch_post_detail` - Get Editor's Picks of discover page: `/tikhub/lemon8/app/fetch_discover_tab_information_tabs` - Search Hashtag through interface: `/tikhub/lemon8/app/fetch_search?search_tab=hashtag&keyword=lemon8` ### Return - Topic information API references: `fetch_discover_tab_information_tabs` = `GET /tikhub/lemon8/app/fetch_discover_tab_information_tabs` (operationId: `get_tikhub_lemon8_app_fetch_discover_tab_information_tabs`); `fetch_post_detail` = `GET /tikhub/lemon8/app/fetch_post_detail` (operationId: `get_tikhub_lemon8_app_fetch_post_detail`); `fetch_search` = `GET /tikhub/lemon8/app/fetch_search` (operationId: `get_tikhub_lemon8_app_fetch_search`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_topic_post_list
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_topic_post_listLemon8 (app). ### Purpose - Get topic post list ### Parameters - category: Topic category ID, can be obtained from the interface `/tikhub/lemon8/app/fetch_topic_info` - max_behot_time: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the max_behot_time returned by the last request is used for subsequent requests. - category_parameter: Category parameter ID, can be obtained from the interface `/tikhub/lemon8/app/fetch_topic_info` - hashtag_name: Hashtag name, can be obtained from the interface `/tikhub/lemon8/app/fetch_topic_info` - sort_type: Sort type, 0 for default sort, currently only support default sort, please do not pass other values. ### Return - Post list API references: `fetch_topic_info` = `GET /tikhub/lemon8/app/fetch_topic_info` (operationId: `get_tikhub_lemon8_app_fetch_topic_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_user_follower_list
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_user_follower_listLemon8 (app). ### Purpose - Get fans list of specified user ### Parameters - user_id: User ID, can be obtained from the interface `/tikhub/lemon8/app/get_user_id` - cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the cursor returned by the last request is used for subsequent requests. ### Return - Fans list API references: `get_user_id` = `GET /tikhub/lemon8/app/get_user_id` (operationId: `get_tikhub_lemon8_app_get_user_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_user_following_list
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_user_following_listLemon8 (app). ### Purpose - Get following list of specified user ### Parameters - user_id: User ID, can be obtained from the interface `/tikhub/lemon8/app/get_user_id` - cursor: Pagination parameter, can be obtained from the return result of the last request. It is empty for the first request, and the cursor returned by the last request is used for subsequent requests. ### Return - Following list API references: `get_user_id` = `GET /tikhub/lemon8/app/get_user_id` (operationId: `get_tikhub_lemon8_app_get_user_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 fetch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/fetch_user_profileLemon8 (app). ### Purpose - Get information of specified user ### Parameters - user_id: User ID, can be obtained from the interface `/tikhub/lemon8/app/get_user_id` ### Return - User information API references: `get_user_id` = `GET /tikhub/lemon8/app/get_user_id` (operationId: `get_tikhub_lemon8_app_get_user_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 get_item_id
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/get_item_idLemon8 (app). ### Purpose: - Get post ID through sharing link ### Parameters: - share_text: Share link, supports long links and short links, can be obtained and copied from the share button on the web and APP. ### Return: - Post ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 get_item_ids
$MeteredPOST https://aisa.one/apis/v1/tikhub/lemon8/app/get_item_idsLemon8 (app). ### Purpose - Get post IDs in batch through sharing links, up to 10 at a time ### Parameters - Root JSON body: Share links list, supports long links and short links, can be obtained and copied from the share button on the web and APP. ### Return - Post IDs list ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 get_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/lemon8/app/get_user_idLemon8 (app). ### Purpose: - Get user ID through sharing link ### Parameters: - share_text: Share link, supports long links and short links, can be obtained and copied from the share button on the web and APP. ### Return: - User ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
lemon8 get_user_ids
$MeteredPOST https://aisa.one/apis/v1/tikhub/lemon8/app/get_user_idsLemon8 (app). ### Purpose - Get user IDs in batch through sharing links, up to 10 at a time ### Parameters - Root JSON body: Share links list, supports long links and short links, can be obtained and copied from the share button on the web and APP. ### Return - User IDs list ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_company_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_company_postsLinkedin (web_v2). ### Purpose: - Fetch a company's posts by company URL. ### Parameters: - url: Company URL. - start: Pagination offset — 0 for page 1, 50 for page 2, and so on. - pagination_token: Token from the `paging` object of the previous response. - sort_by: top or recent. ### Returns: - data: list of posts; paging: pagination info (count / start / pagination_token). <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_company_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_company_profileLinkedin (web_v2). ### Purpose: - Fetch a company's profile by URL. ### Parameters: - url: Full company URL (e.g. https://www.linkedin.com/company/microsoft/). ### Returns: - Public fields such as company name, about, size, industry, headquarters, follower count and affiliated pages. <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_job_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_job_detailLinkedin (web_v2). ### Purpose: - Fetch a job posting by its URL. ### Parameters: - url: Job URL, e.g. https://www.linkedin.com/jobs/view/3766410207/. - include_skills: Whether to include the required skills. - include_hiring_team: Whether to include hiring team information. ### Returns: - data: job title, description, company profile, salary range, location, skills and more. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_post_commentsLinkedin (web_v2). ### Purpose: - Fetch comments of a post by its activity urn. ### Parameters: - urn: Post activity urn (the numeric part of .../urn:li:activity:<urn>/). - sort_by: Most relevant (default) or Most recent. - page: Page number, starting at 1. - pagination_token: Token returned by the previous response. - share_urn: Optional share urn for shared posts. ### Returns: - data: list of comments (commenter, text, time, pinned flag, replies, …); pagination_token: token for the next page; total: number of items returned. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_post_detailLinkedin (web_v2). ### Purpose: - Fetch a post or an article by URL. ### Parameters: - url: Full post or article URL (both /posts/... and /pulse/... are supported). ### Returns: - Fields such as body text, author, posted time, hashtags, images / video and engagement counts. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_user_postsLinkedin (web_v2). ### Purpose: - Fetch a member's posts, commented posts, or reacted posts by profile URL. ### Parameters: - url: Profile URL. - type: posts / comments / reactions. Defaults to posts. - start: Pagination offset — 0 for page 1, 50 for page 2, and so on. - pagination_token: Token from the `paging` object of the previous response. ### Returns: - data: list of posts; paging: pagination info (count / start / pagination_token). <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin get_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/get_user_profileLinkedin (web_v2). ### Purpose: - Fetch a LinkedIn member's public profile by URL. ### Parameters: - url: Full profile URL (e.g. https://www.linkedin.com/in/williamhgates/). ### Returns: - Public fields such as name, current company, about, location, follower count, experience and education. <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
linkedin search_jobs
$MeteredGET https://aisa.one/apis/v1/tikhub/linkedin/web_v2/search_jobsLinkedin (web_v2). ### Purpose: - Search jobs by keywords and filters. ### Parameters: - keywords: Search keywords. - geo_code: LinkedIn geo code. Defaults to 92000000 (worldwide). - date_posted / sort_by: Posting-time filter and sort order. - experience_levels / company_ids / title_ids / onsite_remotes / functions / industries / job_types: List filters — repeat the same parameter to pass multiple values. - start: Pagination offset — 0 for page 1, 25 for page 2, and so on. ### Returns: - data: list of jobs (company, title, location, salary, posted time, …); total: total number of results. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_hashtag_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_hashtag_detailPipixia (app). ### Purpose: - Get hashtag detail data. ### Parameters: - hashtag_id: AKA hashtag id, can be obtained from the share link. ### Return: - Hashtag detail data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_hashtag_post_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_hashtag_post_listPipixia (app). ### Purpose - Get hashtag post list data. ### Parameters - hashtag_id: AKA hashtag id, can be obtained from the share link. - cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page. - feed_count: Page count, default is 0, add 1 for each page, such as 0 for the first page, 1 for the second page, 2 for the third page, and so on. ### Return - Hashtag post list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_home_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_home_feedPipixia (app). ### Purpose: - Get home feed data. ### Parameters: - cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page. ### Return: - Home feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_home_short_drama_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_home_short_drama_feedPipixia (app). ### Purpose: - Get home short drama feed data. ### Parameters: - page: Page number, default is 1, add 1 for each page. ### Return: - Home short drama feed data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_hot_search_board_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_hot_search_board_detailPipixia (app). ### Purpose - Get hot search board detail data. ### Parameters - block_type: Board type, can be obtained from the `/tikhub/pipixia/app/fetch_hot_search_board_list` interface. ### Return - Hot search board detail data API references: `fetch_hot_search_board_list` = `GET /tikhub/pipixia/app/fetch_hot_search_board_list` (operationId: `get_tikhub_pipixia_app_fetch_hot_search_board_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_hot_search_board_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_hot_search_board_listPipixia (app). ### Purpose: - Get hot search board list data. ### Return: - Hot search board list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_hot_search_words
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_hot_search_wordsPipixia (app). ### Purpose: - Get hot search words data. ### Return: - Hot search words data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_increase_post_view_count
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_increase_post_view_countPipixia (app). ### Purpose: - Increase post view count. ### Parameters: - cell_id: AKA video id, can be obtained from the share link. - cell_type: Video type, 1 for video, keep the default value for other types. ### Return: - Execution result <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_post_comment_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_post_comment_listPipixia (app). ### Purpose: - Get the comment list of a post. ### Parameters: - cell_id: AKA video id, can be obtained from the share link. - cell_type: Video type, 1 for video, keep the default value for other types. - offset: Page cursor, default is 0, get the corresponding value from the `offset` Key in the previous page. ### Return: - Post comment list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_post_detailPipixia (app). ### Purpose: - Get single video data, support photo, video, etc. ### Parameters: - cell_id: AKA video id, can be obtained from the share link. - cell_type: Video type, 1 for video, keep the default value for other types. ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_post_statistics
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_post_statisticsPipixia (app). ### Purpose: - Get the statistics of a single post, such as the number of likes, comments, reposts, etc. ### Parameters: - cell_id: AKA video id, can be obtained from the share link. ### Return: - Post statistics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_search
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_searchPipixia (app). ### Purpose: - Search API, support search user, post, etc. ### Parameters: - keyword: Search keyword. - offset: Page cursor, default is 0, get the corresponding value from the `offset` Key in the previous page. - search_type: Search type, available values are as follows: - 1: Comprehensive - 8: Hot - 9: Fresh - 2: Video - 3: Photo - 4: User - 5: Hashtag ### Return: - Search result <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_short_url
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_short_urlPipixia (app). ### Purpose: - Generate short URL. ### Parameters: - original_url: Original URL, can be any link. ### Return: - Short URL <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_user_follower_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_user_follower_listPipixia (app). ### Purpose: - Get user's follower list. ### Parameters: - user_id: AKA user id, can be obtained from the share link. - cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page. ### Return: - User follower list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_user_following_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_user_following_listPipixia (app). ### Purpose: - Get user's following list. ### Parameters: - user_id: AKA user id, can be obtained from the share link. - cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page. ### Return: - User following list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_user_infoPipixia (app). ### Purpose: - Get user information, such as nickname and avatar. ### Parameters: - user_id: AKA user id, can be obtained from the share link. ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
pipixia fetch_user_post_list
$MeteredGET https://aisa.one/apis/v1/tikhub/pipixia/app/fetch_user_post_listPipixia (app). ### Purpose: - Get user post list, such as videos, photos, etc. ### Parameters: - user_id: AKA user id, can be obtained from the share link. - cursor: Page cursor, default is 0, get the corresponding value from the `loadmore_cursor` Key in the previous page. - feed_count: Page count, default is 0, add 1 for each page, such as 0 for the first page, 1 for the second page, 2 for the third page, and so on. ### Return: - User post list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit check_subreddit_muted
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/check_subreddit_mutedReddit (app). ### Purpose: - Check if a specified Reddit subreddit is muted by the current user ### Parameters: - subreddit_id: Subreddit ID starting with "t5_", can be obtained from fetch_subreddit_info endpoint ### Returns: - JSON data of mute status containing: - isMuted: Boolean value indicating if muted - subredditId: Subreddit ID ### Note: - **APP API ID format differs from Web API, requires type prefix** - Subreddit ID prefix: t5_ (e.g., t5_2qh0u) API references: `fetch_subreddit_info` = `GET /tikhub/reddit/app/fetch_subreddit_info` (operationId: `get_tikhub_reddit_app_fetch_subreddit_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_comment_repliesReddit (app). ### Purpose: - Fetch replies (sub-comments/second-level comments) under a specified Reddit APP comment - Use this endpoint when a comment node has more.cursor field to get its sub-comments ### Parameters: - post_id: Post ID, format like "t3_XXXXXX" - cursor: Comment cursor from the more.cursor field in comment data, format like "commenttree:ex:(xxx)" - sort_type: Sort method, supports CONFIDENCE, NEW, TOP, HOT, CONTROVERSIAL, OLD, RANDOM ### Returns: - JSON data of replies under the specified comment, containing: - List of sub-comments - Detailed information for each sub-comment (content, author, upvotes, etc.) - Pagination information ### Usage Steps: 1. First call fetch_post_comments to get top-level comments 2. Find comment nodes with sub-comments (childCount > 0) 3. Get the more.cursor value from that node 4. Use that cursor to call this endpoint to fetch sub-comments ### Note: - cursor value comes from the more.cursor field in comment data - Path example: $.data.postInfoById.commentForest.trees[*].more.cursor - cursor format example: "commenttree:ex:(RjiJd" API references: `fetch_post_comments` = `GET /tikhub/reddit/app/fetch_post_comments` (operationId: `get_tikhub_reddit_app_fetch_post_comments`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_community_highlights
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_community_highlightsReddit (app). ### Purpose: - Fetch featured highlight content of a specified Reddit APP community, including popular posts and important announcements ### Parameters: - subreddit_id: Subreddit ID starting with "t5_", can be obtained from fetch_subreddit_info endpoint ### Returns: - JSON data of community highlights containing: - Featured post list - Pinned announcements - Important community updates - Recommended content ### Note: - **APP API ID format differs from Web API, requires type prefix** - Subreddit ID prefix: t5_ (e.g., t5_2qh0u) API references: `fetch_subreddit_info` = `GET /tikhub/reddit/app/fetch_subreddit_info` (operationId: `get_tikhub_reddit_app_fetch_subreddit_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_dynamic_search
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_dynamic_searchReddit (app). ### Purpose: - Perform Reddit APP dynamic search, supporting posts, communities, comments, media, and users ### Parameters: - query: Search keyword - search_type: Search type, options: - post: Search posts (default) - community: Search communities/subreddits - comment: Search comments - media: Search media (images/videos/GIFs) - people: Search users - sort: Sort method (only for post/comment/media types), options: - RELEVANCE: By relevance - HOT: Hot/trending - TOP: Most popular - NEW: Newest - COMMENTS: By comment count (only for post type) - time_range: Time range (only for post/media types), options: - all: All time - year: Past year - month: Past month - week: Past week - day: Today - hour: Past hour - safe_search: Safe search setting, "unset" or "strict" - allow_nsfw: Allow NSFW content, "0" or "1" - after: Pagination parameter for fetching next page ### Returns: - JSON data of search results containing: - List of matching results (different data types based on search_type) - Pagination information ### Notes: - community and people types do not support sort and time_range parameters - COMMENTS sort option only applies to post type - time_range parameter only applies to post and media types <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_explore_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_explore_feedReddit (app). ### Purpose - Fetch the Reddit APP Explore feed (Communities tab content) including: - Carousel community recommendations - Parent topic groups (TopicGroupFeedElement) - Taxonomy topics (TaxonomyTopicsFeedElement) - Also returns a flat `topics` list — pass each `id` to `/tikhub/reddit/app/fetch_topic_feed` to drill into a category. ### Parameters - sort: Sort method, BEST (default) / HOT / NEW / TOP / CONTROVERSIAL - time: Time range, ALL (default) / HOUR / DAY / WEEK / MONTH / YEAR - need_format: Whether to clean the response API references: `fetch_topic_feed` = `GET /tikhub/reddit/app/fetch_topic_feed` (operationId: `get_tikhub_reddit_app_fetch_topic_feed`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_games_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_games_feedReddit (app). ### Purpose: - Fetch gaming-related recommended content on Reddit APP, displaying popular posts from gaming communities ### Parameters: - sort: Sort method, options: NEW, HOT, TOP, RISING - time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR - after: Pagination parameter for fetching next page ### Returns: - JSON data of games feed containing: - List of gaming-related posts - Gaming community discussions - Game news and updates <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_generated_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_generated_commentsReddit (app). ### Purpose: - Fetch lightweight comment info used by Reddit Answers "Generated for you" cards - Returns: id / createdAt / score / authorInfo / postInfo / permalink ### Parameters: - comment_ids: Comment IDs comma-separated, e.g. "t1_XXXXXX,t1_YYYYYY", max 30 - need_format: Whether to clean and format the data ### Note: - **APP API ID format differs from Web API, requires type prefix** - Comment ID prefix: t1_ <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_generated_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_generated_postsReddit (app). ### Purpose: - Fetch lightweight post info used by the Reddit Answers "Generated for you" cards - More concise than fetch_post_details_batch, only includes id / title / score / commentCount / createdAt / url / authorInfo / subreddit / media ### Parameters: - post_ids: Post IDs comma-separated, e.g. "t3_XXXXXX,t3_YYYYYY", max 30 - need_format: Whether to clean and format the data ### Note: - **APP API ID format differs from Web API, requires type prefix** - Post ID prefix: t3_ API references: `fetch_post_details_batch` = `GET /tikhub/reddit/app/fetch_post_details_batch` (operationId: `get_tikhub_reddit_app_fetch_post_details_batch`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_home_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_home_feedReddit (app). ### Purpose: - Fetch Reddit APP home feed content ### Parameters: - sort: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL - filter_posts: List of post IDs to filter out, used to exclude already fetched posts - after: Pagination parameter for fetching the next page ### Returns: - JSON data of Reddit APP home feed content <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_news_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_news_feedReddit (app). ### Purpose: - Fetch news-related recommended content on Reddit APP, displaying latest news and current affairs discussions ### Parameters: - subtopic_ids: List of subtopic IDs, default ["all"] means all news categories - after: Pagination parameter for fetching next page ### Returns: - JSON data of news feed containing: - List of news posts - Current affairs discussions - Trending topics - News sources and links <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_popular_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_popular_feedReddit (app). ### Purpose: - Fetch popular/trending recommended content on Reddit APP, displaying the most popular posts site-wide ### Parameters: - sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING - time: Time range, options: ALL, HOUR, DAY, WEEK, MONTH, YEAR - filter_posts: List of post IDs to filter out, used to avoid duplicate fetches - after: Pagination parameter for fetching next page ### Returns: - JSON data of popular feed containing: - List of trending posts - Detailed post information (title, content, upvotes, comments, etc.) - Pagination information (after parameter for next page) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_post_commentsReddit (app). ### Purpose: - Fetch comments under a specified Reddit APP post ### Parameters: - post_id: Post ID, format like "t3_XXXXXX" - sort_type: Sort method, supports HOT, NEW, TOP, BEST, CONTROVERSIAL - after: Pagination parameter for fetching the next page, can be found in the last comment node in commentForest, e.g., $.data.postInfoById.commentForest.trees[-1].more.cursor ### Returns: - JSON data of comments under the specified post ### Note: - **APP API ID format differs from Web API, requires type prefix** - Post ID prefix: t3_ (e.g., t3_1ojnvca) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_post_details
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_post_detailsReddit (app). ## Purpose: - Fetch single post details by post ID - Optionally include context for specific comments ## Parameters: - post_id: Post ID, format like "t3_XXXXXX" - include_comment_id: Whether to include specific comment ID, default False - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX" ## Returns: - Data containing detailed post information including: - Post content, title, author - Statistics (upvotes, comment count, etc.) - Subreddit information - Award information - Media resources - Recommendation reasons, etc. ## Note: - **APP API ID format differs from Web API, requires type prefix** - Post ID prefix: t3_ (e.g., t3_1ojnh50) - Comment ID prefix: t1_ (e.g., t1_abcd123) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_post_details_batch
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_post_details_batchReddit (app). ## Purpose: - Fetch post details in batch by post ID list - Support batch query for up to 5 posts - Optionally include context for specific comments ## Parameters: - post_ids: Post IDs comma-separated, format like "t3_XXXXXX,t3_YYYYYY", max 5 posts - include_comment_id: Whether to include specific comment ID, default False - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX" ## Returns: - Data containing detailed post information including: - Post content, title, author - Statistics (upvotes, comment count, etc.) - Subreddit information - Award information - Media resources - Recommendation reasons, etc. ## Notes: - Maximum 5 posts per batch query - Error will be returned if exceeds 5 posts - **APP API ID format differs from Web API, requires type prefix** - Post ID prefix: t3_ (e.g., t3_1ojnh50) - Comment ID prefix: t1_ (e.g., t1_abcd123) <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_post_details_batch_large
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_post_details_batch_largeReddit (app). ## Purpose: - Fetch post details in large batch by post ID list - Support batch query for up to 30 posts - Optionally include context for specific comments ## Parameters: - post_ids: Post IDs comma-separated, format like "t3_XXXXXX,t3_YYYYYY,...", max 30 posts - include_comment_id: Whether to include specific comment ID, default False - comment_id: Comment ID (used when include_comment_id is True), format like "t1_XXXXXX" ## Returns: - Data containing detailed post information including: - Post content, title, author - Statistics (upvotes, comment count, etc.) - Subreddit information - Award information - Media resources - Recommendation reasons, etc. ## Notes: - Maximum 30 posts per batch query - Error will be returned if exceeds 30 posts - Large batch queries may take longer to respond - **APP API ID format differs from Web API, requires type prefix** - Post ID prefix: t3_ (e.g., t3_1ojnh50) - Comment ID prefix: t1_ (e.g., t1_abcd123) <!-- aisa-pricing:start --> Published reference price: $0.025 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_search_typeahead
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_search_typeaheadReddit (app). ### Purpose: - Fetch autocomplete suggestions for the Reddit APP search box, including recommended subreddits, users, and search terms ### Parameters: - query: Search keyword, the search text being typed - safe_search: Safe search setting, options are "unset" or "strict" - allow_nsfw: Whether to allow NSFW (adult) content display, "0" means disallow, "1" means allow ### Returns: - JSON data of search suggestions containing the following types: - Related subreddits - Related users - Search term suggestions - Trending topics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_subreddit_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_subreddit_feedReddit (app). ### Purpose: - Fetch feed content stream of a specified Reddit subreddit, displaying the post list of that subreddit ### Parameters: - subreddit_name: Subreddit name (without r/ prefix), e.g., "pics", "funny" - sort: Sort method, options: BEST, HOT, NEW, TOP, CONTROVERSIAL, RISING - filter_posts: List of post IDs to filter out - after: Pagination parameter for fetching next page ### Returns: - JSON data of subreddit feed containing: - List of posts in the subreddit - Detailed post information - Subreddit metadata - Pagination information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_subreddit_info
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_subreddit_infoReddit (app). ### Purpose: - Fetch detailed information of a specified Reddit APP subreddit, including description, subscriber count, creation time, rules, and other metadata ### Parameters: - subreddit_name: Subreddit name (without r/ prefix), e.g., "pics", "funny", "AskReddit" ### Returns: - JSON data containing detailed subreddit information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_subreddit_post_channels
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_subreddit_post_channelsReddit (app). ### Purpose: - Fetch post channel information of a specified Reddit APP subreddit ### Parameters: - subreddit_name: Subreddit name - sort: Sort method, supports HOT, NEW, TOP, CONTROVERSIAL, RISING - range: Time range, supports HOUR, DAY, WEEK, MONTH, YEAR, ALL ### Returns: - JSON data of post channel information of the specified subreddit <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_subreddit_settings
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_subreddit_settingsReddit (app). ### Purpose: - Fetch settings information of a specified Reddit APP subreddit, including posting rules, flair settings, moderation settings, and other configurations ### Parameters: - subreddit_id: Subreddit ID with format starting with t5_, e.g., "t5_2qh0u" (can be obtained from the fetch_subreddit_info endpoint) ### Returns: - JSON data containing subreddit settings with the following main fields: - subredditType: Subreddit type (public/private/restricted) - submissionType: Allowed submission content types (any/link/self) - allowImages: Whether images are allowed - allowVideos: Whether videos are allowed - allowPolls: Whether polls are allowed - suggestedCommentSort: Suggested comment sort method - spoilersEnabled: Whether spoiler tags are enabled - allowedPostTypes: Allowed post types configuration - contentOptions: Content options settings - flairSettings: User/post flair settings ### Notes: - You need to first get the subreddit ID (subreddit.id field) via the fetch_subreddit_info endpoint - Subreddit ID format must start with "t5_" - **APP API ID format differs from Web API, requires type prefix** - Subreddit ID prefix: t5_ (e.g., t5_2qh0u) API references: `fetch_subreddit_info` = `GET /tikhub/reddit/app/fetch_subreddit_info` (operationId: `get_tikhub_reddit_app_fetch_subreddit_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_subreddit_style
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_subreddit_styleReddit (app). ### Purpose: - Fetch rules and style information of a specified Reddit APP subreddit ### Parameters: - subreddit_name: Subreddit name ### Returns: - JSON data of rules and style information of the specified subreddit <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_topic_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_topic_feedReddit (app). ### Purpose - Fetch the feed for a specific Reddit community topic - Typical flow: call `/tikhub/reddit/app/fetch_explore_feed` first to get topicIds, then pass one here ### Parameters - topic_id: Topic ID, format "tx1_XXXXX", get from `/tikhub/reddit/app/fetch_explore_feed` response's `topics[].id` - scheme_name: Topic scheme, App defaults to "communities_tab_taxonomy_topics_default" - sort: Sort method - time: Time range - need_format: Whether to clean API references: `fetch_explore_feed` = `GET /tikhub/reddit/app/fetch_explore_feed` (operationId: `get_tikhub_reddit_app_fetch_explore_feed`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_trending_searches
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_trending_searchesReddit (app). ### Purpose: - Fetch currently trending search topics and content on Reddit APP ### Parameters: - No parameters required ### Returns: - JSON data of trending searches containing: - List of trending search keywords - Trending topics - Search volume and popularity for each topic - Related post previews <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_user_active_subreddits
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_user_active_subredditsReddit (app). ### Purpose: - Fetch list of Reddit communities where the specified user is most active ### Parameters: - username: Reddit username ### Returns: - JSON data of user's active communities containing: - List of communities where user posts/comments most - Activity level in each community - Basic community information (name, icon, member count, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_user_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_user_commentsReddit (app). ### Purpose: - Fetch list of comments posted by the specified user ### Parameters: - username: Reddit username - sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial) - page_size: Number of comments per page, default 25 - after: Pagination parameter for fetching next page ### Returns: - JSON data of user comments containing: - Comment content - Information about the post where comment was made - Comment timestamp - Upvote count - Reply count - Pagination information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_user_postsReddit (app). ### Purpose: - Fetch list of posts submitted by the specified user ### Parameters: - username: Reddit username - sort: Sort method, options: NEW (newest), TOP (top rated), HOT (hot), CONTROVERSIAL (controversial) - after: Pagination parameter for fetching next page ### Returns: - JSON data of user posts containing: - Post title and content - Submission time - Subreddit - Upvote and comment counts - Post type (text/image/video/link) - Media content (if any) - Pagination information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_user_profileReddit (app). ### Purpose: - Fetch detailed profile information of a specified Reddit APP user ### Parameters: - username: Reddit username (without u/ prefix) ### Returns: - JSON data of user profile containing: - Username and ID - Account creation date - Karma values (post karma and comment karma) - Avatar and banner images - Bio/description - Verification status - Badges and awards - Follower count <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
reddit fetch_user_trophies
$MeteredGET https://aisa.one/apis/v1/tikhub/reddit/app/fetch_user_trophiesReddit (app). ### Purpose: - Fetch public trophies/achievements list of a specified Reddit user ### Parameters: - username: Reddit username (without u/ prefix) ### Returns: - JSON data of user trophies containing: - Trophy list - Detailed information for each trophy: - Trophy name - Trophy description - Trophy icon URL - Award date - Special badges and achievements <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram batch_channel_info
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/batch_channel_infoTelegram (web). ### Purpose: - Fetch basic info (title/description/avatar/subscribers/verified) for multiple public channels concurrently. ### Parameters: - channels: Comma-separated channel usernames, up to 20 per request. ### Return: - `data.results`: one `{channel, ok, info|error}` entry per channel. <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_channel_info
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_channel_infoTelegram (web). ### Purpose: - Get public Telegram channel metadata: title, description, avatar, subscriber count, verified badge and media counters. - Data comes from the public t.me preview page, no login required. ### Parameters: - channel: Channel username (accepts `durov` / `@durov` / `https://t.me/durov`, normalized automatically). ### Return: - `username` / `title` / `verified` / `description` / `photo` / `subscribers` / `counters`. - Returns `exists = false` when the channel does not exist or is not public; `preview_available = false` when the channel disabled web preview. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_channel_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_channel_postsTelegram (web). ### Purpose: - Fetch a public channel's recent posts (text, photos, videos, forwards, replies, link previews, reactions, views, time). ### Parameters: - channel: Channel username (required). - limit: Number of posts (1-100, default 20; when >20 the server automatically pages toward older posts). - before: Pagination cursor — fetch older posts, pass `data.pagination.before_cursor` from the previous page. - after: Pagination cursor — fetch newer posts, pass `data.pagination.after_cursor` from the previous page. ### Return: - `channel_info` (same structure as fetch_channel_info), `messages` array and a `pagination` cursor object. - Media direct links (cdn4.telesco.pe) are signed and expire — download / re-host them promptly. API references: `fetch_channel_info` = `GET /tikhub/telegram/web/fetch_channel_info` (operationId: `get_tikhub_telegram_web_fetch_channel_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_channel_search
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_channel_searchTelegram (web). ### Purpose: - Search posts in a channel by keyword (case-insensitive). - Uses Telegram's server-side search over the full channel history when the MTProto backend is enabled (`data.backend = "mtproto"`); otherwise falls back to best-effort local filtering over recent history (`data.backend = "web"`). ### Parameters: - channel: Channel username (required). - query: Keyword (required). - limit: Number of hits (1-100, default 20). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_post_commentsTelegram (web). ### Purpose: - Fetch comments of a channel post from its **linked discussion group**. ### Parameters: - channel: Channel username; post_id: Post ID; limit: number of comments (1-100). ### Return: - Comment list; empty when the channel has comments disabled / no linked discussion group. - Returns `mtproto_required = true` with a hint when the MTProto backend is not enabled. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_post_detailTelegram (web). ### Purpose: - Get a single public-channel post (parsed from the t.me embed view). ### Parameters: - channel: Channel username (required). - post_id: Post ID (required, auto-incremented integer within the channel). ### Return: - A single post object (same structure as a `messages` element in fetch_channel_posts). API references: `fetch_channel_posts` = `GET /tikhub/telegram/web/fetch_channel_posts` (operationId: `get_tikhub_telegram_web_fetch_channel_posts`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
telegram fetch_similar_channels
$MeteredGET https://aisa.one/apis/v1/tikhub/telegram/web/fetch_similar_channelsTelegram (web). ### Purpose: - Get Telegram's official "similar channels" recommendations (for channel discovery). ### Parameters: - channel: Channel username. ### Return: - List of similar channels (title/username/subscribers, etc.). - Returns `mtproto_required = true` with a hint when the MTProto backend is not enabled. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_post_commentsThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads post comments list ### ⚠️ No pagination - A single call returns all available data (~25 items). There is no way to fetch more. - The `end_cursor` parameter is reserved and currently has no effect — do not rely on it. ### Parameters - post_id: Post ID, for example: 3390920896561588969 - end_cursor: Pagination cursor. No pagination supported; passing it has no effect ### Return - Post comments list data, including: - comments: Comment list - next_cursor: Next page cursor (always null) - has_more: Has more data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_post_detailThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads post detail ### Parameters - post_id: Post ID as a numeric string, for example "3349029093483693129". For a URL or shortcode, the official prerequisite is `GET /api/v1/threads/web/fetch_post_detail_v2` (upstream-only; not exposed in this specification). Its input uses a Threads URL or shortcode. This operation requires the numeric Threads post ID. ### Return - Post detail data, including: - id: Post ID - text: Post text content - user: Publisher information - image_versions2: Image information - video_versions: Video information - like_count: Like count - text_post_app_info: Post app information - etc... <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_user_infoThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads user information ### Parameters - username: Username, for example: jlo, can be obtained from the user's homepage link, for example: jlo in https://www.threads.net/@jlo ### Return - User information data, including: - pk: User ID - username: Username - full_name: Full name - biography: Biography - profile_pic_url: Profile picture URL - follower_count: Follower count - is_verified: Is verified - bio_links: External links in the biography - etc... <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_user_info_by_id
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_user_info_by_idThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads user information by user ID ### Parameters - user_id: User ID, for example: 67027868801, can be obtained from user profile API or post data ### Return - User information data, including: - pk: User ID - username: Username - full_name: Full name - biography: Biography - profile_pic_url: Profile picture URL - follower_count: Follower count - is_verified: Is verified - bio_links: External links in the biography - etc... <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_user_postsThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads user's post list ### ⚠️ No pagination - A single call returns all available data (~25 items). There is no way to fetch more. - The `end_cursor` parameter is reserved and currently has no effect — do not rely on it. ### Parameters - user_id: User ID, for example: 63625256886, can be obtained from user profile API - end_cursor: Pagination cursor. No pagination supported; passing it has no effect ### Return - User post list data, including: - threads: Post list array - next_cursor: Next page cursor (always null) - has_more: Has more data - Each post contains: - id: Post ID - text: Post text content - user: Publisher information - image_versions2: Image information - video_versions: Video information - like_count: Like count - text_post_app_info: Post app information - etc... <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_user_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_user_repliesThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads user's reply list ### ⚠️ No pagination - A single call returns all available data (~25 items). There is no way to fetch more. - The `end_cursor` parameter is reserved and currently has no effect — do not rely on it. ### Parameters - user_id: User ID, for example: 63625256886 - end_cursor: Pagination cursor. No pagination supported; passing it has no effect ### Return - User reply list data, including: - threads: Reply list - next_cursor: Next page cursor (always null) - has_more: Has more data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads fetch_user_reposts
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/fetch_user_repostsThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get Threads user's repost list ### ⚠️ No pagination - A single call returns all available data (~25 items). There is no way to fetch more. - The `end_cursor` parameter is reserved and currently has no effect — do not rely on it. ### Parameters - user_id: User ID, for example: 63625256886 - end_cursor: Pagination cursor. No pagination supported; passing it has no effect ### Return - User repost list data, including: - threads: Repost list - next_cursor: Next page cursor (always null) - has_more: Has more data <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
threads search_profiles
$MeteredGET https://aisa.one/apis/v1/tikhub/threads/web/search_profilesThreads (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search Threads user profiles ### Parameters - query: Search query, for example: mark ### Return - Search result data, including: - users: User list - Each user contains: - pk: User ID - username: Username - full_name: Full name - profile_pic_url: Profile picture URL - is_verified: Is verified - follower_count: Follower count - etc... <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_ad_interactive_analysis
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_interactive_analysisTikTok (ads). ### Purpose - Get ad interactive time analysis to understand audience retention and engagement at different video time points - Analyze ad video attractiveness curve to find optimal duration and key interaction points - Optimize ad content structure to improve overall effectiveness ### Parameters - material_id: Ad material ID, required parameter - metric_type: Analysis type - ctr: Click-through rate analysis - cvr: Conversion rate analysis - clicks: Click count analysis - conversion: Conversion count analysis - remain: Retention rate analysis (default) - period_type: Time range, default 180 days - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Return Description - `interactive_data`: Interactive analysis data - `time_series`: Time series data - `time`: Video playback time point (seconds) - `value`: Corresponding metric value (e.g., retention rate) - `average_watch_time`: Average watch time - `completion_rate`: Completion rate - `peak_interaction_time`: Peak interaction time point <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_ad_keyframe_analysis
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_keyframe_analysisTikTok (ads). ### Purpose - Get keyframe analysis of ad videos to understand audience retention at different time points - Analyze which time points attract viewers most and where viewers drop off - Help optimize ad video structure to improve completion rates ### Parameters - material_id: Ad material ID, required parameter - metric: Analysis metric, options: - retain_ctr: Retention CTR (default) - retain_cvr: Retention CVR - click_cnt: Click count - convert_cnt: Conversion count - play_retain_cnt: Play retention count - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Return Description - `keyframe_data`: Keyframe data - `time_points`: List of time points (seconds) - `retention_rates`: Retention rates at corresponding time points (percentage) - `drop_points`: Time points with high drop-off rates - `highlight_points`: Time points with high viewer interest <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_ad_percentile
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_ad_percentileTikTok (ads). ### Purpose - Get ad percentile ranking data within the industry - Understand ad performance levels relative to peers across various metrics - Help evaluate ad effectiveness and develop optimization strategies ### Parameters - material_id: Ad material ID, required parameter - metric: Analysis metric, options: - ctr_percentile: CTR percentile (default) - time_attr_conversion_rate_percentile: Time-attributed conversion rate percentile - click_cnt_percentile: Click count percentile - time_attr_convert_cnt_percentile: Time-attributed conversion count percentile - show_cnt_percentile: Impression count percentile - period_type: Time period in days, default 180 - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Return Description - `percentile_data`: Percentile data - `ctr_percentile`: Click-through rate percentile (0-100) - `cvr_percentile`: Conversion rate percentile - `engagement_percentile`: Engagement rate percentile - `view_percentile`: View count percentile - `industry_average`: Industry average comparison <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_ads_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_ads_detailTikTok (ads). ### Purpose - Retrieve detailed information about a single TikTok ad, including creative content, creator info, and engagement data - Analyze ad performance metrics such as views, likes, comments, and other core statistics - Help advertisers and marketers gain deep insights into specific ad effectiveness and user feedback ### Parameters - ads_id: Ad ID, required parameter, can be obtained from ad lists or TikTok Ads Creative Center - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Return Description - `ad_title`: Ad title - `brand_name`: Brand name - `comment`: Comment count - `cost`: Cost level (1-5) - `country_code`: List of target country codes - `ctr`: Click-through rate (percentage) - `favorite`: Whether favorited - `has_summary`: Whether has summary - `highlight_text`: Highlight text - `id`: Ad ID - `industry_key`: Industry label - `is_search`: Whether from search results - `keyword_list`: List of keywords - `landing_page`: Landing page URL - `like`: Like count - `objective_key`: Ad objective key - `objectives`: List of ad objectives - `label`: Objective label - `value`: Objective value - `pattern_label`: List of pattern labels - `share`: Share count - `source`: Source - `source_key`: Source key value - `tag`: Tag - `video_info`: Video information - `vid`: Video ID - `duration`: Duration (seconds) - `cover`: Cover image URL - `video_url`: Video playback URLs - `720p`: 720p quality video URL - `width`: Video width - `height`: Video height - `voice_over`: Whether has voice over <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_configure_safety
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_configure_safetyTikTok (ads). ### Purpose - Get the safety/availability config switches of TikTok Creative Center search modules - Check whether top ads, keyword, hashtag, sound, creator searches are currently available ### Parameters - Root JSON body: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Return Description - `top_ads_search`: Top ads search switch (0/1) - `keyword_search`: Keyword search switch (0/1) - `hashtag_search`: Hashtag search switch (0/1) - `sound_search`: Sound search switch (0/1) - `creator_search`: Creator search switch (0/1) - `cc_banner_key`: Banner config key ### Request body Send the cookie value as a JSON string at the root of the request body. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_creators_card
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_creators_cardTikTok (ads). ### Purpose - Batch fetch creator cards including audience profile, follower growth, overall performance and recent posts - Pairs with the Top Contents ranking to analyze the creators behind trending videos ### Parameters - tt_uids: Creator ID list, obtained from `itemInfo.creatorID` of /tikhub/tiktok/ads/get_top_contents_list, multiple IDs allowed - need_loader_list: Data module IDs to return, omit for all. Options: - `101`: Creator basic info - `102`: Quote and price index - `103`: Creator basic info - `104`: Statistics (audience profile / follower trend / overall performance / video performance) - `105`: Recent posts - `106`: Creator marketplace status - `107`: Content labels - `125`: Creator type and display info - creator_type: Creator type, default 2 - cookie: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Request Example ```json { "tt_uids": ["103641138313531392"], "need_loader_list": [101, 104, 105], "creator_type": 2 } ``` ### Return Description - `creators`: Creator card list; returned fields depend on need_loader_list (ttUID / creatorTTInfo / statisticData / recentItems / contentLabels / creatorProfile / priceIndex / esData) API references: `get_top_contents_list` = `POST /tikhub/tiktok/ads/get_top_contents_list` (operationId: `post_tikhub_tiktok_ads_get_top_contents_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_location_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_location_listTikTok (ads). ### Purpose - Get the list of countries/regions supported by TikTok Creative Center - Useful as a reference for the country_code parameter of other endpoints ### Parameters - Root JSON body: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Return Description - `country`: Country/region list, each item contains: - `id`: Country/region code (e.g. US, JP) - `value`: Country/region name (e.g. United States) - `label`: Display label ### Request body Send the cookie value as a JSON string at the root of the request body. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_query_suggestions
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_query_suggestionsTikTok (ads). ### Purpose - Get popular query suggestions for ad search - Understand current popular ad search keywords and trends - Help discover new creative directions and hot topics ### Parameters - query: Leave empty for popular suggestions in scenario 1; provide a keyword for related suggestions in scenario 2 - count: Number of suggestions to return, default 50 - scenario: Scenario type: 1 for popular suggestions, 2 for related suggestions - country_code: Optional country code - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Return Description - `query`: Query suggestions list (string array) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_recommended_ads
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_recommended_adsTikTok (ads). ### Purpose - Get similar recommended ads based on a specified ad - Discover excellent ad cases in the same industry or with similar styles - Provide more references and inspiration for ad creativity ### Parameters - material_id: Reference ad material ID, required parameter - industry: Industry ID, e.g., Games: 25308000000 - country_code: Country code, e.g., US, UK, JP - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Return Description - `materials`: Recommended ad materials list - `ad_title`: Ad title - `brand_name`: Brand name - `cost`: Cost level - `ctr`: Click-through rate - `favorite`: Whether favorited - `id`: Ad ID - `industry_key`: Industry key - `is_search`: Whether search result - `like`: Like count - `objective_key`: Ad objective key - `tag`: Tag - `video_info`: Video information - `vid`: Video ID - `duration`: Duration in seconds - `cover`: Cover image URL - `video_url`: Video playback URLs - `360p`: 360p quality - `480p`: 480p quality - `540p`: 540p quality - `720p`: 720p quality - `width`: Video width - `height`: Video height <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_top_ads_filters
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_top_ads_filtersTikTok (ads). Get the countries, industries, objectives, languages, periods, and creative labels supported by Top Ads search. ### Request body Send the cookie value as a JSON string at the root of the request body. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_top_ads_spotlight
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_top_ads_spotlightTikTok (ads). ### Purpose - Get top ads spotlight for specific industries, showcasing the most popular ad cases - Analyze creative trends and excellent cases within the industry - Provide inspiration and reference for ad creative production ### Parameters - industry: Industry ID, optional, returns cross-industry list if omitted, e.g., Education: 25000000000 - page: Page number, default 1 - limit: Items per page, default 20 - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Return Description - `materials`: Ad materials list - `cost`: Cost level - `ctr`: Click-through rate - `highlight`: Highlight description - `id`: Ad ID - `like`: Like count - `video_info`: Video information - `vid`: Video ID - `duration`: Duration in seconds - `cover`: Cover image URL - `video_url`: Video playback URLs in multiple qualities - `360p`: 360p quality video URL - `480p`: 480p quality video URL - `540p`: 540p quality video URL - `720p`: 720p quality video URL - `width`: Video width - `height`: Video height - `pagination`: Pagination info - `page`: Current page - `size`: Items per page - `total`: Total count - `has_more`: Whether there are more items <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_top_contents_item_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_top_contents_item_detailTikTok (ads). ### Purpose - Get detailed data of a single video from the Top Contents ranking - Returns top comments and author profile on top of the ranking data ### Parameters - item_id: Video ID, obtained from `itemInfo.itemID` of /tikhub/tiktok/ads/get_top_contents_list - period_end_timestamp: Period end timestamp in seconds, required - Generate this value from the target ranking date; it is not returned by another endpoint - Example: `1785024000`; do not pass `0`, which returns an empty result - For period_dimension 1, pass a Sunday 00:00 UTC timestamp; other dates return no data - For period_dimension 3 or 5, any past date works - If item_id comes from /tikhub/tiktok/ads/get_top_contents_list, reuse that ranking query's timestamp - period_dimension: Period, one of 1 / 3 / 5, default 3, recommended to match the ranking query - country_code: Country code of the ranking the video belongs to, default US - cookie: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Note - Prefer passing the same country_code used for the ranking query, e.g. `TH` for a video taken from the TH ranking, to avoid an extra lookup ### Return Description - `entityInfo`: Video detail (itemInfo / itemMetrics / itemAuthorInfo / itemAuthorMetrics / contentTags / commentInfos) API references: `get_top_contents_list` = `POST /tikhub/tiktok/ads/get_top_contents_list` (operationId: `post_tikhub_tiktok_ads_get_top_contents_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_top_contents_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_top_contents_listTikTok (ads). ### Purpose - Get the Top Contents ranking from TikTok Creative Center, which always contains 100 trending videos - Filter by content category and sort by views / engagement rate / 6-second view rate for creative research ### Parameters - period_end_timestamp: Period end timestamp in seconds, required - Generate this value from the target ranking date; it is not returned by another endpoint - Example: `1785024000`; do not pass `0`, which returns an empty result - For period_dimension 1, pass a Sunday 00:00 UTC timestamp; other dates return no data - For period_dimension 3 or 5, any past date works - period_dimension: Period, default 3 - `1`: Weekly ranking - `3`: Daily ranking - `5`: Long-period ranking (covers videos over a longer time span) - country_code: Country code, default US, see /tikhub/tiktok/ads/get_location_list for options - content_label_ids: Content label IDs, comma separated (e.g. `11002,11015`), empty for all. Options: - `11001`: Nature & Animals - `11002`: Beauty & Care - `11003`: Fashion - `11004`: Music & Entertainment - `11005`: Games - `11006`: Education & Work - `11007`: Sports & Outdoor - `11008`: Creativity & Talent - `11009`: Family & Relationship - `11010`: Food & Beverage - `11011`: Vlog & Selfie - `11012`: Society - `11013`: Lifestyle & Leisure - `11014`: Vehicles & Transportation - `11015`: Technology & Finance - order_by_metric: Sorting metric, default 1 - `1`: By video views - `2`: By engagement rate - `3`: By 6-second view-through rate - organic_only: Only include organic content, default False - page: Page number, default 1 - limit: Items per page, default 20, max 100 - cookie: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Note - The ranking always holds 100 items; an out-of-range page returns error code 38014001 - The ranking covers only some countries/regions; uncovered ones return an empty `entityInfos` (a normal response, not a parameter error). As of 2026-08, `US` / `TH` / `JP` / `ID` / `VN` return data; the actual coverage follows upstream - Pass the same country_code to /tikhub/tiktok/ads/get_top_contents_item_detail when querying a video from the ranking ### Return Description - `entityInfos`: Video list (itemInfo / itemMetrics / itemAuthorInfo / itemAuthorMetrics / contentTags) - `pagination`: Pagination info (page / limit / pageCount / totalCount / hasMore) API references: `get_location_list` = `POST /tikhub/tiktok/ads/get_location_list` (operationId: `post_tikhub_tiktok_ads_get_location_list`); `get_top_contents_item_detail` = `POST /tikhub/tiktok/ads/get_top_contents_item_detail` (operationId: `post_tikhub_tiktok_ads_get_top_contents_item_detail`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_trends_hashtag_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_trends_hashtag_detailTikTok (ads). ### Purpose - Get detailed data of a single trending hashtag from the Trends section - Includes popularity curve, related videos, audience age profile, representative countries ### Parameters - hashtag_id: Hashtag ID, obtained from /tikhub/tiktok/ads/get_trends_hashtag_list - time_range: Time range in days, one of 7 / 30 / 90, default 90 (must match the hashtag's ranking range or data will be empty) - country_code: Country code, default US - cookie: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Return Description - `hashtagName`, `publishCnt`, `vv` - `popularityCurve`: Popularity trend curve (timestamp / value) - `videoList`: Related videos (coverURL / itemID / vid / videoURL) - `ageProfile`: Audience age profile (ageLevel / vvPercent) - `representativeCountryProfile`: Representative countries (countryCode / countryTgiScore) - `industryIDs`: Industry IDs API references: `get_trends_hashtag_list` = `POST /tikhub/tiktok/ads/get_trends_hashtag_list` (operationId: `post_tikhub_tiktok_ads_get_trends_hashtag_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_trends_hashtag_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/get_trends_hashtag_listTikTok (ads). ### Purpose - Get the trending hashtag ranking from the Trends section of TikTok Creative Center - Switch by country/region to discover trending topics across markets ### Parameters - time_range: Time range in days, one of 7 / 30 / 90, default 7 - country_code: Country code, default US (see /tikhub/tiktok/ads/get_location_list for options) - page: Page number, default 1 - limit: Items per page, default 20 - industry_id: First-level industry ID (optional), filters hashtags by industry; omit for all industries. Options: - 10000000000: Education - 11000000000: Vehicle & Transportation - 12000000000: Baby, Kids & Maternity - 13000000000: Financial Services - 14000000000: Beauty & Personal Care - 15000000000: Tech & Electronics - 16000000000: Appliances - 17000000000: Travel - 18000000000: Household Products - 19000000000: Pets - 20000000000: Apps - 21000000000: Home Improvement - 22000000000: Apparel & Accessories - 23000000000: News & Entertainment - 24000000000: Business Services - 25000000000: Games - 26000000000: Life Services - 27000000000: Food & Beverage - 28000000000: Sports & Outdoor - 29000000000: Health - cookie: Custom Cookie string, optional parameter, you can use your own Cookie to get more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Return Description - `items`: Hashtag list (hashtagID / hashtagName / industryIDs / popularityCurve / publishCnt / rankIndex / topCreators / vv) - `pagination`: Pagination info (page / limit / totalCount / hasMore) API references: `get_location_list` = `POST /tikhub/tiktok/ads/get_location_list` (operationId: `post_tikhub_tiktok_ads_get_location_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok search_ads
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/ads/search_adsTikTok (ads). ### Purpose - Search ads in TikTok's Creative Center with multi-dimensional filtering and sorting - Discover effective ad cases related to specific industries, keywords, or objectives - Provide reference and inspiration for ad planning and creative production ### Parameters - keyword: Search keyword, optional, returns all ads if empty - objective: Optional ad objective; omit it to include all objectives - like: Optional performance percentile; omit it to include all percentiles - period: Time period in days, e.g., 7, 30, 120, 180 days - industry: Industry ID list, multiple IDs separated by commas. Full industry ID list: https://github.com/TikHub/TikTok-Ads-Industry-Code - page: Page number, default 1 - limit: Items per page, default 20, max 50 - order_by: Sort method, "for_you"=Recommended, "likes"=Sort by likes - country_code: Country code, e.g., US, UK, JP - ad_format: Optional ad format; 1=Spark Ads, 2=Non-Spark Ads - ad_language: Optional ad language code, e.g., en, zh-Hant - duration: Optional video duration filter value - pattern_label: Optional creative pattern label - cookie: Custom Cookie string, optional parameter, can be used to fetch more data ### Note - If you've applied one or more filters and there's no result returned, try adjusting or removing some of them. The TikTok Creator dataset only includes a selection of popular records and may not contain the complete set of data. ### Common Industry ID Examples - Games: 27000000000 - E-commerce: 19000000000 - Financial Services: 30000000000 - Education: 10000000000 - Beauty & Personal Care: 22000000000 - Food & Beverage: 16000000000 ### Return Description - `materials`: List of ad materials - `id`: Ad material ID - `aweme_id`: Ad video ID - `desc`: Ad description - `create_time`: Creation time - `video_info`: Video information - `cover`: Cover image URL - `duration`: Duration in seconds - `statistics`: Statistics - `digg_count`: Number of likes - `comment_count`: Number of comments - `share_count`: Number of shares - `ads_info`: Ad information - `advertiser_name`: Advertiser name - `landing_page`: Landing page URL - `pagination`: Pagination info - `page`: Current page - `limit`: Items per page - `total`: Total count - `has_more`: Whether there are more items <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok detect_fake_views
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/analytics/detect_fake_viewsTikTok (analytics). ### Purpose - Analyze TikTok video traffic data using advanced algorithms to precisely detect potential fake views and unnatural engagement - Evaluate content authenticity and traffic quality based on TikTok's Traffic Pool theory - Provide comprehensive fraud risk analysis with in-depth assessment across 8 dimensions and 20+ metrics - Deliver professional traffic quality reports and optimization recommendations for creators, MCN agencies, and content managers ### Parameters - item_id: Video ID, required parameter, can be extracted from video URL (e.g., 7460937381265411370 from https://www.tiktok.com/@tiktok/video/7460937381265411370) - content_category: Content category, optional parameter, affects engagement rate benchmarks, options include: - default: Default category for general content - entertainment: Entertainment content, expected to have higher engagement - education: Educational content, expected to have moderate engagement and higher save rates - product: Product content, expected to have lower engagement but higher conversion - verified_large: Large verified accounts, expected to have appropriately lower engagement rates ### Return Description - `video_metrics`: Core video metrics - `total_views`: Total number of views - `total_likes`: Total number of likes - `total_comments`: Total number of comments - `total_favorites`: Total number of saves - `total_shares`: Total number of shares - `engagement_rates`: Engagement rate metrics, higher is better - `like_ratio`: Like rate, normal range 1-10%, may be lower for large accounts - `comment_ratio`: Comment rate, normal range 0.1-0.5%, excellent if above 1% - `favorite_ratio`: Save rate, normal range 0.05-0.8% - `share_ratio`: Share rate, normal range 0.05-0.5%, excellent if above 1% - `creator_metrics`: Creator account health indicators - `account_age_days`: Account age in days, longer is more credible - `follower_count`: Number of followers, affects expected view count - `verified`: Whether account is verified, verified accounts have higher credibility - `trust_score`: Account trust score (0-100), higher is more trustworthy - `content_metrics`: Content quality indicators - `content_type`: Content type (video, image, etc.) - `created_by_ai`: Whether AI-generated, AI-generated content may have specific traffic patterns - `high_quality_upload`: Whether high-quality upload, high-quality uploads are more credible - `fake_view_analysis`: Comprehensive fake traffic analysis - `fake_score`: Fake view score (0-100), lower is better: - 0-20: Very low risk, natural traffic patterns - 20-40: Low risk, may have minor anomalies but not problematic - 40-60: Medium risk, anomalies worth attention - 60-80: High risk, obvious fake traffic characteristics - 80-100: Very high risk, almost certainly fake traffic - `confidence_level`: Risk level, categorized as "Minimal", "Low", "Medium", "High" - `estimated_fake_views`: Estimated fake views, calculated based on fake traffic model - `fake_view_percentage`: Fake view percentage, proportion of fake views to total views - `is_suspicious`: Whether suspicious, comprehensive judgment if attention is needed - `main_detection_reason`: Main detection reason, most significant anomaly feature - `component_scores`: Dimensional anomaly scores, each 0-100, lower is better: - `engagement_score`: Engagement anomaly score - `distribution_score`: Distribution anomaly score - `consistency_score`: Consistency anomaly score - `creator_credibility_score`: Creator credibility anomaly score - `content_authenticity_score`: Content authenticity anomaly score - `follower_correlation_score`: Follower correlation anomaly score - `racing_mechanism_score`: Racing mechanism anomaly score - `fan_growth_score`: Fan growth anomaly score - `traffic_pool`: Traffic pool analysis (TikTok racing mechanism) - `current_tier`: Current traffic pool level (1-8), higher means more traffic - `current_tier_name`: Current traffic pool name - `expected_tier`: Expected traffic pool level, based on organic traffic prediction - `expected_tier_name`: Expected traffic pool name - `current_views_range`: Current traffic pool expected view range - `expected_views_range`: Expected traffic pool view range - `estimated_organic_views`: Estimated organic views, real views after deducting fake ones - `suspicious_features`: List of suspicious features, specific detected anomalies - `recommendations`: Recommended actions - `action`: Recommended action type, possible values include: - `no_action`: No action needed, healthy content - `monitor`: Continuous monitoring, minor anomalies present - `scheduled_review`: Schedule review, anomalies worth attention - `immediate_review`: Immediate review, serious anomalies present - `risk_level`: Risk level ("low", "medium", "high", "critical") - `potential_revenue_impact`: Potential revenue impact - `suggested_steps`: Suggested steps, specific action recommendations - `mcn_report`: (Optional) MCN business impact analysis report, applicable for business accounts - `summary`: Summary information - `business_impact`: Business impact assessment - `revenue_impact`: Revenue impact assessment - `brand_safety_impact`: Brand safety impact - `platform_relationship`: Platform relationship impact - `contract_impact`: Contract impact assessment - `recommended_actions`: Recommended action list - `historical_context`: Historical background data ### Features and Advantages - Precise evaluation system built on TikTok's native Traffic Pool theory - Comprehensive analysis across 8 dimensions and 20+ metrics, covering traffic, engagement, creator, content, etc. - Adaptive algorithm automatically adjusts thresholds based on account size, verification status, content type - Anomaly detection based on big data statistical models, accurately identifies unnatural traffic patterns - Provides customized evaluation standards for different account sizes (micro, small, medium, large, extra-large) - Delivers detailed business impact analysis and specific, actionable recommendations <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_comment_keywords
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/analytics/fetch_comment_keywordsTikTok (analytics). ### Purpose - Analyze popular keywords and topics in video comments to uncover user feedback - Extract main content and opinions from audience comments to understand viewer focus points - Support creators in optimizing content strategy and enhancing audience engagement and connection ### Parameters - item_id: Video ID, required parameter, can be obtained from video sharing links or TikTok Studio ### Return Description - `item_id`: The requested video ID - `key_words`: List of keywords extracted from comments, including: - `key_word`: Keyword text - `comments`: List of comments containing this keyword, each comment includes: - `cid`: Comment ID - `text`: Comment content - `create_date`: Comment creation timestamp - `digg_count`: Number of likes on the comment - `comment_type`: Comment type - `comment_author`: Comment author information - `uid`: User ID - `nick_name`: User nickname - `cover`: User avatar information - `url_list`: List of avatar URLs <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_info_and_milestones
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/analytics/fetch_creator_info_and_milestonesTikTok (analytics). ### Purpose - Retrieve basic information and key metrics for TikTok creator accounts - View creator growth journey and important achieved milestones - Analyze creator account development trajectory, understand follower growth and content influence changes ### Parameters - user_id: Creator user ID, required parameter, can be obtained from user profile URL or TikTok backend ### Return Description - `user_id`: The requested creator ID - `creator_info`: The creator's basic information - `nickname`: Creator's display name - `sec_user_id`: Security user ID - `unique_id`: Unique username - `avatar_url`: Profile picture URL - `follower_count`: Number of followers - `like_count`: Total number of likes received - `milestones`: List of creator account milestones, each milestone includes: - `milestone`: Milestone type ID - `milestone_title`: Milestone title (e.g., "Reached 1 million followers") - `milestone_year`: Year when the milestone was achieved - `milestone_month_day`: Month and day when the milestone was achieved - `creator_summary`: Milestone-related description <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_video_metrics
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/analytics/fetch_video_metricsTikTok (analytics). ### Purpose - Retrieve detailed analytics data for TikTok videos, including views, likes, comments, and favorites - Provide total statistics and daily trends for 14 days since the release date, facilitating video performance analysis - Help creators analyze content effectiveness, evaluate user engagement, and optimize content strategy ### Parameters - item_id: Video ID, required parameter, can be obtained from video sharing links or TikTok Studio ### Return Description - `item_id`: The requested video ID - `video_views`: Total number of video views - `value`: View count value - `video_views_14_days`: Daily view trends for the past 14 days - `interval`: Data interval type - `value`: List of daily data - `likes`: Total number of likes on the video - `value`: Like count value - `likes_14_days`: Daily like trends for the past 14 days - `comments`: Total number of comments on the video - `value`: Comment count value - `comments_14_days`: Daily comment trends for the past 14 days - `favorites`: Total number of times the video was favorited - `value`: Favorite count value - `favorites_14_days`: Daily favorite trends for the past 14 days - `video_summary`: Overview analysis of video performance - `title`: Overview title - `content`: Overview content - `summary_type`: Overview type <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok TTencrypt_algorithm
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/TTencrypt_algorithmTikTok (app/v3). ### Purpose: - TikTok APP encryption algorithm, used to generate encrypted parameters in the request header. - The generated encrypted parameter list: - `x-ladon` - `x-khronos` - `x-argus` - `x-gorgon` (8404) ### Parameters: - url: Full URL to be encrypted - data: If the interface is a POST request, please fill in the data of the POST request to participate in the encryption calculation. For GET requests, pass an empty string. - device_info: Device information, optional parameter, if not filled in, the default device information will be used, and the device information will modify the parameters in the URL passed in. ### Return: - Encrypted parameter list <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok check_live_room_online
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/check_live_room_onlineTikTok (app/v3). ### Purpose - Check if live room is online - The Room ID of the live room can be obtained from the `/tikhub/tiktok/web/get_live_room_id` interface through the live room link ### Parameters - room_id: Live room id ### Return - Whether online API references: `get_live_room_id` = `GET /tikhub/tiktok/web/get_live_room_id` (operationId: `get_tikhub_tiktok_web_get_live_room_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok check_live_room_online_batch
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/check_live_room_online_batchTikTok (app/v3). ### Purpose - Batch check TikTok live rooms' online status, supports up to 50 room IDs - Room IDs can be retrieved from `/tikhub/tiktok/web/get_live_room_id` ### Parameters - room_ids: List of TikTok live room IDs ### Return - Online status per room API references: `get_live_room_id` = `GET /tikhub/tiktok/web/get_live_room_id` (operationId: `get_tikhub_tiktok_web_get_live_room_id`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok encrypt_decrypt_login_request
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/encrypt_decrypt_login_requestTikTok (app/v3). ### Purpose: - Encrypt/decrypt the TikTok APP login request body, used for encrypting and decrypting the request body of the login interface. ### Parameters: - username: Username, can be ciphertext or plaintext. - password: Password, can be ciphertext or plaintext. - mode: Mode - `encrypt`: Encrypt - `decrypt`: Decrypt ### Return: - Encrypted/decrypted request body <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_content_translate
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_content_translateTikTok (app/v3). ### Purpose: - Get content translation data ### Parameters: - trg_lang: Target language - zh-Hans: Simplified Chinese - zh-Hant: Traditional Chinese - en: English - ja: Japanese - ko: Korean - fr: French - de: German - ru: Russian - es: Spanish - pt: Portuguese - vi: Vietnamese - th: Thai - id: Indonesian - ar: Arabic - it: Italian - tr: Turkish - he: Hebrew - pl: Polish - nl: Dutch - sv: Swedish - da: Danish - fi: Finnish - no: Norwegian - cs: Czech - hu: Hungarian - src_content: Source content, that is, the content that needs to be translated, the length does not exceed 5000 characters, if it exceeds 5000 characters, only the first 5000 characters will be translated. ### Return: - Content translation data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_info
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_creator_infoTikTok (app/v3). ### Purpose: - Get creator information, including the creator's basic information, number of fans, number of storefront products, shop live room and other information. ### Parameters: - creator_uid: Creator uid ### Return: - Creator information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_search_insights
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_creator_search_insightsTikTok (app/v3). ### Purpose: - Get creator search insights data, used to understand trending search topics and creative inspiration ### Parameters: - offset: Pagination offset, default 0 - limit: Number per page, default 20 - tab: Tab type, options: - all: All - content_gap: Content gap - follower_searched: Follower searched - life_style: Life style - topics: Topics - challenges: Challenges - sounds: Sounds - hashtags: Hashtags - language_filters: Language filters, separated by comma, options: id, de, en, es, fr, pt, vi, tr, ar, th, ja, ko - category_filters: Category filters, separated by comma, options: Gaming, Fashion, Tourism, Science, Food, Sports - creator_source: Creator source, default "general_search" - force_refresh: Force refresh, default False ### Return: - Creator search insights data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_search_insights_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_creator_search_insights_detailTikTok (app/v3). ### Purpose: - Get creator search insights detail data, used to query search statistics for specific query ### Parameters: - query_id_str: Query ID, obtained from fetch_creator_search_insights response - time_range: Time range, options: - past_7_days: Past 7 days - past_30_days: Past 30 days (default) - past_60_days: Past 60 days - past_6_months: Past 6 months - custom: Custom range (requires start_date and end_date, cannot exceed 6 months) - start_date: Start timestamp (seconds), only for custom range - end_date: End timestamp (seconds), only for custom range - dimension_list: Dimension list, separated by comma, options: gender, age, country ### Return: - Search insights detail data, including search trends, user demographics, etc. API references: `fetch_creator_search_insights` = `GET /tikhub/tiktok/app/v3/fetch_creator_search_insights` (operationId: `get_tikhub_tiktok_app_v3_fetch_creator_search_insights`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_search_insights_trend
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_creator_search_insights_trendTikTok (app/v3). ### Purpose: - Get creator search insights trend data, including search popularity by region and time ### Parameters: - query_id_str: Query ID, obtained from fetch_creator_search_insights response - from_tab_path: From tab path, default "TRENDING,TOPICS" - query_analysis_required: Whether query analysis is required, default True ### Return: - Search trend data, including regional popularity, time trends, etc. API references: `fetch_creator_search_insights` = `GET /tikhub/tiktok/app/v3/fetch_creator_search_insights` (operationId: `get_tikhub_tiktok_app_v3_fetch_creator_search_insights`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_creator_search_insights_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_creator_search_insights_videosTikTok (app/v3). ### Purpose: - Get creator search insights related videos, query popular related videos for the search term ### Parameters: - keyword: Search keyword, obtained from fetch_creator_search_insights or fetch_creator_search_insights_trend - offset: Pagination offset, default 0 - count: Number per page, default 20 ### Return: - Related popular videos list API references: `fetch_creator_search_insights` = `GET /tikhub/tiktok/app/v3/fetch_creator_search_insights` (operationId: `get_tikhub_tiktok_app_v3_fetch_creator_search_insights`); `fetch_creator_search_insights_trend` = `GET /tikhub/tiktok/app/v3/fetch_creator_search_insights_trend` (operationId: `get_tikhub_tiktok_app_v3_fetch_creator_search_insights_trend`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_general_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_general_search_resultTikTok (app/v3). ### Purpose: - Get comprehensive search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset - count: Number - sort_type: 0-Relatedness, 1-Most likes - publish_time: 0-Unlimited, 1-Last day, 7-Last week, 30-Last month, 90-Last three months, 180-Last half year ### Return: - Comprehensive search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_hashtag_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_hashtag_detailTikTok (app/v3). ### Purpose: - Get details of specified hashtag ### Parameters: - ch_id: Hashtag id - region: Region, supports US, GB, FR, JP, VN, SG, default US ### Return: - Hashtag details data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_hashtag_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_hashtag_search_resultTikTok (app/v3). ### Purpose: - Get hashtag search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset - count: Number ### Return: - Hashtag search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_hashtag_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_hashtag_video_listTikTok (app/v3). ### Purpose: - Get video list of specified hashtag ### Parameters: - ch_id: Hashtag id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number - region: Region, supports US, GB, FR, JP, VN, SG, default US ### Return: - Hashtag video list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_home_feed
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_home_feedTikTok (app/v3). ### Purpose: - Get home feed(recommend) video data ### Parameters: - cookie: User's own cookie, optional parameter, used for personalized recommendation of interface returned data. ### Return: - Video recommend data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_daily_rank
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_live_daily_rankTikTok (app/v3). ### Purpose: - Get live daily rank data ### Parameters: - anchor_id: Anchor id, which can be obtained from the live room information interface, use the default value, this parameter will affect the returned data, you can try different anchor ids of different live rooms. - room_id: Live room id, which can be obtained from the live room information interface, use the default value, this parameter will affect the returned data, you can try different room ids of different live rooms. - rank_type: Rank type, parameter values are as follows: | type | rankName | Group Type | Description | |------|----------|------------|-------------| | 0 | `hourly_rank` | GIFT_RANK | Hourly Rank | | 1 | `weekly_rank` | GIFT_RANK | Weekly Rank | | 5 | `rookie_star_rank` | GIFT_RANK | Rookie Star Rank | | 6 | `sale_rank` | E_COMMERCE | Sale Rank | | 8 | `daily_rank` | GIFT_RANK | Daily Rank | | 10 | `weekly_game_rank` | GAME_RANK | Weekly Game Rank | | 11 | `daily_game_rank` | GAME_RANK | Daily Game Rank | | 12 | `hall_of_fame_rank` | GIFT_RANK | Hall of Fame Rank | | 13 | `champion_tournament` | GIFT_RANK | Champion Tournament (includes phase_one/two/three) | | 14 | `daily_rookie_star_rank` | GIFT_RANK | Daily Rookie Star Rank | | 15 | `fans_team_rank` | GIFT_RANK | Fans Team Rank | | 16 | `ranking_league` | GIFT_RANK | Ranking League (App display: D5 Level Rank) | | 20 | `pubg` | GAME_RANK | PUBG Rank | | 21 | `mlbb` | GAME_RANK | MLBB Rank (Mobile Legends: Bang Bang) | | 22 | `free_fire` | GAME_RANK | Free Fire Rank | | 23 | `sub_weekly_game_rank1` | GAME_RANK | Sub Weekly Game Rank 1 | | 24 | `sub_weekly_game_rank2` | GAME_RANK | Sub Weekly Game Rank 2 | | 25 | `sub_weekly_game_rank3` | GAME_RANK | Sub Weekly Game Rank 3 | | 26 | `collectibles` | E_COMMERCE | Collectibles Rank | | 27 | `beauty` | E_COMMERCE | Beauty Rank | | 28 | `women_wear` | E_COMMERCE | Women Wear Rank | | 29 | `sale_rank_daily` | E_COMMERCE | Daily Sale Rank | | 1001 | `league_campaign_rank` | GIFT_RANK | League Campaign Rank | | -1 | `unknown` | DEFAULT | Unknown | - region_type: Region type, use the default value, the specific meaning is unknown. - gap_interval: Time interval, use the default value to represent the current day, use -1 to represent the ranking record. - cookie: User's own cookie, optional parameter, used when the interface is not available. ### Return: - Live daily rank data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_ranking_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_live_ranking_listTikTok (app/v3). ### Purpose: - Get ranking list of audience in live room ### Parameters: - room_id: Live room id - anchor_id: Anchor id ### Return: - Ranking list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_room_info
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_live_room_infoTikTok (app/v3). ### Purpose: - Get data of specified live room ### Parameters: - room_id: Live room id ### Return: - Live room data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_room_product_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_live_room_product_listTikTok (app/v3). ### Purpose - Get live room product list data ### Parameters - room_id: Live room id, required parameter. - author_id: Anchor id, required parameter. - page_size: Number per page, optional parameter, default is 15. - offset: Page turning cursor, optional parameter, default is 0, increasing by 15 each time. - region: Region, optional parameter, default is `US`, if you use other regions, such as: `VN`, please bring your own Cookie, otherwise you will not be able to get data. - cookie: User's own cookie, optional parameter, used to crawl data from regions other than `US`. ### Get Parameters - Step 1: Use the interface `f"{API_Base_URL}/tikhub/tiktok/web/get_live_room_id"` to get the live room id (room_id). - Step 2: Use the interface `f"{API_Base_URL}/tikhub/tiktok/app/v3/fetch_live_room_info"` to get the live room information. - Step 3: Use the JSONPATH in the JSON data returned in the second step to get the value of the field `$.data.data.owner.id_str` as the anchor id (author_id). ### Return - Live room product list data API references: `fetch_live_room_info` = `GET /tikhub/tiktok/app/v3/fetch_live_room_info` (operationId: `get_tikhub_tiktok_app_v3_fetch_live_room_info`); `get_live_room_id` = `GET /tikhub/tiktok/web/get_live_room_id` (operationId: `get_tikhub_tiktok_web_get_live_room_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_live_search_resultTikTok (app/v3). ### Purpose: - Get live search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset, starting from 0, the second page gets the cursor value from the response as the offset to continue the request. - count: Number, do not exceed 20 - region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes. ### Return: - Live search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_location_search
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_location_searchTikTok (app/v3). ### Purpose: - Get location search results ### Parameters: - keyword: Keyword - offset: Offset - count: Number ### Return: - Location search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_multi_video
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_multi_videoTikTok (app/v3). ### Purpose - Batch Get Video Information, support photo, video, etc., up to 10 videos at a time. - If this interface reports an error, please use the fetch_multi_video_v3 interface. ### Parameters - Root JSON body: List of video ids, up to 10 video ids are supported. ### Return - Video data ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_music_chart_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_music_chart_listTikTok (app/v3). ### Purpose: - Get TikTok music chart list data ### Parameters: - scene: Chart type - 0: Top 50 (Popular top 50) - 1: Viral 50 (Viral top 50) - cursor: Pagination cursor, default 0 - count: Number per page, default 50, max 50 ### Return: - Music chart data, including song info, ranking changes, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_music_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_music_detailTikTok (app/v3). ### Purpose: - Get details of specified music ### Parameters: - music_id: Music id ### Return: - Music details data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_music_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_music_search_resultTikTok (app/v3). ### Purpose: - Get music search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset, starting from 0, the second page gets the cursor value from the response as the offset to continue the request. - count: Number, do not exceed 20 - filter_by: Filter type, 0-All, 1-Title, 2-Author, default is 0-All - sort_type: Sort type, 0-Relatedness, 1-Most used, 2-Latest, 3-Shortest duration, 4-Longest duration, default is 0-Relatedness - region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes. ### Return: - Music search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_music_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_music_video_listTikTok (app/v3). ### Purpose: - Get video list of specified music ### Parameters: - music_id: Music id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number ### Return: - Music video list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_one_videoTikTok (app/v3). ### Purpose: - Get single video data ### Parameters: - aweme_id: Video id ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_one_video_by_share_url
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_one_video_by_share_url_v2TikTok (app/v3). ### Purpose: - Get single video data by sharing link V2, the data structure will be a bit different, and the region field will be returned. ### Parameters: - share_url: Share link ### Return: - Video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_share_qr_code
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_share_qr_codeTikTok (app/v3). ### Purpose: - Get share QR code ### Parameters: - object_id: Object id, currently supports the uid in the response of the personal homepage interface as a parameter. ### Return: - QR code image <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_share_short_link
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_share_short_linkTikTok (app/v3). ### Purpose: - Get share short link ### Parameters: - url: Long link or link to convert ### Return: - Short link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_similar_user_recommendations
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_similar_user_recommendationsTikTok (app/v3). ### Purpose: - Similar User Recommendations ### Parameters: - sec_uid: User sec_uid - page_token: Page token, not required for the first request, for subsequent requests, pass the next_page_token value from the previous response. ### Return: - Similar User Recommendations <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_country_by_username
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_country_by_usernameTikTok (app/v3). ### Purpose: - Get user account country by username ### Parameters: - username: Username, which can be obtained from the user's homepage link, for example: https://www.tiktok.com/@tiktok, the username is tiktok. ### Return: - User account country <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_follower_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_follower_listTikTok (app/v3). ### Purpose: - Get follower list of specified user ### Parameters: - user_id: User ID, this is a pure numeric version of the user ID (one of user_id and sec_user_id) - sec_user_id: User sec_user_id, this is a mixed letter and number version ID (one of user_id and sec_user_id) - count: Number, do not exceed 20, keep it fixed. - min_time: Minimum time for paging, use default value 0 for the first request, and use the min_time value returned by the last request for subsequent requests. - page_token: Page token, use default value "" for the first request, and use the page_token value returned by the last request for subsequent requests. ### Return: - Follower list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_following_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_following_listTikTok (app/v3). ### Purpose: - Get following list of specified user ### Parameters: - user_id: User ID, this is a pure numeric version of the user ID (one of user_id and sec_user_id) - sec_user_id: User sec_user_id, this is a mixed letter and number version ID (one of user_id and sec_user_id) - count: Number, do not exceed 20, keep it fixed. - min_time: Minimum time for paging, use default value 0 for the first request, and use the min_time value returned by the last request for subsequent requests. - page_token: Page token, use default value "" for the first request, and use the page_token value returned by the last request for subsequent requests. ### Return: - Following list data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_like_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_like_videosTikTok (app/v3). ### Purpose - Get user like video data ### Parameters - sec_user_id: User sec_user_id - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response. - counts: Maximum count number ### Return - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_music_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_music_listTikTok (app/v3). ### Purpose: - Get user music list data ### Parameters: - sec_uid: User sec_uid - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_post_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_post_videosTikTok (app/v3). ### Purpose: - Get user homepage video data ### Parameters: - sec_user_id: User sec_user_id, use sec_user_id to get user video data first, if sec_user_id is empty, use unique_id to get user video data. - max_cursor: Maximum cursor, used for paging, the first page is 0, the second page is the max_cursor value in the first response. - count: Maximum count number - sort_type: Sort type, 0-Latest, 1-Hot - unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user video data, unique_id is also the user's username. - About the parameters of user ID, the priority is sec_user_id > unique_id, the higher the priority, the faster the speed, and it is recommended to use only sec_user_id to get user data. - region: Region, optional parameter, if not passed, the US region data will be used by default. After passing, the data of the corresponding country and region will be preferred, for example: US, GB, FR, JP, SG, VN, etc. ### Return: - User video data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_repost_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_repost_videosTikTok (app/v3). ### Purpose: - Get user repost video data ### Parameters: - user_id: User id, which can be obtained through the handler_user_profile endpoint, with the keyword uid in the response. - offset: Offset - count: Number ### Return: - User repost video data API references: `handler_user_profile` = `GET /tikhub/tiktok/app/v3/handler_user_profile` (operationId: `get_tikhub_tiktok_app_v3_handler_user_profile`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_user_search_resultTikTok (app/v3). ### Purpose: - Get user search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset - count: Number - user_search_follower_count(Sort by number of followers): - Empty-Unlimited, - ZERO_TO_ONE_K = 0-1K, - ONE_K_TO_TEN_K-1K = 1K-10K, - TEN_K_TO_ONE_H_K = 10K-100K, - ONE_H_K_PLUS = 100K and above - user_search_profile_type(Sort by account type): - Empty-Unlimited, - VERIFIED = Verified user - user_search_other_pref(Sort by other preferences): - USERNAME = Sort by username relevance ### Return: - User search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_video_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_video_comment_repliesTikTok (app/v3). ### Purpose: - Get comment replies data of specified video ### Parameters: - item_id: Video id - comment_id: Comment id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number ### Return: - Comment replies data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_video_commentsTikTok (app/v3). ### Purpose: - Get single video comments data ### Parameters: - aweme_id: Video id - cursor: Cursor, used for paging, the first page is 0, the second page is the cursor value in the first response. - count: Number ### Return: - Comments data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_video_search_result
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_video_search_resultTikTok (app/v3). ### Purpose: - Get video search results of specified keywords ### Parameters: - keyword: Keyword - offset: Offset - count: Number - sort_type: 0-Relatedness, 1-Most likes - publish_time: 0-Unlimited, 1-Last day, 7-Last week, 30-Last month, 90-Last three months, 180-Last half year - region: Region, default is US-America, for optional values please refer to TikTok region codes or ISO 3166-1 alpha-2 country codes. ### Return: - Video search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_webcast_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/fetch_webcast_user_infoTikTok (app/v3). ### Purpose: - Get information of specified user ### Parameters: - sec_user_id: User sec_user_id - user_id: User uid, optional parameter, pure number, if used, please keep sec_user_id and unique_id empty. - At least one of the above parameters must be filled in, the priority is sec_user_id > user_id, the higher the priority, the faster the speed. ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_user_id_and_sec_user_id_by_username
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/get_user_id_and_sec_user_id_by_usernameTikTok (app/v3). ### Purpose: - Get user_id and sec_user_id by Username ### Parameters: - username: Username ### Return: - User user_id and sec_user_id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok handler_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/handler_user_profileTikTok (app/v3). ### Purpose: - Get information of specified user ### Parameters: - sec_user_id: User sec_user_id - user_id: User uid, optional parameter, pure number, if used, please keep sec_user_id and unique_id empty. - unique_id: User unique_id, optional parameter, if sec_user_id is empty, use unique_id to get user information, unique_id is also the user's username, if used, please keep sec_user_id and user_id empty. - At least one of the above parameters must be filled in, the priority is sec_user_id > user_id > unique_id, the higher the priority, the faster the speed. ### Return: - User information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok open_tiktok_app_to_keyword_search
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/open_tiktok_app_to_keyword_searchTikTok (app/v3). ### Purpose: - Generate TikTok share link, call TikTok APP, and jump to the specified keyword search result ### Parameters: - keyword: Keyword - Note: If you cannot jump, please make sure that the APP is running in the background ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok open_tiktok_app_to_send_private_message
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/open_tiktok_app_to_send_private_messageTikTok (app/v3). ### Purpose: - Generate TikTok share link, call TikTok APP, and send private messages to specified users ### Parameters: - uid: User id, obtained from the user profile interface. - Note: If you cannot jump, please make sure that the APP is running in the background. ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok open_tiktok_app_to_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/open_tiktok_app_to_user_profileTikTok (app/v3). ### Purpose: - Generate TikTok share link, call TikTok APP, and jump to the specified user profile ### Parameters: - uid: User id, obtained from the user profile interface. - Note: If you cannot jump, please make sure that the APP is running in the background. ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok open_tiktok_app_to_video_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/open_tiktok_app_to_video_detailTikTok (app/v3). ### Purpose: - Generate TikTok share link, call TikTok APP, and jump to the specified video ### Parameters: - aweme_id: Video id - Note: If you cannot jump, please make sure that the APP is running in the background ### Return: - Share link <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok search_follower_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/search_follower_listTikTok (app/v3). ### Purpose: - Search follower list of specified user, can be used to find whether there is a user with a specific nickname in the followers of a certain user. ### Parameters: - user_id: User ID, this is a pure numeric version of the user ID, which can be obtained through the get user info API. - keyword: Search keyword, the user's nickname contains the keyword to match. ### Return: - Search result list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok search_following_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/app/v3/search_following_listTikTok (app/v3). ### Purpose: - Search following list of specified user, can be used to find whether there is a user with a specific nickname in the following of a certain user. ### Parameters: - user_id: User ID, this is a pure numeric version of the user ID, which can be obtained through the get user info API. - keyword: Search keyword, the user's nickname contains the keyword to match. ### Return: - Search result list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_account_health_status
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_account_health_statusTikTok (creator). ### Purpose: - Retrieve the health status of a TikTok Shop creator account, including the health score over the past 90 days and the current number of accumulated violation points. - About violation points: - Violation points are key metrics used by TikTok to measure the health of a creator account. - Higher violation points indicate worse account health, and may lead to restrictions such as reduced exposure, suspension, or account bans. - Violation points directly impact the account’s visibility and recommendation on the platform. ### Punishment Levels for Accumulated Violation Points: | Score Range | Punishment Measures | Duration | | ----------- | ---------------------------------------------------------- | ---------------- | | 9-11 | Warning | None | | 12-14 | E-commerce permissions suspended (video, live, product showcase) | 24 hours | | 15-17 | E-commerce permissions suspended | 48 hours | | 18-20 | E-commerce permissions suspended | 72 hours | | 21-23 | E-commerce permissions suspended | 1 week | | 24+ | Permanent removal of e-commerce permissions and banning of TikTok Shop creator account | Permanently disabled | ### Notes: - This API is only applicable to TikTok Shop creator accounts. ### Parameters: - cookie: User Cookie string for authentication - proxy: Optional HTTP proxy address, can be omitted if not needed - Example format: `http://username:password@host:port` ### Response: - `risk_info`: Account health status: - `risk_level_text`: Current health level description (e.g., Healthy) - `light_color`: Light color code for health level display (RGBA format) - `dark_color`: Dark color code for health level display (RGBA format) - `vio_score_rule_learn_url`: URL to learn more about violation point rules - `is_show_score`: Whether to display violation points (boolean) - `violation_score`: Current violation score - `creator_status`: Creator account status code (0 = normal) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_account_insights_overview
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_account_insights_overviewTikTok (creator). ### Purpose: - Retrieve performance overview of a TikTok Shop creator account within a specified date range, including metrics like revenue, exposure, clicks, and orders. - By default, it aggregates data from the month of `start_date` (e.g., if `start_date` is 2025-04-01, it retrieves data for the entire month of April). ### Notes: - This API is only applicable to TikTok accounts that have TikTok Shop enabled. - Data is segmented by time granularity (daily/monthly), and can be used for performance analysis or trend monitoring. ### Parameters: - cookie: User cookie string for authentication - start_date: Query start date in 'MM-DD-YYYY' format, e.g. '04-01-2025' - proxy: Optional HTTP proxy address. Leave empty if not needed. - Example format: `http://username:password@host:port` ### Response: - `segments`: List of data segments, each containing: - `time_selector`: Time settings for the segment, including period, timestamp range, timezone, and locale - `timed_stats`: Daily or interval-based statistics, including: - `live_revenue.amount`: Revenue from livestream sales - `video_revenue.amount`: Revenue from video sales - `revenue.amount`: Total revenue (live + video) - `base_revenue.amount`: Base revenue - `commission_estimated.amount`: Estimated commission - `alc_base_revenue.amount`: Base revenue under ALC model - `overall_item_sold_cnt`: Total items sold - `product_show_cnt`: Product exposure count - `product_click_cnt`: Product click count - `alc_pay_sku_order_cnt`: Orders under ALC model - `meta.is_bound_shop`: Whether the TikTok account is bound to a shop <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_account_violation_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_account_violation_listTikTok (creator). ### Purpose: - Retrieve the violation history of a TikTok Shop creator account, providing details about past violations and corresponding enforcement actions. - The returned violation records include violation type, violation time, violation reasons, enforcement actions, appeal status, and eligibility for appeal. - Pagination is supported to retrieve multiple records in chronological order. - Suitable for creator account risk management, health monitoring, and compliance auditing. ### Notes: - This API is available only for TikTok Shop creator accounts. - Pagination is supported; by default, it retrieves the latest violation records. ### Parameters: - cookie: User's Cookie string for authentication - page: Integer, page number (default is `1`) - proxy: Optional HTTP proxy address, can be omitted if not needed - Example format: `http://username:password@host:port` ### Response: - `records`: List of violation records: - `record_id`: Unique ID of the violation record - `violation_time`: Time when the violation occurred (Unix timestamp) - `violation_info`: - `violation_reason`: Reason for the violation - `violation_detail`: Detailed description (may be empty) - `violation_suggestion`: Recommended corrective action - `policy_url`: Link to the related policy - `violation_type`: Type of violation (e.g., Video violation) - `record_status`: Record status (1 = active) - `appeal_status`: Appeal status (0 = not appealed, 1 = appealed) - `enforcement_title`: List of enforcement actions taken (e.g., point assignment, commission withholding) - `appeal_valid_time`: Deadline for submitting an appeal (Unix timestamp) - `can_appeal`: Whether the record is eligible for appeal (boolean) - `total`: Total number of violation records - `has_more`: Whether there are more records to fetch - `start_time`: Query start time - `end_time`: Query end time - `creator_status`: Creator account status code (e.g., 0 = normal) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_creator_account_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_creator_account_infoTikTok (creator). ### Purpose: - Retrieve basic information of a TikTok Shop creator account, including username, avatar URLs, account ID, register region, partner binding info, and permission list. - Useful for verifying account status, displaying user profile data, checking partner binding status, and determining access permissions for business processes. ### Notes: - Applicable to all TikTok creator accounts. ### Parameters: - cookie: User Cookie string for authentication - proxy: Optional HTTP proxy address, can be omitted if not used - Example format: `http://username:password@host:port` ### Return Content Description: - `user_id`: User ID (string) - `user_type`: User type (integer, indicates account type) - `register_region_id`: Registered region code (e.g., "us") - `user_name`: Username - `avatar`: Avatar info object - `uri`: Avatar resource URI - `url_list`: List of avatar image URLs - `permission_list`: Permission list (list of integers) - `partner_id`: Partner ID - `partner_name`: Partner name - `shop_account_official`: Whether it's an official shop account (boolean) - `switch_info`: Feature switch info (e.g., live event switch, string format) - `tt_uid`: TikTok UID (string) - `nick_name`: Nickname - `live_streamer_menu_experiment`: Live streamer menu experiment field (string, may be empty) - `experiment_variants`: Experiment variant configurations (object) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_live_analytics_summary
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_live_analytics_summaryTikTok (creator). ### Purpose: - Retrieve a summary of live streaming performance for a TikTok Shop creator account within a specified time range. - By default, it covers one full calendar month starting from the provided `start_date` (e.g., input `04-01-2025` will fetch data for the entire April 2025). ### Response Fields: - `segments` (List of segmented data): - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale) - `filter.creator_id`: Creator ID - `timed_stats`: Live performance statistics per time segment, including: - `live_revenue.amount`: Live streaming revenue - `live_show_gpm.amount`: Average revenue per live show - `new_follower_cnt`: Number of new followers - `sku_order_paid_cnt`: Number of SKUs paid - `item_sold_cnt`: Number of items sold - `product_view`: Number of product views - `product_click`: Number of product clicks - `live_pay_order_ucnt`: Number of unique users who placed live orders - `live_ctr`: Live Click-Through Rate (CTR) - `live_co`: Live Conversion Rate (CO) - `live_like_cnt`: Number of live likes - `live_comment_cnt`: Number of live comments - `live_show_cnt`: Number of live sessions - `live_watch_cnt`: Number of live viewers ### Notes: - This API is only applicable to TikTok Shop creator accounts. - Data is split by natural days during the live sessions. ### Parameters: - cookie: User Cookie string for authentication - start_date: Query start date in the format `MM-DD-YYYY`, e.g., `04-01-2025` - proxy: Optional HTTP proxy address, can be omitted if not used - Example format: `http://username:password@host:port` ### Return: - Creator live streaming performance overview <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_product_analytics_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_product_analytics_listTikTok (creator). ### Purpose: - Retrieve the list of products promoted by a TikTok Shop creator account within a specified time range, along with their sales analytics. - Supports sorting by revenue or product publish time and allows pagination. ### Response Fields: - `segments` (List of segmented data): - `filter.creator_id`: Creator account ID - `list_control`: - `rules`: Sorting rules (e.g., by revenue, by product ID) - `next_pagination`: Pagination info (has more pages, next page number, total pages, total records) - `timed_lists`: List of product statistics within each time range, including: - `product`: - `id`: Product ID - `name`: Product title - `cover_image.thumb_url_list`: List of product thumbnail URLs - `item_sold_cnt`: Number of items sold - `revenue.amount`: Total Gross Merchandise Value (GMV) generated by the product - `commission.amount`: Estimated commission income from the product ### Notes: - This API is only available for TikTok Shop creator accounts. - Data is aggregated by natural month or the customized date range. - Default sorting is by GMV in descending order. ### Parameters: - cookie: User Cookie string for authentication - start_date: Start date, formatted as 'YYYY-MM-DD', e.g., '2025-04-01' - end_date: End date, formatted as 'YYYY-MM-DD', e.g., '2025-05-01' - page: Page number, default is the first page `0` - proxy: Optional HTTP proxy address, can be omitted if not used - Example format: `http://username:password@host:port` ### Return: - Creator product list and corresponding sales analytics data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_product_related_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_product_related_videosTikTok (creator). ### Purpose - Retrieve the list of all videos associated with a specified product along with their interaction metrics (such as like count, comment count, share count). - Useful for analyzing the promotional effectiveness and differences of the same product across different creators' videos. - Supports time-based filtering, defaulting to the calendar month of the specified start_date. ### Notes - Requires both item_id (current video ID) and product_id (product ID). - Returns a list of other videos where the same product is featured. ### Return Description - `segments`: - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp) - `filter`: Query conditions (creator_id, product_id, item_id) - `timed_lists`: List of related videos - `start_timestamp`: Start timestamp - `end_timestamp`: End timestamp - `stats`: - `video_product_id`: Product ID - `video`: - `item_id`: Video ID - `video_id`: Video internal ID - `name`: Video caption/title - `publish_time`: Publish timestamp - `duration`: Video duration (seconds) - `video_play_info`: - `post_url`: Video cover image link - `video_infos.main_url`: Main video URL - `video_like_cnt`: Like count - `video_comment_cnt`: Comment count - `video_share_cnt`: Share count ### Example Request Body ```json { "cookie": "your_cookie", "start_date": "04-01-2025", "item_id": "7496499484705246507", "product_id": "1731050202505515549" } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_showcase_product_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_showcase_product_listTikTok (creator). ### Purpose - Retrieve the list of products currently displayed in a TikTok Shop creator's showcase. - Useful for product management, analytics, and monitoring promoted items. ### Notes - Only available for TikTok creator accounts with the showcase feature enabled. - Supports pagination via `count` and `offset`. ### Parameters - cookie: User Cookie string for authentication - count: Number of products per page (default 20) - offset: Pagination offset (default 0) - proxy: Optional HTTP proxy address - Example: `http://username:password@host:port` ### Return Structure - `products` (List[Dict]): List of showcased products, including: - `product_id`, `title`, `format_available_price`, `seller_info`, `cover`, `images`, `source`, `stock_status`, `review_status`, `affiliate_info`, `category_info`. ### Example Request ```json { "cookie": "your_cookie_string", "count": 20, "offset": 0 } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_analytics_summary
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_analytics_summaryTikTok (creator). ### Purpose: - Retrieve a video performance overview for a TikTok Shop creator account over a specified time range. - By default, the API fetches data for the past 30 days (or full calendar month based on the platform settings). - Useful for analyzing metrics like video count, views, new followers, and generated GMV. ### Response Fields: - `segments` (List of segmented data): - `time_selector`: Time period settings (period, start/end timestamps, timezone, locale) - `filter.creator_id`: Creator account ID - `timed_stats`: Video performance statistics for each time segment, including: - `vv_cnt`: Video Views Count - `new_follower_cnt`: Number of new followers - `video_cnt`: Number of videos published - `gmv.amount`: Gross Merchandise Value generated by videos - `items_sold`: Number of items sold ### Notes: - This API is only available for TikTok Shop creator accounts. - If no data is available for a time segment, the `stats` field might be an empty `{}`. ### Parameters: - cookie: User Cookie string for authentication - proxy: Optional HTTP proxy address, can be omitted if not used - Example format: `http://username:password@host:port` ### Return: - Creator account video performance overview <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_associated_product_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_associated_product_listTikTok (creator). ### Purpose - Retrieve the list of products associated with specified videos on TikTok Shop, along with their promotional performance data. - Useful for analyzing the number of products linked to each video, the product price range, product detail page links, and sales performance metrics. ### Notes - Requires item_ids (list of video IDs). - The time range defaults to the calendar month of the specified start_date. - Supports querying multiple videos at once. ### Return Description - `segments`: - `time_selector`: Time filter information (start/end timestamps) - `filter`: Query conditions (video ID list) - `timed_lists`: Product list associated with videos in the selected time range - `videoToProductsMap`: - `item_id`: Video ID - `products`: - `id`: Product ID - `name`: Product name - `cover_image.thumb_url_list`: List of product image URLs - `product_detail_page_url`: Product detail page link - `price_min` / `price_max`: Price range - `stats`: - `product.id`: Product ID - Promotional performance metrics (e.g., sales volume, CTR) ### Example Request Body ```json { "cookie": "your_cookie", "start_date": "04-01-2025", "item_ids": ["7496499484705246507", "7496110433699482923"] } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_audience_stats
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_audience_statsTikTok (creator). ### Purpose - Retrieve audience profile statistics for a specified TikTok video, including gender distribution, age distribution, and regional distribution. - Useful for accurately understanding the characteristics of the video audience to guide content creation, product selection, and marketing strategy optimization. - Supports trend analysis across different time intervals (daily/weekly/monthly). ### Notes - Requires item_id (video ID). - Audience profile data is based on characteristics of users who viewed and interacted with the video. ### Return Description - `segments`: - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp) - `filter`: Query conditions (creator_id, item_id) - `timed_profile`: Audience profile statistics - `start_timestamp`: Start timestamp - `end_timestamp`: End timestamp - `stats`: - `follower_genders`: Gender distribution - `key`: Gender ("female" or "male") - `value`: Proportion (string, range 0-1) - `follower_ages`: Age group distribution - `key`: Age group (e.g., "18-24", "25-34") - `value`: Proportion (string, range 0-1) - `follower_regions`: Regional distribution - `key`: Country code (e.g., "US") - `value`: Proportion (string, range 0-1) - `profile_type`: Profile type, fixed value 2 (Audience Profile) ### Example Request Body ```json { "cookie": "your_cookie", "start_date": "04-01-2025", "item_id": "7496499484705246507" } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_detailed_stats
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_detailed_statsTikTok (creator). ### Purpose - Retrieve detailed segmented statistics for a specified TikTok video within a given calendar month. - Supports analyzing new followers, likes, comments, shares, product views, and video completion rates across different time segments (daily/weekly/monthly). - Useful for deeply analyzing the performance changes of a single video over time, optimizing content strategies and promotional outcomes. ### Notes - Requires item_id (video ID). - Time range is based on the calendar month of start_date. - Large datasets will be automatically segmented based on granularity (daily/weekly/monthly). ### Return Description - `segments`: - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp) - `filter`: Query conditions (creator_id, item_id) - `timed_stats`: Segmented statistics list - `start_timestamp`: Start timestamp - `end_timestamp`: End timestamp - `stats`: - `creator_id`: Creator ID - `item_id`: Video ID - `new_follower_cnt`: Number of new followers - `share_cnt`: Number of shares - `comment_cnt`: Number of comments - `like_cnt`: Number of likes - `product_view_cnt`: Number of product views - `video_completion_rate`: Video completion rate (string, range 0-1) ### Example Request Body ```json { "cookie": "your_cookie", "start_date": "04-01-2025", "item_id": "7496499484705246507" } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_list_analytics
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_list_analyticsTikTok (creator). ### Purpose: - Retrieve a list of videos published by a TikTok Shop creator account within a specified time range, along with detailed performance metrics. - Supports pagination to fetch multiple pages of video records within the given time range. ### Response Fields: - `segments` (List of segmented data): - `time_selector`: Time range settings (start/end timestamps, timezone, locale) - `filter.creator_id`: Creator account ID - `list_control`: - `rules`: List sorting rules (typically by publish time descending) - `next_pagination`: Pagination information (has more pages, current page, total pages, total records) - `timed_lists`: List of videos for each time range, including: - `video_meta`: - `item_id`: Video Item ID - `name`: Video title - `publish_time`: Video publish time (Unix timestamp) - `duration`: Video duration (seconds) - `video_play_info`: Video play resources (cover image, playback URL, etc.) - `new_follower_cnt`: Number of new followers during the video's period - `vv_cnt`: Video views count - `ctr`: Click Through Rate for associated products - `gmv.amount`: Gross Merchandise Value generated by the video - `item_sold_cnt`: Number of items sold due to the video - `direct_gmv.amount`: Direct GMV from the video - `completion_rate`: Video completion rate ### Notes: - This API is only available for TikTok Shop creator accounts. - Data is grouped by natural day or week, and each video's stats represent the corresponding period. ### Parameters: - cookie: User Cookie string for authentication - start_date: Query start date, formatted as 'MM-DD-YYYY', e.g., '04-01-2025' - page: Page number, default is the first page `0` - rules: List sorting rules, default is by publish time. Available options: - `"VIDEO_LIST_PUBLISH_TIME"`: Sort by video publish time - `"VIDEO_LIST_GMV"`: Sort by gross merchandise value (GMV) - `"VIDEO_LIST_DIRECT_GMV"`: Sort by direct GMV - `"VIDEO_LIST_VV_CNT"`: Sort by video view count - `"VIDEO_LIST_ITEM_SOLD_CNT"`: Sort by number of items sold - `"VIDEO_LIST_CTR"`: Sort by click-through rate - `"VIDEO_LIST_COMPLETION_RATE"`: Sort by video completion rate - `"VIDEO_LIST_LIKE_CNT"`: Sort by number of likes - `"VIDEO_LIST_NEW_FOLLOWER_CNT"`: Sort by number of new followers - proxy: Optional HTTP proxy address, can be omitted if not used - Example format: `http://username:password@host:port` ### Return: - Detailed video list and performance analysis for the creator account <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_video_to_product_stats
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/creator/get_video_to_product_statsTikTok (creator). ### Purpose - Retrieve detailed promotional statistics between a specific TikTok video and a specific product. - Supports analyzing metrics such as product views, clicks, sales, order counts, product revenue, and direct revenue. - The data is segmented by time intervals (daily/weekly/monthly) to observe trends over time. ### Notes - Requires both item_id (video ID) and product_id (product ID). - The time range is based on the calendar month of the specified start_date. ### Return Description - `segments`: - `time_selector`: Time filtering parameters (period, granularity, start_timestamp, end_timestamp) - `filter`: Query conditions (creator_id, item_id, product_id) - `timed_stats`: Segmented statistics list - `start_timestamp`: Start timestamp - `end_timestamp`: End timestamp - `stats`: - `item_id`: Video ID - `product_id`: Product ID - `product_revenue.amount_formatted`: Total product revenue (formatted string, e.g., "$100.00") - `product_revenue.amount`: Total product revenue (numeric) - `direct_revenue.amount_formatted`: Direct sales revenue (formatted string) - `product_sales_cnt`: Number of products sold - `product_view_cnt`: Number of product views - `product_click_cnt`: Number of product clicks - `order_cnt`: Number of orders created ### Example Request Body ```json { "cookie": "your_cookie", "start_date": "04-01-2025", "item_id": "7496499484705246507", "product_id": "1731050202505515549" } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_hot_selling_products_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_hot_selling_products_listTikTok (shop/web). ### ⚠️ This API is deprecated: - To fetch products by category or keyword, use `fetch_products_by_category_id` or `fetch_search_products_list` ### Purpose: - Get TikTok Shop hot selling products list - Returns currently most popular products ### Parameters: - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) - count: Number of products to return, default 20 (optional). Larger values are slower - exclude_product_ids: Comma-separated product IDs you already have (optional), used for paging ### Pagination: - This endpoint has no page or offset parameter - To fetch the next batch, pass the product IDs you already have as a comma-separated list in `exclude_product_ids`; the endpoint skips them and returns new products - `data.hasMore` is `true` when more products are available, `false` when exhausted ### Response Structure: ```json { "code": 0, "message": "success", "data": { "hasMore": true, // Whether more products are available "productList": [ // Hot selling products { "product_id": "1731128793906516409", "title": "Product title" // Remaining fields are passed through as returned upstream } ] } } ``` API references: `fetch_products_by_category_id` = `GET /tikhub/tiktok/shop/web/fetch_products_by_category_id` (operationId: `get_tikhub_tiktok_shop_web_fetch_products_by_category_id`). Upstream-only reference: `fetch_search_products_list` is `GET /api/v1/tiktok/shop/web/fetch_search_products_list` in the official API. It is not exposed as an operation in this specification. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_product_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_product_detail_v3TikTok (shop/web). ### Purpose: - Get TikTok Shop product details - Provides the most complete product information including recommendations, videos, shop info, etc. - Suitable for products from supported regions; GB and BR are unavailable ### Parameters: - product_id: Product ID (required) - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Important Notice: - **Please ensure that the `region` matches the actual region of the `product_id`, otherwise the API will not return any data.** - Due to API rate limiting, please set request timeout to 30 seconds - If you encounter error code 400, please retry the request 3 times ### Response Structure: ```json { "code": 200, "data": { "productInfo": {}, // Product details "frequentlyBoughtTogether": [], // Frequently bought together "similarProductsInCategory": [], // Similar products in category "exploreMoreFromShop": [], // More from shop "brandInCategoryRecommendedProducts": [], // Brand category recommendations "customersAlsoBought": [], // Customers also bought "moreInThisColorStyle": [], // More colors/styles "relatedVideos": [], // Related videos "shopPerformance": {}, // Shop performance "categoryInfo": {}, // Category info "searchRecommendWords": [], // Search recommendation words "randomSearchWord": "", // Random search word "shopInfo": {}, // Shop information "shopHotReviews": [] // Shop hot reviews } } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_product_id_by_share_link
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_product_id_by_share_linkTikTok (shop/web). ### Purpose: - Get Product ID by Share Link ### Parameters: - share_link: Share link ### Return: - Product ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_product_reviews
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_product_reviews_v2TikTok (shop/web). ### Purpose: - Get TikTok Shop product reviews - Support multiple filtering and sorting options - More complete data structure with detailed review information ### Parameters: - product_id: Product ID (required) - page_start: Starting page number, default 1 - When has_more=1 in response, use current page +1 for next page - sort_rule: Sort order, default 2 - 1: Recommended - 2: Most recent - filter_type: Review filter type, default 1 - 1: All reviews; use filter_value to select all ratings or a specific rating - 2: Reviews containing images or videos; filter_value must be 1 - 3: Verified-purchase reviews; filter_value must be 1 - filter_value: Used together with filter_type - When filter_type=1: 6=all ratings (default), 5=5-star, 4=4-star, 3=3-star, 2=2-star, 1=1-star - When filter_type=2 or 3: use 1 - region: Region code, available regions are as follows: - US: United States - SG: Singapore - MY: Malaysia - PH: Philippines - TH: Thailand - VN: Vietnam - ID: Indonesia - JP: Japan - MX: Mexico ### Filter Combination Examples: - All reviews: filter_type=1, filter_value=6 - 5-star reviews: filter_type=1, filter_value=5 - Reviews with images or videos: filter_type=2, filter_value=1 - Verified-purchase reviews: filter_type=3, filter_value=1 ### Important Notice: - Set the request timeout to 30 seconds - Only products accessible via TikTok Shop Web are supported ### Response Structure: ```json { "code": 0, "message": "success", "data": { "reviews": [ // Review list (20 per page) { "review_id": "xxx", "user": { // User info "user_id": "xxx", "nickname": "Username", "avatar": "Avatar URL" }, "rating": 5, // Rating (1-5 stars) "content": "Review content", "medias": [ // Media files (images/videos) { "type": "image", "url": "Media URL" } ], "create_time": 0, // Create timestamp "verified_purchase": true, // Is verified purchase "product_info": {}, // Product info "likes_count": 10, // Likes count "seller_reply": {} // Seller reply } ], "has_more": 1, // Has more: 1=yes, 0=no "page_start": 1, // Current page "total_count": 500, // Total review count "review_summary": { // Review summary "average_rating": 4.8, "star_distribution": { // Star distribution "5": 400, "4": 80, "3": 15, "2": 3, "1": 2 } } } } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_products_by_category_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_products_by_category_idTikTok (shop/web). ### Purpose: - Get product list by category ID - Can be used to build category browsing feature ### Parameters: - category_id: Category ID (required, from fetch_products_category_list API) - offset: Offset for pagination (default 0) - Default 20 products per page, increase by 20 for each request. If `hasMore` in response is true, can request next page, otherwise reached last page. - Example: Page 1 offset=0, Page 2 offset=20, Page 3 offset=40, and so on. - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Important Notice: - Due to API rate limiting, please set request timeout to 30 seconds - If you encounter error code 400, please retry the request 3 times ### Response Structure: ```json { "code": 0, "message": "success", "data": { "products": [ // Product list (up to 20) { "product_id": "xxx", "title": "Product title", "image": "Product image", "price": {}, // Price info "rating": {}, // Rating info "sales": {} // Sales info } ] } } ``` API references: `fetch_products_category_list` = `GET /tikhub/tiktok/shop/web/fetch_products_category_list` (operationId: `get_tikhub_tiktok_shop_web_fetch_products_category_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_products_category_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_products_category_listTikTok (shop/web). ### Purpose: - Get TikTok Shop product category directory - Returns complete category tree structure ### Parameters: - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Response Structure: ```json [ { "self": { // Category info "category_id": "xxx", "category_level": 1, "is_leaf": false, "parent_category_id": "0", "category_name": "Category Name", "category_name_en": "Category Name", "image_url": "Category image URL" }, "children": [ // Sub-categories { "self": {...}, "children": [...] } ] } ] ``` - Total about 28 main categories <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_search_products_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_search_products_list_v2TikTok (shop/web). ### Purpose: - Search products (Mobile API) - More streamlined data, faster response ### Parameters: - search_word: Search keyword (required) - offset: Offset (default 0) - page_token: Page token - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Response Structure: ```json { "code": 0, "message": "success", "data": { "products": [...], // Product list "has_more": true, // Has more "load_more_params": {} // Load more params } } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_search_word_suggestion
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_search_word_suggestion_v2TikTok (shop/web). ### Purpose: - Get search keyword suggestions (Mobile API) - Optimized for e-commerce search results ### Parameters: - search_word: Search keyword (required) - lang: Language code (en-US/zh-CN etc.) - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Important Notice: - Due to API rate limiting, please set request timeout to 30 seconds - If you encounter error code 400, please retry the request 3 times ### Response Structure: ```json { "code": 0, "message": "", "data": [ // Suggestion list (up to 50) "keyword1", "keyword2", "..." ] } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_seller_products_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_seller_products_list_v2TikTok (shop/web). ### Purpose: - Get seller product list (Mobile API) - More streamlined data structure ### Parameters: - seller_id: Seller ID (required) - searchParams: Search parameters (optional) - region: Region code (US/SG/MY/PH/TH/VN/ID/JP/MX) ### Important Notice: - Due to API rate limiting, please set request timeout to 30 seconds - If you encounter error code 400, please retry the request 3 times ### Response Structure: ```json { "code": 0, "message": "success", "data": { "products": [...], // Product list "has_more": true, // Has more "load_more_params": {} // Load more params } } ``` <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok web/fetch_shop_id_by_share_link
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/shop/web/fetch_shop_id_by_share_linkTikTok (shop/web). ### Purpose: - Get Shop ID by Share Link ### Parameters: - share_link: Share link ### Return: - Shop ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok decrypt_strData
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/decrypt_strDataTikTok (web). ### Purpose: - Decrypt strData fingerprint data to analyze fingerprint info in msToken request ### Parameters: - encrypted_data: Encrypted strData string, obtained from browser packet capture ### Return: - Decrypted raw fingerprint data, including browser fingerprint info and environment info, etc. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok device_register
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/device_registerTikTok (web). ### Purpose - Register device to generate device ID and guest Cookie for TikTok Web ### Parameters - None ### Return - Device registration information, including device ID and guest Cookie ### Response ```json { "deviceId": "7556227929396708877", "cookie": "tt_chain_token=wBqjjz5I8m1bt96uxA1s8A==", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36" } ``` <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok encrypt_strData
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/encrypt_strDataTikTok (web). ### Purpose: - Encrypt strData fingerprint data for msToken request ### Parameters: - data: Raw fingerprint data string (please convert JSON format to string before requesting) ### Return: - Encrypted strData <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_batch_check_live_alive
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_batch_check_live_aliveTikTok (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Batch live room start status check - Support up to 50 live rooms query at once - If a live room does not exist or has ended, the corresponding position will return empty or null. ### Parameters - room_ids: Live room ID list separated by commas, e.g.: 7530611486784277278,7530633767468288782 ### Return - Batch live room start status list ### Price Provider usage depends on the number of live rooms queried; please try to query 50 live rooms to avoid wasting API call counts. ### Note - The same room_id will not return the start status repeatedly. <!-- aisa-pricing:start --> Published reference price: $0.05 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_check_live_alive
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_check_live_aliveTikTok (web). ### Purpose: - Live room start status check - If the current live room does not exist or has ended, it will return empty. ### Parameters: - room_id: Live room ID ### Return: - Live room start status <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_explore_post
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_explore_postTikTok (web). ### Purpose - Get explore video data ### Parameters - categoryType: Video category - 100: Animation and comics - 101: Performance - 102: Beauty care - 103: Game - 104: Comedy - 105: Daily life - 106: Family - 107: Emotional relationship - 108: Drama - 109: Dress up - 110: Dubbing - 111: Food - 112: Sports - 113: Animals - 114: Society - 115: Car - 116: Education - 117: Fitness and health - 118: Technology - 119: Singing and dancing - 120: All - count: Number per page ### Return - Video data ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_general_search
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_general_searchTikTok (web). ### Purpose - Get general search list ### Parameters - keyword: Search keyword - offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor. - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request. - For example: search_id = "20240828035554C02011379EBB6A00E00B" - JSON Path-1 : $.data.extra.logid - JSON Path-2 : $.data.log_pb.impr_id - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required) ### Return - General search list ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_gift_name_by_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_gift_name_by_idTikTok (web). ### Purpose Get a gift name by TikTok gift ID. ### Request body Send the gift_id in a JSON object, as defined by the request schema. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_gift_names_by_ids
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_gift_names_by_idsTikTok (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose Get gift names by multiple TikTok gift IDs. ### Request body Send gift_ids in a JSON object, as defined by the request schema. Submit up to 50 IDs per call; if more are supplied, only the first 50 are processed. ### Upstream pricing Use an AIsa price quote for gateway billing. <!-- aisa-pricing:start --> Published reference price: $0.025 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_home_feed
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_home_feedTikTok (web). ### Purpose - Home Feed ### Parameters - count: Number per page - cookie: User's own cookie, optional parameter, used for personalized recommendations of interface return data. - region: Region code, optional parameter, affects the region of recommended content, e.g. US/GB/JP/KR/SG, default US. ### Return - Home Feed ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_gift_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_live_gift_listTikTok (web). ### Purpose - Get live room gift list - room_id is optional parameter, if not provided, will get general gift list (as of August 15, 2025, there are 256 types of gifts) ### Parameters - room_id: Live room ID (optional) ### Return - Live room gift list data ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.025 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_im_fetch
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_live_im_fetchTikTok (web). ### Purpose: - TikTok live room danmaku parameters ### Parameters: - room_id: Live room id - user_unique_id: User unique ID (optional) - resp_content_type: Response format, protobuf (default) or json ### Return: - Danmaku parameter data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_recommend
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_live_recommendTikTok (web). ### Purpose - Get live room homepage recommendation list ### Parameters - related_live_tag: Related live tag (live category). The available values are not fixed; call `/tikhub/tiktok/web/fetch_live_recommend_tabs` first to get the currently available tag list, then pick one to pass in. ### Return - Live room homepage recommendation list ### Note - If you are not sure which values `related_live_tag` accepts, call `/tikhub/tiktok/web/fetch_live_recommend_tabs` to get the currently available tag (category tab) list. - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_live_recommend_tabs` = `GET /tikhub/tiktok/web/fetch_live_recommend_tabs` (operationId: `get_tikhub_tiktok_web_fetch_live_recommend_tabs`); `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_live_recommend_tabs
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_live_recommend_tabsTikTok (web). ### Purpose - Get the available tag (live category tab) list for live room homepage recommendation - Works together with `/tikhub/tiktok/web/fetch_live_recommend` to discover the available values of its `related_live_tag` parameter ### Parameters - logid: Pagination cursor. Leave empty for the first page; to load the next page, pass the `logid` value returned by the previous response ### Return - Available tag (live category tab) list - logid: The log id of this request (from the `x-tt-logid` response header); pass it back as `logid` to load more ### Note - The available values of `related_live_tag` are not fixed and may change by region/time, so it is recommended to fetch them in real time before use. ### Pagination 1. For the first request leave `logid` empty, and read the returned `logid` from the result. 2. To load the next page, pass the previous `logid` back as the `logid` parameter (internally converted to TikTok's req_id). API references: `fetch_live_recommend` = `GET /tikhub/tiktok/web/fetch_live_recommend` (operationId: `get_tikhub_tiktok_web_fetch_live_recommend`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_post_ai_article
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_post_ai_articleTikTok (web). ### Purpose: - Get the AI-generated article and content overview that TikTok generates from the video content - Useful for content analysis, topic research and SEO keyword mining ### Parameters: - itemId: Video id ### Return: - The `itemCustomTDK` field contains: - `title`: AI-generated title - `desc`: AI-generated content overview (summary) - `keywords`: AI-extracted keyword list - `article`: AI-generated article body based on the video content ### Note: - Not every video has AI-generated content. If a video has none, the `itemCustomTDK` field is absent from the response. - Some videos only have `title`/`desc`/`keywords`, with `article` being an empty string. - The language of the article is determined by the video itself and is not affected by request parameters. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_post_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_post_commentTikTok (web). ### Purpose - Get video comments ### Parameters - aweme_id: Video id - cursor: Page cursor - count: Number per page - current_region: Current region, default is empty. ### Return - Video comments ### Example aweme_id = "7304809083817774382" cursor = 0 count = 20 current_region = "" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_post_comment_reply
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_post_comment_replyTikTok (web). ### Purpose - Get video comment replies ### Parameters - item_id: Video id - comment_id: Comment id - cursor: Page cursor - count: Number per page - current_region: Current region, default is empty. ### Return - Video comment replies ### Example item_id = "7304809083817774382" comment_id = "7304877760886588191" cursor = 0 count = 20 current_region = "" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_post_detail_v2TikTok (web). ### Purpose: - Get single video data ### Parameters: - itemId: Video id - region: Region code, optional; affects content region, e.g. US/GB/JP/ID, default US. ### Return: - Video data ### Note: - The video CDN links returned by this interface require the `tt_chain_token` from the response to be accessed, otherwise HTTP 403 will be returned. - When requesting a video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned in the response. - Example request header: `Cookie: tt_chain_token=xxx` - If you need video links that can be accessed **without any Cookie**, use `/fetch_post_detail`. Upstream-only reference: `fetch_post_detail` is `GET /api/v1/tiktok/web/fetch_post_detail` in the official API. It is not exposed as an operation in this specification. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_search_keyword_suggest
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_search_keyword_suggestTikTok (web). ### Purpose: - Search keyword suggest ### Parameters: - keyword: Search keyword ### Return: - Keyword suggest list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_search_live
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_search_liveTikTok (web). ### Purpose: - Search live ### Parameters: - keyword: Search keyword - count: Number per page - offset: Page offset, 0 for the first request, need to provide for the second paging. - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request. - For example: search_id = "20240828035554C02011379EBB6A00E00B" - JSON Path-1 : $.data.extra.logid - JSON Path-2 : $.data.log_pb.impr_id - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required) ### Return: - Live list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_search_photo
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_search_photoTikTok (web). ### Purpose: - Search photo ### Parameters: - keyword: Search keyword - count: Number per page, it is recommended to keep the default value 20. - offset: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor. - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request. - For example: search_id = "20240828035554C02011379EBB6A00E00B" - JSON Path-1 : $.data.extra.logid - JSON Path-2 : $.data.log_pb.impr_id - offset: Page cursor - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required) ### Return: - Video list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_search_user
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_search_userTikTok (web). ### Purpose: - Search user ### Parameters: - keyword: Search keyword - cursor: Page cursor, 0 for the first request, need to provide for the second paging, generally the keyword of this value is offset or cursor. - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request. - For example: search_id = "20240828035554C02011379EBB6A00E00B" - JSON Path-1 : $.data.extra.logid - JSON Path-2 : $.data.log_pb.impr_id - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required) ### Return: - User list ### Note: - If the `status_code` in the `data` field of the interface response is not 0, it means that the search request was not successful. Please check the exceptions in the response. You may be searching for keywords that TikTok does not allow, or searching for sensitive content. Please change the keywords and try again. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_search_video
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_search_videoTikTok (web). ### Purpose: - Search video ### Parameters: - keyword: Search keyword - count: Number per page, it is recommended to keep the default value 20. - offset: Page offset, 0 for the first request, need to provide for the second paging. - search_id: Search id, empty for the first request, need to provide for the second paging, need to get it from the return response of the last request. - For example: search_id = "20240828035554C02011379EBB6A00E00B" - JSON Path-1 : $.data.extra.logid - JSON Path-2 : $.data.log_pb.impr_id - cookie: User cookie (If you need to search with your own account, or encounter an interface error, you can provide the cookie yourself, default is not required) ### Return: - Video list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_tag_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_tag_detailTikTok (web). ### Purpose: - Tag Detail ### Parameters: - tag_name: Tag name ### Return: - Tag Detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_tag_post
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_tag_postTikTok (web). ### Purpose - Tag Post ### Parameters - challengeID: Tag ID - count: Number per page - cursor: Page cursor ### Return - Tag Post ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_tiktok_live_data
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_tiktok_live_dataTikTok (web). ### Purpose: - Get live room information via live link - This interface can get offline live room information ### Parameters: - live_room_url: Live room link ### Return: - Live room information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_tiktok_web_guest_cookie
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_tiktok_web_guest_cookieTikTok (web). ### Purpose: - Get the guest Cookie of TikTok Web - Can be used to crawl data of TikTok Web, such as user videos, mix videos, etc. - Can fix identity to avoid duplicate data for some interfaces. - Please note: Guest Cookie cannot crawl all data, there are certain restrictions. - Can be used with open source projects to implement data crawling of TikTok Web using this interface. ### Parameters: - user_agent: User browser agent ### Return: - Guest Cookie <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_trending_searchwords
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_trending_searchwordsTikTok (web). ### Purpose: - Get daily trending search words ### Return: - Trending search words <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_collect
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_collectTikTok (web). ### Purpose - Get user favorites - Note: This interface can currently only get your own favorites list, you need to provide your account cookie. ### Parameters - cookie: User cookie - secUid: User secUid - cursor: Page cursor - count: Number per page - coverFormat: Cover format ### Return - User favorites ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_fans
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_fansTikTok (web). ### Purpose - Get user followers ### Parameters - secUid: User secUid - count: Number per page - maxCursor: Max cursor - minCursor: Min cursor ### Return - User followers ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_follow
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_followTikTok (web). ### Purpose - Get user followings ### Parameters - secUid: User secUid - count: Number per page - maxCursor: Max cursor - minCursor: Min cursor ### Return - User followings ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_like
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_likeTikTok (web). ### Purpose - Get user likes - Note: This interface requires that the user's like list be public ### Parameters - secUid: User secUid - cursor: Page cursor - count: Number per page, default is 20, cannot be changed. - coverFormat: Cover format - post_item_list_request_type: Sort type - 0: Default sort - 1: Hot sort - 2: Oldest sort ### Return - User likes ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_live_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_live_detailTikTok (web). ### Purpose - Get user live details ### Parameters - uniqueId: User uniqueId ### Return - User live details ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_mix
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_mixTikTok (web). ### Purpose - Get user mix list ### Parameters - mixId: Mix id - cursor: Page cursor - count: Number per page ### Return - User mix list ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. ### Example mixId = "7101538765474106158" cursor = 0 count = 30 API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_play_list
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_play_listTikTok (web). ### Purpose - Get user play list ### Parameters - secUid: User secUid - cursor: Page cursor - count: Number per page ### Return - User play list ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. ### Example secUid = "MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM" cursor = 0 count = 30 API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_post
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_postTikTok (web). ### Purpose - Get user posts ### Parameters - secUid: User secUid - cursor: Page cursor. Pass 0 for the first request, then pass the `cursor` value returned by the previous response. - count: Number per page, default is 15, maximum is 15. Values above 15 are treated as 15. - coverFormat: Cover format, default is 2, optional values are 1 or 2. - post_item_list_request_type: Sort type. Deprecated - any value returns posts ordered from newest to oldest. ### Return - User posts, ordered from newest to oldest - `cursor`: Cursor for the next page, use together with `hasMore` - `hasMore`: Whether more posts are available; `false` means the last page has been reached - Consecutive pages may contain a few overlapping posts; de-duplicate by post `id` before counting or storing ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_profileTikTok (web). ### Purpose: - Get user profile ### Parameters: - secUid: User secUid - uniqueId: User uniqueId - At least one of secUid and uniqueId is provided, and uniqueId is preferred, that is, the username in the user's homepage link. ### Return: - User profile <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok fetch_user_repost
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/fetch_user_repostTikTok (web). ### Purpose - Get user reposts ### Parameters - secUid: User secUid - cursor: Page cursor - count: Number per page, default is 20, cannot be changed. - coverFormat: Cover format, default is 2, optional values are 1 or 2. ### Return - User reposts ### Note - The direct video CDN links returned by this interface require the returned `tt_chain_token` to be accessed, otherwise HTTP 403 will be returned. - When accessing a direct video CDN link, carry `Cookie: tt_chain_token={tt_chain_token}` in the request header, where `{tt_chain_token}` is the value returned by this interface. - **If a direct video CDN link still returns HTTP 403**: 1. Use the video link starting with `https://www.tiktok.com/aweme/v1/play/` from the response instead (found in the `UrlList` fields under `video`) 2. Send that link **without any Cookie** - carrying `tt_chain_token` will cause HTTP 403 - If you need watermark-free video links that require no Cookie at all, use /tikhub/tiktok/app/v3/fetch_one_video. API references: `fetch_one_video` = `GET /tikhub/tiktok/app/v3/fetch_one_video` (operationId: `get_tikhub_tiktok_app_v3_fetch_one_video`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_fingerprint
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_fingerprintTikTok (web). ### Purpose: - Generate random browser fingerprint data for custom msToken request ### Parameters: - browser_type: Specify browser type, options: - chrome_windows: Chrome + Windows - chrome_mac: Chrome + macOS - firefox_windows: Firefox + Windows - firefox_mac: Firefox + macOS - Leave empty for random selection ### Return: - Browser fingerprint data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_hashed_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_hashed_idTikTok (web). ### Purpose: - Generate hashed ID for TikTok Web ### Parameters: - email: Email address ### Return: - Generated hashed ID string <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_real_msToken
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_real_msTokenTikTok (web). ### Purpose: - Generate real msToken ### Parameters: - random_strData: Whether to use randomized browser fingerprint data (recommended for better anti-bot) - browser_type: Specify browser type, options: - chrome_windows: Chrome + Windows - chrome_mac: Chrome + macOS - firefox_windows: Firefox + Windows - firefox_mac: Firefox + macOS - Leave empty for random selection ### Return: - Real msToken <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_ttwid
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_ttwidTikTok (web). ### Purpose: - Generate ttwid ### Parameters: - None ### Return: - ttwid <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_webid
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_webidTikTok (web). ### Purpose: - Generate TikTok web_id (device_id in Web API request parameters) ### Parameters: - cookie: Custom cookie (must contain odin_tt), uses default if not provided - user_agent: User agent string - url: Request source URL - referer: Referrer page - user_unique_id: User unique ID (optional) - app_id: Application ID, default 1988, represents TikTok Web app ### Return: - web_id: Generated web_id - e: Error code (0 means success) - ssid: Session ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_wss_xb_signature
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/generate_wss_xb_signatureTikTok (web). ### Purpose: - Generate X-Bogus signature required for TikTok Live WSS connection ### Parameters: - user_agent: User browser agent (optional, uses default UA if not provided) ### Return: - x_bogus: WSS X-Bogus signature string <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_x_mssdk_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/generate_x_mssdk_infoTikTok (web). ### Purpose: - Generate X-Mssdk-Info and X-Mssdk-RC, used for TikTok Web device registration, login, and other scenarios ### Parameters: - user_agent (str, optional): User-Agent string, currently not supported for customization, defaults to a fixed value ### Return: - X-Mssdk-Info: Generated signing information - X-Mssdk-RC: Generated RC value - user_agent: The User-Agent string used - version: The webmssdk version used for signing <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_xbogus
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/generate_xbogusTikTok (web). ### Purpose: - Generate xbogus ### Parameters: - url: Unsigned API URL - user_agent: User browser User-Agent ### Return: - xbogus <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_xgnarly
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/generate_xgnarlyTikTok (web). ### Purpose: - Generate XGnarly encryption, used for TikTok Web API requests - This interface uses the latest version (V5.2.0, as of March 2026) signing service, User-Agent cannot be customized, a common browser User-Agent will be automatically generated - This interface perfectly restores the algorithm, ignores all risk controls except for verification codes ### Parameters: - url (str): The requested API URL without signature (X-Bogus or X-Gnarly) and including the domain name, no need to URL encode - body (str): The API parameters of the request, applicable for POST requests, not required for GET requests ### Return: - X-Gnarly encryption string + User-Agent of a random browser <!-- aisa-pricing:start --> Published reference price: $0.002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok generate_xgnarly_and_xbogus
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/generate_xgnarly_and_xbogusTikTok (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Generate XGnarly and XBogus encryption, used for TikTok Web API requests - This interface can generate the latest version of encryption parameters X-Bogus and X-Gnarly, User-Agent cannot be customized, a common browser User-Agent will be automatically generated - The X-Bogus and X-Gnarly generated by this interface are the latest versions (V5.2.0, as of March 2026) ### Parameters - url (str): The requested API URL without signature (X-Bogus or X-Gnarly) and including the domain name, no need to URL encode - body (str): The API parameters of the request, applicable for POST requests, not required for GET requests ### Return - The latest version of X-Gnarly encryption + the latest version of X-Bogus encryption + User-Agent of a random browser <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_all_aweme_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/get_all_aweme_idTikTok (web). ### Purpose - Extract list video id ### Parameters - Root JSON body: Video link (Support up to 20 links) ### Return - Video id ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_all_sec_user_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/get_all_sec_user_idTikTok (web). ### Purpose - Extract list user id ### Parameters - Root JSON body: User homepage link (Support up to 10 links) ### Return - If the sec_user_id is successfully obtained, the sec_user_id is returned, otherwise the original input link is returned, and the reason why the sec_user_id cannot be obtained can be manually verified later. ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_all_unique_id
$MeteredPOST https://aisa.one/apis/v1/tikhub/tiktok/web/get_all_unique_idTikTok (web). ### Purpose - Get list unique_id ### Parameters - Root JSON body: User homepage link (Support up to 20 links) ### Return - unique_id ### Request body Send the request body as a JSON array of strings at the root. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_aweme_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/get_aweme_idTikTok (web). ### Purpose: - Extract single video id ### Parameters: - url: Video link ### Return: - Video id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_live_room_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/get_live_room_idTikTok (web). ### Purpose: - Extract live room Room ID from live room link - Support short links, such as: https://vt.tiktok.com/ZSjuyJnWQ/ - Support long links, such as: https://www.tiktok.com/@maksukaracun/live ### Parameters: - live_room_url: Live room link ### Return: - Live room Room ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_sec_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/get_sec_user_idTikTok (web). ### Purpose: - Extract list user id ### Parameters: - url: User homepage link ### Return: - User id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_unique_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/get_unique_idTikTok (web). ### Purpose: - Get user unique_id ### Parameters: - url: User homepage link ### Return: - unique_id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok get_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/get_user_idTikTok (web). ### Purpose: - Extract list user id ### Parameters: - url: User homepage link ### Return: - User id <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
tiktok tiktok_live_room
$MeteredGET https://aisa.one/apis/v1/tikhub/tiktok/web/tiktok_live_roomTikTok (web). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Extract live room danmaku - This interface is no longer available online, you need to purchase the source code and deploy it locally for use. To purchase the source code, please contact the administrator in the Discord server. Discord invite link: https://discord.gg/aMEAS8Xsvz #### Price: ### Parameters - live_room_url: Live room link - danmaku_type: Message type - WebcastChatMessage: Chat message - WebcastMemberMessage: Member message - WebcastRoomUserSeqMessage: User sequence message - WebcastGiftMessage: Gift message - WebcastSocialMessage: Social message - WebcastLikeMessage: Like message - WebcastLinkMicFanTicketMethod: Link Mic Fan Ticket Method - WebcastLinkMicMethod: Link Mic Method ### Return - WebSocket connection information of the danmaku data, you need to use WebSocket connection to get the danmaku data, this interface does not return the danmaku data. <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_article_info
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/app/get_article_infoToutiao (app). ### Purpose: - Get information of specified post ### Parameters: - group_id: Post ID, can be obtained from the link - For example: https://www.toutiao.com/article/7450114952884503059/ ### Return: - Post information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/app/get_commentsToutiao (app). ### Purpose: - Get comments of specified post ### Parameters: - group_id: Post ID, can be obtained from the link - For example: https://www.toutiao.com/i7453372680222523931/ - offset: Offset, used for pagination, default is 0, then add 20 each time ### Return: - Comment list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_user_id
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/app/get_user_idToutiao (app). ### Purpose: - Get user_id from user profile ### Parameters: - user_profile_url: User profile URL - For example: https://www.toutiao.com/c/user/token/MS4wLjABAAAAwK6echNksY69R8l2vcZudupfhTItbGSGt-8ineO5UaB4L-djqkYDgB6TkAdMvrmW/ ### Return: - User ID <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/app/get_user_infoToutiao (app). ### Purpose - Get information of specified user ### Parameters - user_id: User ID, can be obtained from the following API: - `/tikhub/toutiao/app/get_user_id` ### Return - User information API references: `get_user_id` = `GET /tikhub/toutiao/app/get_user_id` (operationId: `get_tikhub_toutiao_app_get_user_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_video_info
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/app/get_video_infoToutiao (app). ### Purpose: - Get information of specified video ### Parameters: - group_id: Post ID, can be obtained from the link - For example: https://www.toutiao.com/video/7431543350882206242/ ### Return: - Post information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_article_info
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/web/get_article_infoToutiao (web). ### Purpose: - Get information of specified post ### Parameters: - aweme_id: Post ID, can be obtained from the link - For example: https://www.toutiao.com/article/7450114952884503059/ ### Return: - Post information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
toutiao get_video_info
$MeteredGET https://aisa.one/apis/v1/tikhub/toutiao/web/get_video_infoToutiao (web). ### Purpose: - Get information of specified video ### Parameters: - aweme_id: Post ID, can be obtained from the link - For example: https://www.toutiao.com/video/7431543350882206242/ ### Return: - Post information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_check_follow
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_check_followTwitter / X (web). ### Purpose: - Check follow ### Parameters: - user_name: Source screen name, for example: elonmusk - follows: Target screen name, for example: NASA ### Return: - Follow relationship result <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_check_retweet
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_check_retweetTwitter / X (web). ### Purpose: - Check retweet ### Parameters: - screen_name: Screen name, for example: elonmusk - tweet_id: Tweet ID, for example: 1808168603721650364 ### Return: - Retweet relationship result <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_community_info
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_community_infoTwitter / X (web). ### Purpose: - Get community info ### Parameters: - community_id: Community ID, for example: 1493290339532222469 ### Return: - Community info, including name, description, member count, primary topic and rules ### Note: - The `status` field in the upstream response is the community join status (always `failed` in practice). It is unrelated to whether the request succeeded — do not use it to determine success. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_community_members
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_community_membersTwitter / X (web). ### Purpose: - Get community members ### ⚠️ No pagination - A single call returns only the first page (~19 members). There is no way to fetch more. - Upstream does return a `next_cursor` in the response, but passing that cursor back yields an empty list (verified across communities of different sizes — the behaviour is consistent). - The `cursor` parameter is kept only for forward compatibility if upstream fixes this. It currently has no effect — do not rely on it. - If you need a complete member list, this endpoint cannot provide it. ### Parameters: - community_id: Community ID, for example: 1493290339532222469 - cursor: Cursor, default is None. No pagination supported; passing it has no effect ### Return: - Community member list (first page only, ~19 members) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_community_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_community_timelineTwitter / X (web). ### Purpose: - Get community timeline ### Parameters: - community_id: Community ID, for example: 1493290339532222469 - ranking: Ranking, optional, default is None (upstream default), optional values are Relevance, Recency - cursor: Cursor, default is None, used for paging, obtained from `cursor` of the last response ### Return: - Community timeline <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_latest_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_latest_post_commentsTwitter / X (web). ### Purpose: - Get the latest tweet comments ### Parameters: - tweet_id: Tweet ID - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - Tweet comments <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_list_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_list_followersTwitter / X (web). ### Purpose: - Get list followers ### Parameters: - list_id: List ID, for example: 84839422 - cursor: Cursor, default is None, used for paging, obtained from `next_cursor` of the last response ### Return: - List followers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_list_members
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_list_membersTwitter / X (web). ### Purpose: - Get list members ### Parameters: - list_id: List ID, for example: 84839422 - cursor: Cursor, default is None, used for paging, obtained from `next_cursor` of the last response ### Return: - List members <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_list_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_list_timelineTwitter / X (web). ### Purpose: - Get list timeline ### Parameters: - list_id: List ID, for example: 84839422 - cursor: Cursor, default is None, used for paging, obtained from `next_cursor` of the last response ### Return: - List timeline <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_post_commentsTwitter / X (web). ### Purpose: - Get comments under the tweet ### Parameters: - tweet_id: Tweet ID - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - Comments <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_retweet_user_list
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_retweet_user_listTwitter / X (web). ### Purpose: - Get ReTweet User list ### Parameters: - tweet_id: Tweet ID, can be obtained from the tweet link. For example: 1808168603721650364 in https://x.com/elonmusk/status/1808168603721650364 - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - ReTweet User list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_search_communities
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_search_communitiesTwitter / X (web). ### Purpose: - Search communities ### Parameters: - keyword: Search keyword, for example: superman - cursor: Cursor, default is None, used for paging, obtained from `next_cursor` of the last response ### Return: - Community search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_search_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_search_timelineTwitter / X (web). ### Purpose: - Search ### Parameters: - keyword: Search keyword - search_type: Search type, default is Top, other optional values are Latest, Media, People, Lists - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - Search results ### Note on search result accuracy: - X's search does not guarantee the keyword or hashtag appears in the tweet text. - Matching happens against more than the caption — it can include the quoted tweet, linked article metadata, media, and account signals. - So a returned tweet can be a legitimate match with the term absent from the text field entirely. - Requiring a literal substring match in `text` will discard a large share of valid results, which is consistent with the 94.6% drop rate observed in practice. - If results look inaccurate, first check whether such a literal filter is being applied downstream. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_trending
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_trendingTwitter / X (web). ### Purpose: - Get Trending ### Parameters: - country: Country, default is UnitedStates, other optional values are as follows - China - India - Japan - Russia - Germany - Indonesia - Brazil - France - UnitedKingdom - Turkey - Italy - Mexico - SouthKorea - Canada - Spain - SaudiArabia - Egypt - Australia - Poland - Iran - Pakistan - Vietnam - Nigeria - Bangladesh - Netherlands - Argentina - Philippines - Malaysia - Colombia - UniteArabEmirates - Romania - Belgium - Switzerland - Singapore - Sweden - Norway - Austria - Kazakhstan - Algeria - Chile - Czechia - Peru ### Return: - Trending <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_tweet_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_tweet_detailTwitter / X (web). ### Purpose: - Get single tweet data ### Parameters: - tweet_id: Tweet ID, can be obtained from the tweet link. For example: 1808168603721650364 in https://x.com/elonmusk/status/1808168603721650364 ### Return: - Tweet data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_about
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_aboutTwitter / X (web). ### Purpose: - Get user about profile ### Parameters: - screen_name: Screen name, for example: elonmusk ### Return: - User account profile info, including registration time, account status and usage <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_affiliates
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_affiliatesTwitter / X (web). ### Purpose: - Get user affiliates ### Parameters: - screen_name: Screen name, for example: NASA. Must be an organization account that has affiliates; personal accounts return an empty list - cursor: Cursor, default is None, used for paging, obtained from `next_cursor` of the last response ### Return: - User affiliate account list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_followersTwitter / X (web). ### Purpose: - Get User Followers ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - User Followers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_followings
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_followingsTwitter / X (web). ### Purpose: - Get User Followings ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - User Followings <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_live_status
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_live_statusTwitter / X (web). ### Purpose: - Check user live status ### Parameters: - rest_id: User rest ID (numeric), for example: 44196397 ### Return: - Current live status of the user ### Note: - This endpoint requires `rest_id` (numeric user ID). Passing a screen name returns an upstream placeholder response (all fields set to "s"), not real data. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_media
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_mediaTwitter / X (web). ### Purpose: - Get user media ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected. - cursor: Cursor, default is None, used for paging, obtained from the `next_cursor` in the last request ### Return: - User media <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_post_tweet
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_post_tweetTwitter / X (web). ### Purpose: - Get user post ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected. - cursor: Cursor, default is None, used for paging, obtained from the JSON in the last request. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_profile
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_profileTwitter / X (web). ### Purpose: - Get user profile ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - rest_id: User ID, for example: 44196397, if the user ID is used, the username will be ignored, only one of them can be selected. ### Return: - User profile <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_profiles_by_rest_ids
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_profiles_by_rest_idsTwitter / X (web). ### Purpose: - Get profiles by rest ids ### Parameters: - rest_ids: User IDs, comma separated, for example: 44196397,34743251 ### Return: - User profile list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
twitter fetch_user_tweet_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/twitter/web/fetch_user_tweet_repliesTwitter / X (web). ### Purpose: - Get user tweet replies ### Parameters: - screen_name: Screen Name, for example: elonmusk, can be obtained from the user's homepage link, for example: elonmusk in https://twitter.com/elonmusk - cursor: Cursor, default is None, used for paging, obtained from the last request ### Return: - User tweet replies <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_channel_id_to_username
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_channel_id_to_usernameWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Resolve a publicly visible Channel ID (`sph…` short ID) into a finder username (`v2_…@finder`). - With the username you can then call `fetch_user_videos`, `fetch_channel_info`, `fetch_user_profile`, etc. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - channel_id: Channel ID (`sph…` short ID), e.g. `sphi9BjV8GK0Zsl` (People's Daily). Must start with `sph`. - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Resolved finder username plus account nickname and description ### Response structure & JSON Path #### `raw=false` (simplified): - Input echo: `$.data.channel_id` - Resolved finder username (feed directly into downstream endpoints): `$.data.username` - Account nickname (search highlight markers stripped): `$.data.nickname` - Account description: `$.data.desc` (may be null) - On miss: `$.data.username` is null with an explanation at `$.data.error` #### `raw=true` (raw): - Result groups: `$.data.data[N]` (each group has `type` + `items[]` / `subBoxes[].items[]`) - Finder username inside account items: `$.data.data[N].items[M].jumpInfo.userName` or `$.data.data[N].items[M].noticeParam.finderUsername` - Title / description: `$.data.data[N].items[M].title` / `.desc` - Others: `$.data.query` (query echo), `$.data.continueFlag`, `$.data.offset` - Mapping: `username` / `nickname` / `desc` of raw=false are extracted from the first `@finder` account item in `data[].items[]` (or `subBoxes[].items[]`) of raw=true. API references: `fetch_channel_info` = `POST /tikhub/wechat_channels/v2/fetch_channel_info` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_info`); `fetch_user_profile` = `POST /tikhub/wechat_channels/v2/fetch_user_profile` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_profile`); `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_channel_info
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_channel_infoWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the "More Info" of a WeChat Channels account: basic info section (IP location / profile location / **Channel ID** = public sph ID) + verification section (service unit / entity type / internet news service license number / service category / verification time). - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - username: WeChat Channels finder username (`v2_…@finder` format), e.g. `v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder` (People's Daily). - How to get it: - The `username` field of each video object in `fetch_video_detail` / `fetch_user_videos` responses (most common) - `fetch_channel_id_to_username`: convert a Channel ID (`sph…` short ID, e.g. `sphi9BjV8GK0Zsl`) into a finder username - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Basic info and verification info of the WeChat Channels account ### Response structure & JSON Path #### `raw=false` (simplified): - Account username: `$.data.finder_username` - Channel ID (sph short ID): `$.data.channel_id` - Section list (original section structure preserved): `$.data.sections[N].title`, `$.data.sections[N].items[M].title` / `.content` - Flattened "title→content" dict (most useful): `$.data.info`, e.g. `$.data.info['视频号ID']`, `$.data.info['IP归属地']`, `$.data.info['服务单位']`, `$.data.info['主体类型']`, `$.data.info['互联网新闻信息服务许可证编号']`, `$.data.info['服务类别']`, `$.data.info['认证时间']` #### `raw=true` (raw): - Status code: `$.data.baseResponse.ret` (0=success) - Section array (camelCase): `$.data.sections[N].title`, `$.data.sections[N].items[M].title` / `.content` / `.type` / `.jumpInfo` - Mapping: `info`/`channel_id` of raw=false correspond to `sections[].items[]` of raw=true (flattened by title with rich-text image markers stripped); raw=true does **not** contain the flattened `info` dict or `channel_id`, extract them from sections yourself. API references: `fetch_channel_id_to_username` = `POST /tikhub/wechat_channels/v2/fetch_channel_id_to_username` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_id_to_username`); `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_collection_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_collection_videosWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Given a collection `topic_id` (from `fetch_user_collections`), return the video list inside that collection. - Each video carries a `media` object (`url` / `url_token` / `decode_key`) ready for download and decryption. - Supports pagination for more videos. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `id` / `topic_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - topic_id: Collection ID (numeric, from `topic_id` of `fetch_user_collections`). E.g. `14616794565351966924` . - topic: Optional, collection name, improves hit rate. Use the exact collection name returned by fetch_user_collections. - username: Optional, creator finder username (`v2_…@finder` format), improves hit rate. - last_buffer: Optional pagination cursor (base64), **leave empty for the first page**; when `down_continue` is truthy, pass the previous page's `last_buffer`. - topic_type: Optional, collection type, default 16 (align with the collection's `topic_type` from `fetch_user_collections`). - raw: Optional, default True. True=raw response; False=simplified parsed structure (recommended for media download). ### Return - Video list of the collection with pagination cursor ### Response structure & JSON Path #### `raw=false` (simplified, snake_case, **recommended for media download**): - `$.data.topic_id` / `$.data.title` (collection name) - `$.data.total_count` — total videos in the collection; `$.data.count` — items on this page (e.g. 20) - `$.data.videos[]` — video array, per item (N is the index): - `$.data.videos[N].id` — video objectId (feed into `fetch_video_detail` / `fetch_video_comments`) - `$.data.videos[N].username` / `.nickname` / `.title` (may be null) / `.create_time` - `$.data.videos[N].read_count` / `.like_count` / `.fav_count` / `.forward_count` / `.comment_count` - `$.data.videos[N].media` — media object (single), download + decrypt: - `$.data.videos[N].media.url` — video CDN link (without Token) - `$.data.videos[N].media.url_token` — Token of the CDN link (anti-hotlinking) - `$.data.videos[N].media.full_url` — pre-concatenated full CDN URL (= `url` + `url_token`, ready to download) - `$.data.videos[N].media.decode_key` — video decryption key (**different on every request**) - Also `cover_url` / `duration` / `width` / `height` / `media_type` etc. - `$.data.down_continue` — has next page (1=yes) - `$.data.last_buffer` — pagination cursor (pass back to this endpoint for the next page) #### `raw=true` (full raw response, camelCase): - `$.data.totalCount` → `total_count` - `$.data.object[]` → `videos[]` (full video objects), per item: - `$.data.object[N].id` → `id`; `$.data.object[N].username` → `username` - Media at `$.data.object[N].objectDesc.media[0]`: `.url` → `url`, `.urlToken` → `url_token`, `.decodeKey` → `decode_key` (`full_url` is produced by the simplified layer; for raw, concatenate `url` + `urlToken` yourself) - `$.data.downContinueFlag` → `down_continue` (note: raw top level also has `continueFlag`; for collection pagination use `downContinueFlag`) - `$.data.lastBuffer` (alias `$.data.last_buffer`) → `last_buffer` ### Important Note (video download & decryption) - Same as `fetch_video_detail`: accessing `url` directly may fail due to anti-hotlinking, download via `full_url` (Token already appended); if the MP4 cannot be played it is encrypted, decrypt with the `decode_key` from the **same response** (the `decode_key` changes on every request). - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/ - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption API references: `fetch_user_collections` = `POST /tikhub/wechat_channels/v2/fetch_user_collections` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_collections`); `fetch_video_comments` = `POST /tikhub/wechat_channels/v2/fetch_video_comments` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_comments`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_live_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_live_detailWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass a live `live_id` to get live-room detail: anchor info, live status, online count, replay info, etc. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `live_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - live_id: Live ID (numeric). Source: replay items of `fetch_live_history`, live entry, or live share. E.g. `2078950291205875194`. - scene: Optional, entry scene, default 5. - finder_username: Optional, anchor finder username (`v2_…@finder` format), improves hit rate. E.g. `v2_060000231003b20faec8cae1811ac4d5c702ea32b0771737aa785454f7f8177114cc4d248d66@finder` (Huxiu). - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Live room detail ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - `$.data.live_id` — live ID; `$.data.object_id` — associated video objectId (may be empty string) - `$.data.anchor_nickname` / `$.data.anchor_username` / `$.data.anchor_head_url` — anchor nickname / username / avatar - `$.data.live_cover_url` — live cover - `$.data.live_status` — live status (1=live / 2=ended …); `$.data.status_desc` — status text (may be empty) - `$.data.online_count` / `$.data.max_online_count` — current / peak online count (usually 0 for ended lives) - `$.data.replay_status` — replay status; `$.data.replay_url` — replay address (may be empty); `$.data.replay_watch_uv` — replay viewer count #### `raw=true` (full raw response, camelCase): - `$.data.liveInfo.liveId` → `live_id`; `$.data.liveInfo.objectId` → `object_id` - `$.data.liveInfo.liveStatus` → `live_status`; `$.data.liveInfo.statusDesc` → `status_desc` - `$.data.liveInfo.onlineCnt` → `online_count`; `$.data.liveInfo.maxOnlineCount` → `max_online_count` - `$.data.liveInfo.replayStatus` → `replay_status`; `$.data.liveInfo.replayUrl` → `replay_url` - `$.data.liveInfo.replayInfo.watchUv` → `replay_watch_uv` - `$.data.anchorContact` (`nickname` / `username` / `headUrl` / `coverImgUrl` / `liveCoverImgUrl`) → anchor-related fields - Also dozens of raw fields like `$.data.liveCover`, `$.data.anchorInfo`, `$.data.replaySubscribedCount` API references: `fetch_live_history` = `POST /tikhub/wechat_channels/v2/fetch_live_history` (operationId: `post_tikhub_wechat_channels_v2_fetch_live_history`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_live_history
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_live_historyWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's live replay list. Each replay is itself a video object with a `media` object (`url` / `url_token` / `decode_key`) ready for download and decryption. - Supports pagination for more replays. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - username: WeChat Channels finder username (`v2_…@finder` format). Example (an account with live replays): `v2_060000231003b20faec8cae1811ac4d5c702ea32b0771737aa785454f7f8177114cc4d248d66@finder` (Huxiu). - last_buffer: Optional pagination cursor (base64), **leave empty for the first page**; when `continue_flag` is truthy, pass the previous page's `last_buffer`. - flag: Optional fetch flag, default 12. - raw: Optional, default True. True=raw response; False=simplified parsed structure (recommended for media download). ### Return - Live replay list with pagination cursor ### Response structure & JSON Path #### `raw=false` (simplified, snake_case, **recommended for media download**): - `$.data.username` - `$.data.count` — items on this page; `$.data.total_count` — total replays (**0 when none**) - `$.data.lives[]` — replay array, each item is a video object (same shape as videos of `fetch_collection_videos`), per item (N is the index): - `$.data.lives[N].id` — replay video objectId - `$.data.lives[N].username` / `.nickname` / `.title` / `.create_time` - `$.data.lives[N].like_count` / `.fav_count` / `.forward_count` / `.comment_count` etc. - `$.data.lives[N].media` — media object (single), download + decrypt: - `$.data.lives[N].media.url` — video CDN link (without Token) - `$.data.lives[N].media.url_token` — Token of the CDN link (anti-hotlinking) - `$.data.lives[N].media.full_url` — pre-concatenated full CDN URL (= `url` + `url_token`, ready to download) - `$.data.lives[N].media.decode_key` — video decryption key (**different on every request**) - `$.data.continue_flag` — has next page (1=yes) - `$.data.last_buffer` — pagination cursor (pass back to this endpoint for the next page) #### `raw=true` (full raw response, camelCase): - `$.data.totalCount` → `total_count` - `$.data.object[]` → `lives[]` (full video objects), media per item at `$.data.object[N].objectDesc.media[0]`: `.url` → `url`, `.urlToken` → `url_token`, `.decodeKey` → `decode_key` (`full_url` is produced by the simplified layer; for raw, concatenate `url` + `urlToken` yourself) - `$.data.continueFlag` → `continue_flag` - `$.data.lastBuffer` (alias `$.data.last_buffer`) → `last_buffer` ### Important Note (video download & decryption) - Same as `fetch_video_detail`: download via `full_url` (Token already appended); if the MP4 cannot be played it is encrypted, decrypt with the `decode_key` from the **same response**. - The `live_id` of a replay (live-room dimension) can be fed into `fetch_live_detail`. - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/ - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption API references: `fetch_collection_videos` = `POST /tikhub/wechat_channels/v2/fetch_collection_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_collection_videos`); `fetch_live_detail` = `POST /tikhub/wechat_channels/v2/fetch_live_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_live_detail`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_search_channel_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_search_channel_videosWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - In-channel search: search a creator's published videos by keyword **within that channel only**. - **Single page per call.** When `continue_flag=1` and `next_cursor` is non-empty, pass `next_cursor` back verbatim as the `cursor` parameter to get the next page. - `next_cursor` is an **opaque string** — do not parse or concatenate it. Upstream seals it (older versions leaked search-session state in plaintext). - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `doc_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - username: Creator finder username (`v2_…@finder` format). E.g. `v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder` (People's Daily). - keyword: Keyword to search within the channel (1-100 chars after trimming). For example, `news`. - raw: Optional, default True. True=raw search response; False=simplified parsed structure. ### Return - In-channel search hit list ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - `$.data.username` / `$.data.keyword` — input echo - `$.data.count` — hits on this page (e.g. 20) - `$.data.items[]` — hit array, per item (N is the index): - `$.data.items[N].type` — result type (e.g. `video`) - `$.data.items[N].doc_id` — document id - `$.data.items[N].title` — title (search highlight markers stripped) - `$.data.items[N].desc` / `.thumb_url` / `.username` / `.nickname` — description / thumbnail / author (**may be null for some items**) - `$.data.continue_flag` — has more (1=yes) - `$.data.next_cursor` — pagination cursor (opaque string; pass it back as `cursor` for the next page, `null` when there is no next page) #### `raw=true` (full raw response, camelCase): - `$.data.query` → `keyword`; `$.data.offset` — next page offset (e.g. 20) - `$.data.data[]` — result group array; hit items are nested at `$.data.data[N].subBoxes[M].items[]` (or possibly `$.data.data[N].items[]`), flattened into `items[]` by the simplified layer - `$.data.continueFlag` → `continue_flag` - `$.data.next_cursor` — same as `raw=false`: opaque pagination cursor (injected at top level). Older versions exposed `searchID` and other search context in plaintext; upstream no longer returns it ### Tip - To get media (download address / decode_key) of a hit video: this endpoint does not return `media` directly; feed the hit into `fetch_video_detail` to get `media` (`url` / `url_token` / `decode_key`). See `fetch_video_detail` docs for the chain and decryption notes. API references: `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_user_collections
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_user_collectionsWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the "Collections" list on a creator's homepage. Pass each collection's `topic_id` to `fetch_collection_videos` to get its videos. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `topic_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - username: WeChat Channels finder username (`v2_…@finder` format). E.g. `v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder` (People's Daily). - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Collection list ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - `$.data.username` — finder username - `$.data.count` — total collections (e.g. 6) - `$.data.collections[]` — collection array, per item (N is the index): - `$.data.collections[N].topic_id` — collection ID (numeric, pass to `fetch_collection_videos`, e.g. `14616794565351966924`) - `$.data.collections[N].name` — collection name - `$.data.collections[N].desc` — collection description (may be empty string) - `$.data.collections[N].cover_url` — collection cover - `$.data.collections[N].feed_count` — number of videos in the collection - `$.data.collections[N].topic_type` — collection type (e.g. 16, matches `topic_type` of `fetch_collection_videos`) #### `raw=true` (full raw response, camelCase): - `$.data.collectionCount` → `count` - `$.data.collectionInfo[]` → `collections[]`, per item: - `$.data.collectionInfo[N].collectionTopicId` → `topic_id` (number; `collectionTopicIdStr` provides a string alias) - `$.data.collectionInfo[N].collectionName` → `name` - `$.data.collectionInfo[N].collectionDesc` → `desc` - `$.data.collectionInfo[N].coverImgUrl` → `cover_url` - `$.data.collectionInfo[N].feedCount` → `feed_count` - `$.data.collectionInfo[N].collectionTopicType` → `topic_type` - Also raw fields like `lastUpdateTime` / `readCount` / `categoryId` - `$.data.lastBuffer` — pagination cursor of the collection list (usually empty; few collections, no pagination needed) API references: `fetch_collection_videos` = `POST /tikhub/wechat_channels/v2/fetch_collection_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_collection_videos`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_user_profile
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_user_profileWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get a creator's homepage profile and interaction stats. **Complementary** to `fetch_channel_info` (verification entity / license): this endpoint provides nickname / signature / avatar, follower / video / like / favorite / forward counts, live duration, IP region, collection count, linked official accounts, etc. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - username: WeChat Channels finder username (`v2_…@finder` format). Source: the `username` field of video objects in `fetch_video_detail` / `fetch_user_videos` responses; or convert a `sph…` short ID via `fetch_channel_id_to_username`. E.g. `v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder` (People's Daily). - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Account homepage profile and interaction stats ### Response structure & JSON Path #### `raw=false` (simplified, flattened snake_case): - `$.data.username` — finder username - `$.data.nickname` / `$.data.signature` / `$.data.head_url` (avatar) / `$.data.region` (IP region) - `$.data.fans_count` — follower count. **Note: some accounts (e.g. People's Daily) return 0** - `$.data.feeds_count` — video count (e.g. 10555) - `$.data.like_count` / `$.data.fav_count` / `$.data.forward_count` — like / favorite / forward counts (0 for some accounts) - `$.data.friend_follow_count` — friend-follow count - `$.data.live_duration_hours` — accumulated live streaming hours - `$.data.original_flag` — original-content flag - `$.data.collection_count` — collection count (e.g. 6; details via `fetch_user_collections`) - `$.data.verify_desc` — verification description (may be null) - `$.data.linked_accounts[]` — linked official accounts `[{nickname, type}]` #### `raw=true` (full raw response, nested camelCase): - `$.data.contact.nickname` / `.signature` / `.headUrl` → `nickname` / `signature` / `head_url` - `$.data.contact.username` → `username`; `$.data.contact.originalFlag` → `original_flag` - `$.data.contact.authInfo` (`authProfession` / `authIconType` …) — verification info - `$.data.ipRegionInfo.regionText` → `region` - `$.data.fansCount` → `fans_count` (also 0 for some accounts); `$.data.feedsCount` → `feeds_count` - `$.data.feedsLikeCount` / `.feedsFavCount` / `.feedsForwardCount` → `like_count` / `fav_count` / `forward_count` - `$.data.liveDurationHours` → `live_duration_hours`; `$.data.collectionListInfo.collectionCount` → `collection_count` - `$.data.bizInfo.info[]` (`bizNickname` / `serviceTypeName`) → `linked_accounts[]` - Also contains dozens of raw fields like `$.data.object[]` (first-screen video list), `$.data.anchorStatInfo` (live session stats), `$.data.lastBuffer` / `$.data.continueFlag` (pagination of the first-screen videos; generally unused here since this endpoint is for profile data). API references: `fetch_channel_id_to_username` = `POST /tikhub/wechat_channels/v2/fetch_channel_id_to_username` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_id_to_username`); `fetch_channel_info` = `POST /tikhub/wechat_channels/v2/fetch_channel_info` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_info`); `fetch_user_collections` = `POST /tikhub/wechat_channels/v2/fetch_user_collections` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_collections`); `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_user_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_user_videosWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the video list from a WeChat Channels account's homepage. - Each video carries a `media` object (`url` / `url_token` / `full_url` / `decode_key`) ready for download and decryption. - Supports pagination for more videos. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `id` / `object_nonce_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - username: WeChat Channels finder username (`v2_…@finder` format), e.g. `v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder` (People's Daily). See `fetch_channel_info` / `fetch_video_detail` / `fetch_channel_id_to_username` docs for how to obtain it. - last_buffer: Optional pagination cursor (base64). **Leave empty for the first page**; when `up_continue` in the response is truthy, pass the previous page's `last_buffer` to get the next page. (base64 contains `+//=` characters, hence body instead of query.) - raw: Optional, default True. True=raw response; False=simplified parsed structure (recommended for media download). ### Return - User video list with pagination cursor ### Response structure & JSON Path #### `raw=false` (simplified, recommended): - Top level: `$.data.username` / `$.data.nickname` / `$.data.count` (videos on this page) / `$.data.up_continue` (has next page) / `$.data.last_buffer` (pagination cursor) - Each video `$.data.videos[N]` (N is the index): - `id` (video objectId, feed into `fetch_video_detail` / `fetch_video_comments`): `$.data.videos[N].id` - `object_nonce_id`: `$.data.videos[N].object_nonce_id` - `username` / `nickname` / `title`: `$.data.videos[N].username` etc. - Interaction counts: `$.data.videos[N].read_count` / `.like_count` / `.fav_count` / `.forward_count` / `.comment_count` - Publish time: `$.data.videos[N].create_time` - Location: `$.data.videos[N].location` #### `raw=true` (raw): - Status code: `$.data.baseResponse.ret` - Video array (note: singular **`object`**, camelCase): `$.data.object[N]` - Pagination: `$.data.upContinueFlag`, `$.data.lastBuffer` (alias `$.data.last_buffer` also provided) - Account profile: `$.data.contact` (nickname/signature/`authInfo` etc.), `$.data.finderUserInfo` - Mapping: `videos[]` of raw=false corresponds to `object[]` of raw=true; `nickname` comes from `finderUserInfo` / `contact.nickname`. ### Important Note (video download & decryption) - Accessing the `url` field directly may fail to open the video page — WeChat Channels uses **anti-hotlinking**. Concatenate `url` and `url_token` into a full URL and download via any HTTP client (opening = HTTP 200, **does not mean playable**, the file is encrypted). - ⚠️ **Video Encryption Notice**: If the downloaded MP4 cannot be played, it is encrypted. Use the `decode_key` field from the response together with the encrypted file to decrypt it. - ⚠️ **Important**: WeChat returns a **new encrypted link and `decode_key` on every request** (even for the same video). Make sure the `decode_key` and the downloaded encrypted file come from the **same API response**, otherwise decryption will fail. - JSON Path (per video — N is the index): - `raw=false` (**recommended for media download**) — `$.data.videos[N].media` is a single object: - Video CDN link (without Token): `$.data.videos[N].media.url` - Token of the video CDN link: `$.data.videos[N].media.url_token` - Pre-concatenated full CDN URL (= url + url_token, ready to use): `$.data.videos[N].media.full_url` - Video decryption key (different on every request): `$.data.videos[N].media.decode_key` - `raw=true` — media is nested at `$.data.object[N].objectDesc.media[0]` (camelCase: `url` / `urlToken` / `decodeKey`, full URL = `url` + `urlToken`). For media download, prefer `raw=false` for cleaner paths. - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/ - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption API references: `fetch_channel_id_to_username` = `POST /tikhub/wechat_channels/v2/fetch_channel_id_to_username` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_id_to_username`); `fetch_channel_info` = `POST /tikhub/wechat_channels/v2/fetch_channel_info` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_info`); `fetch_video_comments` = `POST /tikhub/wechat_channels/v2/fetch_video_comments` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_comments`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_video_comments
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_video_commentsWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get first-level comments of a video (with IP region / like count); pass `comment_id` to get second-level replies under that comment. - Supports pagination for more comments. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `comment_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - object_id: Video objectId (numeric), e.g. `14941130915890399732`. From the video `id` of `fetch_user_videos` / `fetch_video_detail`. - last_buffer: Optional pagination cursor (base64). **Leave empty for the first page**; when `down_continue` is truthy, pass the previous page's `last_buffer`. - comment_id: Optional. To expand the replies of a comment, pass its `comment_id` (numeric); leave empty for the first-level page. - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Comment list with pagination cursor ### Response structure & JSON Path #### `raw=false` (simplified): - Top level: `$.data.object_id` (echo) / `$.data.comment_id` (echo when expanding replies, otherwise null) / `$.data.count` (comments on this page) / `$.data.down_continue` (has next page) / `$.data.last_buffer` (pagination cursor) - Each comment `$.data.comments[N]`: - Comment ID (pass it back to expand its replies): `$.data.comments[N].comment_id` - Commenter: `$.data.comments[N].nickname` / `.username` / `.head_url` - Content: `$.data.comments[N].content` - Like / reply counts: `$.data.comments[N].like_count` / `.reply_count` - Time / IP region: `$.data.comments[N].create_time` / `.ip_region` #### `raw=true` (raw): - Status code: `$.data.baseResponse.ret` - Comment array (camelCase): `$.data.commentInfo[N]`, key fields `commentId` / `nickname` / `username` / `content` / `likeCount` / `createtime` / `headUrl` / `ipRegionInfo.regionText` - Pagination: `$.data.downContinueFlag`, `$.data.lastBuffer` (alias `$.data.last_buffer` also provided) - Global counts: `$.data.monotonicData.commentCount.commentCount`, `$.data.countInfo` (likeCount/favCount/forwardCount etc.) - Mapping: `comments[]` of raw=false corresponds to `commentInfo[]` of raw=true. API references: `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_video_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_video_detailWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the full detail of a WeChat Channels video (media address `media` + `decode_key`). - Three input options, **choose one, priority object_id > export_id > share_url**. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - object_id: Highest priority, optional. Video objectId (numeric), e.g. `14941130915890399732`. Obtainable from the video `id` of `fetch_user_videos` / `fetch_collection_videos`. - export_id: Second priority, optional. `exportId` from search results (must start with `export/`). Search results often only carry `exportId` without a plain object_id — pass export_id directly in that case (it expires, use it soon). - object_nonce_id: Optional. `feedNonceId` (numeric) from search results, pairs with the above to improve hit rate. - share_url: Last, optional. Channels share URL (`https://weixin.qq.com/sph/…`), e.g. `https://weixin.qq.com/sph/AH3sCoIPhH`. Used only when both object_id and export_id are empty. - raw: Optional, default True. True=raw response; False=simplified parsed structure (recommended for media download). - At least one of the three must be provided; `share_url` must be a Channels share URL (`https://weixin.qq.com/sph/…`). ### Return - Full video detail (including media download address and decryption key) ### Typical chain (from a video to the account / more videos) 1. This endpoint `fetch_video_detail` → response contains plain `id` (objectId), `username` (`v2_…@finder`), `media` (`url` / `url_token` / `decode_key`) 2. Feed the obtained `username` into → `fetch_channel_info` (account info / verification), `fetch_user_videos` (more videos of the account), `fetch_user_profile` (homepage stats), `fetch_video_comments` (comments of this video, using `id` from step 1) ### Response structure & JSON Path #### `raw=false` (simplified, recommended): - `data` is a single video object: - `id` (video objectId): `$.data.id` - `username` (`v2_…@finder`) / `nickname` / `title`: `$.data.username` etc. - Interaction counts: `$.data.read_count` / `.like_count` / `.fav_count` / `.forward_count` / `.comment_count` - Publish time / type / location: `$.data.create_time` / `$.data.object_type` / `$.data.location` - Media object: `$.data.media` (see download/decryption below) #### `raw=true` (raw): - Status code: `$.data.baseResponse.ret` - Hit receipt: `$.data.objectResponses[0].objectId` / `.exportId` - Video object (**note: plural `objects`**, camelCase): `$.data.objects[0]` - Mapping: flat fields of raw=false correspond to `objects[0]` of raw=true. ### Important Note (video download & decryption) - Accessing the `url` field directly may fail to open the video page — WeChat applies **anti-hotlinking** to Channels pages. Concatenate `url` and `url_token` into a complete URL, then open it in a browser / HTTP client. (Note: opening = HTTP 200, **does not mean playable**, the video file is encrypted.) - ⚠️ **Video Encryption Notice**: If the MP4 cannot be played, it is encrypted. Use the `decode_key` field from the response together with the encrypted video file to decrypt it. - ⚠️ **Important**: The WeChat API returns a **new encrypted file link and `decode_key` on every request**, even for the same video. Make sure the `decode_key` used for decryption and the downloaded encrypted file come from the **same API response**, otherwise decryption will fail. - JSON Path (by raw): - `raw=false` (recommended for media download) — `$.data.media` is a single object: - Video CDN link (without Token): `$.data.media.url` - Token of the video CDN link: `$.data.media.url_token` - Pre-concatenated full CDN URL (= `url` + `url_token`, ready to use): `$.data.media.full_url` - Video decryption key (different on every request): `$.data.media.decode_key` - `raw=true` — `$.data.objects[0].objectDesc.media[0]`: - Video CDN link (without Token): `$.data.objects[0].objectDesc.media[0].url` - Token: `$.data.objects[0].objectDesc.media[0].urlToken` - Full URL = `url` + `urlToken` (concatenate) - Video decryption key: `$.data.objects[0].objectDesc.media[0].decodeKey` - Online decryption tool: https://evil0ctal.github.io/WeChat-Channels-Video-File-Decryption/ - Self-deployable decryption API (one-click Docker deployment): https://github.com/Evil0ctal/WeChat-Channels-Video-File-Decryption API references: `fetch_channel_info` = `POST /tikhub/wechat_channels/v2/fetch_channel_info` (operationId: `post_tikhub_wechat_channels_v2_fetch_channel_info`); `fetch_collection_videos` = `POST /tikhub/wechat_channels/v2/fetch_collection_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_collection_videos`); `fetch_user_profile` = `POST /tikhub/wechat_channels/v2/fetch_user_profile` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_profile`); `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`); `fetch_video_comments` = `POST /tikhub/wechat_channels/v2/fetch_video_comments` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_comments`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_channels fetch_video_share_url
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_channels/v2/fetch_video_share_urlWeChat Channels (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Given a video `object_id`, return a shareable `weixin.qq.com/sph/…` short link (the inverse of the `share_url` input of `fetch_video_detail`). - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - object_id: Video objectId (numeric), e.g. `14941130915890399732`. From the video `id` of `fetch_user_videos` / `fetch_video_detail`. - raw: Optional, default True. True=raw response; False=simplified parsed structure. ### Return - Video share short link ### Response structure & JSON Path #### `raw=false` (simplified): - Input echo: `$.data.object_id` - Generated share link (feed directly into `share_url` of `fetch_video_detail`): `$.data.share_url` #### `raw=true` (raw): - Status code: `$.data.baseResponse.ret` - Share link: `$.data.feedH5Url` - List form (per item when batched): `$.data.urlList[N].feedH5Url` / `$.data.urlList[N].objectId` - Mapping: `share_url` of raw=false comes from `feedH5Url` (or `urlList[0].feedH5Url`) of raw=true; `object_id` is the input echo. API references: `fetch_user_videos` = `POST /tikhub/wechat_channels/v2/fetch_user_videos` (operationId: `post_tikhub_wechat_channels_v2_fetch_user_videos`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_account_articles
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_account_articlesWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass a `gh_username` to get a **single page** of the account's historical posts (**article** tab). - **Manual paging**: leave `offset` empty for the first page → take `next_offset` (base64 cursor) from the response → pass it as **`offset`** in the next request; `is_end` truthy means the last page. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - username: Official account `gh_username` (`gh_…`). E.g. `gh_363b924965e9` - page_size: Optional, default 20. NOTE: WeChat currently **ignores** this parameter — the count is decided by the account itself (1 and 40 return identically). Paginate with `offset` / `next_offset`. - offset: Optional pagination cursor (base64), **leave empty for the first page**; for the next page pass `next_offset` from the previous response. E.g. `CAMQChiS5KfRBiAKOJLkp9EGQABIAVgAYABwAQ==` - item_show_type: Optional content tab (matches the "Articles / Videos / Audios" tabs on the account homepage). Empty / `0`=articles (default), `5`=videos, `7`=audios, `8`=image-text posts. Omitting it = articles, behavior unchanged. - raw: Optional, default True. True=raw; False=simplified parsing. ### Return - Single page of articles with pagination cursor > Tip: `offset` is a base64 cursor (contains `+/=`), hence POST body. This endpoint **fetches a single page only and does not auto-paginate**. ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - Account username: `$.data.biz_username` - Is last page (0/1): `$.data.is_end` - Articles returned on this page: `$.data.count` - Next-page cursor (pass back as `offset`; null at the last page): `$.data.next_offset` - Article list: `$.data.articles[]` - Single article (N is the index): - Article appmsgid: `$.data.articles[N].app_msg_id` - Title: `$.data.articles[N].title` - Digest: `$.data.articles[N].digest` - URL: `$.data.articles[N].url` - Cover: `$.data.articles[N].cover` (multi-ratio `$.data.articles[N].covers`) - Publish / update timestamps: `$.data.articles[N].create_time` / `.update_time` - Position / type within the batch: `$.data.articles[N].idx` / `.msg_type` / `.item_show_type` - Image count / paid flags: `$.data.articles[N].pic_count` / `.is_paid` / `.is_pay_subscribe` #### `raw=true` (raw, default for this endpoint): - `data` top-level fields match the simplified version (`biz_username` / `is_end` / `count` / `next_offset`), but `articles[]` are full raw batch entries (nested camelCase): - Per entry: `$.data.articles[N].appMsg` (with `baseInfo` / `detailInfo`), `$.data.articles[N].baseInfo` (`msgId` / `msgType` / `dateTime` / `status`) - Article bodies are in `$.data.articles[N].appMsg.detailInfo` (one batch may contain multiple articles: headline / secondary) - Pagination also uses top-level `next_offset` passed back as `offset`. For list display, prefer `raw=false` for cleaner paths. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_account_profile
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_account_profileWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass an account username to get the profile: nickname / IP region / original article count / verification entity type / linked Channels account, etc. - NOTE: **signature and avatar are not obtainable through this path** — WeChat's profile response carries neither. They are always `null` and listed in `$.data.unavailable[]` (never faked as empty strings). - For the **avatar**, use `/tikhub/wechat_mp/v2/fetch_article_detail_h5` instead (pass any article URL of that account with `raw=true`): `$.data.content.round_head_img` / `$.data.content.hd_head_img`. No endpoint currently exposes the signature. - Some accounts (like the example) have sparse fields; `nick_name` / `signature` / `head_url` may be `null`. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - username: Official account `gh_username` (`gh_…`). Sources: `content.user_name` from article detail, or `jumpInfo.userName` from WeChat Search V2 `fetch_search` (business_type=account) results. E.g. `gh_363b924965e9` - raw: Optional, default True. True=raw; False=simplified parsing. ### Return - Official account profile info ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - Account username (`gh_…`): `$.data.user_name` - Nickname (may be null): `$.data.nick_name` - User role: `$.data.user_role` - Service type (subscription / service account code): `$.data.service_type` - Signature / description (may be null): `$.data.signature` - Avatar (may be null): `$.data.head_url` - Ban type (0=normal): `$.data.ban_type` #### `raw=true` (raw, default for this endpoint): - `data` is the full raw response (dozens of top-level fields); simplified fields map to nested locations: - Base info block: `$.data.baseInfo` (raw source of nickname / avatar / description) - Account info: `$.data.accountInfo` (with `userName` etc.) - Stats info: `$.data.statInfo` - Linked Channels account: `$.data.videoFinderInfo` - Service info (raw source of custom menu): `$.data.serviceInfo` - Article tab / message list: `$.data.articleTab` / `$.data.msgList` - IP region: `$.data.ipwording` - Others: `liveInfo` / `nameCard` / `gender` / `setting` / `funcFlag` etc. API references: `fetch_article_detail_h5` = `POST /tikhub/wechat_mp/v2/fetch_article_detail_h5` (operationId: `post_tikhub_wechat_mp_v2_fetch_article_detail_h5`); `fetch_search` = `POST /tikhub/wechat_search/v2/fetch_search` (operationId: `post_tikhub_wechat_search_v2_fetch_search`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_account_services
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_account_servicesWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass a `gh_username` to get the custom menu / service entries at the bottom of the official account. Accounts without a custom menu return an empty menu. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - username: Official account `gh_username` (`gh_…`). E.g. `gh_363b924965e9` - raw: Optional, default True. True=raw; False=simplified parsing. ### Return - Custom menu / service entries of the official account ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - Account username: `$.data.biz_username` - Menu item list (`[]` when no menu): `$.data.menu[]` — each item is a menu button (name / type / sub-menu / jump); the array is empty for accounts without a custom menu. #### `raw=true` (raw, default for this endpoint): - `data` is the full raw menu structure. Accounts without a configured menu return an empty object `{}`. - The simplified `menu[]` is extracted from this raw structure. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_ad
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_adWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass an article URL to get the embedded ad slot info of the article. This endpoint responds relatively slowly, please be patient; articles without ads return empty. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - url: WeChat MP article URL. E.g. `https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw` (this article has no ads, returns empty) - raw: Optional, default True. True=full raw response; False=flattened ad list. ### Return - Article ad slot info ### Response structure & JSON Path #### `raw=false` (simplified projection): - `data` is the flattened ad list: - `$.data.count`: number of ads (merged from `advertisement_info` and `ad_slot_data`) - `$.data.ads[]`: ad item list (`[]` when no ads) #### `raw=true` (raw): - `data` is aggregated by the responses captured: - `$.data.pages`: number of response pages - `$.data.results[]`: full raw response per page (raw ad fields are inside `advertisement_info` / `ad_slot_data` of each page — the source of `ads` in simplified mode) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_comments
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_commentsWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get WeChat MP article comments (single page, `buffer` cursor pagination); returns one page of featured comments. - **Pagination**: leave `buffer` empty for the first page → take `buffer` from the response → pass it back in the next request; `has_more` false means the last page. - For second-level replies of a specific comment, use `fetch_comment_replies` (pass the comment's `content_id`). - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `content_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - url: WeChat MP article URL (`https://mp.weixin.qq.com/s/…`). E.g. `https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw` - buffer: Optional, default empty. Pagination cursor; leave empty for the first page, pass `buffer` from the previous response for the next page. - raw: Optional, default True. True=full raw comment objects; False=simplified comment view. ### Return - One page of comments with pagination cursor ### Response structure & JSON Path #### `raw=false` (simplified view): - `data` outer level is the page summary; `comments[]` are simplified comments: - `$.data.appmsgid`: message id - `$.data.elected_total`: total featured comments - `$.data.total_count`: total comments - `$.data.buffer`: next-page cursor (pass back as `buffer`; empty string at the last page) - `$.data.has_more`: whether there is a next page - `$.data.comment_id`: article comment identifier (internal) - `$.data.comments[N].content_id`: comment id (**feed into `content_id` of `fetch_comment_replies`**) - `$.data.comments[N].nick_name`: commenter nickname - `$.data.comments[N].content`: comment content - `$.data.comments[N].like_num`: like count - `$.data.comments[N].create_time`: comment timestamp - `$.data.comments[N].ip_wording`: IP region (`province_name` / `city_name` etc.) - `$.data.comments[N].is_elected` / `is_top`: featured / pinned flags - `$.data.comments[N].reply_total`: total second-level replies - `$.data.comments[N].replies[]`: reply preview (simplified, see `fetch_comment_replies`) #### `raw=true` (raw): - `data` outer level same as above (`appmsgid` / `elected_total` / `total_count` / `buffer` / `has_more` / `comment_id`); `comments[]` are full raw comment objects with more fields (snake_case): - `$.data.comments[N].content_id`: comment id (same as simplified mode, still the value fed into `fetch_comment_replies`) - `$.data.comments[N].content` / `nick_name` / `like_num` / `create_time` / `ip_wording` / `is_elected` / `is_top`: same names and meanings as `raw=false` - Raw-only extra fields: `$.data.comments[N].id` (floor number) / `openid` / `identity_type` / `logo_url` (avatar) / `like_status` / `is_from_me` / `$.data.comments[N].reply_new` (with `reply_total_cnt` / `reply_list`, corresponding to `reply_total` / `replies` of the simplified mode) API references: `fetch_comment_replies` = `POST /tikhub/wechat_mp/v2/fetch_comment_replies` (operationId: `post_tikhub_wechat_mp_v2_fetch_comment_replies`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_detailWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass an article URL to get the article body / title / author / cover / publish time / album info. - Regardless of `raw`, the nested `content` JSON string is always parsed into an object (structure normalized); `raw` only controls the projection scope of outer fields. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `comment_id` / `msgId` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - url: WeChat MP article URL (`https://mp.weixin.qq.com/s/…` or long URL with `__biz`). E.g. `https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw` - raw: Optional, default True. True=raw response; False=simplified projection. ### Return - Article detail (body / title / author / cover / publish time / album info) ### Response structure & JSON Path #### `raw=false` (simplified projection): - `data` has only 4 top-level fields; the article body is aggregated in `content`: - `$.data.url`: article URL - `$.data.bizUin`: official account bizUin (int) - `$.data.itemIdx`: article position index - `$.data.content`: parsed body object, common paths: - `$.data.content.title`: title - `$.data.content.nick_name` / `$.data.content.user_name`: account name / gh_username - `$.data.content.author`: author - `$.data.content.desc`: digest - `$.data.content.create_time`: publish time (text like `"2025-03-05 12:22"`) - `$.data.content.ori_create_time`: publish timestamp (int seconds) - `$.data.content.cdn_url`: cover image - `$.data.content.comment_id`: comment id (internal id fed into comment endpoints) - `$.data.content.appmsgalbuminfo`: album info (`album_id` / `title` / prev & next links) - `$.data.content.content_text`: plain text extracted from the body HTML #### `raw=true` (raw): - `data` is the full item (all fields of `raw=false`, plus template / cache / time metadata): - `$.data.url` / `$.data.bizUin` / `$.data.itemIdx`: same as simplified mode - `$.data.msgId`: message id - `$.data.lastModifyTime`: last modified timestamp - `$.data.tmplVersion` / `$.data.tmplVersions[]`: H5 template versions - `$.data.clientCacheTime`: client cache seconds - `$.data.content.*`: same structure as `content` of `raw=false` (also includes `content_text`) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_detail_h5
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_detail_h5WeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Fetch WeChat MP article detail via the H5 channel. **Recommended by default**: the body is more reliable and the field coverage is the widest. - Independent from `/tikhub/wechat_mp/v2/fetch_article_detail`; neither falls back to the other. ### Parameters - url: WeChat MP article URL. - raw: Optional, default True. True = extra meta fields; False = core fields only. Top-level shape is identical either way. ### Returns - Article detail (title / author / cover / publish time / album / tags / images ...) API references: `fetch_article_detail` = `POST /tikhub/wechat_mp/v2/fetch_article_detail` (operationId: `post_tikhub_wechat_mp_v2_fetch_article_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_stats
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_statsWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass an article URL to get its interaction metrics (reads / likes / "wow" / shares / favorites / comments). - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - url: WeChat MP article URL (`https://mp.weixin.qq.com/s/…`). E.g. `https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw` - raw: Optional, default True. True=full raw stats object (with `show_*` visibility flags); False=simplified counts only. ### Return - Article interaction stats ### Response structure & JSON Path #### `raw=false` (simplified counts): - `data` contains 7 count fields: - `$.data.read_num`: read count - `$.data.like_count`: like count - `$.data.old_like_count`: "wow" count (old "Looking") - `$.data.share_count`: share count - `$.data.collect_count`: favorite count - `$.data.comment_count`: comment count - `$.data.star_num`: star / like count #### `raw=true` (raw): - `data` is the full raw stats object: all counts of `raw=false` (same names and meanings), plus visibility / status flags: - Counts: `$.data.read_num` / `$.data.like_count` / `$.data.old_like_count` / `$.data.share_count` / `$.data.collect_count` / `$.data.comment_count` / `$.data.star_num` - Visibility flags: `$.data.show_like` / `$.data.show_old_like` / `$.data.show_share` / `$.data.show_collect` / `$.data.show_read` / `$.data.show_star` (and corresponding `*_gray` flags) - Status: `$.data.comment_enabled` (comment switch) / `$.data.get_data_succ` (fetch success) / `$.data.is_subscribed` / `$.data.verify_status` / `$.data.can_use_star` <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_article_stats_h5
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_article_stats_h5WeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Fetch comment counts for a WeChat MP article via the H5 channel. - Read count / likes / shares / favorites are **not available** here: they are returned as `null` and listed in `$.data.unavailable[]` (never faked as `0`). Use `/tikhub/wechat_mp/v2/fetch_article_stats` when you need them. ### Parameters - url: WeChat MP article URL. - raw: Optional, default True. True = include raw counter fields; False = counts only. ### Returns - comment_count / elected_comment_count; other metrics are null and listed in unavailable[] API references: `fetch_article_stats` = `POST /tikhub/wechat_mp/v2/fetch_article_stats` (operationId: `post_tikhub_wechat_mp_v2_fetch_article_stats`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_comment_replies
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_comment_repliesWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the second-level replies under a first-level comment. - Chain: first call `fetch_article_comments` to get each comment's `content_id`, then feed it into this endpoint. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `content_id` / `reply_id` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - url: WeChat MP article URL (`https://mp.weixin.qq.com/s/…`). E.g. `http://mp.weixin.qq.com/s?__biz=Mzk3NTA0MzM5NA==&mid=2247483745&idx=1&sn=3f34e768cf457a501038991ed30be1f4#rd` - content_id: Optional (numeric). `content_id` of the target first-level comment, from `$.data.comments[N].content_id` of the `fetch_article_comments` response; **defaults to the first comment that has replies when omitted**. E.g. `12109128638545265979` - offset: Optional, default 0 (>=0). Reply pagination offset; 0 for the first page, pass `next_offset` from the previous response when `has_more=true`. - Note: `all_pages` was removed upstream — it issued up to 30 upstream requests per billed call and omitted `has_more` / `next_offset`, so callers could not tell the result was truncated. Paginate with `offset` / `next_offset` instead. - raw: Optional, default True. True=full raw reply objects; False=simplified replies. ### Return - Second-level reply list with pagination info > Note: the **outer structure is identical** for `raw=true` and `raw=false`; the difference is only in the field granularity of each `replies[]` element (simplified view vs full raw object). ### Response structure & JSON Path #### `raw=false` (simplified replies): - `$.data.content_id`: target comment id (echo) - `$.data.parent_nick`: nickname of the parent comment (the one replied to) - `$.data.reply_total`: total second-level replies - `$.data.count`: number of replies returned this time - `$.data.replies[N].reply_id`: reply id - `$.data.replies[N].nick_name`: replier nickname - `$.data.replies[N].content`: reply content - `$.data.replies[N].create_time`: reply timestamp - `$.data.replies[N].ip_wording`: IP region - `$.data.replies[N].identity_name`: identity label - `$.data.replies[N].from_ai` / `reply_is_elected`: AI reply / featured flags - Pagination fields: `$.data.offset` / `$.data.next_offset` / `$.data.has_more` #### `raw=true` (raw): - Outer `content_id` / `parent_nick` / `reply_total` / `count` (and `offset` / `next_offset` / `has_more` in single-page mode) are **identical** to `raw=false`; the only difference is that `replies[]` elements are full raw reply objects (including fields projected away in `raw=false`). Common paths remain `$.data.replies[N].content` / `$.data.replies[N].reply_id` / `$.data.replies[N].nick_name`. API references: `fetch_article_comments` = `POST /tikhub/wechat_mp/v2/fetch_article_comments` (operationId: `post_tikhub_wechat_mp_v2_fetch_article_comments`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_mp fetch_related_articles
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_mp/v2/fetch_related_articlesWeChat Official Accounts (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Pass an article URL to get the "related articles" at the bottom of the article. Articles without this feature return an empty list. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. ### Parameters - url: WeChat MP article URL (long or short form). E.g. `https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw` (this article has related articles disabled, returns empty) - raw: Optional, default True. True=full raw response; False=simplified projection. ### Return - Related article list ### Response structure & JSON Path #### `raw=false` (simplified projection): - `data` is flattened into three fields: - `$.data.ret`: return code (0 = OK) - `$.data.count`: number of related articles - `$.data.articles[]`: related article list (merged from whichever source list hits; `[]` when empty) #### `raw=true` (raw): - `data` is the full raw response: - `$.data.article_size`: number of related articles (corresponds to `count` in simplified mode) - `$.data.list[]`: raw related article list (corresponds to `articles` in simplified mode) - `$.data.base_resp.ret`: return code (corresponds to `ret` in simplified mode); `base_resp.exportkey_token`: export token - `$.data.empty_scene`: empty-result scene code; `$.data.show_rec_reason`: whether to show recommendation reason; `$.data.report_info`: report info (JSON string) <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_search fetch_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_search/v2/fetch_searchWeChat Search (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - WeChat universal search universal search; the vertical is switched by the `business_type` **string key** — just pass a keyword. - **Verified to return data**: all / official accounts (incl. service accounts and Channels) / articles / Channels videos / stickers. - ⚠️ The other verticals (live streams, Moments, news, books, listen, images, encyclopedia, WeChat Index, underline, comments, photos, mini games, AI search) are gated server-side per account & region and currently always come back empty. A non-empty `no_more` is the universal signal (top level in both `raw=true` and `raw=false`); `raw=false` additionally gives `count=0` + `items=[]`. Still billed as a normal call. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `docID` / `feedNonceId` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - keyword: Search keyword (1-100 chars after trimming). For example, an account display name - business_type: Optional, default `all`. Vertical string key (18 total). **Verified to return data**: `all` / `account` / `article` / `video` / `sticker`. The rest (`underline` / `encyclopedia` / `live_stream` / `comment` / `listen` / `news` / `photos` / `book` / `moments` / `image` / `mini_game` / `weixin_index` / `ai_search`) are gated server-side per account & region and currently always come back empty. Any value outside this list is rejected (422). - sort: Optional, default `default`. Sort (result page "sort" dropdown, common to all verticals) — `default`/0 (relevance) / `latest`/1 (newest) / `hot`/2 (most liked); string key or integer, invalid values rejected (400). - publish_time: Optional, default `all`. Publish time (result page "time" dropdown, common) — `all`/0 / `day`/1 / `week`/2 / `half_year`/3; string key or integer, invalid values rejected (400). - offset: Optional, default 0 (>=0). Pass `0` for the first page; **use `cursor` to paginate — offset alone does not work** (it returns the first page every time). - cursor: Optional. Pagination cursor. Leave empty for the first page; for the next page pass back the `cursor` returned in the previous response (repeat the same `sort` / `publish_time`), and use `continue_flag` to check whether there are more pages. - raw: Optional, default True. True=raw search response; False=simplified parsing. 💡 The "duration" filter specific to the video vertical is available at `/tikhub/wechat_search/v2/fetch_search_videos` (`business_type=video` + `duration`). ### Return - Search result list (structure varies slightly by vertical) ### Typical chains - 💡 **To get Channels video detail (media download address / decode_key)**: video result items from search (`video` / `all`) do **not** contain media directly — only `exportId` (+ `jumpInfo.extInfo.feedNonceId`). To download / decrypt: take `exportId` → call the Channels V2 endpoint `/tikhub/wechat_channels/v2/fetch_video_detail` (pass `export_id`) to get `media` (`url` / `url_token` / `decode_key`) and the plain `username`. See that endpoint's docs for the full chain and decryption notes. - The `jumpInfo.userName` (`gh_…`) of official account result items can be fed into the MP V2 endpoints `/tikhub/wechat_mp/v2/fetch_account_profile` / `fetch_account_articles`. ### Response structure & JSON Path #### `raw=false` (simplified, snake_case): - Keyword echo: `$.data.keyword` - Effective vertical code (e.g. account=33554499): `$.data.business_type` - Total results: `$.data.total` — the **maximum** `totalCount` scanned across every box and subBox (a vertical's `totalCount` hangs off `subBoxes`; the All tab has no single total, so this is the largest contributing box). **null on a zero-result page** (no positive totalCount anywhere), so it is always null for the always-empty verticals - Has next page: `$.data.continue_flag` - Pagination cursor (pass back as the `cursor` parameter for the next page): `$.data.cursor` - Server-side offset (informational only; passing it back alone does **not** paginate): `$.data.offset` - Results on this page: `$.data.count` - Flattened result item list (items of all boxes / subBoxes merged): `$.data.items[]` - Server-issued vertical tab list (only present for `business_type=all`, null otherwise): `$.data.categories[]` — each entry has `.type` / `.word` / `.extra_kvs`. **This is the authoritative list of verticals actually available to the serving account.** Note `.type` is the vertical's **integer code** (e.g. 33554499) while this endpoint's `business_type` accepts only the 18 **string keys** above — an integer is rejected (422), so map it yourself (e.g. 33554499 → `account`). - Server wording for a zero-result page: `$.data.no_more` (present = a legitimate empty result from WeChat, **not** a failed call) - Single item (N is the index; fields vary by vertical; below is an `account` example): - Title (with `<em>` highlight): `$.data.items[N].title` - Description: `$.data.items[N].desc` - Document id: `$.data.items[N].docID` - Type name: `$.data.items[N].accTypeName` - Jump info: `$.data.items[N].jumpInfo` (`.userName` = `gh_…`, `.nickName`, `.signature`) - Video vertical items also carry `exportId` (+ `jumpInfo.extInfo.feedNonceId`) → see "Typical chains" above #### `raw=true` (raw, default for this endpoint): - `data` top level: `keyword` / `business_type` / `results` (items are **not** flattened) / `total` / `continue_flag` / `offset` / `cursor` / `categories` / `no_more` (`total` / `categories` / `no_more` are top level in both modes — the key sets are aligned) - Full result set: `$.data.results` - Result box array: `$.data.results.data[]`; each box's results are in `$.data.results.data[M].items[]` and `$.data.results.data[M].subBoxes[K].items[]` — the `items[]` of `raw=false` is the flattened merge of these. - Has next page: `$.data.continue_flag` (top level for both `raw=true` / `raw=false`) - Pagination cursor: `$.data.cursor` — pass it back as the `cursor` parameter for the next page; `$.data.offset` is only the server-side offset and passing it back alone does **not** paginate - Read the total from the top level `$.data.total` (present in both raw modes) — it is the **maximum** of `$.data.results.data[M].totalCount` and `$.data.results.data[M].subBoxes[K].totalCount`; a vertical's number hangs off `subBoxes`, so reading only the top-level box's `totalCount` yields null - For result iteration, prefer `raw=false` (items already flattened) for cleaner paths. API references: `fetch_account_articles` = `POST /tikhub/wechat_mp/v2/fetch_account_articles` (operationId: `post_tikhub_wechat_mp_v2_fetch_account_articles`); `fetch_account_profile` = `POST /tikhub/wechat_mp/v2/fetch_account_profile` (operationId: `post_tikhub_wechat_mp_v2_fetch_account_profile`); `fetch_search_videos` = `POST /tikhub/wechat_search/v2/fetch_search_videos` (operationId: `post_tikhub_wechat_search_v2_fetch_search_videos`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
wechat_search fetch_search_videos
$MeteredPOST https://aisa.one/apis/v1/tikhub/wechat_search/v2/fetch_search_videosWeChat Search (v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Search WeChat Channels videos specifically (`video` vertical), with the result page's "duration" filter, "relevance/newest/most-liked" sort, and "time" dropdown. - Equivalent to universal search `/tikhub/wechat_search/v2/fetch_search` (`business_type=video`) plus filters; all filters are verified to work. - ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response. - ⚠️ Large-integer ID precision: IDs such as `docID` / `feedNonceId` in the response are 64-bit big integers beyond JavaScript's safe-integer range (2^53-1). Always receive / pass such IDs as **strings** (parse JSON with json-bigint or read them as text), never through JS `Number`. Swagger UI rounds the trailing digits of huge integers in its docs view — this is expected and does not affect the actual data returned by the API. ### Parameters - keyword: Search keyword (1-100 chars after trimming). For example, `food` - duration: Optional, default `all`. Duration tier (Channels video only) — `all`/0 / `short`/1 (<5min) / `medium`/2 (5-10min) / `long`/3 (20min+); string key or integer, invalid values rejected (400). - sort: Optional, default `default`. Sort — `default`/0 (relevance) / `latest`/1 (newest) / `hot`/2 (most liked); string key or integer, invalid values rejected (400). - publish_time: Optional, default `all`. Publish time — `all`/0 / `day`/1 / `week`/2 / `half_year`/3; string key or integer, invalid values rejected (400). - offset: Optional, default 0 (>=0). Pass `0` for the first page; use `cursor` to paginate (offset alone does not work). - cursor: Optional. Pagination cursor, same usage as universal search `/tikhub/wechat_search/v2/fetch_search`. Leave empty for the first page; for the next page pass back the `cursor` from the previous response (repeat the same `duration` / `sort` / `publish_time`). - raw: Optional, default True. True=raw search response; False=simplified parsing. ### Return - Channels video search result list (same structure as the `video` vertical of universal search) ### Typical chains - 💡 The "account" option in the sort dropdown is **not a sort** — it switches to the official-account vertical; use universal search `/tikhub/wechat_search/v2/fetch_search` (`business_type=account`). - 💡 **To get Channels video detail (media download address / decode_key)**: video result items do **not** contain media directly — only `exportId` (+ `jumpInfo.extInfo.feedNonceId`). To download / decrypt: take `exportId` → call the Channels V2 endpoint `/tikhub/wechat_channels/v2/fetch_video_detail` (pass `export_id`) to get `media` (`url` / `url_token` / `decode_key`) and the plain `username`. Result fields and response structure are the same as `/tikhub/wechat_search/v2/fetch_search`. API references: `fetch_search` = `POST /tikhub/wechat_search/v2/fetch_search` (operationId: `post_tikhub_wechat_search_v2_fetch_search`); `fetch_video_detail` = `POST /tikhub/wechat_channels/v2/fetch_video_detail` (operationId: `post_tikhub_wechat_channels_v2_fetch_video_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_ai_smart_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_ai_smart_searchWeibo (app). ### Purpose: - Use Weibo AI Smart Search to search, return AI-enhanced search results. ### Parameters: - query: Search keyword (required) - page: Page number, starts from 1 (default 1) ### Return: - AI smart search results, including AI-enhanced search content ### Note: - This is AI-enhanced search, results are processed by AI <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_home_recommend_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_home_recommend_feedWeibo (app). ### Purpose: - Get the home recommend feed from Weibo. ### Parameters: - page: Page number, don't pass for first page, pass "2" for second page, and so on - count: Items per page, default 15, max 50 ### Return: - Home recommend feed data ### Note: - Recommended content based on hot topics and trending events <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_hot_searchWeibo (app). ### Purpose: - Get Weibo hot search ranking, supports multiple categories. ### Parameters: - category: Hot search category - mineband: My hot search - realtimehot: Realtime hot search (default) - social: Social hot search - fun: Entertainment hot search - technologynav: Technology hot search - lifenav: Life hot search - region: Local hot search (use region_name to specify city) - sportnav: Sports hot search - gamenav: ACG hot search - page: Page number, starts from 1 (default 1) - count: Items per page, default 20, max 50 - region_name: City name for local hot search, only effective when category=region, default Beijing ### Return: - Hot search ranking data, including search terms, popularity, etc. ### Note: - Hot search ranking updates in real-time <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search_brief
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_hot_search_briefWeibo (app). ### Purpose - Get the Weibo hot search brief (daily hot event digest), returning an AI-generated summary of the day's hot events. Each event contains a title, summary, hot search stats (including rank appearances and time at the top of the trending list) and source posts. ### Parameters - None ### Return - Hot search brief data (raw Weibo response). The brief is nested inside the AI search card: - items[].data.wboxParam.analysis_result: JSON string, needs to be deserialized first - analysis_result.msg: markdown text containing a ```wbCustomBlock code block - data.event_list of that code block's JSON (its type is "hotQuickReport"): array of the day's hot events - analysis_result.hot_brief_data: JSON string; once deserialized, slogan_info holds the brief title and its update time ### Note - The brief is generated by Weibo AI search and is refreshed periodically; see slogan_info.dynamic_wenan for the update time - Returns about 20 hot events for the current day; this endpoint does not support pagination - The brief is a multi-level nested JSON string, callers need to deserialize it level by level - The brief is generated progressively by the AI; the server automatically retries when it hits an in-progress response. In rare cases an in-progress response is still returned, in which case analysis_result.chat_status_stage is not 0 and msg only holds the AI generation trace <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search_categories
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_hot_search_categoriesWeibo (app). ### Purpose: - Get all available hot search category list from Weibo. ### Parameters: - None ### Return: - Hot search category list data, including category names and identifiers ### Note: - Returned categories can be used for category parameter in fetch_hot_search endpoint API references: `fetch_hot_search` = `GET /tikhub/weibo/app/fetch_hot_search` (operationId: `get_tikhub_weibo_app_fetch_hot_search`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_search_all
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_search_allWeibo (app). ### Purpose: - Comprehensive search in Weibo, return related content. Supports multiple search types. ### Parameters: - query: Search keyword (required) - page: Page number, starts from 1 (default 1) - search_type: Search type - 1: General/All (default) - 61: Realtime - 3: Users - 64: Videos - 63: Images - 62: Following - 60: Hot - 21: Whole network - 38: Topics - 98: Super topics - 92: Places/Locations - 97: Products/Goods ### Return: - Search result list, including post content, author info, images, videos, etc. ### Note: - Search results sorted by relevance - Only use page parameter for pagination <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_status_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_status_commentsWeibo (app). ### Purpose: - Get the first-level comment list of specified post (also works for video comments). ### Parameters: - status_id: Post ID or Video ID (required) - max_id: Pagination cursor, don't pass for first request, use returned max_id for subsequent requests - max_id json path: $.data.moreInfo.params.max_id - sort_type: Comment sort type - 0: Sort by popularity (default) - 1: Sort by time ### Return: - Comment list data, including comment content, commenter info, likes count, etc. - Contains max_id field for pagination ### Note: - About 20 comments per page - When no more comments, max_id is empty or same <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_status_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_status_detailWeibo (app). ### Purpose: - Get detailed information of specified post. ### Parameters: - status_id: Post ID (required) ### Return: - Post detailed data, including full text, images, videos, likes, comments, reposts count, etc. ### Note: - May not be available if post has been deleted or set to private <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_status_likes
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_status_likesWeibo (app). ### Purpose: - Get the like list of specified post (also works for video likes). ### Parameters: - status_id: Post ID or Video ID (required) - attitude_type: Like type filter - 0: All (default) - 1: Like - 2: Happy - 3: Surprise - 4: Sad - 5: Angry - 6: Reward - 8: Hug ### Return: - Like list data, including liker info, like type, etc. ### Note: - About 50 likes per page <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_status_reposts
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_status_repostsWeibo (app). ### Purpose: - Get the repost list of specified post (also works for video reposts). ### Parameters: - status_id: Post ID or Video ID (required) - max_id: Pagination cursor, don't pass for first request, use returned max_id for subsequent requests ### Return: - Repost list data, including repost content, reposter info, etc. - Contains max_id field for pagination ### Note: - About 20 reposts per page - When no more reposts, max_id is empty or same <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_album
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_albumWeibo (app). ### Purpose: - Get the album content of specified user. ### Parameters: - uid: User ID (required) - since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests ### Return: - User album data, including image list, etc. ### Note: - If user has set privacy protection, album may not be available - Uses cursor pagination (since_id), not page numbers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_articles
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_articlesWeibo (app). ### Purpose: - Get the article list published by specified user. ### Parameters: - uid: User ID (required) - since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests ### Return: - User article list data ### Note: - If user has not published any articles, returns empty list - Uses cursor pagination (since_id), not page numbers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_audios
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_audiosWeibo (app). ### Purpose: - Get the audio list published by specified user. ### Parameters: - uid: User ID (required) - since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests ### Return: - User audio list data ### Note: - If user has not published any audios, returns empty list - Uses cursor pagination (since_id), not page numbers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_followersWeibo (app). ### Purpose: - Get the followers (fans) list of the specified user, returning follower profiles (nickname, avatar, bio, followers count, latest post, etc.). ### Parameters: - uid: User ID (required) - page: Page number, starting from 1 (default 1) ### Return: - Followers list data - data.list.users: Array of follower users - data.list.next_page: Next page number, None or 0 when there is no more data - data.list.display_total_number: Total followers count ### Note: - This endpoint uses the Weibo mobile (m.weibo.cn) H5 API and relies on the server-side cached logged-in cookie; an expired cookie results in an error - Paginate by incrementing `page`; there is no more data once `data.list.next_page` is empty or 0 - Each page returns 20 items. Weibo filters out some accounts (blogger self-protection strategy), so the actual number of items in a page may be less than 20 - Weibo limits the pagination depth of the followers list (in practice `users` becomes an empty array and `next_page` becomes 0 after roughly 1000 records) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_following
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_followingWeibo (app). ### Purpose - Get the following list of the specified user, returning the profiles of followed users (nickname, avatar, bio, followers count, latest post, etc.). ### Parameters - uid: User ID (required) - since_id: Pagination cursor in "timestamp|offset" format. Don't pass for the first request, use the returned since_id for subsequent requests - since_id json path: $.data.since_id - sort_type: Sort type - 1: Sort by latest post time in descending order (recently posted first) - 2: Sort by following time in descending order (recently followed first, default) ### Return - Following list data - data.users: Array of followed users, each item holds the profile in its `user` field (data.users[].user) - data.since_id: Next pagination cursor, absent when there is no more data - data.total_cnt: Total following count ### Note - This endpoint uses the Weibo mobile (m.weibo.cn) H5 API and relies on the server-side cached logged-in cookie; an expired cookie results in an error - About 20 items per page. Uses cursor pagination (since_id), not page numbers - The absence of since_id in the response means the end of the list has been reached; that last response may still carry a final batch of fewer than 20 items - User profiles are nested under data.users[].user, which differs from the followers endpoint <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_infoWeibo (app). ### Purpose: - Get basic information of Weibo users, including nickname, avatar, bio, following count, followers count, etc. ### Parameters: - uid: User ID (required) ### Return: - User basic information data ### Note: - Some information may not be available if user has set privacy protection <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_info_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_info_detailWeibo (app). ### Purpose: - Get detailed information of Weibo users, more complete than basic info, including verification info, tags, level, etc. ### Parameters: - uid: User ID (required) ### Return: - User detailed information data ### Note: - Some information may not be available if user has set privacy protection <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_profile_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_profile_feedWeibo (app). ### Purpose: - Get the profile feed of specified user. ### Parameters: - uid: User ID (required) - since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests ### Return: - User profile feed data ### Note: - If user has set privacy protection, feed may not be available - Uses cursor pagination (since_id), not page numbers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_super_topics
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_super_topicsWeibo (app). ### Purpose: - Get the super topics list that user participated in. ### Parameters: - uid: User ID (required) - page: Page number, starts from 1 (default 1) ### Return: - User's super topics list data ### Note: - If user has set privacy protection, super topics list may not be available <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_timelineWeibo (app). ### Purpose: - Get the list of posts published by specified user, support pagination and multiple content filters. ### Parameters: - uid: User ID (required) - page: Page number, starts from 1 (default 1) - filter_type: Filter type (default "all") - all: All posts - original: Original posts - likes: Liked posts - video: Video posts - pic: Picture posts - location: Location check-in posts - month: Filter by time (must pass month parameter) - month: Time filter parameter, format YYYYMMDD (only used when filter_type=month) ### Return: - Post list data, including post content, images, videos, etc. ### Note: - If user has set privacy protection, post list may not be available - About 20 posts per page - When using time filter, must specify both filter_type=month and month parameter <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_user_videosWeibo (app). ### Purpose: - Get the video list published by specified user (waterfall layout). ### Parameters: - uid: User ID (required) - since_id: Pagination cursor, don't pass for first request, use returned since_id for subsequent requests ### Return: - Video list data, including video title, cover, views, etc. - Contains moreInfo.params.since_id field for pagination ### Note: - Only returns posts with videos - Uses cursor pagination (since_id), not page numbers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_video_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_video_detailWeibo (app). ### Purpose: - Get detailed information of single video, including video play URL. - **Important**: Required step to get real video ID from Weibo video link (e.g., https://weibo.com/tv/show/1034:5232127105761312) ### Parameters: - mid: Video post ID or ID from link (required) ### Return: - Video detailed data, including video play URL, cover, duration, title, etc. - **items[0].data.idstr**: Real video post ID, can be used for fetching comments ### Note: - Returned video URL may have expiration time - Support getting HD video URL - **Must call this API before fetching comments**: ID from link cannot be used directly for comments, must get real ID from items[0].data.idstr first <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_video_featured_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/app/fetch_video_featured_feedWeibo (app). ### Purpose: - Get the featured video feed from Weibo video section. ### Parameters: - page: Page number, don't pass for first page, pass "2" for second page, and so on ### Return: - Featured video feed data, including video list, etc. ### Note: - About 20 videos per page <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo check_allow_comment_with_pic
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/check_allow_comment_with_picWeibo (web_v2). ### Purpose: - Check if a specific Weibo post allows image comments. ### Parameters: - id: Weibo post ID (required) ### Return: - result: true means image comments allowed, false means not allowed ### Note: - Different posts may have different image comment permissions <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_advanced_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_advanced_searchWeibo (web_v2). ### Purpose: - Weibo advanced search with multi-dimensional filtering. ### Parameters: - q: Search keyword (required) - search_type: Search type (all/hot/original/verified/media/viewpoint) - include_type: Include type (all/pic/video/music/link) - timescope: Time scope (format: custom:start_date:end_date, e.g. custom:2025-09-01-0:2025-09-08-23) - page: Page number (default 1) ### Return: - Search result list, including post content, author info, images, videos, interaction data ### Note: - Video playback requires setting header Referer=https://weibo.com/ <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_ai_related_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_ai_related_searchWeibo (web_v2). ### Purpose: - Get content extensions related to keyword (related questions, blogger recommendations, reference posts). ### Parameters: - keyword: Search keyword (required, recommend using topic format #TopicName#) ### Return: - HTML format extension content, including related questions, blogger recommendations, reference posts ### Note: - Returned content is in HTML format, requires HTML parsing - HTML structure may change, need proper error handling <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_ai_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_ai_searchWeibo (web_v2). ### Purpose: - Get search results through Weibo AI intelligent search. ### Parameters: - query: Search keyword (required, recommend using topic format #TopicName#) ### Return: - AI search results, including recommended content, related topics ### Note: - AI search results are personalized based on user behavior <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_all_groups
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_all_groupsWeibo (web_v2). ### Purpose: - Get all group information on Weibo platform, including default and user-defined groups. ### Parameters: - No additional parameters required ### Return: - Group list, including group ID, name, container ID, etc. ### Note: - Returned gid and containerid can be used as parameters for timeline API - Group information changes infrequently, recommend caching <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_city_list
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_city_listWeibo (web_v2). ### Purpose: - Get region city mapping data for region filter parameter in user search APIs. ### Parameters: - normalized: Whether to return normalized structure (default True) ### Return: - Province-city mapping data, for region parameter in fetch_user_search and other APIs ### Note: - Returned code format is custom:province_code:city_code, e.g. custom:11:1 API references: `fetch_user_search` = `GET /tikhub/weibo/web_v2/fetch_user_search` (operationId: `get_tikhub_weibo_web_v2_fetch_user_search`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_entertainment_ranking
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_entertainment_rankingWeibo (web_v2). ### Purpose: - Get Weibo entertainment ranking data (entertainment, film & TV, variety shows). ### Parameters: - No additional parameters required ### Return: - Entertainment topic list, including topic, heat value, rank, category ### Note: - Recommend caching for 5-10 minutes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_ranking_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_hot_ranking_timelineWeibo (web_v2). ### Purpose: - Get various types of hot ranking content from Weibo platform. ### Parameters: - ranking_type: Ranking type (required) - hour: Hourly ranking - yesterday: Yesterday ranking - day_before: Day before ranking - week: Weekly ranking - male: Male ranking - female: Female ranking - max_id: Pagination cursor, pass "0" for first request - count: Count (default 10) ### Return: - Hot post list, including post content, author info, interaction data ### Note: - Different rankings have different update frequencies: hourly has highest real-time relevance, weekly has high influence <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_hot_searchWeibo (web_v2). ### Purpose: - Get Weibo real-time hot search ranking data. ### Parameters: - No additional parameters required ### Return: - Hot search data, including realtime (real-time hot search), hotgov and other sections ### Note: - Hot search updates frequently, recommend caching for 2-5 minutes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search_index
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_hot_search_indexWeibo (web_v2). ### Purpose: - Quickly get top 10 Weibo hot search items. ### Parameters: - No additional parameters required ### Return: - Hot search term list, including keyword, popularity value, rank ### Note: - Only returns top 10 hot search items - Hot search updates frequently, recommend caching for 2-5 minutes - For complete hot search, use fetch_hot_search_summary API references: `fetch_hot_search_summary` = `GET /tikhub/weibo/web_v2/fetch_hot_search_summary` (operationId: `get_tikhub_weibo_web_v2_fetch_hot_search_summary`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_hot_search_summary
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_hot_search_summaryWeibo (web_v2). ### Purpose: - Get complete Weibo hot search ranking (50 items). ### Parameters: - No additional parameters required ### Return: - Complete hot search list, including rank, keyword, tag (Hot/Boiling/Official/New), heat value ### Note: - Difference from fetch_hot_search_index: this API returns 50 items, fetch_hot_search_index returns 10 items - rank 0 indicates pinned content - Recommend caching for 5-10 minutes API references: `fetch_hot_search_index` = `GET /tikhub/weibo/web_v2/fetch_hot_search_index` (operationId: `get_tikhub_weibo_web_v2_fetch_hot_search_index`). <!-- aisa-pricing:start --> Published reference price: $0.0015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_life_ranking
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_life_rankingWeibo (web_v2). ### Purpose: - Get Weibo life ranking data (food, travel, health, fashion). ### Parameters: - No additional parameters required ### Return: - Life topic list, including topic, heat value, rank, category ### Note: - Recommend caching for 5-10 minutes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_pic_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_pic_searchWeibo (web_v2). ### Purpose: - Search Weibo picture content, aggregated by weibo ID. ### Parameters: - query: Search keyword (required) - page: Page number (default 1) ### Return: - Image list with weibo ID, thumbnail, large image URL, author info, image count ### Note: - Thumbnails are automatically converted to large image URLs <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_post_commentsWeibo (web_v2). ### Purpose: - Get the first-level comment list of specified post. ### Parameters: - id: Weibo post ID (required) - count: Number of comments (default 10) - max_id: Pagination cursor, pass empty for first request, use returned max_id for subsequent requests ### Return: - Comment list data, including comment content, commenter info, likes count - Contains max_id field for pagination ### Note: - When no more comments, max_id is empty <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_post_detailWeibo (web_v2). ### Purpose: - Get detailed information of a specific Weibo post, including content, author, interaction data. ### Parameters: - id: Weibo post ID (required) - is_get_long_text: Whether to get full text of long posts (default "true") ### Return: - Post detailed data, including full text, images, videos, likes, comments, reposts count <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_post_sub_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_post_sub_commentsWeibo (web_v2). ### Purpose: - Get the reply (sub-comment) list of a specified comment. ### Parameters: - id: Main comment ID (required) - count: Number of sub-comments (default 10) - max_id: Pagination cursor, pass empty for first request, use returned max_id for subsequent requests ### Return: - Sub-comment list data, including reply content, replier info, likes count - Contains max_id field for pagination ### Note: - Difference from fetch_post_comments: this API gets replies to comments, not main comments of posts API references: `fetch_post_comments` = `GET /tikhub/weibo/web_v2/fetch_post_comments` (operationId: `get_tikhub_weibo_web_v2_fetch_post_comments`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_realtime_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_realtime_searchWeibo (web_v2). ### Purpose: - Get Weibo realtime search results (latest posts sorted by time). ### Parameters: - query: Search keyword (required) - page: Page number (default 1) ### Return: - Realtime search result list, including post content, author info, images, videos, interaction data ### Note: - Video playback requires setting header Referer=https://weibo.com/ - Return structure is same as advanced search <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_similar_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_similar_searchWeibo (web_v2). ### Purpose: - Get similar search word recommendations based on keyword. ### Parameters: - keyword: Search keyword (required, supports topic tag format like #TopicName#) ### Return: - Similar search term list, including suggestion, search count ### Note: - Similar word recommendations are relatively stable, can cache for 15-30 minutes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_social_ranking
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_social_rankingWeibo (web_v2). ### Purpose: - Get Weibo social ranking data (current affairs, social hotspots, livelihood topics). ### Parameters: - No additional parameters required ### Return: - Social topic list, including topic, heat value, rank, category ### Note: - Social hotspots change rapidly, recommend caching for 2-5 minutes <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_topic_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_topic_searchWeibo (web_v2). ### Purpose - Search Weibo topics, get topic name, cover, discussion count, read count. ### Parameters - query: Search keyword (required) - page: Page number (default 1) ### Return - Topic list with topic name, cover image, discussion count, read count ### Note - Counts expressed in ten-thousand or hundred-million units are converted to integers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_basic_info
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_basic_infoWeibo (web_v2). ### Purpose: - Get basic information of Weibo users (lightweight API). ### Parameters: - uid: User ID (required) ### Return: - User basic info, including user ID, username, avatar, bio, verification ### Note: - Compared to fetch_user_info, this API returns less data with faster response - Suitable for batch user info retrieval and user card display API references: `fetch_user_info` = `GET /tikhub/weibo/web_v2/fetch_user_info` (operationId: `get_tikhub_weibo_web_v2_fetch_user_info`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_fans
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_fansWeibo (web_v2). ### Purpose: - Get the fans list of specified user (who follows the user). ### Parameters: - uid: User ID (required) - page: Page number, starts from 0 (default 0) ### Return: - Fans user list, including username, avatar, bio, followers count ### Note: - Fans list affected by user privacy settings - page parameter starts from 0, not 1 - Difference from fetch_user_following: this API gets who follows the user, fetch_user_following gets who user follows API references: `fetch_user_following` = `GET /tikhub/weibo/web_v2/fetch_user_following` (operationId: `get_tikhub_weibo_web_v2_fetch_user_following`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_following
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_followingWeibo (web_v2). ### Purpose: - Get the following list of specified user (who the user follows). ### Parameters: - uid: User ID (required) - page: Page number, starts from 0 (default 0) ### Return: - Following user list, including username, avatar, bio, followers count ### Note: - Following list affected by user privacy settings - page parameter starts from 0, not 1 - Difference from fetch_user_fans: this API gets who user follows, fetch_user_fans gets who follows the user API references: `fetch_user_fans` = `GET /tikhub/weibo/web_v2/fetch_user_fans` (operationId: `get_tikhub_weibo_web_v2_fetch_user_fans`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_infoWeibo (web_v2). ### Purpose: - Get detailed information of Weibo users, including nickname, avatar, bio, following count, followers count. ### Parameters: - uid: User ID (optional, choose one with custom) - custom: Custom username (optional, choose one with uid) ### Return: - User detailed information data ### Note: - At least one of uid and custom must be provided - If both provided, uid takes priority - It's recommended to use uid parameter first <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_original_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_original_postsWeibo (web_v2). ### Purpose: - Get original posts published by specified user (excluding reposts). ### Parameters: - uid: User ID (required) - page: Page number, starts from 1 (default 1) - since_id: Pagination identifier (first page must get from fetch_user_posts) ### Return: - Original post list, including content, images, videos, interaction data ### Note: - Difference from fetch_user_posts: this API only returns original posts, excludes reposts - since_id must be obtained from fetch_user_posts first, required for first page, not needed for subsequent pages API references: `fetch_user_posts` = `GET /tikhub/weibo/web_v2/fetch_user_posts` (operationId: `get_tikhub_weibo_web_v2_fetch_user_posts`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_postsWeibo (web_v2). ### Purpose Get a user's published posts with pagination and selectable response detail. ### Parameters - uid: Required user ID. - page: Page number starting at 1; defaults to 1. - feature: Response detail level, default 0. Value 0 returns 10 basic posts; 1, 2, and 3 return 20 posts with progressively richer fields. Use 3 for the highest detail level. - since_id: Pass the returned since_id to retrieve the next page. ### Return Post content, images, videos, and a since_id for pagination. Feature 0 has the best performance. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_recommend_timeline
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_recommend_timelineWeibo (web_v2). ### Purpose: - Get recommended timeline content from Weibo homepage, displaying personalized recommendations based on user interests. ### Parameters: - refresh: Refresh type (0=normal refresh, 1=force refresh) - group_id: Group ID (can be obtained through fetch_all_groups) - containerid: Container ID (usually same as group_id) - extparam: Extended parameters (default "discover|new_feed") - max_id: Pagination cursor, pass "0" for first request - count: Count (default 10, suggested 5-20) ### Return: - Recommended post list, including post content, author info, interaction data - Contains max_id field for pagination ### Note: - Recommend calling fetch_all_groups first to get available groups API references: `fetch_all_groups` = `GET /tikhub/weibo/web_v2/fetch_all_groups` (operationId: `get_tikhub_weibo_web_v2_fetch_all_groups`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_searchWeibo (web_v2). ### Purpose - Search Weibo users with multiple filter options. ### Parameters - query: Search keyword (optional) - page: Page number (default 1) - region: Region code from /tikhub/weibo/web_v2/fetch_city_list (optional) - auth: Auth type org_vip/per_vip/ord (optional) - gender: Gender man/women (optional) - age: Age bucket 18y/22y/29y/39y/40y (optional) - nickname: Nickname filter (optional) - tag: Tag filter (optional) - school: School filter (optional) - work: Company filter (optional) ### Return - User list with uid, nickname, avatar, fans count, profile URL ### Note - Too many filters may result in no results API references: `fetch_city_list` = `GET /tikhub/weibo/web_v2/fetch_city_list` (operationId: `get_tikhub_weibo_web_v2_fetch_city_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_video_collection_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_video_collection_detailWeibo (web_v2). ### Purpose: - Get detailed content of specified collection, including video list. ### Parameters: - cid: Collection ID (required, get from fetch_user_video_collection_list) - cursor: Pagination cursor, pass empty for first request, use returned cursor for subsequent - tab_code: Sort type (0=default, 1=hottest, 2=latest) ### Return: - Collection info and video list, including video title, cover, duration, views - Contains next_cursor and has_more fields for pagination ### Note: - Cursors for different sorting methods are not universal, switching sorting requires restarting pagination API references: `fetch_user_video_collection_list` = `GET /tikhub/weibo/web_v2/fetch_user_video_collection_list` (operationId: `get_tikhub_weibo_web_v2_fetch_user_video_collection_list`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_video_collection_list
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_video_collection_listWeibo (web_v2). ### Purpose: - Get video collection list of specified user. ### Parameters: - uid: User ID (required) ### Return: - Collection list, including collection ID, name, description, video count ### Note: - Collection list affected by user privacy settings - Some users may not have created video collections <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_user_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_user_video_listWeibo (web_v2). ### Purpose: - Get all videos published by specified user (waterfall layout). ### Parameters: - uid: User ID (required) - cursor: Pagination cursor, pass "0" for first request, use returned next_cursor for subsequent requests ### Return: - Video list data, including video title, cover, views, etc. - Contains next_cursor and has_more fields for pagination ### Note: - Difference from collection APIs: this API gets user published videos, collection APIs get user collected videos <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo fetch_video_search
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/fetch_video_searchWeibo (web_v2). ### Purpose: - Search Weibo video content, supports hot and all modes. ### Parameters: - query: Search keyword (required) - mode: Search mode hot=popular / all=all (default hot) - page: Page number (default 1) ### Return: - Video list with weibo ID, author, content, video URL, interaction data ### Note: - Video playback requires setting Referer=https://weibo.com/ <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
weibo search_user_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/weibo/web_v2/search_user_postsWeibo (web_v2). ### Purpose: - Search for content containing specific keywords in a specified user's posts. ### Parameters: - uid: User ID (required) - q: Search keyword (optional, empty string means search all content) - page: Page number, starts from 1 (default 1) - starttime: Start timestamp (optional, Unix timestamp format) - endtime: End timestamp (optional, Unix timestamp format) - hasori: Include original posts (default 1 include) - hasret: Include retweets (default 1 include) - hastext: Include text posts (default 1 include) - haspic: Include image posts (default 1 include) - hasvideo: Include video posts (default 1 include) - hasmusic: Include music posts (default 1 include) ### Return: - Search result list, including post content, author info, interaction data ### Note: - Search results affected by user privacy settings - Timestamp parameters use Unix timestamp format <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_creator_hot_inspiration_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_creator_hot_inspiration_feedXiaohongshu (app_v2). ### Purpose: - Get creator center hot inspiration feed, using cursor pagination ### Parameters: - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. "1", "2"...) ### Return: - Hot inspiration feed data ### Pagination Guide: - First request: leave cursor empty - Next page: pass cursor value from previous response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_creator_inspiration_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_creator_inspiration_feedXiaohongshu (app_v2). ### Purpose: - Get creator center recommended inspiration feed, using cursor pagination ### Parameters: - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response (e.g. "r_1", "r_2"...) - tab: Tab type, default 0 - source: Source, default "creator_center" ### Return: - Recommended inspiration feed data ### Pagination Guide: - First request: leave cursor empty - Next page: pass cursor value from previous response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_image_note_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_image_note_detailXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get full detail data of an image note ### API Priority - ⭐ Xiaohongshu API priority: `App V2 (this)` > `App` > `Web V2` > `Web` ### ⚠️ Note Type Notice (Important) - Xiaohongshu notes come in two types: `image notes (normal)` and `video notes (video)`. Make sure to distinguish them when using the APIs. - This endpoint can fetch data for **both image notes and video notes**. - However, due to Xiaohongshu's official restriction: when the requested note is a video note, this endpoint **will NOT return the video play URL, only the video cover image**. - To get the video play URL, use `/tikhub/xiaohongshu/app_v2/get_video_note_detail` (video note endpoint), which can only fetch data of video notes. ### Recommended Workflow (when note type is unknown) - 1. Request this endpoint (image note endpoint) first. - 2. Check the note type field in the response (e.g. whether `type` is `video`) to determine if it is a video note. - 3. If it is a video note and you need the video play URL, request `/tikhub/xiaohongshu/app_v2/get_video_note_detail` again with the same note_id to get the video play URL. ### ⚠️ Billing Notice - If a wrong or non-existent note ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - note_id: Note ID, e.g. "697c0eee000000000a03c308" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail. ### Return - Image note detail data, including note content, image list, author info, interaction data, etc. - For video notes, only basic data such as the cover image is returned, without the video play URL API references: `get_video_note_detail` = `GET /tikhub/xiaohongshu/app_v2/get_video_note_detail` (operationId: `get_tikhub_xiaohongshu_app_v2_get_video_note_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_note_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_note_commentsXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get comment list for a specified note, supports pagination and multiple sort strategies ### ⚠️ Billing Notice - If a wrong or non-existent note ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - note_id: Note ID, e.g. "697c0eee000000000a03c308" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail. - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page - index: Comment index, pass 0 for first request, pass index value from previous response for next page - pageArea: Fold status, default "UNFOLDED" (unfolded), pass pageArea value from previous response for next page - sort_strategy: Sort strategy - "latest_v2": Sort by time desc (latest, recommended default) - "like_count": Sort by like_count - "default": Sort by default (not recommended, may cause missing or duplicate comments when paginating) ### Return - Comments data object, including comment list, pagination cursor, etc. ### Pagination Guide - First request: leave cursor empty, pass index as 0 - Next page: pass cursor and index and pageArea values from previous response - The pagination fields are usually located in the `$.data.data` object of the response (e.g. cursor ← `$.data.data.cursor`), extract the corresponding values from the previous response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_note_sub_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_note_sub_commentsXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get sub-comment (reply) list under a specific comment of a note, using cursor pagination ### ⚠️ Billing Notice - If a wrong or non-existent note ID / comment ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - note_id: Note ID, e.g. "699916e6000000001d0253da" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail. - comment_id: Parent comment ID (required), e.g. "699fb9930000000008030db6" - cursor: Pagination cursor, leave empty for first request, extract `cursor` value from `$.data.data.cursor` of previous response for next page - index: Pagination index, pass 1 for first request, extract `index` value from `$.data.data.cursor` of previous response for next page ### Return - Sub-comments data object, including sub-comment list, pagination cursor, etc. ### Pagination Guide - The `$.data.data.cursor` in response is a JSON object, e.g. `{"cursor":"69a0c134000000000c00910d","index":3}` - First request: leave cursor empty, pass index as 1 - Next page: extract `cursor` and `index` from `$.data.data.cursor` and pass them as corresponding parameters <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_product_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_product_detailXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get product detail by SKU ID, including price, specifications, stock, description, etc. ### ⚠️ Billing Notice - If a wrong or non-existent product SKU ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed" - source: Source, default "mall_search" - pre_page: Previous page, default "mall_search" ### Return - Product detail data, including price, specifications, stock, description, etc. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_product_recommendations
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_product_recommendationsXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get recommended products list by SKU ID, using cursor pagination ### ⚠️ Billing Notice - If a wrong or non-existent product SKU ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed" - cursor_score: Pagination cursor, leave empty for first request, pass cursor_score value from previous response for next page - region: Region, default "US" ### Return - Recommended products list data ### Pagination Guide - First request: leave cursor_score empty - Next page: pass cursor_score value from previous response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_product_review_overview
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_product_review_overviewXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get product review statistics, including rating distribution, positive rate, review tags, etc. ### ⚠️ Billing Notice - If a wrong or non-existent product SKU ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed" - tab: Tab type, default 2 ### Return - Product review overview data, including rating distribution, positive rate, review tags, etc. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_product_reviews
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_product_reviewsXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get product user reviews list, supports pagination, sorting, and filtering reviews with images ### ⚠️ Billing Notice - If a wrong or non-existent product SKU ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - sku_id: Product SKU ID (required), e.g. "669ddd44e05f3700011067ed" - page: Page number, start from 0 - sort_strategy_type: Sort strategy - 0: General sort (default) - 1: Latest sort - share_pics_only: Show reviews with images only, 0=no, 1=yes - from_page: From page, default "score_page" ### Return - Product reviews list data ### Pagination Guide - page starts from 0 and increments <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_topic_feed
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_topic_feedXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get notes list under a specified topic, supports sorting by trending or latest, using cursor pagination ### ⚠️ Billing Notice - If a wrong or non-existent topic page ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - page_id: Topic page ID (required), e.g. "5c1cc866febed9000184b7c1" - Can be obtained from single note API or search API - sort: Sort type - "trend": Trending (default) - "time": Latest - cursor_score: Pagination cursor score, pass last item's cursor_score from previous response - last_note_id: Last note ID from previous page - last_note_ct: Last note create time from previous page - session_id: Session ID, keep consistent for pagination - first_load_time: First load timestamp, keep consistent for pagination - source: Source, default "normal" ### Return - Topic notes list data ### Pagination Guide - First request: only pass page_id and sort, leave others empty - Next page: pass fields from last item of previous response: - cursor_score ← items[-1].cursor_score - last_note_id ← items[-1].id - last_note_ct ← items[-1].create_time - Recommended to also pass session_id and first_load_time for session consistency <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_topic_info
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_topic_infoXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get topic detail info, including topic name, view count, discussion count, share info, etc. ### ⚠️ Billing Notice - If a wrong or non-existent topic page ID is passed, the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - page_id: Topic page ID (required), e.g. "5c1cc866febed9000184b7c1" - source: Source, default "normal" - note_id: Source note ID, pass when jumping from note to topic (optional) ### Return - Topic detail data, including page_info (name/view count/discussion count), tabs, share_info, etc. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_user_faved_notes
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_user_faved_notesXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get list of notes faved by a specified user, using cursor pagination ### ⚠️ Billing Notice - If a wrong or non-existent user ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - user_id: User ID, e.g. "5a8cf39111be10466d285d6b" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail. - cursor: Pagination cursor, leave empty for first request, pass last note_id from previous page for next page ### Return - User faved notes list data, including basic note info and pagination info ### Pagination Guide - First request: leave cursor empty - Next page: pass last note_id from previous page <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_user_infoXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get detailed info of a specified user ### ⚠️ Notice (Important) - Make sure the `user_id` you pass is correct and valid. If a wrong or non-existent user ID is passed, the endpoint will still respond normally, but the `data` field will contain a "service error" message from Xiaohongshu official. - Since the request has actually been sent and returned successfully, such requests **will still be billed as normal**. Please validate the user ID before calling. ### Parameters - user_id: User ID, e.g. "61b46d790000000010008153" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail. ### Return - User detailed info, including nickname, avatar, bio, follower count, following count, note count, etc. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_user_posted_notes
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_user_posted_notesXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get list of notes posted by a specified user, using cursor pagination ### ⚠️ Billing Notice - If a wrong or non-existent user ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - user_id: User ID, e.g. "61b46d790000000010008153" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `user_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `user_id` shall prevail. - cursor: Pagination cursor, leave empty for first request, pass cursor value from previous response for next page - The cursor is usually the note_id of the last note in the notes list - JSON path example: `$.data.data.notes[-1].cursor` ### Return - User posted notes list data, including basic note info and pagination info ### Pagination Guide - First request: leave cursor empty - Next page: pass cursor value from previous response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_video_note_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/get_video_note_detailXiaohongshu (app_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get full detail data of a video note ### ⚠️ Note Type Notice (Important) - Xiaohongshu notes come in two types: `image notes (normal)` and `video notes (video)`. Make sure to distinguish them when using the APIs. - This endpoint can **ONLY fetch data of video notes**. Passing the note_id of an image note will fail to get any content. This restriction comes from Xiaohongshu official. - The image note endpoint `/tikhub/xiaohongshu/app_v2/get_image_note_detail` can fetch both image and video notes, but for video notes it will NOT return the video play URL, only the video cover image. ### Recommended Workflow (when note type is unknown) - 1. Request `/tikhub/xiaohongshu/app_v2/get_image_note_detail` (image note endpoint) first. - 2. Check the note type field in the response (e.g. whether `type` is `video`) to determine if it is a video note. - 3. If it is a video note, request this endpoint again with the same note_id to get the video play URL. ### ⚠️ Billing Notice - If a wrong or non-existent note ID is passed (or the share link fails to parse), the endpoint still responds normally, but the `data` field will contain an upstream "service error" message. Such requests **will still be billed as normal**. Please make sure the parameters are valid before calling. ### Parameters - note_id: Note ID, e.g. "697c0eee000000000a03c308" - share_text: Xiaohongshu sharing link, supports APP and Web sharing links, including `xiaohongshu.com` full links, `xhslink.com` and `xhslink.cn` short links - Prefer to use `note_id`, if not, use `share_text`, one of the two parameters is required, if both are carried, `note_id` shall prevail. ### Return - Video note detail data, including video play URL, cover image, author info, interaction data, etc. API references: `get_image_note_detail` = `GET /tikhub/xiaohongshu/app_v2/get_image_note_detail` (operationId: `get_tikhub_xiaohongshu_app_v2_get_image_note_detail`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu search_groups
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/search_groupsXiaohongshu (app_v2). ### Purpose - Search Xiaohongshu groups by keyword, supports pagination ### Parameters - keyword: Search keyword (required), e.g. "Shanghai" - page_no: Page number, start from 0 - search_id: Search ID, pass value from first search response for pagination - source: Source, default "unifiedSearchGroup" - is_recommend: Is recommend, 0=no, 1=yes ### Return - Search result data, including group list and pagination info ### Pagination Guide - First request: leave search_id empty (auto-generated), page_no pass 0 - Next page: pass search_id from first search response, increment page_no <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu search_images
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/search_imagesXiaohongshu (app_v2). ### Purpose - Search Xiaohongshu images by keyword, returns 20 results per page, supports pagination ### Parameters - keyword: Search keyword (required), e.g. "wallpaper" - page: Page number, start from 1 - search_id: Search ID, pass value from first search response for pagination - search_session_id: Search session ID, pass value from first search response for pagination - word_request_id: Word request ID, pass value from first search response for pagination - source: Source, default "explore_feed" ### Return - Search result data, including image list and pagination info ### Pagination Guide - First request: only pass keyword and page - Next page: pass search_id, search_session_id, and word_request_id from first search response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu search_notes
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/search_notesXiaohongshu (app_v2). ### Purpose - Search Xiaohongshu notes by keyword, supports multiple sort types, note type filters, and time filters ### Parameters - keyword: Search keyword (required), e.g. "food recommendations" - page: Page number, start from 1 - sort_type: Sort type - "general": General sort (default) - "time_descending": Sort by time descending (latest) - "popularity_descending": Sort by like count (most liked) - "comment_descending": Sort by comment count (most commented) - "collect_descending": Sort by collect count (most collected) - "english_preferred": English preferred - note_type: Note type filter - "不限": All types (default) - "视频笔记": Video notes only - "普通笔记": Image notes only - "直播笔记": Live notes only - time_filter: Time filter - "不限": All time (default) - "一天内": Within 24 hours - "一周内": Within 7 days - "半年内": Within 6 months - search_id: Search ID, pass value from first search response for pagination - search_session_id: Search session ID, pass value from first search response for pagination - source: Source, default "explore_feed" - ai_mode: AI mode, 0=off, 1=on ### Return - Search result data, including note list and pagination info ### Pagination Guide - First request: only pass keyword and page - Next page: pass search_id and search_session_id from first search response Pass note_type and time_filter using the literal Chinese values listed above. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu search_products
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/search_productsXiaohongshu (app_v2). ### Purpose - Search Xiaohongshu products by keyword, returns 20 results per page, supports pagination ### Parameters - keyword: Search keyword (required), e.g. "phone case" - page: Page number, start from 1 - search_id: Search ID, pass value from first search response for pagination - source: Source, default "explore_feed" ### Return - Search result data, including product list and pagination info ### Pagination Guide - First request: only pass keyword and page - Next page: pass search_id from first search response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu search_users
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/app_v2/search_usersXiaohongshu (app_v2). ### Purpose - Search Xiaohongshu users by keyword, returns 20 results per page, supports pagination ### Parameters - keyword: Search keyword (required), e.g. "food creator" - page: Page number, start from 1 - search_id: Search ID, pass value from first search response for pagination - source: Source, default "explore_feed" ### Return - Search result data, including user list and pagination info ### Pagination Guide - First request: only pass keyword and page - Next page: pass search_id from first search response <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_core_data
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_core_dataXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Daily trend and period summary of a blogger, for plotting performance charts ### Request Body Parameters - user_id: **required**, blogger user ID - business: 0=organic (default), 1=sponsored - note_type: 3=image-text+video (default), 1=image-text, 2=video **Warning**: differs from the upstream V1 note-list endpoint (not exposed in this specification), where 4=all and 3=sponsored - date_type: 1=last 30 days (default), 2=last 90 days - advertise_switch: 1=all traffic (default), 0=organic only ### Return - dailyData[]: daily data points - sumData: period aggregates (impressions / reads / engagements / CPM / CPE) ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_data_summary
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_data_summaryXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Account-level data summary of a blogger ### Request Body Parameters - user_id: **required**, blogger user ID - business: 0=organic (default), 1=sponsored ### Return - Cost/quote estimates: estimatePictureCpm / estimateVideoCpm / pictureReadCost - Service metrics: active days in last 7d, 48h invitation reply rate - Growth: fans change rate and percentile vs peers ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_detailXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get full profile of a single blogger (PGY blogger homepage header) - The response already embeds many metrics, so other blogger endpoints are often unnecessary ### Request Body Parameters - user_id: Blogger user ID, e.g. "5c668b3e0000000012021605" ### Return - Profile: userId / name / redId / headPhoto / location / personalTags - Commercial: image-text & video quotes, cooperation status, MCN agency - Tags: contentTags / featureTags - Metrics: fans count, medians, last-30d impressions ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_fans_history
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_fans_historyXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Fans growth curve over time ("Fans Analysis → Fans Trend") ### Request Body Parameters - user_id: **required**, blogger user ID - increase_type: 1=**cumulative total** (default), 2=**daily increment** - date_type: 1=last 30 days (default), 2=last 60 days ### Return - list[]: daily data points - fansNumInc: net growth over the period - fansNumIncRate: growth rate over the period ### Tip - Defaults match the PGY web page (cumulative total + last 30 days) - Pass increase_type=2 for the daily-increment curve ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_fans_profile
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_fans_profileXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Audience distribution of a blogger's fans, to check fit with the target audience ### Request Body Parameters - user_id: Blogger user ID ### Return - ages[] / gender (male, female) / provinces[] / cities[] / devices[] / interests[] ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_fans_summary
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_fans_summaryXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Core fans metrics of a blogger ("Fans Analysis → Core Metrics") ### Request Body Parameters - user_id: Blogger user ID ### Return - fansNum / fansIncreaseNum / fansGrowthRate - activeFansRate / reading fans ratio / engaging fans ratio - Percentile vs peers (e.g. activeFansBeyondRate) ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_filter_options
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_filter_optionsXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose Fetch the tree-style option dictionaries used by /tikhub/xiaohongshu/pgy/get_blogger_list. Values are maintained by the platform and can change; cache the response and reuse it instead of calling before every search. Copy dictionary labels verbatim, including required Chinese strings. ### Request body No parameters; send an empty JSON object if supplying a body. ### Return and response access The raw envelope (code, msg, success) is in response.data; dictionaries are in response.data.data. - contentTags: creator categories, including level-2 categories; feeds blogger.content_tag. - contentScenes: note categories; feeds blogger.note_scene. - areas: creator locations down to district level; fansAreas: audience locations down to city level. - industryTags: industry taxonomy (taxonomy1Tag / taxonomy2Tags), used by coop.industry and flags.industry_first. This differs from creator categories. - personalTagsV2: creator personas; featureTags: specialty content; contentTheme: content themes. - audience20: audience segments; automotiveIndustryTag: industry-specific audience profiles. - consumerBehavior: estimated consumer behavior; may be null for some accounts. - market: marketing goals; activities: campaign options, whose code values feed flags.activity_codes. ### Upstream billing Upstream HTTP 200 responses are charged even if the data is null or no creators match; do not retry solely because data is empty. Upstream HTTP 400 responses are not charged. Use an AIsa price quote for gateway billing. API references: `get_blogger_list` = `POST /tikhub/xiaohongshu/pgy/get_blogger_list` (operationId: `post_tikhub_xiaohongshu_pgy_get_blogger_list`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_listXiaohongshu (pgy). ### Purpose Search PGY note creators by keyword and about 60 filters in seven groups: goal (marketing goals), blogger (creator attributes), fans (audience profiles), note (organic note metrics), coop (sponsored note metrics), live (live-stream metrics), and flags (recommendation and exclusion switches). Results contain about 140 fields, so separate creator-detail calls are often unnecessary. ### Search and sorting - keyword: Empty means filtering without a text search. - search_type: 1 searches note keywords (default); 0 searches creator nicknames. - column: One of the 34 sort keys listed in the request schema. The default is comprehensiverank. - sort: desc (default) or asc. - brand_user_id: Optional advertiser ID for personalized recommendations and prior-cooperation markers. - similar_user_id: Find similar creators while retaining all other filters. The separate /tikhub/xiaohongshu/pgy/get_blogger_similar endpoint does not support these filters and returns at most four creators per page. - similar_word: Optional nickname for display; it does not change results. ### Filter values Use the exact enum values in the schema. Dictionary-backed labels must be copied verbatim from /tikhub/xiaohongshu/pgy/get_blogger_filter_options; Chinese labels are protocol values and must not be translated. Cache and reuse this dictionary. - blogger.content_tag: contentTags; mix level-1 and level-2 names in one flat array. Use the parent name to select an entire category. Expanding all children can miss creators tagged only at the parent level. Omit the field for unrestricted categories. - blogger.personal_tags: personalTagsV2; copy tagName at any available level. - blogger.feature_tags: featureTags; mix level-1 and level-2 names. - blogger.location: areas; province, city, and district names may be mixed. fans.location uses fansAreas and supports provinces and cities, without districts. - blogger.content_theme: contentTheme; level-1 labels only. - blogger.audience20: audience20; use a bare level-1 name or a level-2 value formatted as "<level1> <level1>-<level2>". A bare level-2 label returns zero results. - blogger.note_scene: contentScenes; use the complete space-separated path including the root. A path may stop at any depth; a bare leaf returns zero results. - blogger.consumer_behavior: consumerBehavior; use the complete space-separated path including the root. Bare leaf values can silently disable this filter and return unfiltered results. Compare totals with and without the filter; a null dictionary value means this feature is unavailable to the account. - blogger.industry_crowd: automotiveIndustryTag; use the deepest leaf's numeric value, not its label. - flags.industry_first / industry_second: industryTags; one bare label per field. This taxonomy differs from creator categories. - flags.activity_codes: activities; copy each item's code. Arrays combine values with OR and remove duplicates; at most 30 items, with at most 64 characters per item. Across different filters the conditions are combined. Ranges use {"min": value, "max": value}. Omitted min means zero and omitted max means unbounded; an entirely empty range returns HTTP 422. Values outside fixed enums also return HTTP 422. Invalid dictionary labels often return zero matches without an error, so verify copied labels before concluding that no creators match. ### Pagination Use page_num from 1 to 250 and page_size from 1 to 20. Keep page_size at 20: the upstream removes unavailable or non-cooperating creators from each page, so a smaller size may leave zero rows. Page 251 and later return an empty array. Change only page_num between pages and keep all filters and sorting identical. The returned total is always 5000: it is the paging cap, not the actual match count. ### Return and response access The raw upstream envelope is in response.data; its payload is one level deeper at response.data.data. The payload contains kols[] (matched creators), total (paging cap, always 5000), trackId, and highlightWords. Each kols item includes identity fields userId, name, redId, headPhoto, location, and gender; tags contentTags, featureTags, personalTags, and tradeType; metrics fansNum, clickMidNum, interMidNum, fans30GrowthRate, and kliveCnt30d; and commercial fields picturePrice, videoPrice, lowerPrice, estimatePictureCpm, and cooperateState. Inspect these fields before making additional detail calls. Misspelled request field names return HTTP 422. API references: `get_blogger_filter_options` = `POST /tikhub/xiaohongshu/pgy/get_blogger_filter_options` (operationId: `post_tikhub_xiaohongshu_pgy_get_blogger_filter_options`); `get_blogger_similar` = `POST /tikhub/xiaohongshu/pgy/get_blogger_similar` (operationId: `post_tikhub_xiaohongshu_pgy_get_blogger_similar`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_notes_rate
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_notes_rateXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Overall content performance of a blogger, for judging quality and consistency ### Request Body Parameters - user_id: **required**, blogger user ID - business: note scope, 0=organic (default), 1=**sponsored** - note_type: 3=image-text+video (default), 1=image-text, 2=video **Warning**: differs from the upstream V1 note-list endpoint (not exposed in this specification), where 4=all and 3=sponsored - date_type: 1=last 30 days (default), 2=last 90 days - advertise_switch: 1=all traffic (default), 0=organic only ### Return - Medians: impMedian / readMedian / interactionMedian - Rates: engagement rate, completion rate, 100-like / 1000-like note ratio - Percentile vs peers (e.g. impMedianBeyondRate) ### Tip - Set business=1 and compare against business=0 to see how the blogger performs on sponsored content ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_notes
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_notes_v2Xiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Paginated note cases of a blogger (v2). A **separate endpoint** from `the upstream V1 note-list endpoint (not exposed in this specification)`: wider coverage (incl. cross-platform notes) and a different response shape - **Use this when `the upstream V1 note-list endpoint (not exposed in this specification)` returns an empty list** - The two endpoints differ in note_type values and return fields; do not mix them ### Request Body Parameters - user_id: **required**, blogger user ID - page_number: page number from 1 - page_size: **1-8** (fixed at 8 on the PGY web page, cannot be larger) - note_type: 0=all (default), 1=image-text, 2=video - order_type: 1=newest (default), 2=most read, 3=most engaged ### Return - noteList[]: each item has noteInfo (noteId / title / imageUrl / notePublishTime / noteType / impNum / readNum / engageNum / favNum) + userInfo - total: total notes matching the filters ### Paging - Change page_number only, keep other params identical; an empty array means no more data ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_blogger_similar
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_blogger_similarXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Given one blogger, return similar bloggers ("Similar Bloggers" on the blogger page) - Typical use: pick one good benchmark blogger, then expand by similarity ### Request Body Parameters - user_id: **required**, target blogger user ID - page_num: page number from 1 - page_size: **1-4** (fixed at 4 on the PGY web page) ### Return - Same shape as the note blogger square (kols[] + total), parsing code is reusable - Similar bloggers usually number from a few to a few dozen; total is the cap ### Paging - Change page_num only; an empty array means no more data ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_content_square
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_content_squareXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Replica of PGY "Learn Content → Inspiration → Content Square": **no ID required**, directly answers "what content is hot right now" - Opposite direction from every other endpoint — this one is an entry point; take the blogger IDs from the returned notes and drill down with the blogger endpoints ### 1. Full Parameter List | Param | Required | Default | Description | |---|---|---|---| | `biz_type` | ✅ | — | Leaderboard, see section 3 | | `page_num` | | `1` | Page, 1-100 | | `page_size` | | `34` | **1-34** (fixed at 34 on the web page) | | `search_word` | | `""` | Keyword; empty = whole board. Comma-separated for batch search | | `order_by` | | per board | Sort field, see section 5; empty = board default | | `date_range` | | `7` | Window in days: `3` / `7` / `14` / `30` | | `sub_biz_type` | | `3` | **Board 8 only**, see section 6 | | `category` | | — | **Board 1 only**, see section 4 | | `industry` | | — | **Boards 2/3/4/5/6/7/8**, see section 4 | | `note_type` / `content_type` / `theme` | | — | See section 6 | | `author_type` / `placement` / `marketing_target` | | — | See section 6 | | `price` / `fans` | | — | **Board 4 only**, see section 6 | Omitted filters mean "no limit". **Do not send unused fields as empty strings or 0** — they would be treated as a real filter. ### 2. Paging Change `page_num` only and keep every other parameter identical. **Each board holds exactly 100 items** (`total` is always 100) — this is a leaderboard, not a full search; upstream only exposes the Top 100. With `page_size=34` you reach the end at page 3, and page 4 returns an empty array. For more content switch boards, filters or `date_range` — **raising `page_size` does not help** (capped at 34). `pageInfoDto.totalPage` is always `0` in practice — **do not use it** to detect more pages. ### 3. Leaderboards (`biz_type`) | Value | Board | Content | |---|---|---| | `1` | Xiaohongshu Hot | Platform-wide hot content | | `2` | Product Seeding | Content aimed at product seeding | | `3` | E-commerce Promotion | Content promoting goods or live streams | | `4` | PGY Cooperation | Sponsored notes from PGY bloggers | | `5` | Lead Collection | Content aimed at lead collection | | `6` | E-commerce Hot | Hot e-commerce product content | | `7` | Direct Seeding | Content aimed at direct seeding | | `8` | App Promotion | Content promoting apps | ### 4. Filters Differ per Board The board determines which filters are available — sending an unsupported field returns **422** listing what the board does support, instead of being silently ignored (otherwise you would receive unfiltered data without noticing). | Board | Available filters | |---|---| | `1` | `category`, `note_type`, `content_type` | | `2` / `5` / `7` | `industry`, `placement`, `note_type`, `content_type`, `theme` | | `3` | `industry`, `placement`, `note_type`, `content_type`, `marketing_target` | | `4` | `industry`, `note_type`, `author_type`, `theme`, `price`, `fans` | | `6` | `industry`, `note_type`, `content_type` | | `8` | `industry`, `placement`, `note_type`, `content_type`, `theme`, `sub_biz_type` | **How to fill industry** (different boards use different taxonomies — do not mix them): | Board | Field | Values | |---|---|---| | `1` | `category` | `内容类目#X` or `所属行业#X`, e.g. `内容类目#美妆` | | `2/4/5/7/8` | `industry` | Industry names (母婴, 美妆个护, 3C数码, ... 25 in total) | | `3/6` | `industry` | E-commerce product categories (茶, 厨房电器, ... hundreds, a different taxonomy) | ### 5. Sorting (`order_by`) Leave empty to use the board default (boards 2 and 3 default to read rate, others to impressions). Common to all boards: | Value | Meaning | Value | Meaning | |---|---|---|---| | `premium_imp_num` | Impressions | `premium_engage_rate` | Engagement rate | | `premium_read_num` | Reads | `premium_like_num` | Likes | | `premium_ctr` | Read rate | `premium_fav_num` | Favorites | | `premium_engage_num` | Engagements | `premium_cmt_num` | Comments | Boards `3` / `6` additionally support `premium_ecm_dgmv` (paid GMV), `premium_ecm_order_pv` (paid orders), `premium_ecm_order_rate` (paid conversion rate). Board `4` additionally supports off-site metrics for Taobao, JD, and VIP: `taobao_third_active_pgy_user_ratio` / `_cost`, `jd_third_active_pgy_user_ratio` / `_cost`, `wph_third_active_pgy_user_ratio` / `_cost`. Sending a sort value the board does not support also returns 422. ### 6. Other Enums | Param | Web name | All values | |---|---|---| | `note_type` | Content type | `1` image-text, `2` video | | `content_type` | Content source | `1` blogger sponsored, `2` celebrity sponsored, `3` employee, `5` buyer, `6` pro account, `11` owner, `-1` user (values are non-contiguous) | | `author_type` | Creator type | `1` PGY blogger, `2` celebrity | | `placement` | Traffic placement | `1` discovery, `2` search, `3` in-video feed | | `marketing_target` | Marketing target | `3` product promotion, `8` live promotion | | `sub_biz_type` | App action | `1` app download, `2` mini-program, `3` app open | | `date_range` | Time window | `3`, `7`, `14`, `30` (last N days) | | `theme` | Theme | 21 Chinese theme names (开箱, 测评类, 好物合集, ...) | `price` (board 4) needs both the quote type and the range, because image-text and video are two independent quotes: `{"kind": 1, "range": {"min": 10000, "max": 50000}}` where `kind` is `1` image-text / `2` video. `fans` (board 4) takes a plain range. ### 7. Return - `noteList[]`: matched notes; each has `noteInfo` (title, noteType, noteLink, noteImages, readNum, likeNum, favNum, cmtNum, videoDuration, notePublishTime) plus blogger info - `total`: always **100** (board capacity) - `pageInfoDto`: upstream paging echo; its `totalPage` is always `0` and unusable ### 8. Notes - **Misspelled fields, invalid enums, and board/filter mismatches all return 422** - Keyword supports comma-separated batch search (same as the web search box) ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) Category, industry, and theme names are protocol values. Copy the original Chinese labels verbatim; do not translate them. <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_keyword_daily
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_keyword_dailyXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Daily search trend of a keyword — tells whether it is rising, fading, or seasonal ### Request Body Parameters - search_word: keyword, e.g. "face mask" ### Return - `dailyData[]`: one entry per day with `dateKey`, `searchScore`, `noteNum`, `userNum` ### Notes - The time span is decided by PGY (about the last three months in practice); there is no adjustable time parameter here - For aggregates and period-over-period change, use `/tikhub/xiaohongshu/pgy/get_keyword_stat` ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) API references: `get_keyword_stat` = `POST /tikhub/xiaohongshu/pgy/get_keyword_stat` (operationId: `post_tikhub_xiaohongshu_pgy_get_keyword_stat`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_keyword_related
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_keyword_relatedXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - What users search **before** and **after** this keyword ("Related Inspiration" card) - Typical use: expand one seed keyword into a candidate list, then compare each with `/tikhub/xiaohongshu/pgy/get_keyword_stat` to find low-competition but decent-volume terms ### Request Body Parameters - search_word: keyword, e.g. "face mask" ### Return - `upSearchWords[]` (upstream terms) and `downSearchWords[]` (downstream terms) - Each term carries `searchScore`, `readTotalCount`, `noteNum`, `relevanceRank`, `brandTag` ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) API references: `get_keyword_stat` = `POST /tikhub/xiaohongshu/pgy/get_keyword_stat` (operationId: `post_tikhub_xiaohongshu_pgy_get_keyword_stat`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_keyword_stat
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_keyword_statXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Site-wide popularity overview of a keyword, plus the profile of bloggers posting about it - Corresponds to the "Site Data" + "Blogger Profile" cards in the PGY content square ### Request Body Parameters - search_word: keyword, e.g. "face mask" ### Return | Object | Fields | |---|---| | `searchWordData` | `searchScore`, `noteNum`, `userNum`, `readNum`; each has a `*30bm` counterpart = 30-day change in percent | | `wordKolProfile` | Blogger profile: content category share, persona share | ### Related - `/tikhub/xiaohongshu/pgy/get_keyword_daily` for the daily trend, `/tikhub/xiaohongshu/pgy/get_keyword_related` for up/downstream keywords - The three endpoints are independent; call whichever you need ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) API references: `get_keyword_daily` = `POST /tikhub/xiaohongshu/pgy/get_keyword_daily` (operationId: `post_tikhub_xiaohongshu_pgy_get_keyword_daily`); `get_keyword_related` = `POST /tikhub/xiaohongshu/pgy/get_keyword_related` (operationId: `post_tikhub_xiaohongshu_pgy_get_keyword_related`). <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_live_blogger_list
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_live_blogger_listXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Replica of PGY "Find Bloggers → Live Blogger Square"; filter live-commerce bloggers by e-commerce conversion, live performance and fans purchasing power ### 1. Difference from the Note Blogger Square They are **two parallel entry points** with almost no overlapping filters (note seeding vs. live commerce), but they **return the same blogger ID space**, so results are cross-usable. ### 2. Filter Groups | Group | Covers | |---|---| | `nick_name` | Search by nickname (top-level param, not a group) | | `category` | Cooperation categories (level 1 + 2) | | `buyer` | Buyer groups, content personas | | `ecom` | Average GMV, partner-brand average GMV, average transaction value | | `live` | Live plans (and plan dates) + live performance (avg viewers, peak online) | | `fans` | Fans count, age, gender, consumption power | | `flags` | Actively seeking cooperation, high reply rate, contact visible, worked with brands, follow relations, high live potential, daily broadcaster, celebrity | ### 3. Range Fields (value = `{"min": x, "max": y}`) | Path | Web filter | |---|---| | `fans.count` | Fans count | | `ecom.avg_gmv` / `ecom.brand_avg_gmv` | Average GMV / partner-brand average GMV (CNY) | | `ecom.atv` | Average transaction value (CNY). Upstream matches by **tier**, so any overlapping tier is included | | `live.avg_viewer` / `live.max_online` | Average viewers / peak concurrent viewers | ### 4. Boolean Flags (value = `true`) | Path | Web filter | |---|---| | `live.has_plan` | Has live plans (use with `live.plan_days`, format YYYYMMDD) | | `flags.actively_seeking` / `flags.high_reply_rate` | Actively seeking / high invitation reply rate | | `flags.contact_visible` / `flags.cooperated_before` | Contact visible / worked on sponsored deals | | `flags.following` / `flags.follower` | You follow them / they follow you | | `flags.live_potential_high` / `flags.daily_buyer` / `flags.is_star` | High live potential / daily broadcaster / celebrity | ### 5. Paging (**`seed` is specific to this endpoint**) | Param | Range | Note | |---|---|---| | `page_num` | **1-250** | Upstream exposes only the first 5000 items; page 251+ is empty | | `page_size` | **1-20** | Fixed at 20 on the web page | | `seed` | int | Result-set seed, see below | Ranking here is **randomized**, so paging without a stable `seed` causes duplicates or gaps. Echo back the `seed` from the previous response; send `0` for the first page (and echo `0` back if that is what the response contains). Keep all other filters unchanged. **`total` is not the pageable count**: `total` is the match count (possibly millions), while only `page_total` (always 5000) is actually reachable. ### 6. Return `distributor_info_list[]` — matched live sellers, each with two objects: - `distributor_data_info`: `distributor_id` (= blogger `userId`) / `red_id` / `distributor_name` / `fans_num` / `atv` (ATV tier) / `avg_sale_amount` (avg GMV) / `avg_live_viewer_num` / `max_online_people_num` / `distribution_live_num` (sessions) / `content_categorys` / `city` - `distributor_extra_info`: intended categories, commission, contact, level Plus `total` (match count) / `page_total` (paging cap) / `seed` (echo back when paging) / `req_id`. ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_note_comments
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_note_commentsXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the featured comments of a single note, including the blogger's own replies - Mirrors the "Featured Comments" block in the PGY note detail dialog ### Request Body Parameters - note_id: Note ID, e.g. "6a85646a0000000006005aea" (from the upstream V1 note-list endpoint (not exposed in this specification) list[].noteId, /tikhub/xiaohongshu/pgythe upstream V1 note-list endpoint (not exposed in this specification)_v2 noteList[].noteInfo.noteId, or /tikhub/xiaohongshu/pgy/get_content_square results) ### No paging - Upstream always returns **5 items** and does not support paging, so this endpoint exposes no paging parameters - Verified: pageIndex 0/1/2/5/20 and pageSize 5/10/20/50/100 all return the very same batch (identical comment.idStr) — it is a fixed "top 5 featured", not a comment feed ### Return - `data.data` is an **array** (not an object); each item is one comment thread: - comment: top-level comment. content / createTime / likeCount / subCommentCount / idStr / userIdStr - l1L2Comments[]: replies under it — **the blogger's replies live here**; same fields as comment, targetCommentId points at the parent - userMap: {userIdStr: {userNickName, imageUrl, gender}} - ⚠️ **Join userMap for nicknames/avatars** — comment and l1L2Comments[] carry only userIdStr - ⚠️ id / noteId / userId exceed JS safe integers; always use idStr / noteIdStr / userIdStr ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) API references: `get_content_square` = `POST /tikhub/xiaohongshu/pgy/get_content_square` (operationId: `post_tikhub_xiaohongshu_pgy_get_content_square`). <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_note_components
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_note_componentsXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get the components attached to a single note (content search / comment-area / bottom) - Mirrors the component tags under the title in the PGY note detail dialog ### Request Body Parameters - note_id: Note ID, same sources as /tikhub/xiaohongshu/pgy/get_note_comments ### Not a duplicate of compClickData in get_note_detail - This endpoint returns component **configuration**: which component, search word, brand, blogger, button label, jump target - compClickData returns component **click-rate tiers**: normal / high / very high (thresholds 0-2% / 2%-10% / 10%+) ### Return - Three component slots under `data.data`, **null when the component is not attached**: - noteContent: content component. subType (e.g. NOTE_CONTENT_SEARCH) / searchWord / brandName / gameAppId - noteComment: comment-area component. componentInfo (subType / name / buttonName / content / jumpType, jumpUrl / type) + brandInfo + kolInfo - noteBottom: bottom component; empirically null for most notes - Useful for seeing which conversion component a sponsored note carries and where it points ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) API references: `get_note_comments` = `POST /tikhub/xiaohongshu/pgy/get_note_comments` (operationId: `post_tikhub_xiaohongshu_pgy_get_note_comments`); `get_note_detail` = `POST /tikhub/xiaohongshu/pgy/get_note_detail` (operationId: `post_tikhub_xiaohongshu_pgy_get_note_detail`). <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu get_note_detail
$MeteredPOST https://aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_note_detailXiaohongshu (pgy). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get detail data of a single PGY (Pugongying) note ### Request Body Parameters - note_id: Note ID, e.g. "6a20edfa0000000021020951" ### Return - Note detail data: - Basics: noteId / noteLink / title / content / type / createTime - Author: userId / name / headPhoto - Media: imagesList[] (url with width/height) / videoInfo - Metrics: impNum / readNum / likeNum / favNum / cmtNum ### Response shape (two layers) - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) <!-- aisa-pricing:start --> Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu fetch_homefeed
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/web_v3/fetch_homefeedXiaohongshu (web_v3). ### Purpose - Get homepage recommended notes ### API Priority - Xiaohongshu API priority: `App V2` > `App` > `Web V3 (this)` > `Web V2` > `Web` ### Parameters - num (max 40), cursor_score, category, need_filter_image ### Return - Recommended notes list <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu fetch_homefeed_categories
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/web_v3/fetch_homefeed_categoriesXiaohongshu (web_v3). ### Purpose: - Get homepage category channels ### API Priority: - Xiaohongshu API priority: `App V2` > `App` > `Web V3 (this)` > `Web V2` > `Web` ### Return: - Categories list <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu fetch_note_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/web_v3/fetch_note_detailXiaohongshu (web_v3). ### Purpose: - Get note detail (image/video) ### API Priority: - Xiaohongshu API priority: `App V2` > `App` > `Web V3 (this)` > `Web V2` > `Web` ### Parameters: - note_id: Note ID, can be obtained from the sharing link of Xiaohongshu - xsec_token: Security token, can be obtained from the sharing link of Xiaohongshu ### Return: - Note detail data <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu fetch_search_suggest
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/web_v3/fetch_search_suggestXiaohongshu (web_v3). ### Purpose: - Get search suggestions, returns popular recommendations when keyword is empty ### API Priority: - Xiaohongshu API priority: `App V2` > `App` > `Web V3 (this)` > `Web V2` > `Web` ### Parameters: - keyword: Keyword (optional) ### Return: - Suggestions list <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xiaohongshu fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/xiaohongshu/web_v3/fetch_user_infoXiaohongshu (web_v3). ### Purpose: - Get user public profile ### API Priority: - Xiaohongshu API priority: `App V2` > `App` > `Web V3 (this)` > `Web V2` > `Web` ### Parameters: - user_id: User ID ### Return: - User info <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua fetch_one_video
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/fetch_one_videoXigua (app/v2). ### Purpose - Get single video data (less information, does not include title and other information, but includes information about related videos) ### Parameters - item_id: Video id ### Return - Video data, which contains the Base64 encoded playback address of the video link, which needs to be decoded and used by the front end, or use /tikhub/xigua/app/v2/fetch_one_video_play_url to get the playback link. API references: `fetch_one_video_play_url` = `GET /tikhub/xigua/app/v2/fetch_one_video_play_url` (operationId: `get_tikhub_xigua_app_v2_fetch_one_video_play_url`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua fetch_one_video_play_url
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/fetch_one_video_play_urlXigua (app/v2). ### Purpose: - Get single video play URL, the interface returns the decoded play URL, which can be used directly. ### Parameters: - item_id: Video id ### Return: - Play URL of the video, plaintext link. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/fetch_user_infoXigua (app/v2). ### Purpose: - Personal information ### Parameters: - user_id: User id ### Return: - Personal information <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua fetch_user_post_list
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/fetch_user_post_listXigua (app/v2). ### Purpose: - Get user post list ### Parameters: - user_id: User id - max_behot_time: Maximum behavior time, default empty, pass empty for the first request, pass the max_behot_time returned by the previous request for subsequent requests - The value of max_behot_time can be the JSON path: $.data.data.[-1].behot_time - That is, the cursor value of the last element in data ### Return: - Post list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua fetch_video_comment_list
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/fetch_video_comment_listXigua (app/v2). ### Purpose: - Video comment list ### Parameters: - item_id: Video id - offset: Offset, pass 0 for the first request, pass the offset returned by the previous request for subsequent requests - count: Quantity, default 20, it is recommended to keep the default. ### Return: - Comment list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
xigua search_video
$MeteredGET https://aisa.one/apis/v1/tikhub/xigua/app/v2/search_videoXigua (app/v2). ### Purpose: - Search video ### Parameters: - keyword: Keyword - offset: Offset, pass 0 for the first request, pass the offset returned by the previous request for subsequent requests - order_type: Order type, empty for default sorting, the following are optional sorting methods. - Newest: publish_time - Hottest: play_count - min_duration: Minimum duration, default empty, in seconds. - max_duration: Maximum duration, default empty, in seconds. ### Return: - Video list <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_info
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/get_channel_infoYouTube (web). ### Purpose: - Get channel information. ### Parameters: - channel_id: Channel ID. ### Returns: - Channel information. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_short_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/get_channel_short_videosYouTube (web). ### Purpose: - Get channel short videos. ### Parameters: - channel_id: Channel ID. - continuation_token: Token to continue fetching channel short videos. Default is None. ### Returns: - Channel short videos. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_url
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/get_channel_urlYouTube (web). ### Purpose: - Convert YouTube channel ID to channel handle (@username) - Reverse operation of get_channel_id_v2 endpoint ### Parameters: - channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg) ### Returns: - channel_id: Channel ID - handle: Channel handle (e.g., CozyCraftYT) - title: Channel name - channel_url: Standard channel URL (/channel/ format) - vanity_url: Vanity URL (/@username format) ### Use Cases: - When you have channel ID but need @username format URL - When you need to display user-friendly channel links Upstream-only reference: `get_channel_id_v2` is `GET /api/v1/youtube/web/get_channel_id_v2` in the official API. It is not exposed as an operation in this specification. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_relate_video
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/get_relate_videoYouTube (web). ### Purpose: - Get related videos by video ID. ### Parameters: - video_id: Video ID, get it from the URL, for example: https://www.youtube.com/watch?v=LuIL5JATZsc, the id is LuIL5JATZsc. - continuation_token: Token to continue fetching related videos. Default is None. ### Returns: - Related videos. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_trending_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/get_trending_videosGet trending videos <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube search_channel
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/search_channelYouTube (web). ### Purpose: - Search channel. ### Parameters: - search_query: Search keyword. - language_code: Language code, default is en. - country_code: Country code, default is us. - continuation_token: Token to continue fetching search results. Default is None. ### Returns: - Search results. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube search_video
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web/search_videoYouTube (web). ### Purpose: - Search video. ### Parameters: - search_query: Search keyword. - language_code: Language code, default is en. - order_by: Order by, default is this_month, optional values are this_week, this_month, this_year, last_hour, today. - country_code: Country code, default is us. - continuation_token: Token to continue fetching search results. Default is None. ### Returns: - Search results. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_community_posts
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_community_postsYouTube (web_v2). ### Purpose - Get YouTube channel's community posts list - Supports pagination via continuation_token ### Parameters #### Required: **channel_id** (string) - **Purpose**: Channel ID - **How to get**: Extract from channel URL, e.g., `https://www.youtube.com/channel/UCkRfArvrzheW2E7b6SVT7vQ` - **Example**: `"UCkRfArvrzheW2E7b6SVT7vQ"` #### Optional: **language_code** (string, optional) - Language code, default `"zh-CN"` **country_code** (string, optional) - Country code, default `"US"` **continuation_token** (string, optional) - Pagination token for next page **need_format** (bool, optional) - Whether to format data, default `true` ### Returns #### When need_format=true: - channel_id: Channel ID - posts: Posts list - post_id: Post ID - post_url: Post URL - author_name: Author name - author_channel_id: Author channel ID - author_url: Author channel URL - author_thumbnails: Author avatar thumbnails - content_text: Post text content - published_time: Published time (relative) - vote_count: Like count - comment_count: Comment count - attachment: Attachment (image/multi_image/video/poll, may be null) - continuation_token: Next page pagination token - has_more: Whether there are more posts - total_count: Current page post count #### When need_format=false: - Returns raw response data ### Usage Flow 1. First request: Only pass channel_id parameter 2. Get continuation_token from response 3. Next request: Pass channel_id and continuation_token 4. Repeat steps 2-3 until has_more is false ### Notes - Each page typically returns around 20 posts - Post attachments support: image, multi_image, video, poll types - Some channels may not have posts/community tab ### Example #### Get channel posts: channel_id = "UCkRfArvrzheW2E7b6SVT7vQ" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_description
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_descriptionYouTube (web_v2). ### Purpose: - Get YouTube channel description information (subscribers, videos, views, creation date, social links, etc.) ### Important - Two requests required for complete data: - **First request** (with channel_id): Returns basic info (title, description, subscribers, videos, avatar, banner, etc.) - **Second request** (with continuation_token): Returns advanced info (**creation date, social media links, country, view count**, etc.) ### How to get channel_id: - If you only have channel URL (e.g., `https://www.youtube.com/@CozyCraftYT`), call **get_channel_id** endpoint first - It will return channel_id like `UCeu6U67OzJhV1KwBansH3Dg` ### Parameters: #### 📌 Required (choose one): **channel_id** (string) - **Purpose**: Channel ID for first request to get basic channel info - **Format**: Usually starts with `UC`, 24 characters - **Example**: `"UCeu6U67OzJhV1KwBansH3Dg"` - **How to get**: Call **get_channel_id** endpoint with channel URL **continuation_token** (string) - **Purpose**: Pagination token for second request to get advanced info - **How to get**: Get `continuation_token` field from first request response - **Note**: Must provide either `channel_id` or `continuation_token` #### ⚙️ Optional: **language_code** (string, optional) - **Purpose**: Set language preference - **Default**: `"zh-CN"` - **Values**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"`, etc. **country_code** (string, optional) - **Purpose**: Set region code - **Default**: `"US"` - **Values**: `"US"`, `"JP"`, `"GB"`, etc. **need_format** (boolean, optional) - **Purpose**: Whether to return cleaned simplified data - **Default**: `true` - **Values**: - `false` - Return raw complete data - `true` - Return cleaned simplified data (recommended, default) ### Usage Flow (3 steps for complete data): 1. **Get channel_id**: If you only have URL, call `get_channel_id?channel_url=https://www.youtube.com/@CozyCraftYT` 2. **First request**: Use `channel_id` parameter to get basic info and `continuation_token` 3. **Second request**: Use `continuation_token` to get advanced info (creation date, social links, etc.) ### Response Structure (need_format=true): #### First request response (with channel_id): ```json { "channel_id": "UCeu6U67OzJhV1KwBansH3Dg", "title": "CozyCraft", "handle": "CozyCraftYT", "description": "Channel description...", "subscriber_count": "98.4K subscribers", "video_count": "181 videos", "view_count": null, "country": null, "creation_date": null, "links": [], "avatar": [{"url": "...", "width": 900, "height": 900}], "banner": [{"url": "...", "width": 2560, "height": 424}], "keywords": "Minecraft Ambience...", "channel_url": "https://www.youtube.com/channel/UCeu6U67OzJhV1KwBansH3Dg", "vanity_url": "http://www.youtube.com/@CozyCraftYT", "rss_url": "https://www.youtube.com/feeds/videos.xml?channel_id=UCeu6U67OzJhV1KwBansH3Dg", "is_family_safe": true, "verified": false, "has_business_email": false, "has_membership": true, "continuation_token": "4qmFsgJg..." } ``` #### Second request response (with continuation_token): ```json { "channel_id": "UCeu6U67OzJhV1KwBansH3Dg", "title": null, "handle": "CozyCraftYT", "description": "Full channel description...", "subscriber_count": "98.4K subscribers", "video_count": "181 videos", "view_count": "53,218,926 views", "country": "United States", "creation_date": "Oct 28, 2022", "links": [ {"name": "Discord", "url": "https://discord.gg/tvuxxcsgSS"}, {"name": "Twitter", "url": "https://twitter.com/..."} ], "avatar": [], "banner": [], "verified": false, "has_business_email": true, "continuation_token": null } ``` ### Notes: - **Two requests are required to get complete channel information** - First request: Get basic info (title, avatar, banner, keywords, rss_url, etc.) and continuation_token - Second request: Get advanced info (creation_date, links, view_count, country, etc.) - Recommend setting `need_format=true` for both requests - You can merge results from both requests for complete channel info API references: `get_channel_id` = `GET /tikhub/youtube/web_v2/get_channel_id` (operationId: `get_tikhub_youtube_web_v2_get_channel_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_id
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_idYouTube (web_v2). ### Purpose: - Convert YouTube channel URL to channel ID. - Supports multiple URL formats including @username, /channel/, /c/, /user/ formats. ### Parameters: - channel_url: Channel URL. ### Returns: - channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg) - channel_url: Normalized channel URL - source: Data source (url_parse means parsed from URL directly, page_parse means parsed from page) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_shorts
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_shortsYouTube (web_v2). ### Purpose - Get YouTube channel's Shorts (short videos) list - Supports pagination to get more shorts ### Parameters - channel_id: Channel ID (recommended, e.g., UCuAXFkgsw1L7xaCfnd5JJOw) - channel_url: Channel URL (optional, ignored if channel_id is provided) - continuation_token: Pagination token (optional, for next page) - need_format: Whether to format data (default true) - true: Return formatted structured data (recommended) - false: Return raw YouTube API structure (for debugging) ### Returns #### When need_format=true: - channel_id: Channel ID - shorts: Shorts list - video_id: Short video ID - title: Title - view_count_text: View count text (e.g., "1.2M views") - thumbnails: Thumbnail list - accessibility_text: Accessibility description text - video_url: Short video URL - continuation_token: Next page pagination token - has_more: Whether there are more shorts - total_count: Current page shorts count #### When need_format=false: - channel_id: Channel ID - shorts: Raw reelItemRenderer object list - continuation_token: Next page pagination token - has_more: Whether there are more shorts - total_count: Current page shorts count ### Usage Flow 1. First request: Only pass channel_id parameter 2. Get continuation_token from response 3. Next request: Pass channel_id and continuation_token 4. Repeat steps 2-3 until has_more is false ### Notes - Each page typically returns around 30 shorts - ⚠️ Currently does not support @username format, please use channel ID (UCxxxx format) ### Example #### Get Shorts: channel_id = "UCuAXFkgsw1L7xaCfnd5JJOw" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_url
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_urlYouTube (web_v2). ### Purpose: - Convert YouTube channel ID to channel handle (@username) - Reverse operation of get_channel_id endpoint ### Parameters: - channel_id: Channel ID (e.g., UCeu6U67OzJhV1KwBansH3Dg) ### Returns: - channel_id: Channel ID - handle: Channel handle (e.g., CozyCraftYT) - title: Channel name - channel_url: Standard channel URL (/channel/ format) - vanity_url: Vanity URL (/@username format) ### Use Cases: - When you have channel ID but need @username format URL - When you need to display user-friendly channel links API references: `get_channel_id` = `GET /tikhub/youtube/web_v2/get_channel_id` (operationId: `get_tikhub_youtube_web_v2_get_channel_id`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_channel_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_channel_videosYouTube (web_v2). ### Purpose - Get YouTube channel video list - Supports pagination via continuation_token ### Parameters #### 📌 Required: **channel_id** (string) - **Purpose**: Channel ID - **How to get**: - Extract from channel URL, e.g., `https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg` - Or visit the channel page to get the real channel ID from `@username` format URLs - **Example**: `"UCJHBJ7F-nAIlMGolm0Hu4vg"` #### ⚙️ Optional: **language_code** (string, optional) - **Purpose**: Set language preference - **Default**: `"zh-CN"` - **Values**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"`, etc. **country_code** (string, optional) - **Purpose**: Set region code - **Default**: `"US"` - **Values**: `"US"`, `"JP"`, `"GB"`, etc. **continuation_token** (string, optional) - **Purpose**: Pagination token for next page - **How to get**: Extract from previous response - **First request**: Omit or set to `null` **need_format** (boolean, optional) - **Purpose**: Whether to return cleaned simplified data - **Default**: `true` - **Values**: - `false` - Return raw complete data - `true` - Return cleaned simplified data (recommended, default) ### Response Structure (need_format=true) ```json { "channel": { "id": "UCJHBJ7F-nAIlMGolm0Hu4vg", "name": "Maizen", "description": "Thank you very much for watching our videos...", "handle_url": "http://www.youtube.com/@maizenofficial", "avatar": "https://yt3.googleusercontent.com/...=s900-...", "url": "https://www.youtube.com/channel/UCJHBJ7F-nAIlMGolm0Hu4vg", "rss_url": "https://www.youtube.com/feeds/videos.xml?channel_id=...", "keywords": "Minecraft", "is_family_safe": true, "is_verified": true }, "videos": [ { "video_id": "zd3yCa1bJCM", "title": "Minecraft: DREAM! - Asleep Custom Map", "thumbnail": "https://i.ytimg.com/vi/zd3yCa1bJCM/hqdefault.jpg", "thumbnails": [ {"url": "...", "width": 168, "height": 94}, {"url": "...", "width": 336, "height": 188} ], "moving_thumbnail": "https://i.ytimg.com/an_webp/zd3yCa1bJCM/mqdefault_6s.webp?...", "duration": "16:57", "duration_accessibility": "16 minutes, 57 seconds", "view_count": "343,369 views", "short_view_count": "343K views", "published_time": "18 hours ago", "description": "", "is_live": false, "is_verified": true, "url": "https://www.youtube.com/watch?v=zd3yCa1bJCM", "playback_url": "https://rr5---sn-ogueln67.googlevideo.com/initplayback?..." } ], "continuation_token": "next page token" } ``` ### Cleaned Data Field Descriptions **`channel` (object, channel-level metadata, shared across the listing):** ⚠️ **Only returned on the first request (when `continuation_token` is not provided).** Paginated responses do not include channel-level metadata from YouTube, so the `channel` field is **omitted** — cache the first-page value as the source of truth. Likewise, `videos[].is_verified` is always `false` on paginated responses (unreliable). - `id`: Channel ID (same as the `channel_id` query param) - `name`: Channel name - `description`: Channel bio (multi-line text, often contains contact info / social links / channel introduction) - `handle_url`: Channel handle URL (e.g., `http://www.youtube.com/@maizenofficial`) - `avatar`: Channel avatar URL (largest size, up to 900×900) - `url`: Channel home URL - `rss_url`: Channel RSS feed URL - `keywords`: Channel keywords - `is_family_safe`: Whether the channel is family-safe - `is_verified`: Whether the channel has a YouTube verified (blue check) badge **`videos[]` (list, per video):** - `video_id`: Video ID - `title`: Video title - `thumbnail`: Highest resolution thumbnail URL - `thumbnails`: List of all resolution thumbnails - `moving_thumbnail`: Moving thumbnail URL (webp format, hover preview) - `duration`: Video duration (e.g., "16:57") - `duration_accessibility`: Duration accessibility text (e.g., "16 minutes, 57 seconds") - `view_count`: Full view count (e.g., "343,369 views") - `short_view_count`: Short view count (e.g., "343K views". Note: under the lockup format this is identical to `view_count`; kept only for backward compatibility) - `published_time`: Published time (e.g., "18 hours ago") - `description`: ⚠️ Since 2026, YouTube's channel video listings (lockup format) no longer include per-video description snippets. This field is always `""`. For the channel-wide bio use the top-level `channel.description`; for per-video descriptions call the video detail endpoint. - `is_live`: Whether it's a live stream - `is_verified`: Whether the channel is verified (same as top-level `channel.is_verified` in the channel-videos context) - `url`: Video playback page URL - `playback_url`: Video playback initialization URL (googlevideo.com) - `continuation_token`: Pagination token for next page <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_general_search
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_general_searchYouTube (web_v2). ### Purpose - YouTube comprehensive search with multiple filter options for precise result filtering ### Parameters - **search_query**: Search keyword - **language_code**: Language code (zh-CN for Chinese, en-US for English) - **country_code**: Country code affecting regional relevance - **time_zone**: Time zone setting ### Filter Options (select one value for each) #### Upload Time (upload_time): - `hour`: Uploaded in the past hour - `today`: Uploaded today - `week`: Uploaded this week - `month`: Uploaded this month - `year`: Uploaded this year #### Duration (duration): - `short`: Short videos (under 4 minutes) - `medium`: Medium length (4-20 minutes) - `long`: Long videos (over 20 minutes) #### Content Type (content_type): - `video`: Videos - `channel`: Channels - `playlist`: Playlists - `movie`: Movies #### Features (feature): - `hd`: High definition - `4k`: 4K videos - `subtitles`: With subtitles - `live`: Live streams - `creative_commons`: Creative Commons licensed - `360`: 360-degree videos - `vr180`: VR180 videos - `3d`: 3D videos - `hdr`: HDR videos - `location`: With location info - `purchased`: Purchased content #### Sort By (sort_by): - `relevance`: Relevance (default) - `upload_date`: Upload date - `view_count`: View count - `rating`: Rating ### ⚠️ Recommend using V2 version - This endpoint returns raw YouTube data structure that requires manual parsing - This endpoint returns raw data. The structured V2 search variant described by the upstream is not exposed in this specification. ### Returns - Filtered search results <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_post_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_post_comment_repliesYouTube (web_v2). ### Purpose - Get replies to a post comment (second-level comments) ### Parameters #### Required: **continuation_token** (string) - **Purpose**: Reply continuation token - **How to get**: Extract `reply_continuation_token` from post comment response #### Optional: **language_code** (string, optional) - Language code, default `"zh-CN"` **country_code** (string, optional) - Country code, default `"US"` **need_format** (bool, optional) - Whether to format data, default `true` ### Usage Flow 1. Get post comments via `/tikhub/youtube/web_v2/get_post_comments` 2. Extract `reply_continuation_token` from a comment with replies 3. Pass it as `continuation_token` to this endpoint 4. Use returned `continuation_token` for more replies ### Returns (need_format=true) - comments: Reply comments list - continuation_token: Next page token (if more replies) ### Example #### GET /tikhub/youtube/web_v2/get_post_comment_replies?continuation_token=xxx&need_format=true API references: `get_post_comments` = `GET /tikhub/youtube/web_v2/get_post_comments` (operationId: `get_tikhub_youtube_web_v2_get_post_comments`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_post_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_post_commentsYouTube (web_v2). ### Purpose - Get YouTube post (community post) comments - Supports pagination for more comments ### Parameters #### Required (at least one): **post_id** (string) - Post ID, required for first request **continuation_token** (string) - Pagination token (from get_post_detail's comments_continuation_token or previous response) #### Optional: **language_code** (string, optional) - Language code, default `"zh-CN"` **country_code** (string, optional) - Country code, default `"US"` **need_format** (bool, optional) - Whether to format data, default `true` ### Returns (need_format=true) - comments: Comments list - comment_id, content, published_time, like_count, reply_count - reply_continuation_token: Token for fetching replies - author: Author info (channel_id, display_name, avatar_url, etc.) - continuation_token: Next page token ### Usage Flow 1. First request: Pass post_id (or use comments_continuation_token from get_post_detail) 2. Get continuation_token from response 3. Next request: Pass continuation_token for more comments 4. Use reply_continuation_token to get replies via get_post_comment_replies ### Example #### Get post comments: post_id = "UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy" API references: `get_post_comment_replies` = `GET /tikhub/youtube/web_v2/get_post_comment_replies` (operationId: `get_tikhub_youtube_web_v2_get_post_comment_replies`); `get_post_detail` = `GET /tikhub/youtube/web_v2/get_post_detail` (operationId: `get_tikhub_youtube_web_v2_get_post_detail`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_post_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_post_detailYouTube (web_v2). ### Purpose - Get YouTube post (community post) detail information - Includes post content, attachments, engagement data ### Parameters #### Required: **post_id** (string) - **Purpose**: Post ID - **How to get**: Extract from post URL, e.g., `https://www.youtube.com/post/UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy` - **Example**: `"UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy"` #### Optional: **language_code** (string, optional) - Language code, default `"zh-CN"` **country_code** (string, optional) - Country code, default `"US"` **need_format** (bool, optional) - Whether to format data, default `true` ### Returns #### When need_format=true: - post: Post detail - post_id: Post ID - post_url: Post URL - author_name: Author name - author_channel_id: Author channel ID - author_url: Author channel URL - author_thumbnails: Author avatar thumbnails - content_text: Post text content - published_time: Published time (relative) - vote_count: Like count - comment_count: Comment count - attachment: Attachment data (image/multi_image/video/poll, may be null) - channel_metadata: Channel metadata (name, description, URL, etc.) - comments_continuation_token: Comments pagination token #### When need_format=false: - Returns raw data ### Notes - post_id starts with "Ugk" - Post attachments support: image, multi_image, video, poll types ### Example #### Get post details: post_id = "UgkxiCSRfD6g7SPlWGPDa3vbP7aIsytXRkvy" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_related_videos
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_related_videosYouTube (web_v2). ### Purpose - Get YouTube video's related content recommendations (recommended videos list) - Similar to the related videos shown on the right side of video playback page - Returns all recommended videos at once (typically 20-30 videos) ### Parameters - video_id: Video ID (recommended) - video_url: Full video URL (optional, ignored if video_id is provided) - need_format: Whether to format data (default true) - true: Return formatted structured data (recommended) - false: Return raw YouTube API structure (for debugging or custom parsing) ### Returns #### When need_format=true: - video_id: Current video ID - related_videos: Related videos list - video_id: Related video's ID - title: Video title - author: Author name - author_id: Author channel ID - author_url: Author channel URL - length_text: Video duration text (e.g., "3:45") - length_seconds: Video duration in seconds - view_count_text: View count text (e.g., "1.2M views") - short_view_count_text: Short view count text (e.g., "1.2M") - published_time_text: Published time text (e.g., "2 days ago") - thumbnails: All resolution thumbnails - rich_thumbnail: Moving thumbnail (if available) - badges: Video badges (e.g., NEW, LIVE) - owner_badges: Channel verification badges - video_url: Video URL - navigation_endpoint: Navigation endpoint - total_count: Total number of recommended videos #### When need_format=false: - video_id: Current video ID - related_videos: Raw lockupViewModel object list - total_count: Total number of recommended videos ### Notes - Each video's recommendations are generated by YouTube's algorithm and may change - Recommendation list typically contains 20-30 videos - ⚠️ **This API does not support pagination**, returns all recommendations at once ### Example #### Get related videos: video_id = "dQw4w9WgXcQ" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_search_suggestions
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_search_suggestionsYouTube (web_v2). ### Purpose - Get YouTube search suggestions (autocomplete) - Similar to suggestions shown when typing in YouTube search box ### Parameters - keyword: Search keyword (required) - language: Language code (optional, default en) - en: English - zh-cn: Simplified Chinese - ja: Japanese - ko: Korean - region: Region code (optional, default US) - US: United States - SG: Singapore - CN: China - JP: Japan - KR: Korea ### Returns - keyword: Search keyword - suggestions: Suggestions list (array of strings) - total_count: Number of suggestions ### Notes - Suggestions vary by language and region - Typically returns 10-20 suggestions - Very fast response (< 1 second) ### Example #### Get search suggestions: keyword = "Rick Astley" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_shorts_search
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_shorts_searchYouTube (web_v2). ### Purpose - YouTube Shorts specialized search using native YouTube API ### Features - 🎬 Specialized search for YouTube Shorts (<60 seconds) - 🔍 Support for multiple filter conditions and sorting options - 📱 Optimized for mobile short-form content - ⚡ Smart filtering: First request may return mixed content (long+short videos), automatically filters long videos by default ### Important - YouTube Shorts Search Mechanism According to YouTube's search logic, Shorts search has these characteristics: 1. **First request** (no continuation_token): May return mixed content (some long videos + some short videos) 2. **Subsequent requests** (with continuation_token): Returns only pure Shorts content 3. **Solutions**: - Solution A: Use `filter_mixed_content=true` (default) to automatically filter long videos - Solution B: Use continuation_token from first response for second request to get pure Shorts - Solution C: Set `filter_mixed_content=false` to get original mixed content ### Parameters - **search_query**: Search keyword - **language_code**: Language code (zh-CN for Chinese, en-US for English) - **country_code**: Country code affecting regional relevance - **time_zone**: Time zone (e.g., America/Los_Angeles, Asia/Shanghai) - **filter_mixed_content**: Whether to filter long videos from mixed content (default true) ### Shorts-specific Filters #### Upload Time (upload_time): - `hour`: Shorts uploaded in the past hour - `today`: Shorts uploaded today - `week`: Shorts uploaded this week - `month`: Shorts uploaded this month - `year`: Shorts uploaded this year #### Sort By (sort_by): - `relevance`: Relevance (default) - `upload_date`: Upload date - `view_count`: View count - `rating`: Rating ### Pagination Mechanism Explained #### How to get continuation_token: Extract from response JSON, typically at one of these paths: ```python # Path 1: In onResponseReceivedCommands response["onResponseReceivedCommands"][0]["appendContinuationItemsAction"]["continuationItems"][-1]["continuationItemRenderer"]["continuationEndpoint"]["continuationCommand"]["token"] # Path 2: In contents response["contents"]["twoColumnSearchResultsRenderer"]["primaryContents"]["sectionListRenderer"]["contents"][-1]["continuationItemRenderer"]["continuationEndpoint"]["continuationCommand"]["token"] ``` #### Usage Flow: 1. **First request**: Don't pass continuation_token ``` GET /tikhub/youtube/web_v2/get_shorts_search?search_query=python ``` 2. **Extract token**: Find continuation_token in response 3. **Next requests**: Pass continuation_token to get next page ``` GET /tikhub/youtube/web_v2/get_shorts_search?search_query=python&continuation_token=xxx ``` ### Response Data Structure ```json { "code": 200, "data": { "contents": { "twoColumnSearchResultsRenderer": { "primaryContents": { "sectionListRenderer": { "contents": [ { "itemSectionRenderer": { "contents": [ { "gridShelfViewModel": { // Shorts video list "items": [...] } } ] } }, { "continuationItemRenderer": { "continuationEndpoint": { "continuationCommand": { "token": "xxx" // Token for next page } } } } ] } } } } } } ``` ### ⚠️ Recommend using V2 version - This endpoint returns raw YouTube data structure that requires manual parsing - This endpoint returns raw data. The structured V2 search variant described by the upstream is not exposed in this specification. ### Returns - Shorts-specific search results with video list and pagination token <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_signed_stream_url
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_signed_stream_urlYouTube (web_v2). ### Purpose: - Get signed playback URL for specific itag (ready to play) - Use with get_video_streams endpoint: first get all formats, then select itag to get playback URL ### Parameters: - video_id: Video ID (recommended) - video_url: Full video URL (optional) - itag: Format identifier, selected from formats list returned by get_video_streams ### Returns: - itag: Format identifier - url: Signed playback URL (ready to use) - expires_in_seconds: URL validity period (typically 6 hours = 21600 seconds) ### Notes: - Playback URLs expire after approximately 6 hours, need to regenerate after expiration - URL length is long (approximately 1000-2000 characters) - Some videos may have regional restrictions API references: `get_video_streams` = `GET /tikhub/youtube/web_v2/get_video_streams` (operationId: `get_tikhub_youtube_web_v2_get_video_streams`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_captions
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_captionsYouTube (web_v2). Pricing and billing notes describe the upstream provider. Use the AIsa price quote for gateway calls. ### Purpose - Get video caption list or caption content for a specific language - Supports multiple caption format outputs ### Parameters - video_id: Video ID (recommended) - video_url: Full video URL (optional) - language_code: Language code (e.g. en, zh-Hans, a.en), returns available caption list if empty - format: Caption format - srt: SubRip subtitle format (with timestamps) - xml: Raw XML format - json3: JSON format (YouTube raw structure) - txt: Plain text (no timestamps) ### Returns #### Without language_code (caption language list): ```json { "video_id": "dQw4w9WgXcQ", "captions": [ { "language_code": "en", "language_name": "English" }, { "language_code": "ja", "language_name": "Japanese" } ] } ``` #### With language_code (caption content): - format=srt: Standard SRT subtitle content (with sequence numbers, timestamps, text) - format=txt: Plain text (text only, no timestamps) - format=xml: YouTube raw XML captions - format=json3: YouTube JSON format captions #### Large videos (async job): ```json { "video_id": "dQw4w9WgXcQ", "status": "processing", "job_id": "123e4567-e89b-12d3-a456-426614174000" } ``` - When `status="processing"` is returned, poll `/tikhub/youtube/web_v2/get_video_captions_result` with the `job_id` to retrieve the final captions #### Video has no captions: ```json { "video_id": "dQw4w9WgXcQ", "captions": [], "message": "No transcript is available for this video", "message_zh": "该视频没有可用字幕" } ``` ### Usage flow 1. Call without language_code to get available caption list 2. Select language_code from the list to get caption content ### Notes - Not all videos have captions - Only captions that already exist on the video are returned; AI speech-to-text transcription is not provided. Videos without captions return the no-captions result shown above - At least one of video_id or video_url is required - Large videos become async jobs; poll `/tikhub/youtube/web_v2/get_video_captions_result` for the result - A video with no captions returns 200 with the message above and is still billed (the upstream provider charges for this request) API references: `get_video_captions_result` = `GET /tikhub/youtube/web_v2/get_video_captions_result` (operationId: `get_tikhub_youtube_web_v2_get_video_captions_result`). <!-- aisa-pricing:start --> Published reference price: $0.008 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_captions_result
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_captions_resultyoutube get_video_captions_result <!-- aisa-pricing:start --> Published reference price: $0.0001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_comment_replies
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_comment_repliesYouTube (web_v2). ### Purpose: - Get video second-level comment replies ### Parameters: #### Required: **continuation_token** (string) - **Purpose**: Reply continuation token from first-level comment - **How to get**: Extract `reply_continuation_token` from the first-level comment response #### Optional: **language_code** (string, optional) - **Purpose**: Language preference for comments - **Default**: `"zh-CN"` **country_code** (string, optional) - **Purpose**: Region code - **Default**: `"US"` **need_format** (boolean, optional) - **Purpose**: Whether to return cleaned simplified data - **Default**: `true` ### Returns: - `replies`: List of reply comments - `continuation_token`: Next page token (if more replies available) ### Usage flow: 1. Get first-level comments via `get_video_comments` 2. Extract `reply_continuation_token` from a comment that has replies 3. Pass it as `continuation_token` to this endpoint 4. For more replies, use the returned `continuation_token` API references: `get_video_comments` = `GET /tikhub/youtube/web_v2/get_video_comments` (operationId: `get_tikhub_youtube_web_v2_get_video_comments`). <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_commentsYouTube (web_v2). ### Purpose: - Get YouTube video first-level comments ### Parameters: #### 📌 Required: **video_id** (string) - **Purpose**: Video ID - **Format**: YouTube video ID string - **Example**: `"oaSNBz4qMQY"` - **How to get**: Extract from URL `https://www.youtube.com/watch?v=oaSNBz4qMQY` #### ⚙️ Optional: **language_code** (string, optional) - **Purpose**: Set language preference for comments - **Default**: `"zh-CN"` - **Values**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"`, etc. **country_code** (string, optional) - **Purpose**: Set region code - **Default**: `"US"` - **Values**: `"US"`, `"JP"`, `"GB"`, etc. **sort_by** (string, optional) - **Purpose**: Comment sorting method - **Default**: `"top"` - **Values**: - `"top"` - Top comments (sorted by likes) - `"newest"` - Newest comments (sorted by time) **continuation_token** (string, optional) - **Purpose**: Pagination token for next page - **Default**: `null` - **How to get**: Extract from previous response **need_format** (boolean, optional) - **Purpose**: Whether to return cleaned simplified data - **Default**: `true` - **Values**: - `false` - Return raw complete data - `true` - Return cleaned simplified data (recommended, default) ### Response Structure (need_format=true): ```json { "comments": [ { "comment_id": "UgzRDoUJAvDNn5_8i8p4AaABAg", "content": "Comment text content", "published_time": "1 day ago", "reply_level": 0, "like_count": "2", "like_count_a11y": "2 likes", "reply_count": "0", "reply_count_a11y": "0 replies", "reply_count_text": "1 reply", "reply_continuation_token": "...", "author": { "channel_id": "UCzRzHrLFuH0lHZYnrI84I8Q", "display_name": "@username", "channel_url": "https://www.youtube.com/@username", "avatar_url": "https://yt3.ggpht.com/...", "avatar_thumbnails": [ {"url": "...", "width": 88, "height": 88} ], "is_verified": false, "is_creator": false, "is_artist": false }, "creator_thumbnail_url": "https://yt3.ggpht.com/..." } ], "continuation_token": "next page token" } ``` ### Field Descriptions: - `comment_id`: Unique comment ID - `content`: Comment text content - `published_time`: Published time (relative, e.g., "1 day ago") - `reply_level`: Reply level (0 for first-level comments) - `like_count`: Number of likes - `reply_count`: Number of replies - `reply_count_text`: Reply count text (e.g., "1 reply") - `reply_continuation_token`: Token to get replies for this comment - `author`: Comment author info - `channel_id`: Author's channel ID - `display_name`: Display name - `channel_url`: Channel URL - `avatar_url`: Avatar URL - `is_verified`: Whether verified - `is_creator`: Whether video creator - `is_artist`: Whether artist - `creator_thumbnail_url`: Video creator's avatar URL <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_info
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_infoYouTube (web_v2). ### Purpose: - Get YouTube video details - Returns raw complete data (includes playerResponse and initialData) ### Parameters: #### 📌 Required: **video_id** (string) - **Purpose**: Video ID - **How to get**: Extract from video URL, e.g., `https://www.youtube.com/watch?v=oaSNBz4qMQY`, video_id is `oaSNBz4qMQY` - **Example**: `"oaSNBz4qMQY"` #### ⚙️ Optional: **language_code** (string, optional) - **Purpose**: Set language preference - **Default**: `"zh-CN"` - **Values**: `"zh-CN"`, `"en-US"`, `"ja-JP"`, `"ko-KR"`, etc. ### Response Structure: ```json { "playerResponse": { "videoDetails": {}, "streamingData": { "formats": [], "adaptiveFormats": [] }, "microformat": {}, ... }, "initialData": { "contents": { "twoColumnWatchNextResults": { "results": { "results": { "contents": [ { "videoPrimaryInfoRenderer": {...}, "videoSecondaryInfoRenderer": {...} } ] } } } }, ... } } ``` ### Key Fields: - `playerResponse`: YouTube player response data - `videoDetails`: Basic video info (may be empty depending on YouTube's response) - `streamingData`: Video stream data (includes formats and adaptiveFormats with googlevideo.com URLs) - `microformat`: Metadata information - `initialData`: YouTube page initialization data - `videoPrimaryInfoRenderer`: Primary info (title, view count, like count, etc.) - `videoSecondaryInfoRenderer`: Secondary info (channel info, description, etc.) <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube get_video_streams
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/get_video_streamsYouTube (web_v2). ### ⚠️ Important Notice - **This endpoint ONLY returns format information, URL fields are null** - **MUST use get_signed_stream_url endpoint to get playback URLs** - For getting all URLs at once, use get_video_streams_v2 endpoint ### Purpose - Get all quality format information for YouTube video - Returns standard formats (merged audio/video) and adaptive formats (separate audio/video) ### Parameters - video_id: Video ID (recommended) - video_url: Full video URL (optional, ignored if video_id is provided) ### Returns - Basic video info (title, author, duration, view count, etc.) - formats: Standard format streams (audio and video combined) - adaptive_formats: Adaptive format streams (video-only or audio-only) - Each format contains: itag, mime_type, quality label, resolution, bitrate, etc. - ⚠️ **url field is null** (YouTube requires signature decryption to get actual playback URL) - has_signature=true means need to use get_signed_stream_url endpoint - hls_manifest_url: HLS manifest URL (if available) - dash_manifest_url: DASH manifest URL (if available) - available_qualities: List of all available quality levels ### Usage Flow (Two-Step Method) 1. **Step 1**: Call this endpoint to get all available format information (URLs are null) 2. **Step 2**: Select the desired itag from returned formats or adaptive_formats 3. **Step 3**: Call get_signed_stream_url endpoint with video_id and itag to get actual playback URL ### Notes - YouTube video playback URLs require signature decryption, null URL fields in raw API response is normal - Playback URLs must be obtained separately via get_signed_stream_url endpoint - High-quality videos (720p+) usually require separate download and merge of audio/video streams ### Example #### Step 1 - Get format information: video_id = "dQw4w9WgXcQ" #### Step 2 - Get playback URLs: use get_signed_stream_url with selected itag API references: `get_signed_stream_url` = `GET /tikhub/youtube/web_v2/get_signed_stream_url` (operationId: `get_tikhub_youtube_web_v2_get_signed_stream_url`). Upstream-only reference: `get_video_streams_v2` is `GET /api/v1/youtube/web_v2/get_video_streams_v2` in the official API. It is not exposed as an operation in this specification. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
youtube search_channels
$MeteredGET https://aisa.one/apis/v1/tikhub/youtube/web_v2/search_channelsYouTube (web_v2). ### Purpose - Search YouTube channels - Only returns channel-type search results (filters out videos, playlists, etc.) - Supports pagination to get more channels ### Parameters - keyword: Search keyword (required for first request) - continuation_token: Pagination token (optional, for next page) - need_format: Whether to format data (default true) - true: Return formatted structured data (recommended) - false: Return raw YouTube API structure (for debugging) ### Returns #### When need_format=true: - keyword: Search keyword - channels: Channels list - channel_id: Channel ID (e.g., "UCjuNibFJ21MiSNpu8LZyV4w") - title: Channel name - handle: Channel custom handle (e.g., "@chaijing2023") - subscriber_count_text: Subscriber count text (e.g., "1.11M subscribers") - description: Channel description snippet - thumbnails: Thumbnail list (multiple sizes) - is_subscribed: Whether current user is subscribed to this channel (boolean) - canonical_url: Channel canonical URL path (e.g., "/@chaijing2023") - channel_url: Full channel URL (prefers custom URL) - continuation_token: Next page pagination token - has_more: Whether there are more channels - total_count: Current page channel count #### When need_format=false: - keyword: Search keyword - channels: Raw channelRenderer object list - continuation_token: Next page pagination token - has_more: Whether there are more channels - total_count: Current page channel count ### Usage Flow 1. First request: Only pass keyword parameter 2. Get continuation_token from response 3. Next request: Pass continuation_token (keyword optional) 4. Repeat steps 2-3 until has_more is false ### Notes - Each page typically returns 10-20 channels - Search results only include channels, not videos, playlists, etc. - Order and quantity of results determined by YouTube algorithm ### Example #### Search channels: keyword = "Rick Astley" <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_ai_search_stream
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_ai_search_streamZhihu (web). ### Purpose: - Get Zhihu AI Search results (new endpoint) ### Parameters: - message_content: Search Content - chat_mode: Chat mode, default FAST - session_id: Session ID for multi-turn ### Returns: - Zhihu AI Search results as an event list {"events": [...]} <!-- aisa-pricing:start --> Published reference price: $0.005 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_answer_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_answer_detailZhihu (web). ### Purpose: - Get a single Zhihu answer's detail (content / stats / author / question, etc.) ### Parameters: - answer_id: Answer ID (the numeric id in the page URL .../answer/{answer_id}) ### Returns: - Zhihu Answer Detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_article_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_article_search_v3Zhihu (web). ### Purpose: - Get Zhihu Article Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of articles per page - show_all_topics: Show all topics - 0 Do not show topics - 1 Show topics - search_source: Search Source - Filter parameter takes effect - Normal is normal result - search_hash_id: Search Hash ID, used to filter duplicate search results - vertical: Empty unlimited type - answer only see answers - article only see articles - zvideo only see videos - sort: Empty comprehensive sorting - upvoted_count most upvoted - created_time latest release - time_interval: Time interval - Empty unlimited time - a_day within a day - a_week within a week - a_month within a month - three_months within three months - half_a_year within half a year - a_year within a year - vertical_info: Vertical information - 0,0,0,0,0,0,0,0,0,0,0,0 unlimited type, do not set do not fill ### Returns: - Zhihu Article Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_article_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_article_detailZhihu (web). ### Purpose: - Get Zhihu Column Article Detail ### Parameters: - article_id: Article ID ### Returns: - Zhihu Column Article Detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_articles
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_articlesZhihu (web). ### Purpose: - Get Zhihu Column Articles ### Parameters: - column_id: Column ID - limit: Number of articles per page - offset: Offset ### Returns: - Zhihu Column Articles <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_comment_config
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_comment_configZhihu (web). ### Purpose: - Get Zhihu Column Comment Config ### Parameters: - article_id: Article ID ### Returns: - Zhihu Column Comment Config <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_recommend
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_recommendZhihu (web). ### Purpose: - Get Zhihu Similar Column Recommend ### Parameters: - article_id: Article ID - limit: Number of columns per page - offset: Offset ### Returns: - Zhihu Similar Column Recommend <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_relationship
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_relationshipZhihu (web). ### Purpose: - Get Zhihu Column Relationship ### Parameters: - article_id: Article ID ### Returns: - Zhihu Column Relationship <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_column_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_column_search_v3Zhihu (web). ### Purpose: - Get Zhihu Column Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of columns per page - search_hash_id: Search Hash ID ### Returns: - Zhihu Column Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_comment_v5Zhihu (web). ### Purpose: - Get Zhihu Comment V5 ### Parameters: - answer_id: Answer ID - order_by: Sort - score Hottest Sort - ts Latest Sort - limit: Number of comments per page - offset: Offset/Page Number ### Returns: - Zhihu Comment V5 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_ebook_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_ebook_search_v3Zhihu (web). ### Purpose: - Get Zhihu Ebook Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of ebooks per page - search_hash_id: Search Hash ID ### Returns: - Zhihu Ebook Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_hot_list
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_hot_listZhihu (web). ### Purpose: - Get Zhihu Hot List ### Parameters: - limit: Number of articles per page - desktop: Is it a desktop ### Returns: - Zhihu Hot List <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_hot_recommend
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_hot_recommendZhihu (web). ### Purpose: - Get Zhihu Hot Recommend ### Parameters: - offset: Offset - page_number: Page Number - session_token: Session Token <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_pin_comments
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_pin_commentsZhihu (web). ### Purpose: - Get the comments of a Zhihu pin ### Parameters: - pin_id: Pin ID - order_by: Sort, score=default, ts=newest - limit: Number of comments per page - offset: Offset, take the cursor from the response for paging ### Returns: - Zhihu Pin Comments <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_pin_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_pin_detailZhihu (web). ### Purpose: - Get the detail of a single Zhihu pin ### Parameters: - pin_id: Pin ID ### Returns: - Zhihu Pin Detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_preset_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_preset_searchZhihu (web). ### Purpose: - Get Zhihu Preset Search ### Parameters: - None ### Returns: - Zhihu Preset Search <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_question_answers
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_question_answersZhihu (web). ### Purpose: - Get Zhihu Question Answers List ### Parameters: - question_id: Question ID - cursor: Pagination cursor for next page, extracted from response fields - limit: Number of answers per page, default 5 - offset: Offset, default 0 - order: Sort order, default=default sort, updated=sort by time - session_id: Session ID for pagination state, extracted from response fields ### Returns: - Zhihu Question Answers List Data <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_question_detail
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_question_detailZhihu (web). ### Purpose: - Get Zhihu Question Detail (title / description / stats / topics, etc.) ### Parameters: - question_id: Question ID ### Returns: - Zhihu Question Detail <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_recommend_followees
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_recommend_followeesZhihu (web). ### Purpose: - Get Zhihu Recommend Followees ### Parameters: - None ### Returns: - Zhihu Recommend Followees <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_salt_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_salt_search_v3Zhihu (web). ### Purpose: - Get Zhihu Salt Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of contents per page - search_hash_id: Search Hash ID ### Returns: - Zhihu Salt Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_scholar_search
$MeteredPOST https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_scholar_search_v3Zhihu (web). ### Purpose - Get Zhihu Scholar Search V3 ### Parameters - keyword: Search Keywords - offset: Offset - limit: Number of papers per page - Root JSON body: Object containing the filter fields. ### Returns - Zhihu Scholar Search V3 ### Request body Send filter fields as a JSON object at the root of the request body. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_search_recommend
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_search_recommendZhihu (web). ### Purpose: - Get Zhihu Search Recommend ### Parameters: - None ### Returns: - Zhihu Search Recommend <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_search_suggest
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_search_suggestZhihu (web). ### Purpose: - Get Zhihu Search Suggest ### Parameters: - keyword: Search Keywords ### Returns: - Zhihu Search Suggest <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_sub_comment
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_sub_comment_v5Zhihu (web). ### Purpose: - Get Zhihu Sub Comment V5 ### Parameters: - comment_id: Comment ID - order_by: Sort - score Hottest Sort - ts Latest Sort - limit: Number of comments per page - offset: Offset/Page Number ### Returns: - Zhihu Sub Comment V5 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_topic_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_topic_search_v3Zhihu (web). ### Purpose: - Get Zhihu Topic Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of topics per page ### Returns: - Zhihu Topic Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_answers
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_answersZhihu (web). ### Purpose: - Get Zhihu User Answers ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of answers per page - sort_type: Sort Type - created Sort by creation time - voteups Sort by vote ups ### Returns: - Zhihu User Answers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_articles
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_articlesZhihu (web). ### Purpose: - Get Zhihu User Articles ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of articles per page - sort_type: Sort Type - created Sort by creation time - voteups Sort by vote ups ### Returns: - Zhihu User Articles <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_collections
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_collectionsZhihu (web). ### Purpose: - Get collections **created** by a Zhihu user (distinct from followed favlists) ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of collections per page ### Returns: - Zhihu User Created Collections <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_follow_collections
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_follow_collectionsZhihu (web). ### Purpose: - Get Zhihu User Follow Collections ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of collections per page ### Returns: - Zhihu User Follow Collections <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_follow_columns
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_follow_columnsZhihu (web). ### Purpose: - Get Zhihu User Columns ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of columns per page ### Returns: - Zhihu User Columns <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_follow_questions
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_follow_questionsZhihu (web). ### Purpose: - Get Zhihu User Follow Questions ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of questions per page ### Returns: - Zhihu User Follow Questions <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_follow_topics
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_follow_topicsZhihu (web). ### Purpose: - Get Zhihu User Follow Topics ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of topics per page ### Returns: - Zhihu User Follow Topics <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_followees
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_followeesZhihu (web). ### Purpose: - Get Zhihu User Following ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of users per page ### Returns: - Zhihu User Following <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_followers
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_followersZhihu (web). ### Purpose: - Get Zhihu User Followers ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of users per page ### Returns: - Zhihu User Followers <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_included_articles
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_included_articlesZhihu (web). ### Purpose: - Get Zhihu User Included Articles ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of articles per page ### Returns: - Zhihu User Included Articles <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_info
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_infoZhihu (web). ### Purpose: - Get Zhihu User Info ### Parameters: - user_url_token: User ID ### Returns: - Zhihu User Info <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_pins
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_pinsZhihu (web). ### Purpose: - Get a Zhihu user's pins (moments) list ### Parameters: - user_url_token: User ID - offset: Offset - limit: Number of pins per page ### Returns: - Zhihu User Pins <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_search_v3Zhihu (web). ### Purpose: - Get Zhihu User Search V3 ### Parameters: - keyword: Search Keywords - offset: Offset - limit: Number of users per page ### Returns: - Zhihu User Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_user_segments
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_user_segmentsZhihu (web). ### Purpose: - Get a Zhihu user's highlighted segments (lineComments) ### Parameters: - user_url_token: MUST be the user's **member hash id** (e.g. c72367...), not the url_token - content_type: Content type, all for all - offset: Offset - limit: Number per page ### Returns: - Zhihu User Segments <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_video_list
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_video_listZhihu (web). ### Purpose: - Get Zhihu Video List ### Parameters: - offset: Offset - limit: Number of videos per page ### Returns: - Zhihu Video List <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
zhihu fetch_video_search
$MeteredGET https://aisa.one/apis/v1/tikhub/zhihu/web/fetch_video_search_v3Zhihu (web). ### Purpose: - Get Zhihu Video Search V3 ### Parameters: - keyword: Search Keywords - limit: Number of videos per page - offset: Offset - search_hash_id: Search Hash ID ### Returns: - Zhihu Video Search V3 <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Article
$MeteredGET https://aisa.one/apis/v1/twitter/articleGet the full body of an X Article (long-form post) by its tweet ID. Use this when a tweet links to or is an Article and the 280-character preview is not enough — this returns the complete text rather than the truncated tweet. Returns the article under `article`. For ordinary tweets use `get_twitter_tweets`. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
OAuth_Twitter
$MeteredPOST https://aisa.one/apis/v1/twitter/auth_twitter默认价格配置 <!-- aisa-pricing:start --> Published reference price: $0.000001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Community Tweets
$MeteredGET https://aisa.one/apis/v1/twitter/community/get_tweets_from_all_communitySearch posts across all X Communities by keyword, sorted by Latest (default) or Top, cursor-paginated. Use this to find topic-specific discussion happening inside communities rather than on the public timeline — signal density is usually higher and noise lower. Returns full tweet objects. Once you identify a community worth following, use `get_twitter_community_tweets` to read it directly, or `get_twitter_community_info` for its metadata. For public-timeline search use `get_twitter_tweet_advanced_search`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Community Info
$MeteredGET https://aisa.one/apis/v1/twitter/community/infoGet metadata for an X Community by its numeric community ID — name, description, member count, and access rules. Use this to qualify a community before pulling its members or posts. Returns the object under `community_info`. To discover communities by topic, search their posts with `get_twitter_community_tweets_all`. <!-- aisa-pricing:start --> Published reference price: $0.0002 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List Community Members
$MeteredGET https://aisa.one/apis/v1/twitter/community/membersList the members of an X Community, cursor-paginated. Use this to map who participates in a topic-specific group — usually a higher-signal audience than general followers, because membership is opt-in. Returns full user objects. For the subset who moderate it, use `get_twitter_community_moderators`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0036 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Community Moderators
$MeteredGET https://aisa.one/apis/v1/twitter/community/moderatorsList the moderators of an X Community, cursor-paginated. Use this to identify the people who set the agenda in a community — the highest-leverage contacts for outreach or partnership. Returns full user objects. For the full membership use `get_twitter_community_members`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0036 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Community Tweets
$MeteredGET https://aisa.one/apis/v1/twitter/community/tweetsGet posts published inside one specific X Community, cursor-paginated. Use this to read what a known community is actually discussing. Returns full tweet objects with engagement counts. If you do not know which community to look at, search across all of them with `get_twitter_community_tweets_all`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Delete Tweet
$MeteredPOST https://aisa.one/apis/v1/twitter/delete_twitter<!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Follow User
$MeteredPOST https://aisa.one/apis/v1/twitter/follow_twitterMake the authenticated source user follow the given target user on X/Twitter. Mirrors the [official X v2 `POST /2/users/{id}/following` endpoint](https://docs.x.com/x-api/users/follow-user), routed through the AIsa gateway. **Authentication.** This is a write action that requires an OAuth session for the source user, attached to your AIsa API key. Link your X account once by calling `POST /apis/v1/twitter/auth_twitter` — AIsa then uses that session automatically for every write request sent with your key. **Scopes.** The underlying X session must hold `follows.write`, `tweet.read`, and `users.read`. <!-- aisa-pricing:start --> Published reference price: $0.015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Like Tweet
$MeteredPOST https://aisa.one/apis/v1/twitter/like_twitterLike a tweet on behalf of the authenticated source user. Mirrors the [official X v2 `POST /2/users/{id}/likes` endpoint](https://docs.x.com/x-api/users/like-post), routed through the AIsa gateway. **Authentication.** Requires an OAuth session for the source user, attached to your AIsa API key. Link the account once via `POST /apis/v1/twitter/auth_twitter`. **Scopes.** The underlying X session must hold `like.write`, `tweet.read`, and `users.read`. Liking a tweet already liked is a no-op and still returns `200` with `liked: true`. <!-- aisa-pricing:start --> Published reference price: $0.015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List List Followers
$MeteredGET https://aisa.one/apis/v1/twitter/list/followersList the accounts that subscribe to an X List, 20 per page, cursor-paginated. Use this to gauge how much attention a curated list attracts and who cares about that topic. Returns full user objects under `followers`. For the accounts included in the List (not its subscribers) use `get_twitter_list_members`. <!-- aisa-pricing:start --> Published reference price: $0.0015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get List Members
$MeteredGET https://aisa.one/apis/v1/twitter/list/membersList the accounts included in an X List, 20 per page, cursor-paginated. Use this to extract a ready-made, human-curated cohort — someone else has already done the filtering. Returns full user objects under `members`. To read what those accounts are posting as one feed, use `get_twitter_list_tweets_timeline`. For the List's subscribers use `get_twitter_list_followers`. <!-- aisa-pricing:start --> Published reference price: $0.0015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get List Tweet TimeLine
$MeteredGET https://aisa.one/apis/v1/twitter/list/tweets_timelineGet the tweet timeline of an X List by `listId`, up to 20 per page, cursor-paginated. Use this to monitor a hand-curated set of accounts as a single feed — Lists are the cheapest way to track a fixed cohort (competitors, analysts, a beat) without polling each account. Returns tweets with `has_next_page` and `next_cursor`. To see who is in the List use `get_twitter_list_members`. <!-- aisa-pricing:start --> Published reference price: $0.0015 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Post Twitter
$MeteredPOST https://aisa.one/apis/v1/twitter/post_twitterPublish a new tweet on behalf of the authenticated source user, or edit an existing tweet. Mirrors the [official X v2 `POST /2/tweets` endpoint](https://docs.x.com/x-api/posts/create-post), routed through the AIsa gateway. **Authentication.** Requires an OAuth session for the source user, attached to your AIsa API key. Link the account once via `POST /apis/v1/twitter/auth_twitter`. **Scopes.** The underlying X session must hold `tweet.read`, `tweet.write`, and `users.read`. **Mutually exclusive fields.** `media`, `poll`, `quote_tweet_id`, and `card_uri` cannot be combined in the same request. At most one of them may be set. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.015 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Trends By Woeid
$MeteredGET https://aisa.one/apis/v1/twitter/trendsGet the trending topics for a location, identified by its Yahoo WOEID (Where On Earth ID), with an optional `count` (default 30). Use this for a real-time read on what a specific market is talking about right now — useful for timing content or spotting emerging stories. Returns trend names and volumes under `trends`. Once you pick a trend, search its posts with `get_twitter_tweet_advanced_search`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00015 USD (not a fixed price). Declared unit rate: $0.00001 USD per provider_credit. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Advanced Search
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/advanced_searchSearch X posts by keyword or query with X's advanced search operators, sorted by Latest (default) or Top. This is the primary entry point for X content research when you do not yet have tweet IDs or handles. Supports operators in the query string such as `from:`, `to:`, `since:`, `until:`, `min_faves:`, and `-filter:replies`. Cursor-paginated; returns tweets with `has_next_page` and `next_cursor`. To search accounts rather than posts use `get_twitter_user_search`. To read one account's own posts use `get_twitter_user_tweet_timeline`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweet Quotations
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/quotesGet quote tweets of a given tweet — posts that embedded it with added commentary — cursor-paginated. Use this to see how a post is being reframed or argued about, which is often more revealing than plain replies. Returns full tweet objects with engagement counts. For direct replies use `get_twitter_tweet_replies_v2`; for accounts that amplified it without comment use `get_twitter_tweet_retweeters`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweet Replies
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/repliesGet the direct replies to a tweet, cursor-paginated. Use this to read the discussion under a post — sentiment, corrections, or follow-up questions. Returns full tweet objects with engagement counts. Prefer `get_twitter_tweet_replies_v2` when you want to control ordering (Relevance, Latest, or Likes); this v1 endpoint returns the default order only. To follow a conversation upward to its root instead of downward, use `get_twitter_tweet_thread_context`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01335 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweet Replies V2
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/replies/v2Get replies to a tweet with control over sort order — Relevance (default), Latest, or Likes — 20 per page, cursor-paginated. Use this instead of `get_twitter_tweet_replies` whenever ordering matters: Likes surfaces the community's top responses, Latest gives a live view of an unfolding thread. Returns full tweet objects with engagement counts. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.01095 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweet Retweeters
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/retweetersList the accounts that retweeted a given tweet, cursor-paginated. Use this to map who amplified a message and how influential they are. Returns user objects (handle, name, bio, follower count, verification) — not tweets. For retweets that added commentary use `get_twitter_tweet_quotes`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0036 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweet Thread Context
$MeteredGET https://aisa.one/apis/v1/twitter/tweet/thread_contextReconstruct the conversation around a tweet. Accepts either a reply or an original tweet and returns the surrounding thread, cursor-paginated. Use this when a tweet lacks context on its own and you need the parent chain to interpret it correctly. Returns tweets under `tweets` with `has_next_page` and `next_cursor`. For only the replies below a post use `get_twitter_tweet_replies_v2`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00555 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Tweets By IDs
$MeteredGET https://aisa.one/apis/v1/twitter/tweetsFetch the full content of specific tweets when you already know their numeric tweet IDs (accepts multiple IDs in one call). Use this to expand IDs surfaced by search, timelines, or replies into complete objects. Returns text, author, source client, language, creation time, and engagement counts (likes, retweets, replies, quotes, bookmarks, views). If you do not have IDs yet, start with `get_twitter_tweet_advanced_search`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0075 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Unfollow User
$MeteredPOST https://aisa.one/apis/v1/twitter/unfollow_twitterMake the authenticated source user unfollow the given target user on X/Twitter. Mirrors the [official X v2 `DELETE /2/users/{source_user_id}/following/{target_user_id}` endpoint](https://docs.x.com/x-api/users/unfollow-user), routed through the AIsa gateway. Uses POST (not DELETE) for consistency with the other AIsa Twitter write actions. **Authentication.** Requires an OAuth session for the source user, attached to your AIsa API key. Link the account once via `POST /apis/v1/twitter/auth_twitter`. **Scopes.** The underlying X session must hold `follows.write`, `tweet.read`, and `users.read`. Unfollowing a user you don't currently follow is a no-op and still returns `200` with `following: false`. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Unlike Tweet
$MeteredPOST https://aisa.one/apis/v1/twitter/unlike_twitterRemove the source user's like from a tweet. Mirrors the [official X v2 `DELETE /2/users/{id}/likes/{tweet_id}` endpoint](https://docs.x.com/x-api/users/unlike-post), routed through the AIsa gateway. Uses POST (not DELETE) for consistency with the other AIsa Twitter write actions. **Authentication.** Requires an OAuth session for the source user, attached to your AIsa API key. Link the account once via `POST /apis/v1/twitter/auth_twitter`. **Scopes.** The underlying X session must hold `like.write`, `tweet.read`, and `users.read`. Unliking a tweet the source user has not liked is a no-op and still returns `200` with `liked: false`. <!-- aisa-pricing:start --> Published reference price: $0.01 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Upload Media
$MeteredPOST https://aisa.one/apis/v1/twitter/upload_mediaUploads media files such as images or videos to be used in tweets or profiles. <!-- aisa-pricing:start --> Published reference price: $0.000001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Batch Get User Info By UserIds
$MeteredGET https://aisa.one/apis/v1/twitter/user/batch_info_by_ids<!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00018 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Check Follow Relationship
$MeteredGET https://aisa.one/apis/v1/twitter/user/check_follow_relationshipCheck whether one X user follows another, in both directions, by @handle. Use this for a single targeted lookup instead of paging through `get_twitter_user_followers` or `get_twitter_user_followings` — it answers 'does A follow B, and does B follow A' in one request. Returns the relationship flags under `data`. <!-- aisa-pricing:start --> Published reference price: $0.001 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List User Followers
$MeteredGET https://aisa.one/apis/v1/twitter/user/followersList the accounts that follow a given X user, identified by @handle, newest follower first. Returns up to 200 per page by default with `has_next_page` and `next_cursor`; each entry is a full user object (handle, name, bio, follower count, verification). Use this for audience analysis, mapping a competitor's follower base, or finding influential followers. For the reverse direction (who this user follows) use `get_twitter_user_followings`. For only the verified subset use `get_twitter_user_verified_followers` — note that one takes a numeric `user_id`, not a handle. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.00326 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
List User Followings
$MeteredGET https://aisa.one/apis/v1/twitter/user/followingsList the accounts a given X user follows, identified by @handle. Returns 200 entries per page with `has_next_page` and `next_cursor`. Use this to infer a user's interests, information sources, or professional network — who someone follows is usually a stronger signal of intent than who follows them. For the opposite direction use `get_twitter_user_followers`. To test a single specific pair without paging through thousands of records, use `get_twitter_user_check_follow_relationship`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0036 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get User Info
$MeteredGET https://aisa.one/apis/v1/twitter/user/infoLook up one X (Twitter) user's public profile by @handle (screen name). Use this when you need to know who an account is — identity, reach, or credibility — before deciding whether to trust or analyze their content. Returns display name, bio, follower/following counts, verification status, account creation date, location, and profile images. If you only have a numeric user ID, use `get_twitter_user_batch_info_by_ids` instead. If you need extended profile metadata such as country or username-change history, use `get_twitter_user_about`. If you want their posts rather than their profile, use `get_twitter_user_tweet_timeline`. <!-- aisa-pricing:start --> Published reference price: $0.00018 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get User Tweets
$MeteredGET https://aisa.one/apis/v1/twitter/user/last_tweetsGet a user's most recent tweets, accepting either `userName` (@handle) or `userId` — useful when you have not resolved the handle to an ID yet. Optionally include replies. Cursor-paginated. Returns tweets under `data` with `has_next_page` and `next_cursor`. Use `get_twitter_user_tweet_timeline` instead when you already have the numeric ID and want the full profile-order timeline with parent-tweet expansion. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get User Mentions
$MeteredGET https://aisa.one/apis/v1/twitter/user/mentionsGet tweets that mention a given @handle, 20 per page. This is the only user-scoped X endpoint that supports a time window: pass `sinceTime` and/or `untilTime` as Unix timestamps in seconds to bound the range. Use this for monitoring — brand mentions, inbound replies, reputation tracking, or 'what happened to this account in the last 24 hours'. Returns tweets with `has_next_page` and `next_cursor`. For the account's own posts rather than mentions of it, use `get_twitter_user_tweet_timeline`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.003 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Users
$MeteredGET https://aisa.one/apis/v1/twitter/user/searchSearch X user accounts by keyword and get back matching profiles. Use this when you know roughly who you are looking for — a company name, a topic, a partial handle — but not the exact @handle. Cursor-paginated; returns full user objects under `users`. This searches accounts, not posts; to search tweet content use `get_twitter_tweet_advanced_search`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0036 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get User TimeLine
$MeteredGET https://aisa.one/apis/v1/twitter/user/tweet_timelineRetrieve a user's own tweets by numeric `userId`, newest first, matching the order shown on their profile in the X app. Up to 20 tweets per page; pass the returned cursor for more. Optionally include replies and the parent tweet of each reply. Use this to read what an account publishes over time. Time-range filtering is NOT supported here — if you need tweets within a specific time window, use `get_twitter_user_mentions` (which accepts `sinceTime`/`untilTime`) or `get_twitter_tweet_advanced_search` with date operators in the query. If you only have a @handle, `get_twitter_user_last_tweets` accepts either handle or ID. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.0057 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get Verified Followers
$MeteredGET https://aisa.one/apis/v1/twitter/user/verifiedFollowersList only the verified accounts following a given X user, in reverse chronological order. Use this to gauge the quality rather than the size of an audience — verified followers are a better credibility signal than raw follower count. Cursor-paginated. Takes a numeric `user_id`, not a @handle; resolve the handle first with `get_twitter_user_info`. For the complete follower list use `get_twitter_user_followers`. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.006 USD (not a fixed price). Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Get User About Info
$MeteredGET https://aisa.one/apis/v1/twitter/user_aboutGet the extended 'About this account' panel for an X user by @handle. Use this for provenance and trust checks — it surfaces signals the standard profile does not, such as the account's country, verification details, and username-change history. Returns a single profile object under `data`. For the standard profile (bio, follower counts, avatar), use `get_twitter_user_info` instead. <!-- aisa-pricing:start --> Published reference price: $0.00018 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Creator AI Search
$MeteredPOST https://aisa.one/apis/v1/waveinflu/ai-searchFinds creators from a natural-language brief instead of a seed account. `platform` and `query` are required; add `limit` (1–100, default 40) and the same optional `filters` as Similar Creators. Describe the creators you want in plain language (for example, "beauty creators in the US") and the response returns matching creators in the same rich shape as Similar Creators — full profile metrics plus AI-inferred `gender`, `ageRange`, `ethnicity`, `faceVisibility`, `accountPositioning`, `aiDescription`, and a relevance `score`. Billing is per delivered creator (`data.count`). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.124425 USD (not a fixed price). Declared unit rate: $0.004977 USD per similar_creator_point. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Email Lookup
$MeteredPOST https://aisa.one/apis/v1/waveinflu/email-lookupLooks up the contact email for one Instagram, TikTok, or YouTube creator from a profile URL. Pass `profile_url`; the response returns the parsed `platform`, the normalized `profile_url`, and an `email` object `{status, value}`. A `not_found` status (with `value` null) is a normal result, not an error, and is still billed as one valid lookup. Handles one creator per call. To assemble a creator list first, use Similar Creators or AI Search — each match already includes an `email` for most creators; use this endpoint for the ones that come back null. <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.001991 USD (not a fixed price). Declared unit rate: $0.001991 USD per email_lookup_point. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Similar Creators
$MeteredPOST https://aisa.one/apis/v1/waveinflu/similarFinds creators similar to a seed account on Instagram, TikTok, or YouTube. `platform` and `target_account` are required; add `limit` (1–100, default 40) and optional `filters` (regions, languages, follower and play-count ranges, gender, ethnicity, creator type, face visibility, workspace dedup). Each match returns a rich profile: `biography`, `email`, `followerCount`, `averagePlayCount` / `medianPlayCount`, `averageEngagementRate` / `medianEngagementRate`, plus AI-inferred `gender`, `ageRange`, `ethnicity`, `faceVisibility`, `accountPositioning` tags, and an `aiDescription`, with a relevance `score`. Results are sorted by `score` descending. Billing is per delivered creator (`data.count`). <!-- aisa-pricing:start --> Usage-based billing; Default request estimate: $0.124425 USD (not a fixed price). Declared unit rate: $0.004977 USD per similar_creator_point. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Search Videos
$MeteredGET https://aisa.one/apis/v1/youtube/searchSearch YouTube and get back matching videos, channels, and playlists. Set `engine=youtube` and pass the query in `q`; both are required. Optionally narrow by country (`gl`) and interface language (`hl`), or pass a YouTube filter token in `sp` for pagination and advanced filters such as upload date, duration, or result type. Use this to find video content on a topic, track a channel's recent uploads, or gauge how much video coverage a subject has. Note: this is served through the AIsa mapped path `/apis/v1/youtube/search`; the upstream provider's canonical path is not mounted directly. <!-- aisa-pricing:start --> Published reference price: $0.0029 USD per successful request. Account-specific pricing and final settlement may differ. <!-- aisa-pricing:end -->
Create chat completion
$MeteredPOST https://aisa.one/chat/completionsGenerate chat responses with support for images, streaming, function calling, and logprobs.
Account Balance
$MeteredGET https://aisa.one/credits/balanceReturn the current account credit balance. Accepts either an API key or an OAuth access token. No parameters.
Create embeddings
$MeteredPOST https://aisa.one/embeddingsGenerate embedding vectors for one or more input strings using jina-embeddings-v3 or jina-embeddings-v5-text-small (both 1024-dim output). OpenAI-compatible request and response. Served via the AIsa relay path /v1/embeddings. Billing is token-based.
Generate images (OpenAI-compatible)
$MeteredPOST https://aisa.one/images/generationsGenerate images with the OpenAI-compatible images-generations endpoint. **Size constraint (Seedream routes only).** Seedream's upstream requires a minimum of **3,686,400 pixels** per image. Requests below that return `400 InvalidParameter: image size must be at least 3686400 pixels`. Wan and `gpt-image-2` routes accept smaller sizes — `1024x1024` is verified working for `wan2.7-image`.
Create a message
$MeteredPOST https://aisa.one/messagesSend a structured conversation to a Claude model and receive a response. Compatible with the Anthropic Messages API.
Generate content using a Gemini-compatible AIsa model
$MeteredPOST https://aisa.one/models/{model}:generateContentRerank documents
$MeteredPOST https://aisa.one/rerankRerank a list of documents against a query using jina-reranker-v3, returning documents ordered by relevance score. Served via the AIsa relay path /v1/rerank. Billing is token-based.
Get Space Detail
$MeteredGET https://aisa.one/twitter/spaces/detailGet details of an X Space (live audio room) by its space ID — title, state, host, participants, and scheduling. Use this to check whether a Space is scheduled, live, or ended, and who is hosting, before deciding to reference or attend it. Returns the object under `data`.
Account Usage
$MeteredGET https://aisa.one/usageReturn request and spend usage over a time window, split into daily buckets. Accepts either an API key or an OAuth access token. The scope reflects the credential used (e.g. a single key vs the whole account).
Checks
reachable
valid
2026-11-19T09:47:24.947Z
No settlement evidence found in chain signals.
Gateway routing
Score ≥70/100 — Cleared attestation pass. Route via Gateway before pay.
Gateway traffic
Leaderboard →0
Routes to you
3
Category · 7d
0
Unique agents
—
Your win rate
3 agent routes in other this week — none to you yet. Cleared ($49/mo) = attested + preferred when agents route. Get Cleared →
Claim to manage this card — or go straight to Cleared attestation ($49/mo).
Claim listingNext · optional
Prefer this listing when agents route?
3 routes in other this week — none to you yet. Preferred routing puts you first when agents choose.
Cleared adds +12 Gateway preference, full manifest checks, and a watchlist — so agents land on you first. $49/mo