{ "openapi": "3.1.0", "info": { "title": "Jinghai Data Public API", "version": "2026-09-21", "description": "Reference definitions for 216 public product endpoints, including request parameters and product-detail links. Project credentials, billing, and service levels follow the applicable integration plan." }, "servers": [ { "url": "https://jhzyapi.com", "description": "Public HTTPS origin" } ], "tags": [ { "name": "Shopee", "description": "20 public endpoints" }, { "name": "TikTok / Douyin", "description": "27 public endpoints" }, { "name": "Amazon", "description": "10 public endpoints" }, { "name": "Cdiscount", "description": "8 public endpoints" }, { "name": "Joybuy (JD International)", "description": "8 public endpoints" }, { "name": "GrabFood", "description": "3 public endpoints" }, { "name": "Lazada", "description": "19 public endpoints" }, { "name": "Temu", "description": "19 public endpoints" }, { "name": "eBay", "description": "7 public endpoints" }, { "name": "AliExpress", "description": "4 public endpoints" }, { "name": "YouTube", "description": "26 public endpoints" }, { "name": "X / Twitter", "description": "21 public endpoints" }, { "name": "Reddit", "description": "18 public endpoints" }, { "name": "Google", "description": "3 public endpoints" }, { "name": "Coupang", "description": "3 public endpoints" }, { "name": "Rakuten 日本乐天", "description": "4 public endpoints" }, { "name": "Naver 韩国门户", "description": "16 public endpoints" } ], "paths": { "/api/shopee/v1/product/detail": { "get": { "tags": [ "Shopee" ], "summary": "Product detail V1", "description": "Public fields: found, status, name, image, price, units sold, stock status, SKU, model ID", "operationId": "api_shopee_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-detail" } }, "/api/shopee/v2/product/detail": { "get": { "tags": [ "Shopee" ], "summary": "Product detail V2", "description": "Public fields: name, image, price, units sold, stock status, SKU, model ID", "operationId": "api_shopee_v2_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v2-product-detail" } }, "/api/shopee/v1/search/products": { "get": { "tags": [ "Shopee" ], "summary": "Keyword product search", "description": "Public fields: product name, shop/item ID, display model ID, display price, image", "operationId": "api_shopee_v1_search_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-search-products" } }, "/api/shopee/v1/shop/products": { "get": { "tags": [ "Shopee" ], "summary": "Shopee shop product card data channel", "description": "Public fields: shop home product cards, display model ID, display price", "operationId": "api_shopee_v1_shop_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "description": "Required · shop account", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-products" } }, "/api/shopee/v1/product/sku-matrix": { "get": { "tags": [ "Shopee" ], "summary": "Product variant matrix", "description": "Public fields: variant dimensions, option combinations, review_count", "operationId": "api_shopee_v1_product_sku_matrix", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-sku-matrix" } }, "/api/shopee/v1/shop/reviews-rich": { "get": { "tags": [ "Shopee" ], "summary": "Shop reviews, rich", "description": "Public fields: review, media, tags, replies, likes, translated fields", "operationId": "api_shopee_v1_shop_reviews_rich", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-reviews-rich" } }, "/api/shopee/v1/product/snapshot": { "get": { "tags": [ "Shopee" ], "summary": "Product display snapshot", "description": "Public fields: product name, image, variants, price, review tags", "operationId": "api_shopee_v1_product_snapshot", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-snapshot" } }, "/api/shopee/v1/search/prefills": { "get": { "tags": [ "Shopee" ], "summary": "Search prefills", "description": "Public fields: prefilled terms, recommended content, target links", "operationId": "api_shopee_v1_search_prefills", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-search-prefills" } }, "/api/shopee/v1/search/filters": { "get": { "tags": [ "Shopee" ], "summary": "Search filter config", "description": "Public fields: filter groups, filter options, scenario config", "operationId": "api_shopee_v1_search_filters", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-search-filters" } }, "/api/shopee/v1/shop/categories": { "get": { "tags": [ "Shopee" ], "summary": "Shop categories", "description": "Public fields: in-shop categories, category levels, product count per category", "operationId": "api_shopee_v1_shop_categories", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-categories" } }, "/api/shopee/v1/product/review-models": { "get": { "tags": [ "Shopee" ], "summary": "Product review variant distribution", "description": "Public fields: product name, main image, variant dimensions, options, reviews per combination", "operationId": "api_shopee_v1_product_review_models", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-review-models" } }, "/api/shopee/v1/product/installments": { "get": { "tags": [ "Shopee" ], "summary": "Instalments and amounts", "description": "Public fields: instalment plans, total_amount", "operationId": "api_shopee_v1_product_installments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } }, { "name": "detailLevel", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-installments" } }, "/api/shopee/v1/product/review-tags": { "get": { "tags": [ "Shopee" ], "summary": "Product review tags", "description": "Public fields: review tags, tag counts, insight counts", "operationId": "api_shopee_v1_product_review_tags", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-review-tags" } }, "/api/shopee/v1/product/reviews": { "get": { "tags": [ "Shopee" ], "summary": "Reviews for a given product", "description": "Public fields: review text, media, author, rating, SKU snapshot", "operationId": "api_shopee_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } }, { "name": "ratingType", "in": "query", "required": false, "description": "Optional · 0—5", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-reviews" } }, "/api/shopee/v1/product/sku-models": { "get": { "tags": [ "Shopee" ], "summary": "SKU model tracking", "description": "Public fields: model ID, model name, snapshot ID, observation count", "operationId": "api_shopee_v1_product_sku_models", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "itemId", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } }, { "name": "ratingType", "in": "query", "required": false, "description": "Optional · 0—5", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-product-sku-models" } }, "/api/shopee/v1/search/facets": { "get": { "tags": [ "Shopee" ], "summary": "Search category facets", "description": "Public fields: category, catid, result count, parent and child categories", "operationId": "api_shopee_v1_search_facets", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-search-facets" } }, "/api/shopee/v1/shop/base": { "get": { "tags": [ "Shopee" ], "summary": "Shop basics", "description": "Public fields: shopid, shop name, followers, rating, account profile", "operationId": "api_shopee_v1_shop_base", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "description": "Required · shop account name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-base" } }, "/api/shopee/v1/shop/detail": { "get": { "tags": [ "Shopee" ], "summary": "Shop detail", "description": "Public fields: shop info, account profile, rating, storefront setup and status", "operationId": "api_shopee_v1_shop_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "username", "in": "query", "required": true, "description": "Required · shop account name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-detail" } }, "/api/shopee/v1/shop/reviews": { "get": { "tags": [ "Shopee" ], "summary": "Shop reviews", "description": "Public fields: review text, author, star rating, media, product_items", "operationId": "api_shopee_v1_shop_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } }, { "name": "ratingType", "in": "query", "required": false, "description": "Optional · 0—5", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-reviews" } }, "/api/shopee/v1/shop/seo": { "get": { "tags": [ "Shopee" ], "summary": "Shop profile and rating summary", "description": "Public fields: shop title, description, rating summary, keywords", "operationId": "api_shopee_v1_shop_seo", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · defaults to TW; supports TW / ID / TH", "schema": { "type": "string" } }, { "name": "shopId", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/shopee/#endpoint-shopee-v1-shop-seo" } }, "/api/tiktok/v1/shop/product/detail": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "TikTok Shop product detail", "description": "Public fields: product info, store info, price, SKU, category, review summary", "operationId": "api_tiktok_v1_shop_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · TikTok Shop product ID", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "required": false, "description": "Optional · product URL alias, default product", "schema": { "type": "string" } }, { "name": "include_split_data", "in": "query", "required": false, "description": "Optional · include deferred blocks, default false", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-shop-product-detail" } }, "/api/tiktok/v1/shop/search": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "TikTok Shop product search", "description": "Public fields: product list, store list, filters, pagination cursor, has-next flag", "operationId": "api_tiktok_v1_shop_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · product search keyword", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · the JSON cursor from the previous page, optional", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-shop-search" } }, "/api/tiktok/v1/shop/product/reviews": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "TikTok Shop product reviews", "description": "Public fields: review list, rating stats, photos and videos, total reviews, has-next flag", "operationId": "api_tiktok_v1_shop_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · TikTok Shop product ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } }, { "name": "sort_rule", "in": "query", "required": false, "description": "Optional · sort: 1 recommended, 2 newest", "schema": { "type": "integer" } }, { "name": "filter_type", "in": "query", "required": false, "description": "Optional · filter: 1 star rating, 2 with photo or video, 3 verified purchase", "schema": { "type": "integer" } }, { "name": "filter_value", "in": "query", "required": false, "description": "Optional · 1–5 stars, 6 for all", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-shop-product-reviews" } }, "/api/tiktok/v1/video/detail": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Single video lookup", "description": "Public fields: video ID, title, author, playback URL, cover image, engagement metrics", "operationId": "api_tiktok_v1_video_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "url", "in": "query", "required": true, "description": "Required · full video URL", "schema": { "type": "string" } }, { "name": "hd", "in": "query", "required": false, "description": "Optional · high definition, default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-video-detail" } }, "/api/tiktok/v1/douyin/feed": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Douyin recommendation feed", "description": "Public fields: recommended post list, engagement metrics, playback info", "operationId": "api_tiktok_v1_douyin_feed", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-douyin-feed" } }, "/api/tiktok/v1/ads/trends/hashtags": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Trending hashtags", "description": "Public fields: hashtag, rank, publish count, views, top creators", "operationId": "api_tiktok_v1_ads_trends_hashtags", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "country_code", "in": "query", "required": false, "description": "Optional · country code, default US", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Optional · period 7 / 30 / 120, default 7", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-trends-hashtags" } }, "/api/tiktok/v1/douyin/hot": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Douyin trend board", "description": "Public fields: trend term, volume, rank", "operationId": "api_tiktok_v1_douyin_hot", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-douyin-hot" } }, "/api/tiktok/v1/ads/top/list": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads list", "description": "Public fields: material ID, title, industry, objective, CTR, cover", "operationId": "api_tiktok_v1_ads_top_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "country_code", "in": "query", "required": false, "description": "Optional · country code, default US", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Optional · period 7 / 30 / 120, default 30", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "required": false, "description": "Optional · sort order, default for_you", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-list" } }, "/api/tiktok/v1/ads/trends/videos": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Trending videos", "description": "Public fields: video ID, title, cover, author, engagement metrics", "operationId": "api_tiktok_v1_ads_trends_videos", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "country_code", "in": "query", "required": false, "description": "Optional · country code, default US", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Optional · period 7 / 30 / 120, default 30", "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } }, { "name": "order_by_metric", "in": "query", "required": false, "description": "Optional · sort metric 1-5, default 1", "schema": { "type": "integer" } }, { "name": "organic_only", "in": "query", "required": false, "description": "Optional · organic only, default false", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-trends-videos" } }, "/api/tiktok/v1/ads/library/detail": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Ads library detail", "description": "Public fields: ad title, advertiser, landing page, targeting, creative video", "operationId": "api_tiktok_v1_ads_library_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "item_id", "in": "query", "required": true, "description": "Required · ads library item ID", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Optional · language, default en-US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-library-detail" } }, "/api/tiktok/v1/ads/library/regions": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Ads library regions", "description": "Public fields: region code, region name, coverage note", "operationId": "api_tiktok_v1_ads_library_regions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "lang", "in": "query", "required": false, "description": "Optional · language, default en-US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-library-regions" } }, "/api/tiktok/v1/ads/library/search": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Ads library search", "description": "Public fields: ad ID, advertiser, title, shown dates, estimated reach, cover", "operationId": "api_tiktok_v1_ads_library_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "region", "in": "query", "required": true, "description": "Required · two-letter country code, e.g. DE", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · advertiser or ad keyword", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "description": "Optional · start date YYYY-MM-DD, last 30 days by default", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "description": "Optional · end date YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } }, { "name": "lang", "in": "query", "required": false, "description": "Optional · language, default en-US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-library-search" } }, "/api/tiktok/v1/ads/top/detail": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads detail", "description": "Public fields: title, brand, industry, CTR, landing page, video", "operationId": "api_tiktok_v1_ads_top_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "material_id", "in": "query", "required": true, "description": "Required · top-ads material ID from the list endpoint", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-detail" } }, "/api/tiktok/v1/ads/top/filters": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads filters", "description": "Public fields: language, country, industry, objective, pattern, period", "operationId": "api_tiktok_v1_ads_top_filters", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-filters" } }, "/api/tiktok/v1/ads/top/keyframes": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads keyframes", "description": "Public fields: duration, highlight, per-second points", "operationId": "api_tiktok_v1_ads_top_keyframes", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "material_id", "in": "query", "required": true, "description": "Required · top-ads material ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-keyframes" } }, "/api/tiktok/v1/ads/top/locations": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads locations", "description": "Public fields: country code, country name, default market", "operationId": "api_tiktok_v1_ads_top_locations", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-locations" } }, "/api/tiktok/v1/ads/top/percentile": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads CTR percentile", "description": "Public fields: material ID, CTR percentile", "operationId": "api_tiktok_v1_ads_top_percentile", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "material_id", "in": "query", "required": true, "description": "Required · top-ads material ID", "schema": { "type": "string" } }, { "name": "period_type", "in": "query", "required": false, "description": "Optional · window 7 / 30 / 180, default 180", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-percentile" } }, "/api/tiktok/v1/ads/top/recommend": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Similar top ads", "description": "Public fields: similar ads, material ID, title, cover", "operationId": "api_tiktok_v1_ads_top_recommend", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "material_id", "in": "query", "required": true, "description": "Required · top-ads material ID", "schema": { "type": "string" } }, { "name": "industry", "in": "query", "required": true, "description": "Required · industry ID from the list industry field", "schema": { "type": "string" } }, { "name": "country_code", "in": "query", "required": false, "description": "Optional · country code, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-recommend" } }, "/api/tiktok/v1/ads/top/retention": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads retention curve", "description": "Public fields: duration, retention curve", "operationId": "api_tiktok_v1_ads_top_retention", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "material_id", "in": "query", "required": true, "description": "Required · top-ads material ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-retention" } }, "/api/tiktok/v1/ads/top/suggestions": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Top ads suggestions", "description": "Public fields: Suggestion list", "operationId": "api_tiktok_v1_ads_top_suggestions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-top-suggestions" } }, "/api/tiktok/v1/ads/trends/countries": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Trend country dictionary", "description": "Public fields: country code, country name", "operationId": "api_tiktok_v1_ads_trends_countries", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-ads-trends-countries" } }, "/api/tiktok/v1/challenge/detail": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Hashtag detail", "description": "Public fields: hashtag ID, name, view count, video count", "operationId": "api_tiktok_v1_challenge_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "challenge_name", "in": "query", "required": true, "description": "Required · hashtag without #, e.g. fyp", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-challenge-detail" } }, "/api/tiktok/v1/shop/store/products": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "TikTok Shop store products", "description": "Public fields: store info, product list, pagination cursor, has-next flag", "operationId": "api_tiktok_v1_shop_store_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "seller_id", "in": "query", "required": true, "description": "Required · TikTok Shop seller ID", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "required": false, "description": "Optional · store URL alias, default store", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · the JSON cursor from the previous page, optional", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-shop-store-products" } }, "/api/tiktok/v1/user/card": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "User card", "description": "Public fields: author name, title summary, thumbnail, page link", "operationId": "api_tiktok_v1_user_card", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "unique_id", "in": "query", "required": true, "description": "Required · username, without @", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-user-card" } }, "/api/tiktok/v1/user/info": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "User profile", "description": "Public fields: display name, followers, likes, post count, avatar, bio", "operationId": "api_tiktok_v1_user_info", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "unique_id", "in": "query", "required": true, "description": "Required · username without @, e.g. tiktok", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-user-info" } }, "/api/tiktok/v1/user/videos": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "User post list", "description": "Public fields: post ID, title, plays / likes / comments, cover image, duration", "operationId": "api_tiktok_v1_user_videos", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "unique_id", "in": "query", "required": true, "description": "Required · username, without @", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor, default 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-user-videos" } }, "/api/tiktok/v1/video/search": { "get": { "tags": [ "TikTok / Douyin" ], "summary": "Video keyword search", "description": "Public fields: post list, author, engagement metrics", "operationId": "api_tiktok_v1_video_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keywords", "in": "query", "required": true, "description": "Required · search term, e.g. cat", "schema": { "type": "string" } }, { "name": "region", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor, default 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/tiktok/#endpoint-tiktok-v1-video-search" } }, "/api/amazon/v1/product/reviews/count": { "get": { "tags": [ "Amazon" ], "summary": "Filtered review count", "description": "Public fields: matching_review_count (exact count), is_exact (precision), count_lower_bound (lower bound when not exact), count_text, filters, applied_filters_text, checked_at; Returns an exact count or an explicit lower bound. Results may be cached for up to 120 seconds.", "operationId": "api_amazon_v1_product_reviews_count", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character product ASIN; use the desired variant ASIN for a specific variant", "schema": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$" }, "example": "B0113UZJE2" }, { "name": "site", "in": "query", "required": false, "description": "Optional · Default US; US / UK / DE / FR / IT / ES / JP / CA / MX / SE / NL / AE / TR / PL / SA / AU / BE / IN; GB is an alias of UK and returns site=UK; the ASIN must belong to the selected marketplace", "schema": { "type": "string", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "JP", "CA", "MX", "SE", "NL", "AE", "TR", "PL", "SA", "AU", "BE", "IN", "GB" ], "default": "US" } }, { "name": "filter_by_star", "in": "query", "required": false, "description": "Optional · Default all_stars; one_star / two_star / three_star / four_star / five_star / positive / critical", "schema": { "type": "string", "enum": [ "all_stars", "one_star", "two_star", "three_star", "four_star", "five_star", "positive", "critical" ], "default": "all_stars" } }, { "name": "format_type", "in": "query", "required": false, "description": "Optional · Default all_formats (all variants); current_format (only the supplied ASIN variant)", "schema": { "type": "string", "enum": [ "all_formats", "current_format" ], "default": "all_formats" } }, { "name": "reviewer_type", "in": "query", "required": false, "description": "Optional · Default all_reviews; avp_only_reviews includes verified purchases only", "schema": { "type": "string", "enum": [ "all_reviews", "avp_only_reviews" ], "default": "all_reviews" } }, { "name": "media_type", "in": "query", "required": false, "description": "Optional · Default all_contents; media_reviews_only includes images or videos only", "schema": { "type": "string", "enum": [ "all_contents", "media_reviews_only" ], "default": "all_contents" } }, { "name": "keyword", "in": "query", "required": false, "description": "Optional · Default empty; review keyword, up to 200 characters", "schema": { "type": "string", "default": "", "maxLength": 200 } }, { "name": "sort_by", "in": "query", "required": false, "description": "Optional · Default recent; helpful sorts by helpfulness without changing the filter scope", "schema": { "type": "string", "enum": [ "recent", "helpful" ], "default": "recent" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "success", "error" ] }, "data": { "type": "object", "properties": { "asin": { "type": "string" }, "site": { "type": "string" }, "filters": { "type": "object" }, "matching_review_count": { "type": [ "integer", "null" ], "minimum": 0 }, "count_lower_bound": { "type": [ "integer", "null" ], "minimum": 0 }, "is_exact": { "type": "boolean" }, "count_text": { "type": "string" }, "applied_filters_text": { "type": "string" }, "checked_at": { "type": "string", "format": "date-time" } } } } } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-product-reviews-count" } }, "/api/amazon/v1/product/detail": { "get": { "tags": [ "Amazon" ], "summary": "Product Detail", "description": "Public fields: title, brand, rating, feature bullets, images, price, parent_asin, selected_variations, SKU variant matrix", "operationId": "api_amazon_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character ASIN", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-product-detail" } }, "/api/amazon/v1/offer/listing": { "get": { "tags": [ "Amazon" ], "summary": "Competing offers", "description": "Public fields: offer entries, seller, price, delivery info", "operationId": "api_amazon_v1_offer_listing", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character ASIN", "schema": { "type": "string" } }, { "name": "condition", "in": "query", "required": false, "description": "Optional · default all", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-offer-listing" } }, "/api/amazon/v1/search/keyword": { "get": { "tags": [ "Amazon" ], "summary": "Keyword search", "description": "Public fields: ASIN, title, price, rating, review count, image", "operationId": "api_amazon_v1_search_keyword", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-search-keyword" } }, "/api/amazon/v1/offer/all": { "get": { "tags": [ "Amazon" ], "summary": "All offers", "description": "Public fields: product title and all offer data", "operationId": "api_amazon_v1_offer_all", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character ASIN", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-offer-all" } }, "/api/amazon/v1/seller/storefront": { "get": { "tags": [ "Amazon" ], "summary": "Amazon seller storefront data channel", "description": "Public fields: seller name, address block, storefront basics", "operationId": "api_amazon_v1_seller_storefront", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "seller_id", "in": "query", "required": true, "description": "Required · seller ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-seller-storefront" } }, "/api/amazon/v1/bestsellers": { "get": { "tags": [ "Amazon" ], "summary": "Best sellers", "description": "Public fields: ranked ASIN, rank, title", "operationId": "api_amazon_v1_bestsellers", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "Optional · category slug", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-bestsellers" } }, "/api/amazon/v1/product/reviews": { "get": { "tags": [ "Amazon" ], "summary": "Product Reviews", "description": "Public fields: review text, star rating, author, time, variant-expanded pool", "operationId": "api_amazon_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character ASIN", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Optional · recent/helpful", "schema": { "type": "string" } }, { "name": "filter_by_star", "in": "query", "required": false, "description": "Optional · empty for all; one_star..five_star / positive / critical", "schema": { "type": "string" } }, { "name": "expand_variants", "in": "query", "required": false, "description": "Optional · true/false, default true", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-product-reviews" } }, "/api/amazon/v1/search/suggestions": { "get": { "tags": [ "Amazon" ], "summary": "Search suggestions", "description": "Public fields: Suggestion list", "operationId": "api_amazon_v1_search_suggestions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "prefix", "in": "query", "required": false, "description": "Optional · input prefix", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v1-search-suggestions" } }, "/api/amazon/v2/product/detail": { "get": { "tags": [ "Amazon" ], "summary": "Product detail v2", "description": "Public fields: title, brand, rating, selling points, images, price, variants", "operationId": "api_amazon_v2_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / UK / DE", "schema": { "type": "string" } }, { "name": "asin", "in": "query", "required": true, "description": "Required · 10-character ASIN", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/amazon/#endpoint-amazon-v2-product-detail" } }, "/api/cdiscount/v1/product/detail": { "get": { "tags": [ "Cdiscount" ], "summary": "Product Detail", "description": "Public fields: Title, brand, EAN, category, offer, images, technical specifications, energy information, and repairability index", "operationId": "api_cdiscount_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "offer_id", "in": "query", "required": true, "description": "Required · offer ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-product-detail" } }, "/api/cdiscount/v1/product/offers": { "get": { "tags": [ "Cdiscount" ], "summary": "Product offer list", "description": "Public fields: Offer ID, seller, EUR price, reference price, shipping origin, rating, and product status", "operationId": "api_cdiscount_v1_product_offers", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "department_id", "in": "query", "required": false, "description": "Optional · department ID", "schema": { "type": "string" } }, { "name": "category_node_id", "in": "query", "required": false, "description": "Optional · category node", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default price", "schema": { "type": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "description": "Optional · default asc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-product-offers" } }, "/api/cdiscount/v1/search/keyword": { "get": { "tags": [ "Cdiscount" ], "summary": "Keyword search", "description": "Public fields: Product ID, offer ID, title, image, EUR price, rating, and seller", "operationId": "api_cdiscount_v1_search_keyword", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search keyword", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "department_id", "in": "query", "required": false, "description": "Optional · default 10", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default relevance", "schema": { "type": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "description": "Optional · default desc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-search-keyword" } }, "/api/cdiscount/v1/shop/products": { "get": { "tags": [ "Cdiscount" ], "summary": "Shop products", "description": "Public fields: Product ID, offer ID, title, image, price, rating, and sales", "operationId": "api_cdiscount_v1_shop_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "seller_id", "in": "query", "required": true, "description": "Required · seller ID", "schema": { "type": "string" } }, { "name": "seller_name", "in": "query", "required": false, "description": "Optional · seller name", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "description": "Optional · in-store keyword", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default sales_7_days", "schema": { "type": "string" } }, { "name": "sort_direction", "in": "query", "required": false, "description": "Optional · default desc", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-shop-products" } }, "/api/cdiscount/v1/shop/detail": { "get": { "tags": [ "Cdiscount" ], "summary": "Shop detail", "description": "Public fields: Seller name, cumulative sales, rating, review count, rating distribution, and business information", "operationId": "api_cdiscount_v1_shop_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "seller_id", "in": "query", "required": true, "description": "Required · seller ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-shop-detail" } }, "/api/cdiscount/v1/shop/reviews": { "get": { "tags": [ "Cdiscount" ], "summary": "Seller reviews", "description": "Public fields: Average rating, review count, rating distribution, author, content, stars, and time", "operationId": "api_cdiscount_v1_shop_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "seller_id", "in": "query", "required": true, "description": "Required · seller ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "required": false, "description": "Optional · sort mode", "schema": { "type": "integer" } }, { "name": "stars", "in": "query", "required": false, "description": "Optional · 1 to 5 stars", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-shop-reviews" } }, "/api/cdiscount/v1/product/reviews": { "get": { "tags": [ "Cdiscount" ], "summary": "Product reviews", "description": "Public fields: Product rating, review count, rating distribution, author, title, content, and time", "operationId": "api_cdiscount_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "required": false, "description": "Optional · default 2", "schema": { "type": "integer" } }, { "name": "stars", "in": "query", "required": false, "description": "Optional · 1 to 5 stars", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-product-reviews" } }, "/api/cdiscount/v1/product/questions": { "get": { "tags": [ "Cdiscount" ], "summary": "Product Q&A", "description": "Public fields: Question count, answered count, question text, author, time, and answer list", "operationId": "api_cdiscount_v1_product_questions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "description": "Optional · question keyword", "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "description": "Optional · default 6", "schema": { "type": "integer" } }, { "name": "hydrate_answers", "in": "query", "required": false, "description": "Optional · default true", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/cdiscount/#endpoint-cdiscount-v1-product-questions" } }, "/api/jdintl/v1/product/search": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Product Search", "description": "Public fields: product ID, title, image, price, original price, currency, stock", "operationId": "api_jdintl_v1_product_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search keyword", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de, supports de/fr/uk", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-product-search" } }, "/api/jdintl/v2/product/search": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Product Search V2", "description": "Public fields: product ID, title, image, price, original price, brand, discount text, sold text, delivery label, stock", "operationId": "api_jdintl_v2_product_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search keyword", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de, supports de/fr/uk", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v2-product-search" } }, "/api/jdintl/v1/product/detail": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Product Detail", "description": "Public fields: title, brand, prices, 3-level category, main gallery, SKU variants (image/stock), spend-reward promotions, detail gallery, shop & seller, review summary", "operationId": "api_jdintl_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-product-detail" } }, "/api/jdintl/v1/review/list": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Product Reviews", "description": "Public fields: total reviews, positive rate, star rating, review text, user, time, likes and images", "operationId": "api_jdintl_v1_review_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-review-list" } }, "/api/jdintl/v1/category/list": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Category tree", "description": "Public fields: 3-level category tree (id, name, level)", "operationId": "api_jdintl_v1_category_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-category-list" } }, "/api/jdintl/v1/shop/search": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Shop Search", "description": "Public fields: shop ID, name, logo and type", "operationId": "api_jdintl_v1_shop_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "required · brand or keyword", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-shop-search" } }, "/api/jdintl/v1/shop/detail": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Shop detail", "description": "Public fields: shop ID, name, logo, status and seller type", "operationId": "api_jdintl_v1_shop_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "shop_id", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-shop-detail" } }, "/api/jdintl/v1/shop/products": { "get": { "tags": [ "Joybuy (JD International)" ], "summary": "Shop products", "description": "Public fields: All live products of the shop (product ID/title/image/price/original price/stock), 20 per page", "operationId": "api_jdintl_v1_shop_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "shop_id", "in": "query", "required": true, "description": "Required · shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · default de", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/jdintl/#endpoint-jdintl-v1-shop-products" } }, "/api/grab/v1/restaurant/search": { "get": { "tags": [ "GrabFood" ], "summary": "Restaurant search", "description": "Public fields: Merchant ID, name, chain, cuisine, rating, estimated delivery time and delivery fee", "operationId": "api_grab_v1_restaurant_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": false, "description": "optional · keyword; defaults to location-based results", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · defaults to MY; supports MY/SG/TH/PH/VN/ID/KH", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "optional · latitude; defaults to the country's center", "schema": { "type": "number" } }, { "name": "lng", "in": "query", "required": false, "description": "optional · longitude; defaults to the country's center", "schema": { "type": "number" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/grab/#endpoint-grab-v1-restaurant-search" } }, "/api/grab/v1/restaurant/menu": { "get": { "tags": [ "GrabFood" ], "summary": "Restaurant menu", "description": "Public fields: Store profile, categories, dishes, prices, discounts, images and modifier groups", "operationId": "api_grab_v1_restaurant_menu", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "merchant_id", "in": "query", "required": true, "description": "required · merchant ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "optional · defaults to MY", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "Optional · latitude", "schema": { "type": "number" } }, { "name": "lng", "in": "query", "required": false, "description": "Optional · longitude", "schema": { "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/grab/#endpoint-grab-v1-restaurant-menu" } }, "/api/grab/v1/restaurant/recommend": { "get": { "tags": [ "GrabFood" ], "summary": "Restaurant recommendations", "description": "Public fields: Recommended merchant groups and cards", "operationId": "api_grab_v1_restaurant_recommend", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "optional · defaults to MY", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "Optional · latitude", "schema": { "type": "number" } }, { "name": "lng", "in": "query", "required": false, "description": "Optional · longitude", "schema": { "type": "number" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/grab/#endpoint-grab-v1-restaurant-recommend" } }, "/api/lazada/v1/product/detail_live": { "get": { "tags": [ "Lazada" ], "summary": "Product detail (live, full)", "description": "Public fields: product modules, SKU selling price, original price, discount and response status", "operationId": "api_lazada_v1_product_detail_live", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "sku_id", "in": "query", "required": false, "description": "Optional · uses the exact SKU path when supplied", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-detail-live" } }, "/api/lazada/v1/category/listing": { "get": { "tags": [ "Lazada" ], "summary": "Category product list", "description": "Public fields: category product cards, price, image, shop", "operationId": "api_lazada_v1_category_listing", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "Optional · category slug, e.g. mobiles", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-category-listing" } }, "/api/lazada/v1/search/catalog": { "get": { "tags": [ "Lazada" ], "summary": "Keyword search (catalog)", "description": "Public fields: product ID, title, price, image, shop, rating, units sold", "operationId": "api_lazada_v1_search_catalog", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-search-catalog" } }, "/api/lazada/v1/search/keyword": { "get": { "tags": [ "Lazada" ], "summary": "Keyword search", "description": "Public fields: product ID, title, price, image, shop, rating, units sold", "operationId": "api_lazada_v1_search_keyword", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-search-keyword" } }, "/api/lazada/v1/product/detail": { "get": { "tags": [ "Lazada" ], "summary": "Product Detail", "description": "Public fields: title, brand, price, SKU, images, seller, category", "operationId": "api_lazada_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "url", "in": "query", "required": true, "description": "Required · full product URL", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-detail" } }, "/api/lazada/v1/product/reviews": { "get": { "tags": [ "Lazada" ], "summary": "Product Reviews", "description": "Public fields: review text, rating, time, buyer", "operationId": "api_lazada_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "filter", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-reviews" } }, "/api/lazada/v1/review/list": { "get": { "tags": [ "Lazada" ], "summary": "Product reviews (enhanced)", "description": "Public fields: review list, sentiment tags, pagination", "operationId": "api_lazada_v1_review_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "filter", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-review-list" } }, "/api/lazada/v1/product/delivery": { "get": { "tags": [ "Lazada" ], "summary": "Delivery options", "description": "Public fields: region, postcode, delivery method per SKU, lead time and shipping fee", "operationId": "api_lazada_v1_product_delivery", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "seller_id", "in": "query", "required": false, "description": "Optional · resolved automatically when omitted", "schema": { "type": "string" } }, { "name": "sku_id", "in": "query", "required": false, "description": "Optional", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-delivery" } }, "/api/lazada/v1/category/tree": { "get": { "tags": [ "Lazada" ], "summary": "Full category tree", "description": "Public fields: top-level categories, subcategories, multi-level navigation, category images and links", "operationId": "api_lazada_v1_category_tree", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-category-tree" } }, "/api/lazada/v1/brand/listing": { "get": { "tags": [ "Lazada" ], "summary": "Brand product list", "description": "Public fields: product cards, filters, sorting, pagination, brand and page metadata", "operationId": "api_lazada_v1_brand_listing", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "brand", "in": "query", "required": true, "description": "Required · brand or tag slug, e.g. apple", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-brand-listing" } }, "/api/lazada/v1/context/site": { "get": { "tags": [ "Lazada" ], "summary": "Site context", "description": "Public fields: Site, region, and localization context", "operationId": "api_lazada_v1_context_site", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-context-site" } }, "/api/lazada/v1/product/aux_detail": { "get": { "tags": [ "Lazada" ], "summary": "Auxiliary product detail", "description": "Public fields: delivery, warranty, instalments, vouchers and flash sales for every SKU", "operationId": "api_lazada_v1_product_aux_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "seller_id", "in": "query", "required": false, "description": "Optional · resolved automatically when omitted", "schema": { "type": "string" } }, { "name": "sku_id", "in": "query", "required": false, "description": "Optional", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-aux-detail" } }, "/api/lazada/v1/product/recommendations": { "get": { "tags": [ "Lazada" ], "summary": "Related products", "description": "Public fields: same-shop and similar-item recommendations, price, rating, units sold, seller, recommendation module", "operationId": "api_lazada_v1_product_recommendations", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-recommendations" } }, "/api/lazada/v1/product/sku_list_prices": { "get": { "tags": [ "Lazada" ], "summary": "Per-SKU list price", "description": "Public fields: SKU ID, list price, currency, variant path, completeness", "operationId": "api_lazada_v1_product_sku_list_prices", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } }, { "name": "max_skus", "in": "query", "required": false, "description": "Optional · default 50, max 50", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-sku-list-prices" } }, "/api/lazada/v1/product/sku_prices": { "get": { "tags": [ "Lazada" ], "summary": "Full-variant prices", "description": "Public fields: SKU ID, selling price, original price, discount, variant path", "operationId": "api_lazada_v1_product_sku_prices", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-sku-prices" } }, "/api/lazada/v1/product/vouchers": { "get": { "tags": [ "Lazada" ], "summary": "Product vouchers", "description": "Public fields: voucher list, spend threshold, value, validity, claim info", "operationId": "api_lazada_v1_product_vouchers", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "required · product ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-product-vouchers" } }, "/api/lazada/v1/recommend": { "get": { "tags": [ "Lazada" ], "summary": "Related items", "description": "Public fields: recommended products and suggestions", "operationId": "api_lazada_v1_recommend", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "description": "Optional · recommendation seed term", "schema": { "type": "string" } }, { "name": "app_id", "in": "query", "required": false, "description": "Optional · default 9802", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-recommend" } }, "/api/lazada/v1/search/enhanced": { "get": { "tags": [ "Lazada" ], "summary": "Keyword search (enhanced)", "description": "Public fields: Live products, shops, prices, sales, and pagination", "operationId": "api_lazada_v1_search_enhanced", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-search-enhanced" } }, "/api/lazada/v1/store/listing": { "get": { "tags": [ "Lazada" ], "summary": "Shop product list", "description": "Public fields: shop products, shop info, filters, sorting, pagination", "operationId": "api_lazada_v1_store_listing", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · SG / MY / TH / VN / PH / ID", "schema": { "type": "string" } }, { "name": "store_path", "in": "query", "required": true, "description": "Required · shop slug, e.g. ugreen", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "query", "in": "query", "required": false, "description": "Optional · default All-Products", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/lazada/#endpoint-lazada-v1-store-listing" } }, "/api/temu/v1/homepage/hub": { "get": { "tags": [ "Temu" ], "summary": "Home modules", "description": "Public fields: home hub modules, trust modules and more", "operationId": "api_temu_v1_homepage_hub", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-homepage-hub" } }, "/api/temu/v1/category/top-sales": { "get": { "tags": [ "Temu" ], "summary": "Category bestsellers", "description": "Public fields: bestselling items, price, sales, rating, category", "operationId": "api_temu_v1_category_top_sales", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "opt_id", "in": "query", "required": false, "description": "Optional · category ID, default 7320", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-category-top-sales" } }, "/api/temu/v1/homepage/goods": { "get": { "tags": [ "Temu" ], "summary": "Home product feed", "description": "Public fields: product ID, title, price, sales hint, main image, link", "operationId": "api_temu_v1_homepage_goods", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-homepage-goods" } }, "/api/temu/v1/mall/recommend": { "get": { "tags": [ "Temu" ], "summary": "Shop recommended products", "description": "Public fields: recommended shop products, price, units sold, rating, SKU variants", "operationId": "api_temu_v1_mall_recommend", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "mall_id", "in": "query", "required": true, "description": "Required · Temu shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-mall-recommend" } }, "/api/temu/v1/homepage/activity": { "get": { "tags": [ "Temu" ], "summary": "Home campaigns", "description": "Public fields: campaign banners, flash sale and top-bar modules", "operationId": "api_temu_v1_homepage_activity", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-homepage-activity" } }, "/api/temu/v1/setting": { "get": { "tags": [ "Temu" ], "summary": "Regional settings", "description": "Public fields: region, language, currency and other site settings", "operationId": "api_temu_v1_setting", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-setting" } }, "/api/temu/v1/product/detail": { "get": { "tags": [ "Temu" ], "summary": "Full product detail", "description": "Public fields: title, price, SKU, stock, variants, promotions, delivery, shop, review summary", "operationId": "api_temu_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "goods_id", "in": "query", "required": true, "description": "Required · Temu product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "required": false, "description": "Optional · product slug, default item", "schema": { "type": "string" } }, { "name": "product_url", "in": "query", "required": false, "description": "Optional · full Temu product URL", "schema": { "type": "string" } }, { "name": "include_skus", "in": "query", "required": false, "description": "Optional · return SKUs, default true", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-product-detail" } }, "/api/temu/v1/categories": { "get": { "tags": [ "Temu" ], "summary": "Product category tree", "description": "Public fields: category ID at every level, name, image, subcategories", "operationId": "api_temu_v1_categories", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-categories" } }, "/api/temu/v1/home/footer": { "get": { "tags": [ "Temu" ], "summary": "Footer categories", "description": "Public fields: footer copyright and category links", "operationId": "api_temu_v1_home_footer", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-home-footer" } }, "/api/temu/v1/mall/goods": { "get": { "tags": [ "Temu" ], "summary": "Shop product list", "description": "Public fields: shop products, price, units sold, rating, category, SKU variants", "operationId": "api_temu_v1_mall_goods", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "mall_id", "in": "query", "required": true, "description": "Required · Temu shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "page_number", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-mall-goods" } }, "/api/temu/v1/mall/info": { "get": { "tags": [ "Temu" ], "summary": "Shop entity info", "description": "Public fields: shop name, legal entity, address, country or region", "operationId": "api_temu_v1_mall_info", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "mall_id", "in": "query", "required": true, "description": "Required · Temu shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-mall-info" } }, "/api/temu/v1/mall/reviews": { "get": { "tags": [ "Temu" ], "summary": "Shop review list", "description": "Public fields: review text, rating, images, product, SKU, time", "operationId": "api_temu_v1_mall_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "mall_id", "in": "query", "required": true, "description": "Required · Temu shop ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } }, { "name": "sort_type", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-mall-reviews" } }, "/api/temu/v1/pay_icons": { "get": { "tags": [ "Temu" ], "summary": "Payment icons", "description": "Public fields: payment and security icon assets", "operationId": "api_temu_v1_pay_icons", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-pay-icons" } }, "/api/temu/v1/product/reviews": { "get": { "tags": [ "Temu" ], "summary": "Product review list", "description": "Public fields: review text, rating, variant, images, video, time, reviewer display name", "operationId": "api_temu_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "goods_id", "in": "query", "required": true, "description": "Required · Temu product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-product-reviews" } }, "/api/temu/v1/product/reviews/info": { "get": { "tags": [ "Temu" ], "summary": "Product review summary", "description": "Public fields: rating, total reviews, star distribution, tags, core product info", "operationId": "api_temu_v1_product_reviews_info", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "goods_id", "in": "query", "required": true, "description": "Required · Temu product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-product-reviews-info" } }, "/api/temu/v1/product/similar": { "get": { "tags": [ "Temu" ], "summary": "Similar product recommendations", "description": "Public fields: similar products, price, units sold, rating, shop, SKU variants", "operationId": "api_temu_v1_product_similar", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "goods_id", "in": "query", "required": true, "description": "Required · Temu product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-product-similar" } }, "/api/temu/v1/product/snapshot": { "get": { "tags": [ "Temu" ], "summary": "Core product snapshot", "description": "Public fields: title, price, original price, discount, images, rating, review stats", "operationId": "api_temu_v1_product_snapshot", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "goods_id", "in": "query", "required": true, "description": "Required · Temu product ID", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-product-snapshot" } }, "/api/temu/v1/search": { "get": { "tags": [ "Temu" ], "summary": "Keyword product search", "description": "Public fields: product, price, units sold, rating, review count, shop, image", "operationId": "api_temu_v1_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search keyword", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · defaults to 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-search" } }, "/api/temu/v1/server_time": { "get": { "tags": [ "Temu" ], "summary": "Server time", "description": "Public fields: server timestamp", "operationId": "api_temu_v1_server_time", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · US / EU / DE / UK / CA / AU and more", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/temu/#endpoint-temu-v1-server-time" } }, "/api/ebay/v1/item/detail": { "get": { "tags": [ "eBay" ], "summary": "Product Detail", "description": "Public fields: title, price, images, description, SKU / variants", "operationId": "api_ebay_v1_item_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · Site, such as US / UK / DE / FR", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": true, "description": "Required · eBay item ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-item-detail" } }, "/api/ebay/v1/search/keyword": { "get": { "tags": [ "eBay" ], "summary": "Keyword search", "description": "Public fields: item_id, title, price, item link", "operationId": "api_ebay_v1_search_keyword", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · Site, such as US / UK / DE / AU / CA / FR", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search term, e.g. iphone 15", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-search-keyword" } }, "/api/ebay/v1/seller/feedback": { "get": { "tags": [ "eBay" ], "summary": "Seller feedback page", "description": "Public fields: feedback page title, positive-rate candidates, score candidates", "operationId": "api_ebay_v1_seller_feedback", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · site, default US", "schema": { "type": "string" } }, { "name": "seller", "in": "query", "required": true, "description": "Required · seller username", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-seller-feedback" } }, "/api/ebay/v1/seller/items": { "get": { "tags": [ "eBay" ], "summary": "Seller active listings", "description": "Public fields: item_id, title, price", "operationId": "api_ebay_v1_seller_items", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · site, default US", "schema": { "type": "string" } }, { "name": "seller", "in": "query", "required": true, "description": "Required · seller username", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · page number, default 1", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-seller-items" } }, "/api/ebay/v1/seller/profile": { "get": { "tags": [ "eBay" ], "summary": "Seller profile", "description": "Public fields: seller name, page title, profile summary", "operationId": "api_ebay_v1_seller_profile", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · site, default US", "schema": { "type": "string" } }, { "name": "seller", "in": "query", "required": true, "description": "Required · seller username", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-seller-profile" } }, "/api/ebay/v1/product/family": { "get": { "tags": [ "eBay" ], "summary": "Product family page", "description": "Public fields: product title, linked listings and items", "operationId": "api_ebay_v1_product_family", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · site, default US", "schema": { "type": "string" } }, { "name": "product_id", "in": "query", "required": true, "description": "Required · product family ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-product-family" } }, "/api/ebay/v1/search/suggest": { "get": { "tags": [ "eBay" ], "summary": "Search suggestions", "description": "Public fields: Suggestion list", "operationId": "api_ebay_v1_search_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · site, default US", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": true, "description": "Required · prefix term, e.g. iphone", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/ebay/#endpoint-ebay-v1-search-suggest" } }, "/api/aliexpress/v1/product/reviews": { "get": { "tags": [ "AliExpress" ], "summary": "Product Reviews", "description": "Public fields: review text, score, country, variant, photos, follow-up reviews, impression tags, star stats", "operationId": "api_aliexpress_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · product ID, e.g. 1005007429636284", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default GLO · site, GLO global / US United States", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · page number, starting at 1", "schema": { "type": "string" } }, { "name": "filter_by", "in": "query", "required": false, "description": "Optional · default all · filter, all / image / additional / local", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default complex_default · sort, default complex_default", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/aliexpress/#endpoint-aliexpress-v1-product-reviews" } }, "/api/aliexpress/v1/home/deals": { "get": { "tags": [ "AliExpress" ], "summary": "Homepage deals", "description": "Public fields: product ID, current price, discount, sold text, main image", "operationId": "api_aliexpress_v1_home_deals", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US · site, GLO global / US United States", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/aliexpress/#endpoint-aliexpress-v1-home-deals" } }, "/api/aliexpress/v1/product/overview": { "get": { "tags": [ "AliExpress" ], "summary": "Product overview", "description": "Public fields: product title, description, image captions", "operationId": "api_aliexpress_v1_product_overview", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · product ID, e.g. 1005007429636284", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US · site, GLO global / US United States", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/aliexpress/#endpoint-aliexpress-v1-product-overview" } }, "/api/aliexpress/v1/product/related": { "get": { "tags": [ "AliExpress" ], "summary": "Related items", "description": "Public fields: related product ID, title, trending keywords", "operationId": "api_aliexpress_v1_product_related", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · product ID, e.g. 1005007429636284", "schema": { "type": "string" } }, { "name": "site", "in": "query", "required": false, "description": "Optional · default US · site, GLO global / US United States", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/aliexpress/#endpoint-aliexpress-v1-product-related" } }, "/api/youtube/v1/channel/updates": { "get": { "tags": [ "YouTube" ], "summary": "Channel updates", "description": "Public fields: recent uploads, title, publish time, views", "operationId": "api_youtube_v1_channel_updates", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "channel_id", "in": "query", "required": true, "description": "Required · channel ID (UCxxxx) — or playlist_id", "schema": { "type": "string" } }, { "name": "playlist_id", "in": "query", "required": false, "description": "Optional · playlist ID (or channel_id)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-channel-updates" } }, "/api/youtube/v1/comments": { "get": { "tags": [ "YouTube" ], "summary": "Comment list", "description": "Public fields: comment text, author, likes, reply count, pagination cursor", "operationId": "api_youtube_v1_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · top or newest, default top", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor returned by the previous page", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-comments" } }, "/api/youtube/v1/video/embed": { "get": { "tags": [ "YouTube" ], "summary": "Video display card", "description": "Public fields: title, author, thumbnail", "operationId": "api_youtube_v1_video_embed", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "url", "in": "query", "required": true, "description": "Required · full watch or youtu.be URL", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-video-embed" } }, "/api/youtube/v1/captions": { "get": { "tags": [ "YouTube" ], "summary": "Caption track list", "description": "Public fields: language, track name, auto-generated flag", "operationId": "api_youtube_v1_captions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-captions" } }, "/api/youtube/v1/channel": { "get": { "tags": [ "YouTube" ], "summary": "Channel tabs", "description": "Public fields: channel profile, video list, pagination cursor", "operationId": "api_youtube_v1_channel", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "channel", "in": "query", "required": true, "description": "Required · UCxxxx, @handle or channel URL", "schema": { "type": "string" } }, { "name": "tab", "in": "query", "required": false, "description": "Optional · videos / shorts / streams / playlists / community / about / home", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-channel" } }, "/api/youtube/v1/channel/search": { "get": { "tags": [ "YouTube" ], "summary": "In-channel search", "description": "Public fields: matching videos within the channel", "operationId": "api_youtube_v1_channel_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "channel", "in": "query", "required": true, "description": "Required · UCxxxx, @handle or channel URL", "schema": { "type": "string" } }, { "name": "query", "in": "query", "required": true, "description": "Required · keyword within the channel", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-channel-search" } }, "/api/youtube/v1/comments/replies": { "get": { "tags": [ "YouTube" ], "summary": "Comment replies", "description": "Public fields: reply text, author, likes", "operationId": "api_youtube_v1_comments_replies", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · reply cursor from a comment entry", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-comments-replies" } }, "/api/youtube/v1/hashtag": { "get": { "tags": [ "YouTube" ], "summary": "Hashtag", "description": "Public fields: videos under a hashtag", "operationId": "api_youtube_v1_hashtag", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "tag", "in": "query", "required": true, "description": "Required · hashtag name, e.g. music or #music", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-hashtag" } }, "/api/youtube/v1/home/feed": { "get": { "tags": [ "YouTube" ], "summary": "Discovery feed", "description": "Public fields: recommended video cards, pagination cursor", "operationId": "api_youtube_v1_home_feed", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-home-feed" } }, "/api/youtube/v1/live/chat": { "get": { "tags": [ "YouTube" ], "summary": "Live chat", "description": "Public fields: chat messages, Super Chat, continuation cursor", "operationId": "api_youtube_v1_live_chat", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · live or replay video ID", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · continuation cursor", "schema": { "type": "string" } }, { "name": "replay", "in": "query", "required": false, "description": "Optional · true to pull replay chat, default false", "schema": { "type": "boolean" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-live-chat" } }, "/api/youtube/v1/music/browse": { "get": { "tags": [ "YouTube" ], "summary": "Music charts", "description": "Public fields: chart, home and new-release entries", "operationId": "api_youtube_v1_music_browse", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "feed", "in": "query", "required": false, "description": "Optional · charts / home / new_releases, default charts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-music-browse" } }, "/api/youtube/v1/music/search": { "get": { "tags": [ "YouTube" ], "summary": "Music search", "description": "Public fields: song, album and artist cards", "operationId": "api_youtube_v1_music_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "query", "in": "query", "required": true, "description": "Required · music search term", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-music-search" } }, "/api/youtube/v1/music/suggest": { "get": { "tags": [ "YouTube" ], "summary": "Music suggestions", "description": "Public fields: Suggestion list", "operationId": "api_youtube_v1_music_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "query", "in": "query", "required": true, "description": "Required · prefix term", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-music-suggest" } }, "/api/youtube/v1/playlist": { "get": { "tags": [ "YouTube" ], "summary": "Playlists", "description": "Public fields: playlist title, entries, pagination cursor", "operationId": "api_youtube_v1_playlist", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "playlist_id", "in": "query", "required": true, "description": "Required · playlist ID", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-playlist" } }, "/api/youtube/v1/resolve-url": { "get": { "tags": [ "YouTube" ], "summary": "URL and handle resolver", "description": "Public fields: browse_id、canonical_url、video_id", "operationId": "api_youtube_v1_resolve_url", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "url", "in": "query", "required": true, "description": "Required · channel, hashtag or short URL, or an @handle link", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-resolve-url" } }, "/api/youtube/v1/search": { "get": { "tags": [ "YouTube" ], "summary": "Keyword search", "description": "Public fields: video, channel and playlist cards, estimated result count, pagination cursor", "operationId": "api_youtube_v1_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "query", "in": "query", "required": true, "description": "Required · search term, e.g. lo-fi hip hop", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "required": false, "description": "Optional · video / channel / playlist / live / short, etc.", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-search" } }, "/api/youtube/v1/search/suggest": { "get": { "tags": [ "YouTube" ], "summary": "Search suggestions", "description": "Public fields: Suggestion list", "operationId": "api_youtube_v1_search_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "query", "in": "query", "required": true, "description": "Required · prefix term, e.g. lo-fi", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-search-suggest" } }, "/api/youtube/v1/shorts/item": { "get": { "tags": [ "YouTube" ], "summary": "Single Short", "description": "Public fields: Shorts metadata and engagement panel", "operationId": "api_youtube_v1_shorts_item", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · Shorts video ID", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-shorts-item" } }, "/api/youtube/v1/shorts/sequence": { "get": { "tags": [ "YouTube" ], "summary": "Shorts recommendation sequence", "description": "Public fields: Shorts recommendation sequence entries", "operationId": "api_youtube_v1_shorts_sequence", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-shorts-sequence" } }, "/api/youtube/v1/thumbnails": { "get": { "tags": [ "YouTube" ], "summary": "Thumbnail URLs", "description": "Public fields: maxres / sd / hq / mq / default / webp direct URLs", "operationId": "api_youtube_v1_thumbnails", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-thumbnails" } }, "/api/youtube/v1/transcript": { "get": { "tags": [ "YouTube" ], "summary": "Full transcript", "description": "Public fields: full text, timed segments, language", "operationId": "api_youtube_v1_transcript", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": true, "description": "Required · caption language, e.g. en / zh-Hans", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-transcript" } }, "/api/youtube/v1/video": { "get": { "tags": [ "YouTube" ], "summary": "Video metadata", "description": "Public fields: title, channel, duration, views, publish time, cover image, category", "operationId": "api_youtube_v1_video", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID, e.g. dQw4w9WgXcQ", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-video" } }, "/api/youtube/v1/video/engagement": { "get": { "tags": [ "YouTube" ], "summary": "Engagement metrics", "description": "Public fields: views, likes, comment count, channel subscriber count", "operationId": "api_youtube_v1_video_engagement", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-video-engagement" } }, "/api/youtube/v1/video/full": { "get": { "tags": [ "YouTube" ], "summary": "Full video info", "description": "Public fields: metadata, likes, subscriber count, description, related videos", "operationId": "api_youtube_v1_video_full", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-video-full" } }, "/api/youtube/v1/video/updated-metadata": { "get": { "tags": [ "YouTube" ], "summary": "Metric polling", "description": "Public fields: views, likes, live flag", "operationId": "api_youtube_v1_video_updated_metadata", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-video-updated-metadata" } }, "/api/youtube/v1/watch/next": { "get": { "tags": [ "YouTube" ], "summary": "Related items", "description": "Public fields: related videos, engagement summary, comment cursor", "operationId": "api_youtube_v1_watch_next", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "video_id", "in": "query", "required": true, "description": "Required · 11-character video ID", "schema": { "type": "string" } }, { "name": "playlist_id", "in": "query", "required": false, "description": "Optional · playlist ID", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default US", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/youtube/#endpoint-youtube-v1-watch-next" } }, "/api/twitter/v1/profile/timeline": { "get": { "tags": [ "X / Twitter" ], "summary": "User posts V2", "description": "Public fields: V2 post feed, pagination", "operationId": "api_twitter_v1_profile_timeline", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "handle", "in": "query", "required": true, "description": "Required · username", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "description": "Optional · time filter", "schema": { "type": "string" } }, { "name": "with_replies", "in": "query", "required": false, "description": "Optional · include replies", "schema": { "type": "string" } }, { "name": "groupthreads", "in": "query", "required": false, "description": "Optional · group threads", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Optional · language", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-profile-timeline" } }, "/api/twitter/v1/tweet/card": { "get": { "tags": [ "X / Twitter" ], "summary": "Single post snapshot", "description": "Public fields: text, author, engagement stats", "operationId": "api_twitter_v1_tweet_card", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "id", "in": "query", "required": true, "description": "Required · post ID", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Optional · default en", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-tweet-card" } }, "/api/twitter/v1/friendships/show": { "get": { "tags": [ "X / Twitter" ], "summary": "Account relationship", "description": "Public fields: follows, followed by", "operationId": "api_twitter_v1_friendships_show", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "source_screen_name", "in": "query", "required": true, "description": "Required · source username (or source_id)", "schema": { "type": "string" } }, { "name": "target_screen_name", "in": "query", "required": true, "description": "Required · target username (or target_id)", "schema": { "type": "string" } }, { "name": "source_id", "in": "query", "required": false, "description": "Optional · source user ID (optional)", "schema": { "type": "string" } }, { "name": "target_id", "in": "query", "required": false, "description": "Optional · target user ID (optional)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-friendships-show" } }, "/api/twitter/v1/geo/search": { "get": { "tags": [ "X / Twitter" ], "summary": "Place search", "description": "Public fields: place candidates, place identifiers", "operationId": "api_twitter_v1_geo_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "query", "in": "query", "required": true, "description": "Required · place keyword", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "Optional · latitude", "schema": { "type": "number" } }, { "name": "long", "in": "query", "required": false, "description": "Optional · longitude", "schema": { "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-geo-search" } }, "/api/twitter/v1/lists/memberships": { "get": { "tags": [ "X / Twitter" ], "summary": "Lists containing a user", "description": "Public fields: lists the account belongs to", "operationId": "api_twitter_v1_lists_memberships", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "user_id", "in": "query", "required": false, "description": "Optional · user ID (or screen_name)", "schema": { "type": "string" } }, { "name": "screen_name", "in": "query", "required": true, "description": "Required · username (optional)", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-lists-memberships" } }, "/api/twitter/v1/lists/show": { "get": { "tags": [ "X / Twitter" ], "summary": "List detail", "description": "Public fields: list name, description, member count", "operationId": "api_twitter_v1_lists_show", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "list_id", "in": "query", "required": true, "description": "Required · list ID (preferred)", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "required": false, "description": "Optional · list slug (optional)", "schema": { "type": "string" } }, { "name": "owner_screen_name", "in": "query", "required": false, "description": "Optional · list owner (use with slug)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-lists-show" } }, "/api/twitter/v1/profile/basic": { "get": { "tags": [ "X / Twitter" ], "summary": "User profile (enriched)", "description": "Public fields: enriched profile summary fields", "operationId": "api_twitter_v1_profile_basic", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "user", "in": "query", "required": true, "description": "Required · username", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-profile-basic" } }, "/api/twitter/v1/profile/detail": { "get": { "tags": [ "X / Twitter" ], "summary": "Profile V2", "description": "Public fields: V2 profile structure", "operationId": "api_twitter_v1_profile_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "handle", "in": "query", "required": true, "description": "Required · username", "schema": { "type": "string" } }, { "name": "about_account", "in": "query", "required": false, "description": "Optional · expansion toggle", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-profile-detail" } }, "/api/twitter/v1/profile/timeline_lite": { "get": { "tags": [ "X / Twitter" ], "summary": "User content timeline", "description": "Public fields: timeline content set", "operationId": "api_twitter_v1_profile_timeline_lite", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "screen_name", "in": "query", "required": true, "description": "Required · username, without @", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-profile-timeline-lite" } }, "/api/twitter/v1/search/posts": { "get": { "tags": [ "X / Twitter" ], "summary": "Historical keyword search", "description": "Public fields: Post ID, author, text, publication time, engagement and next-page cursor", "operationId": "api_twitter_v1_search_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · search keyword", "schema": { "type": "string" } }, { "name": "start_time", "in": "query", "required": false, "description": "Optional · Start time, default 60 days before the end; dates use UTC", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "required": false, "description": "Optional · Exclusive end time, default now", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · Next-page cursor; reuse the returned time bounds", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-search-posts" } }, "/api/twitter/v1/trends/available": { "get": { "tags": [ "X / Twitter" ], "summary": "Trend region directory", "description": "Public fields: list of regions with trend data", "operationId": "api_twitter_v1_trends_available", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-trends-available" } }, "/api/twitter/v1/trends/closest": { "get": { "tags": [ "X / Twitter" ], "summary": "Nearby trend regions", "description": "Public fields: nearby regions with trend data", "operationId": "api_twitter_v1_trends_closest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "lat", "in": "query", "required": true, "description": "Required · latitude", "schema": { "type": "number" } }, { "name": "long", "in": "query", "required": true, "description": "Required · longitude", "schema": { "type": "number" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-trends-closest" } }, "/api/twitter/v1/trends/list": { "get": { "tags": [ "X / Twitter" ], "summary": "Trend board V2", "description": "Public fields: trend term list and volume data", "operationId": "api_twitter_v1_trends_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "type", "in": "query", "required": false, "description": "Optional · default trending", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-trends-list" } }, "/api/twitter/v1/trends/place": { "get": { "tags": [ "X / Twitter" ], "summary": "Regional trends", "description": "Public fields: trend terms, volume metrics", "operationId": "api_twitter_v1_trends_place", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "woeid", "in": "query", "required": false, "description": "Optional · region ID, 1 = worldwide", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-trends-place" } }, "/api/twitter/v1/tweet/basic": { "get": { "tags": [ "X / Twitter" ], "summary": "Single post (enriched)", "description": "Public fields: enriched post detail", "operationId": "api_twitter_v1_tweet_basic", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "user", "in": "query", "required": true, "description": "Required · username", "schema": { "type": "string" } }, { "name": "id", "in": "query", "required": true, "description": "Required · post ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-tweet-basic" } }, "/api/twitter/v1/tweet/by_rest_id": { "get": { "tags": [ "X / Twitter" ], "summary": "Single post detail", "description": "Public fields: text, author, published time, engagement metrics", "operationId": "api_twitter_v1_tweet_by_rest_id", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "tweet_id", "in": "query", "required": true, "description": "Required · post ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-tweet-by-rest-id" } }, "/api/twitter/v1/tweet/detail": { "get": { "tags": [ "X / Twitter" ], "summary": "Single post V2", "description": "Public fields: V2 post detail structure", "operationId": "api_twitter_v1_tweet_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "id", "in": "query", "required": true, "description": "Required · post ID", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Optional · language", "schema": { "type": "string" } }, { "name": "about_account", "in": "query", "required": false, "description": "Optional · expansion toggle", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-tweet-detail" } }, "/api/twitter/v1/tweet/embed": { "get": { "tags": [ "X / Twitter" ], "summary": "Post display card", "description": "Public fields: card HTML, author, summary", "operationId": "api_twitter_v1_tweet_embed", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "url", "in": "query", "required": true, "description": "Required · full post URL", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-tweet-embed" } }, "/api/twitter/v1/user/by_screen_name": { "get": { "tags": [ "X / Twitter" ], "summary": "User profile", "description": "Public fields: user ID, display name, bio, follower and following counts, verified status, avatar", "operationId": "api_twitter_v1_user_by_screen_name", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "screen_name", "in": "query", "required": true, "description": "Required · username, without @", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-user-by-screen-name" } }, "/api/twitter/v1/user/highlights": { "get": { "tags": [ "X / Twitter" ], "summary": "User highlights", "description": "Public fields: highlighted post list", "operationId": "api_twitter_v1_user_highlights", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "user_id", "in": "query", "required": true, "description": "Required · user ID", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-user-highlights" } }, "/api/twitter/v1/user/tweets": { "get": { "tags": [ "X / Twitter" ], "summary": "User posts", "description": "Public fields: post list, engagement data, pagination cursor", "operationId": "api_twitter_v1_user_tweets", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "user_id", "in": "query", "required": true, "description": "Required · user ID", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/twitter/#endpoint-twitter-v1-user-tweets" } }, "/api/reddit/v1/community/listing": { "get": { "tags": [ "Reddit" ], "summary": "Community content feed", "description": "Public fields: post title, body summary, author, score, comment count, posted time, images and media URLs", "operationId": "api_reddit_v1_community_listing", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": true, "description": "Required · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default hot · sort, e.g. hot / new / top", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "t", "in": "query", "required": false, "description": "Optional · time window (with top sort), e.g. day / week / month / year", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-listing" } }, "/api/reddit/v1/community/search": { "get": { "tags": [ "Reddit" ], "summary": "In-community search", "description": "Public fields: matching post list, score, comment count, author, community, images", "operationId": "api_reddit_v1_community_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": true, "description": "Required · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": true, "description": "Required · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default new · sort, e.g. relevance / new / top / comments", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "t", "in": "query", "required": false, "description": "Optional · time window (with top sort), e.g. day / week / month / year", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-search" } }, "/api/reddit/v1/link/mentions": { "get": { "tags": [ "Reddit" ], "summary": "Link mention monitoring", "description": "Public fields: posts mentioning the site, community, score, comment count, time", "operationId": "api_reddit_v1_link_mentions", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "website", "in": "query", "required": true, "description": "Required · site domain, e.g. anker.com", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default new · sort, e.g. hot / new / top", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "t", "in": "query", "required": false, "description": "Optional · time window (with top sort), e.g. day / week / month / year", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-link-mentions" } }, "/api/reddit/v1/post/related": { "get": { "tags": [ "Reddit" ], "summary": "Cross-posted discussions", "description": "Public fields: posts sharing the link, their community, score, comment count", "operationId": "api_reddit_v1_post_related", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "post_id", "in": "query", "required": true, "description": "Required · post ID, e.g. 1va0gvr (t3_1va0gvr also works)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-post-related" } }, "/api/reddit/v1/search/posts": { "get": { "tags": [ "Reddit" ], "summary": "Site-wide post search", "description": "Public fields: site-wide post list, community, score, comment count, summary, images", "operationId": "api_reddit_v1_search_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort, e.g. relevance / new / top / comments", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "t", "in": "query", "required": false, "description": "Optional · time window (with top sort), e.g. day / week / month / year", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-search-posts" } }, "/api/reddit/v1/trending/posts": { "get": { "tags": [ "Reddit" ], "summary": "Trending post feed", "description": "Public fields: trending post list, community, score, comment count, summary", "operationId": "api_reddit_v1_trending_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "scope", "in": "query", "required": false, "description": "Optional · default popular · scope, popular / all / best", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-trending-posts" } }, "/api/reddit/v1/user/posts": { "get": { "tags": [ "Reddit" ], "summary": "User posts", "description": "Public fields: user's past posts, community, score, summary, images", "operationId": "api_reddit_v1_user_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "username", "in": "query", "required": true, "description": "Required · username, e.g. spez (u/spez also works)", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort, e.g. new / top / hot", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-user-posts" } }, "/api/reddit/v1/community/comments": { "get": { "tags": [ "Reddit" ], "summary": "Community comment feed", "description": "Public fields: comment text, author, score, parent post, time", "operationId": "api_reddit_v1_community_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": true, "description": "Required · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-comments" } }, "/api/reddit/v1/history/comments": { "get": { "tags": [ "Reddit" ], "summary": "Historical comment search", "description": "Public fields: historical comment text, community, author, score, time", "operationId": "api_reddit_v1_history_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": false, "description": "Optional · supply at least one of community or author", "schema": { "type": "string" } }, { "name": "author", "in": "query", "required": false, "description": "Optional · supply at least one of community or author", "schema": { "type": "string" } }, { "name": "after", "in": "query", "required": false, "description": "Optional · lower time bound, e.g. 2024-01-01 or unix seconds", "schema": { "type": "string" } }, { "name": "before", "in": "query", "required": false, "description": "Optional · upper time bound, e.g. 2025-01-01 or unix seconds", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort, new (default) or old", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-history-comments" } }, "/api/reddit/v1/post/comments": { "get": { "tags": [ "Reddit" ], "summary": "Post comment paging", "description": "Public fields: comment text, author, score, depth, parent comment, time", "operationId": "api_reddit_v1_post_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "post_id", "in": "query", "required": true, "description": "Required · post ID, e.g. 1va0gvr (t3_1va0gvr also works)", "schema": { "type": "string" } }, { "name": "community", "in": "query", "required": false, "description": "Optional · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · comment sort, e.g. top / new / confidence", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-post-comments" } }, "/api/reddit/v1/post/detail": { "get": { "tags": [ "Reddit" ], "summary": "Post detail and comments", "description": "Public fields: full post detail, comment list, author, score, time, images", "operationId": "api_reddit_v1_post_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "post_id", "in": "query", "required": true, "description": "Required · post ID, e.g. 1va0gvr (t3_1va0gvr also works)", "schema": { "type": "string" } }, { "name": "community", "in": "query", "required": false, "description": "Optional · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · comment sort, e.g. top / new / confidence", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-post-detail" } }, "/api/reddit/v1/search/users": { "get": { "tags": [ "Reddit" ], "summary": "User discovery", "description": "Public fields: username, karma, account age, bio, avatar", "operationId": "api_reddit_v1_search_users", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-search-users" } }, "/api/reddit/v1/user/about": { "get": { "tags": [ "Reddit" ], "summary": "User profile", "description": "Public fields: username, account age, post and comment karma, bio, avatar", "operationId": "api_reddit_v1_user_about", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "username", "in": "query", "required": true, "description": "Required · username, e.g. spez (u/spez also works)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-user-about" } }, "/api/reddit/v1/user/comments": { "get": { "tags": [ "Reddit" ], "summary": "User comment list", "description": "Public fields: comment text, community, score, time", "operationId": "api_reddit_v1_user_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "username", "in": "query", "required": true, "description": "Required · username, e.g. spez (u/spez also works)", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort, e.g. new / top / hot", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-user-comments" } }, "/api/reddit/v1/community/about": { "get": { "tags": [ "Reddit" ], "summary": "Community profile", "description": "Public fields: community name, title, description, subscriber count, created date, community icon", "operationId": "api_reddit_v1_community_about", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": true, "description": "Required · community name, e.g. magsafe (r/magsafe also works)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-about" } }, "/api/reddit/v1/community/discover": { "get": { "tags": [ "Reddit" ], "summary": "Community discovery", "description": "Public fields: community name, title, description, subscriber count, active users, community icon", "operationId": "api_reddit_v1_community_discover", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Optional · pagination cursor — pass back next_cursor from the previous response as-is", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-discover" } }, "/api/reddit/v1/community/suggest": { "get": { "tags": [ "Reddit" ], "summary": "Community name suggestions", "description": "Public fields: community name, title, subscriber count, community icon", "operationId": "api_reddit_v1_community_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-community-suggest" } }, "/api/reddit/v1/history/posts": { "get": { "tags": [ "Reddit" ], "summary": "Historical post search", "description": "Public fields: historical post list, community, author, score, time", "operationId": "api_reddit_v1_history_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "community", "in": "query", "required": false, "description": "Optional · supply at least one of community or author", "schema": { "type": "string" } }, { "name": "author", "in": "query", "required": false, "description": "Optional · supply at least one of community or author", "schema": { "type": "string" } }, { "name": "keyword", "in": "query", "required": false, "description": "Optional · keyword, e.g. anker / magsafe powerbank", "schema": { "type": "string" } }, { "name": "after", "in": "query", "required": false, "description": "Optional · lower time bound, e.g. 2024-01-01 or unix seconds", "schema": { "type": "string" } }, { "name": "before", "in": "query", "required": false, "description": "Optional · upper time bound, e.g. 2025-01-01 or unix seconds", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · sort, new (default) or old", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/reddit/#endpoint-reddit-v1-history-posts" } }, "/api/google/v1/maps/search": { "get": { "tags": [ "Google" ], "summary": "Map place search", "description": "Public fields: place name, rating, review count, address, latitude and longitude, place_id, feature id, category", "operationId": "api_google_v1_maps_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "q", "in": "query", "required": true, "description": "Required · search term, e.g. coffee shops in San Francisco", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default us", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "Optional · viewport latitude, default 37.7749", "schema": { "type": "number" } }, { "name": "lng", "in": "query", "required": false, "description": "Optional · viewport longitude, default -122.4194", "schema": { "type": "number" } }, { "name": "zoom_meters", "in": "query", "required": false, "description": "Optional · viewport radius in metres, default 12000", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "required": false, "description": "Optional · pagination offset, default 0", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/google/#endpoint-google-v1-maps-search" } }, "/api/google/v1/maps/place_id": { "get": { "tags": [ "Google" ], "summary": "Place identifier lookup", "description": "Public fields: page title, feature id, place_id", "operationId": "api_google_v1_maps_place_id", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "url", "in": "query", "required": true, "description": "Required · full Google Maps place share link", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } }, { "name": "gl", "in": "query", "required": false, "description": "Optional · region, default us", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/google/#endpoint-google-v1-maps-place-id" } }, "/api/google/v1/search/suggest": { "get": { "tags": [ "Google" ], "summary": "Search suggestions", "description": "Public fields: Suggestion list", "operationId": "api_google_v1_search_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "q", "in": "query", "required": true, "description": "Required · prefix term, e.g. starbucks", "schema": { "type": "string" } }, { "name": "hl", "in": "query", "required": false, "description": "Optional · language, default en", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/google/#endpoint-google-v1-search-suggest" } }, "/api/coupang/v1/product/search": { "get": { "tags": [ "Coupang" ], "summary": "Product Search", "description": "Public fields: Product ID, title, main image, price, currency, rating, review count", "operationId": "api_coupang_v1_product_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · Search keyword, e.g. 갤럭시, 아이폰, laptop", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/coupang/#endpoint-coupang-v1-product-search" } }, "/api/coupang/v1/product/detail": { "get": { "tags": [ "Coupang" ], "summary": "Product Detail", "description": "Public fields: Product ID, title, price, list price, discount rate, rating, review count, image gallery, unit price, Rocket delivery", "operationId": "api_coupang_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · Product ID, e.g. 1915590980 (from search)", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "required": false, "description": "Optional · Item ID (from search results)", "schema": { "type": "string" } }, { "name": "vendor_item_id", "in": "query", "required": false, "description": "Optional · Vendor item ID (from search results)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/coupang/#endpoint-coupang-v1-product-detail" } }, "/api/coupang/v1/product/reviews": { "get": { "tags": [ "Coupang" ], "summary": "Product Reviews", "description": "Public fields: Review ID, rating, title, full text, helpful count, date, reviewer, variant, photos, rating distribution, total", "operationId": "api_coupang_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · Product ID, e.g. 1915590980 (from search)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · Page number", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default best · Review sort: best / latest", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/coupang/#endpoint-coupang-v1-product-reviews" } }, "/api/rakuten/v1/product/search": { "get": { "tags": [ "Rakuten 日本乐天" ], "summary": "Product Search", "description": "Public fields: Shop code, item code, title, main image, price in JPY, rating, review count", "operationId": "api_rakuten_v1_product_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · Search keyword, e.g. iPhone, イヤホン, ramen", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/rakuten/#endpoint-rakuten-v1-product-search" } }, "/api/rakuten/v1/product/detail": { "get": { "tags": [ "Rakuten 日本乐天" ], "summary": "Product Detail", "description": "Public fields: Shop code, item code, title, tagline, image gallery, price range, rating, review count, category, variant options, SKU variants", "operationId": "api_rakuten_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "shop_code", "in": "query", "required": true, "description": "Required · Shop code, e.g. rakutenmobile-store (returned by search)", "schema": { "type": "string" } }, { "name": "item_code", "in": "query", "required": true, "description": "Required · Item code, e.g. iphone-17 (returned by search)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/rakuten/#endpoint-rakuten-v1-product-detail" } }, "/api/rakuten/v1/product/reviews": { "get": { "tags": [ "Rakuten 日本乐天" ], "summary": "Product Reviews", "description": "Public fields: Rating, review date, reviewer, gender, age band, purchased variant, review text, total count, average score", "operationId": "api_rakuten_v1_product_reviews", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "shop_code", "in": "query", "required": true, "description": "Required · Shop code, e.g. rakutenmobile-store (returned by search)", "schema": { "type": "string" } }, { "name": "item_code", "in": "query", "required": true, "description": "Required · Item code, e.g. iphone-17 (returned by search)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/rakuten/#endpoint-rakuten-v1-product-reviews" } }, "/api/rakuten/v1/ranking/products": { "get": { "tags": [ "Rakuten 日本乐天" ], "summary": "Product Ranking", "description": "Public fields: Rank, shop code, item code, title, main image, price (category rankings)", "operationId": "api_rakuten_v1_ranking_products", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "genre_id", "in": "query", "required": false, "description": "Optional · Genre ID, e.g. 560278 (mobile category ranking); omit for the overall ranking", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/rakuten/#endpoint-rakuten-v1-ranking-products" } }, "/api/naver/v1/keyword/suggest": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Search Suggestions", "description": "Public fields: Keyword, suggestion list", "operationId": "api_naver_v1_keyword_suggest", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · Search keyword, e.g. 아이폰 (iPhone)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-keyword-suggest" } }, "/api/naver/v1/category/tree": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Shopping Category Tree", "description": "Public fields: Category ID, category name, child categories", "operationId": "api_naver_v1_category_tree", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "category_id", "in": "query", "required": false, "description": "Optional · default 0 · Category ID, e.g. 50000001 (fashion accessories)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-category-tree" } }, "/api/naver/v1/keyword/trends": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Shopping Keyword Trends", "description": "Public fields: Rank, keyword, category ID, date range", "operationId": "api_naver_v1_keyword_trends", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "category_id", "in": "query", "required": false, "description": "Optional · default 50000001 · Category ID, e.g. 50000001 (fashion accessories)", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "required": false, "description": "Optional · Start date YYYY-MM-DD; defaults to the last 7 days", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "required": false, "description": "Optional · End date YYYY-MM-DD; defaults to today", "schema": { "type": "string" } }, { "name": "age", "in": "query", "required": false, "description": "Optional · Age segment; defaults to all", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "required": false, "description": "Optional · Gender segment; defaults to all", "schema": { "type": "string" } }, { "name": "device", "in": "query", "required": false, "description": "Optional · Device segment (pc/mo); defaults to all", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-keyword-trends" } }, "/api/naver/v1/news/list": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "News List", "description": "Public fields: Press ID, article ID, title, press name", "operationId": "api_naver_v1_news_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "section", "in": "query", "required": false, "description": "Optional · default 105 · News section ID (105 = IT/Science)", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Optional · Date YYYYMMDD; defaults to today", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-news-list" } }, "/api/naver/v1/news/detail": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "News Detail", "description": "Public fields: Title, press, publish time, body text, images", "operationId": "api_naver_v1_news_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "press_id", "in": "query", "required": true, "description": "Required · Press ID, e.g. 421 (returned by news list)", "schema": { "type": "string" } }, { "name": "article_id", "in": "query", "required": true, "description": "Required · Article ID, e.g. 0009154957 (returned by news list)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-news-detail" } }, "/api/naver/v1/news/comments": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "News Comments", "description": "Public fields: Comment ID, author, text, time, likes, dislikes, total count", "operationId": "api_naver_v1_news_comments", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "press_id", "in": "query", "required": true, "description": "Required · Press ID, e.g. 421 (returned by news list)", "schema": { "type": "string" } }, { "name": "article_id", "in": "query", "required": true, "description": "Required · Article ID, e.g. 0009154957 (returned by news list)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · page", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": false, "description": "Optional · default favorite · Comment sort: favorite (popularity) / new (latest)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-news-comments" } }, "/api/naver/v1/news/ranking": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "News Daily Ranking", "description": "Public fields: Rank, title, press, press ID, article ID, publish time", "operationId": "api_naver_v1_news_ranking", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-news-ranking" } }, "/api/naver/v1/blog/posts": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Blog Post List", "description": "Public fields: Post number, title, publish date, comment count", "operationId": "api_naver_v1_blog_posts", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "blog_id", "in": "query", "required": true, "description": "Required · Blog ID, e.g. naverofficial", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "Optional · default 1 · page", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-blog-posts" } }, "/api/naver/v1/blog/post/detail": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Blog Post Detail", "description": "Public fields: Title, publish time, body text, image gallery", "operationId": "api_naver_v1_blog_post_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "blog_id", "in": "query", "required": true, "description": "Required · Blog ID, e.g. naverofficial", "schema": { "type": "string" } }, { "name": "log_no", "in": "query", "required": true, "description": "Required · Post number, e.g. 224400531915 (returned by blog list)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-blog-post-detail" } }, "/api/naver/v1/webtoon/list": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Webtoon Weekly Chart", "description": "Public fields: Title ID, title, author, rating, completion status, cover", "operationId": "api_naver_v1_webtoon_list", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "week", "in": "query", "required": false, "description": "Optional · Weekday (mon..sun); defaults to the server's current day", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-webtoon-list" } }, "/api/naver/v1/finance/quote": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Realtime Market Quote", "description": "Public fields: Name, last price, change, change rate, open/high/low, volume, turnover, EPS, BPS, dividend", "operationId": "api_naver_v1_finance_quote", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "code", "in": "query", "required": false, "description": "Optional · default KOSPI · Code: KOSPI/KOSDAQ index or a 6-digit stock code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-finance-quote" } }, "/api/naver/v1/finance/timeline": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Intraday Timeline", "description": "Public fields: Time, price", "operationId": "api_naver_v1_finance_timeline", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "code", "in": "query", "required": false, "description": "Optional · default KOSPI · Code: KOSPI/KOSDAQ index or a 6-digit stock code", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-finance-timeline" } }, "/api/naver/v1/place/search": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Place Search", "description": "Public fields: Place ID, name, category, road address, coordinates, review count", "operationId": "api_naver_v1_place_search", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "keyword", "in": "query", "required": true, "description": "Required · Search keyword, e.g. 아이폰 (iPhone)", "schema": { "type": "string" } }, { "name": "lat", "in": "query", "required": false, "description": "Optional · default 37.5665 · Latitude; defaults to central Seoul", "schema": { "type": "string" } }, { "name": "lng", "in": "query", "required": false, "description": "Optional · default 126.9780 · Longitude; defaults to central Seoul", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-place-search" } }, "/api/naver/v1/place/detail": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "Place Detail", "description": "Public fields: Name, category, address, business hours, rating, review count, blog review count, image gallery", "operationId": "api_naver_v1_place_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "place_id", "in": "query", "required": true, "description": "Required · Place ID, e.g. 37749845 (returned by place search)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-place-detail" } }, "/api/naver/v1/product/detail": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "SmartStore Product Detail", "description": "Public fields: Product ID, title, price in KRW, discounted price, brand, maker, category chain, store, rating, review count, image gallery, delivery fee and courier, similar products", "operationId": "api_naver_v1_product_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "product_id", "in": "query", "required": true, "description": "Required · Product ID, e.g. 12460786735", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-product-detail" } }, "/api/naver/v1/shop/detail": { "get": { "tags": [ "Naver 韩国门户" ], "summary": "SmartStore Store Detail", "description": "Public fields: Store slug, store name, brand store name, business entity type, description, status", "operationId": "api_naver_v1_shop_detail", "parameters": [ { "name": "token", "in": "query", "required": true, "description": "Project credential placeholder; keep the real value on the server.", "schema": { "type": "string" }, "example": "YOUR_TOKEN" }, { "name": "store", "in": "query", "required": true, "description": "Required · Store slug, e.g. royalbabykorea", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "4XX": { "description": "Request or credential error; exact envelope follows the endpoint response." }, "5XX": { "description": "Service-side error; use bounded retry and preserve request evidence." } }, "x-product-page": "/en/products/naver/#endpoint-naver-v1-shop-detail" } } }, "x-generated-at": "2026-09-21T16:47:09+08:00", "x-public-interface-count": 216 }