/vivo/apps/search

POST /api/vivo/apps/search

Price: 1 credit

Search the vivo App Store catalog by keyword

How to use it

Keyword search over vivo's mainland-China Android storefront. The catalogue is Simplified Chinese, and Latin brand names match as well as Chinese ones. The store stops serving a keyword after 50 hits however large the real catalogue is, so this is a lookup tool, not a way to enumerate a category — and there is no sort, price or category parameter to steer it with. A package name is matched as ordinary text, not resolved as an identifier, so pass it to /vivo/apps instead when you want that exact app. Search rows are the store's list card: pass id to /vivo/apps for the description and screenshots.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search term, matched against app titles and descriptions (examples: "微信", "浏览器", "whatsapp"; minLength: 1)
• count integer required — Max number of apps to return (min: 1; max: 50)

Response

• @type string (default: "VivoApp")
• id integer required
• name string required
• package_name string required
• short_name string nullable
• developer string nullable
• version string nullable
• version_code string nullable
• size_kb integer nullable
• download_count integer nullable
• rating number nullable
• rating_count integer nullable
• tagline string nullable
• description string nullable
• changelog string nullable
• icon string nullable
• screenshots array (default: [])
• video_url string nullable
• video_cover string nullable
• is_game boolean nullable
• is_online_game boolean nullable
• is_official boolean nullable
• has_ads boolean nullable
• category string nullable
• category_id integer nullable
• subcategories array (default: [])
• subcategory_ids array (default: [])
• badges array (default: [])
• md5 string nullable
• released_at integer nullable
• updated_at integer nullable
• privacy_policy_url string nullable
• icp_license string nullable
• icp_operator string nullable
• security_scans array (default: [])
• download_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.