{ "openapi": "3.1.0", "info": { "title": "Scrumball Creator Data API", "description": "Social media creator data across TikTok, Instagram and YouTube: profiles, content performance, audience insights and video monitoring.", "version": "1.0.0", "contact": { "name": "Scrumball Support", "url": "https://platform.scrumball.com/docs" } }, "servers": [ { "url": "https://openapi.scdata.cc", "description": "Production" } ], "tags": [ { "name": "system", "description": "Service health and connectivity checks." }, { "name": "youtube", "description": "YouTube creator profiles, video data, brand collaborations and realtime collection." }, { "name": "instagram", "description": "Instagram creator profiles, posts, stories, brand collaborations and realtime collection." }, { "name": "tiktok", "description": "TikTok creator profiles, video data, brand collaborations, e-commerce performance and realtime collection." }, { "name": "search", "description": "Keyword search across creators and content on all three platforms." }, { "name": "audience", "description": "Audience demographics, geography, interests, engagement behavior and follower authenticity." }, { "name": "monitor", "description": "Scheduled video monitoring tasks and metric refresh." }, { "name": "twitter", "description": "X (Twitter) creator profiles, posts, brand collaborations and similar creators." }, { "name": "twitch", "description": "Twitch streamer profiles, videos, chat data, search and live monitoring." }, { "name": "facebook", "description": "Facebook page and post collection, realtime and task based." }, { "name": "billing", "description": "API usage and quota for the calling key." } ], "paths": { "/api/ping": { "get": { "tags": [ "system" ], "summary": "API Health Check", "description": "A lightweight connectivity check that returns a fixed success payload. Call it first when integrating to confirm network access and base URL before adding authentication.", "operationId": "ping", "externalDocs": { "description": "API Health Check - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/system/api-health-check" }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "string", "title": "Response Ping Api Ping Get" } } } } } } }, "/api/v1/tiktok/user/info": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Profile", "description": "Returns the stored public profile of a TikTok creator: identity and bio, follower and following counts, verification flag, linked accounts on other platforms and rolling engagement averages over recent videos. Records come from the persisted database, which suits batch screening; use the realtime variant when you need up-to-the-minute values.", "operationId": "tiktok_db_user_info", "externalDocs": { "description": "Get TikTok Creator Profile - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-profile" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": false, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TiktokUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user_id": "208464585232822272", "related_platforms": [ { "platform": "youtube", "platform_url": "https://www.youtube.com/channel/UCUFgkRb0ZHc4Rpq15VRCICA" }, { "platform": "instagram", "platform_url": "https://www.instagram.com/nike" } ], "unique_id": "nike", "nickname": "Nike", "channel_url": "https://www.tiktok.com/@nike", "description": "Just Do It.", "avatar": "https://img.scrumball.cn/tiktok/Fs6qFtdehp7X-BBzS8tfmaB46mB8", "country": "US", "language": "en", "gender": "unknown", "follower_count": 7696590, "following_count": 72, "is_verified": true, "is_private": true, "tags": [ "#nikebasketball", "#teamnike", "#justdoit", "#nikefootball", "#NikeFootball", "#nikerunning", "#TomaElJuego", "#breaking4", "#Breaking4" ], "publish_count_month": 14, "publish_count_week": 7, "last_publish_at": "2025-09-05", "total_video_count": 1027, "total_like_count": 36719860, "avg_engagement_rate_5": "8.04%", "avg_view_rate_5": "0.38%", "avg_view_count_5": "29984.80", "avg_comment_count_5": "59.60", "avg_like_count_5": "2323.40", "avg_share_count_5": "29.20", "avg_engagement_rate_10": "1.10%", "avg_view_rate_10": "12.26%", "avg_view_count_10": "943984.30", "avg_comment_count_10": "126.30", "avg_like_count_10": "9732.10", "avg_share_count_10": "519.50", "avg_engagement_rate_30": "6.52%", "avg_view_rate_30": "8.18%", "avg_view_count_30": "629982.83", "avg_comment_count_30": "245.60", "avg_like_count_30": "15754.00", "avg_share_count_30": "706.20", "med_engagement_rate_30": "1.68%", "med_view_rate_30": "3.39%", "med_view_count_30": "261396", "med_comment_count_30": "137", "med_like_count_30": "3974", "med_share_count_30": "86", "last_update_at": "2025-09-05 17:04:04" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/videos": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Videos", "description": "Returns a paginated list of a TikTok creator's videos from the persisted database, each with its publish time, caption and engagement counters. Ideal for building performance timelines or picking representative content.", "operationId": "tiktok_db_user_videos", "externalDocs": { "description": "Get TikTok Creator Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2025-01-01", "schema": { "type": "string", "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2025-01-31", "schema": { "type": "string", "description": "Publish time to", "title": "Publish At End" } }, { "name": "video_id", "in": "query", "required": false, "description": "Video ID", "example": "7437208265911455006", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } }, { "name": "is_paid", "in": "query", "required": false, "description": "Sponsored video (1 = yes)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Sponsored video (1 = yes)", "title": "Is Paid" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort field (publish_at, view_count, engagement_rate)", "example": "publish_at", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort field (publish_at, view_count, engagement_rate)", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "description": "Sort direction (asc, desc), default desc", "example": "desc", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort direction (asc, desc), default desc", "title": "Sort Order" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TiktokUserVideoInfoItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "video_id": "7508413737670413614", "description": "Things you might experience on Fly Vini Airlines with captain @Vini Jr.: speed, samba and smiles. #NikeFootball ", "video_url": "https://www.tiktok.com/@nike/video/7508413737670413614", "cover_url": "https://img.scrumball.cn/tiktok/FuaboiN2W8mT6WnSCI9Qs1Ywo9LE?imageView2/2/w/300", "duration_second": 32, "tags": [ "nikefootball" ], "publish_at": "2025-05-26 00:00:39", "view_count": 188037, "share_count": 293, "like_count": 8058, "comment_count": 162, "like_rate": "0.04", "view_follower_rate": "0.03", "engagement_rate": "4.53", "video_author_nickname": "Nike", "video_author_unique_id": "nike", "video_author_url": "https://www.tiktok.com/@nike", "video_author_follower_count": 7393587, "last_update_at": "2025-06-06 15:43:28" } ], "total": 704, "page": 1, "page_size": 1, "total_pages": 704 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/brands": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Brand Deals", "description": "Returns the brands detected in a TikTok creator's sponsored content, with how often and how recently each appeared. This is a higher-cost analytics endpoint; see the quota note below.", "operationId": "tiktok_user_brands", "externalDocs": { "description": "Get TikTok Creator Brand Deals - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-brand-deals" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Items per page", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_VideoBrandCollaborationItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "brand_name": "string", "collaboration_count": 0, "last_collaboration_at": "string", "engagement_rate": "string", "total_view_count": 0, "total_like_count": 0, "total_comment_count": 0, "videos": [ { "video_id": "string", "title": "string", "description": "string", "cover_url": "string", "video_url": "string", "publish_at": "string", "view_count": 0, "like_count": 0, "comment_count": 0, "engagement_rate": 0 } ] } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/similar": { "get": { "tags": [ "tiktok" ], "summary": "Find Similar TikTok Creators", "description": "Given one TikTok creator, returns a ranked list of accounts with a comparable audience, size and content style, each with a similarity score and summary metrics. Higher quota cost than a plain profile read.", "operationId": "tiktok_user_similar", "externalDocs": { "description": "Find Similar TikTok Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/find-similar-tiktok-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": false, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_TiktokUserSimilarItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "unique_id": "joshotusanya", "nickname": "Josh Otusanya 🇳🇬", "description": "American Stand up Comedian \nSelf Help | Comedy | Lifestyle\n📍Barcelona • 🇺🇸🇳🇬 \njosh@joshotusanya.com\nLive Shows/Newsletter/Free Guides ⤵️", "avatar": "https://img.scrumball.cn/Fr6IT6ZSn00Mvv--iHRo0pp4YdoH", "follower_count": 7520125 }, { "unique_id": "agnes_jennifer", "nickname": "Agnes Jennifer", "description": "Creator of The Year 2021 Nominee\nIdolaTikTok 2021\nTikTok Shop Summit Award 2022", "avatar": "https://img.scrumball.cn/FoxwafvDXdzdG81EfmXB8erM1g3n", "follower_count": 4990219 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/realtime/user/info": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Profile (Realtime)", "description": "Collects a TikTok creator's profile directly from the platform at request time instead of reading the persisted database. Use it when freshness matters more than throughput; realtime calls consume more quota than database reads.", "operationId": "tiktok_realtime_user_info", "externalDocs": { "description": "Get TikTok Creator Profile (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-profile-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": false, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "user_id", "in": "query", "required": false, "description": "user_id", "example": "208464585232822272", "schema": { "type": "string", "description": "user_id", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeTiktokUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "uid": "string", "unique_id": "string", "sec_uid": "string", "nickname": "string", "profile_url": "string", "avatar": "string", "description": "string", "verified": true, "country": "string", "follower_count": 0, "following_count": 0, "total_favorited": 0, "video_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/realtime/user/videos": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Videos (Realtime)", "description": "Fetches a creator's most recent videos straight from TikTok at request time. Use it for content published in the last hours or when the database copy is stale; realtime collection costs more quota than a database read.", "operationId": "tiktok_realtime_user_videos", "externalDocs": { "description": "Get TikTok Creator Videos (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-videos-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "uid", "in": "query", "required": true, "description": "uid or sec_uid", "example": "208464585232822272", "schema": { "type": "string", "description": "uid or sec_uid", "title": "Uid" } }, { "name": "region", "in": "query", "required": false, "description": "country code:US,VN...", "example": "US", "schema": { "type": "string", "description": "country code:US,VN...", "default": "US", "title": "Region" } }, { "name": "offset", "in": "query", "required": false, "description": "offset", "schema": { "type": "string", "description": "offset", "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeTiktokUserVideosRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "videos": [ { "video_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "author_uid": "string", "author_unique_id": "string", "author_nickname": "string", "duration": 0, "video_url": "string", "cover_url": "string", "share_count": 0, "like_count": 0, "comment_count": 0, "play_count": 0, "collect_count": 0 } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/realtime/video/detail": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Video Details (Realtime)", "description": "Collects one TikTok video directly from the platform and returns its full metadata and engagement counters as of the call. Suited to tracking individual pieces of content rather than whole accounts.", "operationId": "tiktok_realtime_video_detail", "externalDocs": { "description": "Get TikTok Video Details (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-video-details-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "Video ID", "example": "7447950131443469614", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } }, { "name": "region", "in": "query", "required": true, "description": "country code:US,VN...", "example": "US", "schema": { "type": "string", "description": "country code:US,VN...", "title": "Region" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeTiktokVideoInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "video_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "author_uid": "string", "author_unique_id": "string", "author_nickname": "string", "duration": 0, "video_url": "string", "cover_url": "string", "share_count": 0, "like_count": 0, "comment_count": 0, "play_count": 0, "collect_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/shop/sale": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Sales Data", "description": "Summarises a TikTok creator's TikTok Shop activity — promoted products, order and sales totals, revenue and the share of content that carries product links. This is a premium commerce endpoint with a higher per-request quota cost.", "operationId": "tiktok_user_shop_sale", "externalDocs": { "description": "Get TikTok Creator Sales Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-sales-data" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "popmart.usshop", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TiktokUserShopSaleRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "currency_symbol": "$", "revenue_amount": "3132136.98", "sales_volumn": 83007, "video_revenue_amount": "309.90", "live_revenue_amount": "3123058.84", "avg_sales_price": "37.73", "live_views_number": 22712398, "video_views_number": 13409031, "new_followers_number": 53000, "start_time": "2025-08-01", "end_time": "2025-08-31" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/shop/video/ad/list": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Ad Videos", "description": "Returns the videos in which a TikTok creator promoted products, each with the linked product, engagement and attributed sales. A premium commerce endpoint with a higher quota cost.", "operationId": "tiktok_user_shop_video_ad_list", "externalDocs": { "description": "Get TikTok Creator Ad Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-ad-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "popmart.usshop", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "sort_field", "in": "query", "required": false, "description": "Sort field: revenue_amount, views_count, ads_deal_rate, ads_view_rate, ads_roas_rate", "schema": { "type": "string", "description": "Sort field: revenue_amount, views_count, ads_deal_rate, ads_view_rate, ads_roas_rate", "title": "Sort Field" } }, { "name": "sort_type", "in": "query", "required": false, "description": "Sort order: asc = ascending, desc = descending", "schema": { "type": "string", "description": "Sort order: asc = ascending, desc = descending", "title": "Sort Type" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TiktokUserShopVideoAdItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "video_id": "7483378078563962142", "video_description": "I love.❤️ #popmart #skullpanda #wintersymphony #blindbox #vinyl #plush ", "video_url": "https://www.tiktok.com/@popmart.usshop/video/7483378078563962142", "video_cover_url": "https://d3uucz7wx6jq40.cloudfront.net/tiktok.video/7483378078563962142/cover.png", "video_publish_at": "2024-03-29", "revenue_amount": "309.90", "view_count": 47129, "like_count": 18310, "comment_count": 197, "share_count": 1198, "ads_deal_rate": "0", "ads_view_rate": "0", "ads_roas_rate": "0" } ], "total": 47, "page": 1, "page_size": 10, "total_pages": 5 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/shop/goods/list": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Products", "description": "Returns every product a TikTok creator has attached to their content, with product details and the sales attributed to the creator. A premium commerce endpoint with a higher quota cost.", "operationId": "tiktok_user_shop_goods_list", "externalDocs": { "description": "Get TikTok Creator Products - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-products" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "popmart.usshop", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TiktokUserShopGoodsItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "goods_id": "1731491957866860552", "goods_name": "THE MONSTERS Let's Checkmate Series-Vinyl Plush Doll", "goods_pic_url": "https://d3uucz7wx6jq40.cloudfront.net/tiktok.product/1731491957866860552/cover.png", "currency_symbol": "$", "goods_price": "114.99", "goods_sales_revenue": "240559.08", "goods_sales_volumn": 2092 } ], "total": 100, "page": 1, "page_size": 10, "total_pages": 10 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/shop/live/list": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Livestreams", "description": "Returns the live shopping sessions a TikTok creator has hosted, with audience and sales figures for each. A premium commerce endpoint with a higher quota cost.", "operationId": "tiktok_user_shop_live_list", "externalDocs": { "description": "Get TikTok Creator Livestreams - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-livestreams" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "popmart.usshop", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "sort_field", "in": "query", "required": false, "description": "Sort field: live_revenue_amount, live_view_count, live_price, live_revenue_per_thousand", "schema": { "type": "string", "description": "Sort field: live_revenue_amount, live_view_count, live_price, live_revenue_per_thousand", "title": "Sort Field" } }, { "name": "sort_type", "in": "query", "required": false, "description": "Sort order: asc = ascending, desc = descending", "schema": { "type": "string", "description": "Sort order: asc = ascending, desc = descending", "title": "Sort Type" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TiktokUserShopLiveItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "live_name": "SKULLPANDA Launch!", "live_cover_url": "https://d3uucz7wx6jq40.cloudfront.net/tiktok.live/7541145940804029239/cover.png", "live_start_time": "08/22 05:00", "live_end_time": "08/22 17:08", "live_duration": "12.1h", "live_revenue_amount": "405921.55", "live_view_count": 1647040, "live_price": "43.76", "live_revenue_per_thousand": "246.45" } ], "total": 35, "page": 1, "page_size": 10, "total_pages": 4 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/monitor/metrics": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Creator Growth Metrics", "description": "Returns a time series of a TikTok creator's key metrics — followers, content count and engagement — over a chosen date range, built from daily monitoring snapshots. Higher quota cost than a single profile read.", "operationId": "tiktok_user_monitor_metrics", "externalDocs": { "description": "Get TikTok Creator Growth Metrics - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-creator-growth-metrics" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "period", "in": "query", "required": false, "description": "Period (last_31_days, monthly)", "example": "last_31_days", "schema": { "type": "string", "description": "Period (last_31_days, monthly)", "default": "last_31_days", "title": "Period" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_TiktokUserMonitorMetricsRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "date": "2025-11-02", "follower_count": 121000000 }, { "date": "2025-11-03", "follower_count": 121000000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/tiktok/user/hashtag/engagement": { "get": { "tags": [ "tiktok" ], "summary": "Get TikTok Hashtag Engagement Data", "description": "Engagement data for the top 10 hashtags in the user's recent videos", "operationId": "tiktok_user_hashtag_engagement", "externalDocs": { "description": "Get TikTok Hashtag Engagement Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/tiktok/get-tiktok-hashtag-engagement" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_KolHashtagEngagementRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "hashtag": "#Clips", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" }, { "hashtag": "#Felix", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/info": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Profile", "description": "Returns the stored public profile of a Instagram creator: identity and bio, follower and following counts, verification flag, linked accounts on other platforms and rolling engagement averages over recent posts. Records come from the persisted database, which suits batch screening; use the realtime variant when you need up-to-the-minute values.", "operationId": "instagram_db_user_info", "externalDocs": { "description": "Get Instagram Creator Profile - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-profile" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_InstagramUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user_id": "695995017", "related_platforms": [], "username": "chanelofficial", "nickname": "CHANEL", "avatar": "https://img.scrumball.cn/instagram/Fnu9-hyneWMt_HWQsMQJz7WK5nmG", "description": "", "channel_url": "https://www.instagram.com/chanelofficial/", "follower_count": 59840913, "country": "FR", "language": "en", "gender": "female", "is_business_account": true, "is_verified": true, "tags": [ "#Les4Ombres", "#CHANELMakeup", "#BleuLExclusif", "#BleuDeCHANEL", "#CHANELFragrance", "#cometescollective", "#CHANELandCinema", "#CHANELJewelry", "#CHANELHighJewelry", "#CHANELPremiere" ], "publish_count_month": 30, "publish_count_week": 9, "last_publish_at": "2025-09-01", "total_media_count": 6917, "total_video_count": 11, "avg_engagement_rate_5": "0.04%", "avg_view_rate_5": "0.89%", "avg_view_count_5": "5291533.40", "avg_like_count_5": "24831.60", "avg_comment_count_5": "518.00", "avg_engagement_rate_10": "0.03%", "avg_view_rate_10": "0.77%", "avg_view_count_10": "4582762.30", "avg_like_count_10": "19976.10", "avg_comment_count_10": "333.40", "avg_engagement_rate_30": "0.03%", "avg_engagement_rate_30_video": "0.95%", "avg_view_rate_30": "0.79%", "avg_view_count_30": "4705411.12", "avg_like_count_30": "17957.40", "avg_comment_count_30": "210.23", "med_engagement_rate_30": "0.02%", "med_view_rate_30": "0.76%", "med_view_count_30": "4503210", "med_like_count_30": "14789", "med_comment_count_30": "149", "last_update_at": "2025-09-02 01:21:06" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/medias": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Posts", "description": "Returns a paginated list of a Instagram creator's posts from the persisted database, each with its publish time, caption and engagement counters. Ideal for building performance timelines or picking representative content.", "operationId": "instagram_db_user_medias", "externalDocs": { "description": "Get Instagram Creator Posts - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-posts" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2025-01-01", "schema": { "type": "string", "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2025-01-31", "schema": { "type": "string", "description": "Publish time to", "title": "Publish At End" } }, { "name": "media_code", "in": "query", "required": false, "description": "Post code", "example": "DFdDk_eRYU3", "schema": { "type": "string", "description": "Post code", "title": "Media Code" } }, { "name": "media_type", "in": "query", "required": false, "description": "Post type (video, sidecar = carousel, image = single image)", "example": "video", "schema": { "anyOf": [ { "$ref": "#/components/schemas/InstagramMediaTypeNameEnum" }, { "type": "null" } ], "description": "Post type (video, sidecar = carousel, image = single image)", "title": "Media Type" } }, { "name": "is_paid", "in": "query", "required": false, "description": "Sponsored post (1 = yes)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Sponsored post (1 = yes)", "title": "Is Paid" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort field (publish_at, like_count, engagement_rate)", "example": "publish_at", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort field (publish_at, like_count, engagement_rate)", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "description": "Sort direction (asc, desc), default desc", "example": "desc", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort direction (asc, desc), default desc", "title": "Sort Order" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_InstagramUserMediaItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "media_code": "DKruTaYRac_", "media_url": "https://www.instagram.com/p/DKruTaYRac_/", "description": "The future of tennis is in good hands.", "cover_url": "https://img.scrumball.cn/instagram/Fpr2ndmGyZJECypIFBKcbklDFT3B?imageView2/2/w/300", "publish_at": "2025-06-09 22:20:35", "like_count": 144865, "comment_count": 376, "view_count": 0, "media_type": "sidecar", "engagement_rate": "0.05", "media_username": "nike", "media_user_url": "https://www.instagram.com/nike/", "media_user_follower_count": 300572085, "last_update_at": "2025-06-10 09:32:48" } ], "total": 765, "page": 1, "page_size": 1, "total_pages": 765 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/brands": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Brand Deals", "description": "Returns the brands detected in a Instagram creator's sponsored content, with how often and how recently each appeared. This is a higher-cost analytics endpoint; see the quota note below.", "operationId": "instagram_user_brands", "externalDocs": { "description": "Get Instagram Creator Brand Deals - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-brand-deals" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Items per page", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_VideoBrandCollaborationItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "brand_name": "string", "collaboration_count": 0, "last_collaboration_at": "string", "engagement_rate": "string", "total_view_count": 0, "total_like_count": 0, "total_comment_count": 0, "videos": [ { "video_id": "string", "title": "string", "description": "string", "cover_url": "string", "video_url": "string", "publish_at": "string", "view_count": 0, "like_count": 0, "comment_count": 0, "engagement_rate": 0 } ] } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/similar": { "get": { "tags": [ "instagram" ], "summary": "Find Similar Instagram Creators", "description": "Given one Instagram creator, returns a ranked list of accounts with a comparable audience, size and content style, each with a similarity score and summary metrics. Higher quota cost than a plain profile read.", "operationId": "instagram_user_similar", "externalDocs": { "description": "Find Similar Instagram Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/find-similar-instagram-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_InstagramUserSimilarItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "username": "psg", "nickname": "Paris Saint-Germain", "avatar": "https://img.scrumball.cn/FrnaI8Vmawgv7_lzJnvZ5oNwP31z", "description": "CHAMPIONS D’EUROPE 🏆❤️💙", "follower_count": 65722412 }, { "username": "9gag", "nickname": "9GAG: Go Fun The World", "avatar": "https://img.scrumball.cn/FkKYYK-t2d7t6LI9HoYqp-2rBg3Q", "description": "Building @memeland, one meme at a time. \nOur mascot looks like a 🥔 @potatozzz.\n-\n👇🏻Get your daily dose of memes and fun", "follower_count": 54294310 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/realtime/user/info": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Profile (Realtime)", "description": "Collects a Instagram creator's profile directly from the platform at request time instead of reading the persisted database. Use it when freshness matters more than throughput; realtime calls consume more quota than database reads.", "operationId": "instagram_realtime_user_info", "externalDocs": { "description": "Get Instagram Creator Profile (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-profile-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": false, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "user_id", "in": "query", "required": false, "description": "user_id", "example": "13460080", "schema": { "type": "string", "description": "user_id", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeInstagramUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user_id": "string", "username": "string", "full_name": "string", "profile_url": "string", "avatar": "string", "verified": true, "description": "string", "follower_count": 0, "following_count": 0, "media_count": 0, "is_private": true } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/realtime/user/medias": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Posts (Realtime)", "description": "Fetches a creator's most recent posts straight from Instagram at request time. Use it for content published in the last hours or when the database copy is stale; realtime collection costs more quota than a database read.", "operationId": "instagram_realtime_user_medias", "externalDocs": { "description": "Get Instagram Creator Posts (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-posts-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "query", "required": true, "description": "user_id", "example": "13460080", "schema": { "type": "string", "description": "user_id", "title": "User Id" } }, { "name": "offset", "in": "query", "required": false, "description": "offset", "schema": { "type": "string", "description": "offset", "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeInstagramUserMediasRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "medias": [ { "author_user_id": "string", "author_username": "string", "author_nickname": "string", "media_id": "string", "media_code": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "resources": [ "string" ], "description": "string", "accessibility_caption": "string", "media_url": "string", "media_type": 0, "duration": 0, "like_count": 0, "comment_count": 0, "play_count": 0 } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/realtime/media/detail": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Post Details (Realtime)", "description": "Collects one Instagram post directly from the platform and returns its full metadata and engagement counters as of the call. Suited to tracking individual pieces of content rather than whole accounts.", "operationId": "instagram_realtime_media_detail", "externalDocs": { "description": "Get Instagram Post Details (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-post-details-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "media_code", "in": "query", "required": true, "description": "media code", "example": "DB1OqFnxIZM", "schema": { "type": "string", "description": "media code", "title": "Media Code" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeInstagramMediaInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "author_user_id": "string", "author_username": "string", "author_nickname": "string", "media_id": "string", "media_code": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "resources": [ "string" ], "description": "string", "accessibility_caption": "string", "media_url": "string", "media_type": 0, "duration": 0, "like_count": 0, "comment_count": 0, "play_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/realtime/user/stories": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Stories (Realtime)", "description": "Fetches the stories an Instagram creator has live at request time. Stories expire after 24 hours, so this endpoint is realtime only and costs more quota than database reads.", "operationId": "instagram_realtime_user_stories", "externalDocs": { "description": "Get Instagram Creator Stories (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-stories-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "query", "required": true, "description": "user_id", "example": "13460080", "schema": { "type": "string", "description": "user_id", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeInstagramUserStoriesRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user": { "user_id": "string", "username": "string", "full_name": "string", "is_private": true, "is_verified": true, "avatar": "string" }, "stories": [ { "media_id": "string", "media_code": "string", "create_at": "2019-08-24T14:15:22.123Z", "expiring_at": "2019-08-24T14:15:22.123Z", "media_type": 0, "cover_url": "string", "video_url": "string", "video_duration": "string", "mention_users": [ { "user_id": "string", "username": "string", "full_name": "string", "is_private": true, "is_verified": true, "avatar": "string" } ], "locations": [ { "location_id": "string", "name": "string", "address": "string", "city": "string", "latitude": 0, "longitude": 0 } ] } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/monitor/metrics": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Creator Growth Metrics", "description": "Returns a time series of a Instagram creator's key metrics — followers, content count and engagement — over a chosen date range, built from daily monitoring snapshots. Higher quota cost than a single profile read.", "operationId": "instagram_user_monitor_metrics", "externalDocs": { "description": "Get Instagram Creator Growth Metrics - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-creator-growth-metrics" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "period", "in": "query", "required": false, "description": "Period (last_31_days, monthly)", "example": "last_31_days", "schema": { "type": "string", "description": "Period (last_31_days, monthly)", "default": "last_31_days", "title": "Period" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_InstagramUserMonitorMetricsRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "date": "2025-11-02", "follower_count": 121000000 }, { "date": "2025-11-03", "follower_count": 121000000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/instagram/user/hashtag/engagement": { "get": { "tags": [ "instagram" ], "summary": "Get Instagram Hashtag Engagement Data", "description": "Engagement data for the top 10 hashtags in the user's recent posts", "operationId": "instagram_user_hashtag_engagement", "externalDocs": { "description": "Get Instagram Hashtag Engagement Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/instagram/get-instagram-hashtag-engagement" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_KolHashtagEngagementRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "hashtag": "#Clips", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" }, { "hashtag": "#Felix", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/info": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Profile", "description": "Returns the stored public profile of a YouTube creator: identity and bio, follower and following counts, verification flag, linked accounts on other platforms and rolling engagement averages over recent videos. Records come from the persisted database, which suits batch screening; use the realtime variant when you need up-to-the-minute values.", "operationId": "youtube_db_user_info", "externalDocs": { "description": "Get YouTube Creator Profile - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-profile" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": false, "description": "channel_id", "example": "UCUFgkRb0ZHc4Rpq15VRCICA", "schema": { "type": "string", "description": "channel_id", "default": "", "title": "Channel Id" } }, { "name": "username", "in": "query", "required": false, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "default": "", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_YoutubeUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "channel_id": "UCX6OQ3DkcsbYNE6H8uQQuVA", "username": "MrBeast", "related_platforms": [], "title": "MrBeast", "channel_url": "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA", "avatar": "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK", "description": "SUBSCRIBE FOR A COOKIE!\nNew MrBeast or MrBeast Gaming video every single Saturday at noon eastern time!\nAccomplishments:\n- Raised $20,000,000 To Plant 20,000,000 Trees\n- Removed 30,000,000 pounds of trash from the ocean\n- Helped 2,000 people walk again\n- Helped 1,000 blind people see\n- Helped 1,000 deaf people hear\n- Built wells in Africa\n- Built and gave away 100 houses\n- Adopted every dog in a shelter (twice)\n- Given millions to charity\n- Started my own snack company Feastables\n- Started my own software company Viewstats\n- Started Lunchly, a tasty, better-for-you lunch option\n- Gave away a private island (twice)\n- Gave away 1 million meals\n- I counted to 100k\n- Ran a marathon in the world's largest shoes\n- Survived 50 hours in Antarctica\n- Recreated Squid Game in real life\n- Created the largest competition show with 1000 people (Beast Games)\n- Gave $5,000,000 to one person\n- Passed T-Series to become most subscribed YouTube channel 🥹\nyou get it, I appreciate all of you so much :)\n", "gender": "male", "country": "US", "language": "en", "tags": [], "register_at": "2012-02-20 08:43:50", "subscriber_count": 432000000, "publish_count_month": 8, "publish_count_week": 1, "last_publish_at": "2025-09-02", "total_video_count": 897, "total_view_count": 94445033195, "avg_view_count": "137128083.23", "avg_engagement_rate_5": "2.99%", "avg_view_rate_5": "32.08%", "avg_view_count_5": "138597632.40", "avg_comment_count_5": "12504.60", "avg_like_count_5": "4134483.00", "avg_engagement_rate_10": "2.94%", "avg_view_rate_10": "24.87%", "avg_view_count_10": "107445917.40", "avg_comment_count_10": "14019.30", "avg_like_count_10": "3140011.50", "avg_engagement_rate_30": "2.37%", "avg_view_rate_30": "31.74%", "avg_view_count_30": "137128083.23", "avg_comment_count_30": "21829.07", "avg_like_count_30": "3221348.67", "med_engagement_rate_30": "2.42%", "med_view_rate_30": "27.22%", "med_view_count_30": "117601552", "med_comment_count_30": "11374", "med_like_count_30": "2831302", "last_update_at": "2025-09-08 17:27:53" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/videos": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Videos", "description": "Returns a paginated list of a YouTube creator's videos from the persisted database, each with its publish time, caption and engagement counters. Ideal for building performance timelines or picking representative content.", "operationId": "youtube_db_user_videos", "externalDocs": { "description": "Get YouTube Creator Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2025-01-01", "schema": { "type": "string", "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2025-01-31", "schema": { "type": "string", "description": "Publish time to", "title": "Publish At End" } }, { "name": "video_id", "in": "query", "required": false, "description": "Video ID", "example": "L5ihmu87xTE", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } }, { "name": "is_paid", "in": "query", "required": false, "description": "Sponsored video (1 = yes)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Sponsored video (1 = yes)", "title": "Is Paid" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort field (publish_at, view_count, engagement_rate)", "example": "publish_at", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort field (publish_at, view_count, engagement_rate)", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "description": "Sort direction (asc, desc), default desc", "example": "desc", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort direction (asc, desc), default desc", "title": "Sort Order" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_YoutubeUserVideoInfoItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "video_id": "hTSaweR8qMI", "video_url": "https://www.youtube.com/watch?v=hTSaweR8qMI", "title": "$1 vs $500,000 Romantic Date", "description": "Experiencing all of this was incredible\nBuy Feastables! It tastes amazing and it's ethically sourced 👉 https://fstbls.com/5mj6dv\n\nNew Merch - https://mrbeast.store\n\nCheck out Viewstats! - https://www.viewstats.com/\n\nSUBSCRIBE OR I TAKE YOUR DOG\n╔═╦╗╔╦╗╔═╦═╦╦╦╦╗╔═╗\n║╚╣║║║╚╣╚╣╔╣╔╣║╚╣═╣ \n╠╗║╚╝║║╠╗║╚╣║║║║║═╣\n╚═╩══╩═╩═╩═╩╝╚╩═╩═╝\n\nFor any questions or inquiries regarding this video, please reach out to chucky@mrbeastbusiness.com\n\n----------------------------------------------------------------\nfollow all of these or i will kick you\n• Facebook - https://www.facebook.com/MrBeast/\n• Twitter - https://twitter.com/MrBeast\n• Instagram - https://www.instagram.com/mrbeast\n• Im Hiring! - https://www.mrbeastjobs.com/\n--------------------------------------------------------------------", "cover_url": "https://img.scrumball.cn/FskvLUVwLC3ka5xax-Tw1APV80on?imageView2/2/w/300", "publish_at": "2025-06-08 00:00:00", "duration_second": 1042, "like_count": 1892706, "comment_count": 37838, "view_count": 51032102, "video_type": "video", "like_rate": "0.04", "view_subscriber_rate": "0.13", "engagement_rate": "3.78", "channel_title": "MrBeast", "channel_url": "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA", "channel_subscriber_count": 403000000, "last_update_at": "2025-06-10 00:06:48" } ], "total": 293, "page": 1, "page_size": 1, "total_pages": 293 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/brands": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Brand Deals", "description": "Returns the brands detected in a YouTube creator's sponsored content, with how often and how recently each appeared. This is a higher-cost analytics endpoint; see the quota note below.", "operationId": "youtube_user_brands", "externalDocs": { "description": "Get YouTube Creator Brand Deals - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-brand-deals" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Items per page", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_VideoBrandCollaborationItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "brand_name": "string", "collaboration_count": 0, "last_collaboration_at": "string", "engagement_rate": "string", "total_view_count": 0, "total_like_count": 0, "total_comment_count": 0, "videos": [ { "video_id": "string", "title": "string", "description": "string", "cover_url": "string", "video_url": "string", "publish_at": "string", "view_count": 0, "like_count": 0, "comment_count": 0, "engagement_rate": 0 } ] } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/similar": { "get": { "tags": [ "youtube" ], "summary": "Find Similar YouTube Creators", "description": "Given one YouTube creator, returns a ranked list of accounts with a comparable audience, size and content style, each with a similarity score and summary metrics. Higher quota cost than a plain profile read.", "operationId": "youtube_user_similar", "externalDocs": { "description": "Find Similar YouTube Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/find-similar-youtube-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": false, "description": "channel_id", "example": "UCUFgkRb0ZHc4Rpq15VRCICA", "schema": { "type": "string", "description": "channel_id", "default": "", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_YoutubeUserSimilarItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "channel_id": "UClNwztERQAfHAb9zKWuelAg", "title": "Cleaning The Dirtiest", "avatar": "https://img.scrumball.cn/FjZ6BIztbbmQPMxKixn16DvwoCH3", "description": "Cleaning The Dirtiest. ", "subscriber_count": 2110000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/realtime/user/info": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Profile (Realtime)", "description": "Collects a YouTube creator's profile directly from the platform at request time instead of reading the persisted database. Use it when freshness matters more than throughput; realtime calls consume more quota than database reads.", "operationId": "youtube_realtime_user_info", "externalDocs": { "description": "Get YouTube Creator Profile (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-profile-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": false, "description": "channel_id", "example": "UCUFgkRb0ZHc4Rpq15VRCICA", "schema": { "type": "string", "description": "channel_id", "default": "", "title": "Channel Id" } }, { "name": "username", "in": "query", "required": false, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "default": "", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeYoutubeUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "channel_id": "string", "username": "string", "title": "string", "profile_url": "string", "avatar": "string", "description": "string", "subscriber_count": 0, "video_count": 0, "country": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/realtime/user/videos": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Videos (Realtime)", "description": "Fetches a creator's most recent videos straight from YouTube at request time. Use it for content published in the last hours or when the database copy is stale; realtime collection costs more quota than a database read.", "operationId": "youtube_realtime_user_videos", "externalDocs": { "description": "Get YouTube Creator Videos (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-videos-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "channel_id", "example": "UCUFgkRb0ZHc4Rpq15VRCICA", "schema": { "type": "string", "description": "channel_id", "title": "Channel Id" } }, { "name": "offset", "in": "query", "required": false, "description": "offset", "schema": { "type": "string", "description": "offset", "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeYoutubeUserVideosRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "videos": [ { "video_id": "string", "title": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "channel_title": "string", "channel_id": "string" } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/realtime/video/detail": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Video Details (Realtime)", "description": "Collects one YouTube video directly from the platform and returns its full metadata and engagement counters as of the call. Suited to tracking individual pieces of content rather than whole accounts.", "operationId": "youtube_realtime_video_detail", "externalDocs": { "description": "Get YouTube Video Details (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-video-details-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "video_id", "example": "Sv6dMFF_yts", "schema": { "type": "string", "description": "video_id", "title": "Video Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_RealTimeYoutubeVideoInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "video_id": "string", "title": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "duration": "string", "video_url": "string", "cover_url": "string", "channel_title": "string", "channel_id": "string", "video_type": "string", "category_id": 0, "caption": true, "like_count": 0, "comment_count": 0, "play_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/monitor/metrics": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Creator Growth Metrics", "description": "Returns a time series of a YouTube creator's key metrics — followers, content count and engagement — over a chosen date range, built from daily monitoring snapshots. Higher quota cost than a single profile read.", "operationId": "youtube_user_monitor_metrics", "externalDocs": { "description": "Get YouTube Creator Growth Metrics - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-creator-growth-metrics" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "period", "in": "query", "required": false, "description": "Period (last_31_days, monthly)", "example": "last_31_days", "schema": { "type": "string", "description": "Period (last_31_days, monthly)", "default": "last_31_days", "title": "Period" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_YoutubeUserMonitorMetricsRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "date": "2025-11-02", "subscriber_count": 121000000 }, { "date": "2025-11-03", "subscriber_count": 121000000 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/youtube/user/hashtag/engagement": { "get": { "tags": [ "youtube" ], "summary": "Get YouTube Hashtag Engagement Data", "description": "Engagement data for the top 10 hashtags in the user's recent videos", "operationId": "youtube_user_hashtag_engagement", "externalDocs": { "description": "Get YouTube Hashtag Engagement Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/youtube/get-youtube-hashtag-engagement" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCbCmjCuTUZos6Inko4u57UQ", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_KolHashtagEngagementRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "hashtag": "#Clips", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" }, { "hashtag": "#Felix", "frequency": 10, "engagement_rate_median": "7.89%", "engagement_rate_mean": "8.09%", "views_median": 26817, "interactions_median": "2548.50", "interactions_total": 27655, "grade": "A" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/youtube/user": { "post": { "tags": [ "search" ], "summary": "Search YouTube Creators", "description": "Runs a filtered search over the YouTube creator database and returns matching accounts with summary metrics, paginated. Combine filters to narrow down by niche, size and geography. Search requests carry a higher quota cost than single lookups.", "operationId": "search_youtube_user", "externalDocs": { "description": "Search YouTube Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-youtube-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchYoutubeUserReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "category_ids": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "sort_by": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchYoutubeUserRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "channel_id": "string", "title": "string", "username": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_comment_count": "string", "avg_like_count": "string", "avg_play_count": "string", "video_count": 0, "last_publish_at": "string", "recent_month_publish_count": 0, "recent_week_publish_count": 0, "last_video": { "video_id": "string", "title": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "like_count": 0, "comment_count": 0, "play_count": 0 }, "evaluation_min": "string", "evaluation_max": "string" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/youtube/video": { "post": { "tags": [ "search" ], "summary": "Search YouTube Videos", "description": "Runs a filtered search over indexed YouTube videos and returns matches with their creator and engagement counters, paginated. Search requests carry a higher quota cost than single lookups.", "operationId": "search_youtube_video", "externalDocs": { "description": "Search YouTube Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-youtube-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchYoutubeVideoReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "categorys": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "engagement_rate_min": 0, "engagement_rate_max": 0, "comment_count_min": 0, "comment_count_max": 0, "like_count_min": 0, "like_count_max": 0, "play_count_min": 0, "play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "creative_form": 0, "unique_author": 0, "channel_id": "string", "video_type": 0, "duration_min": 0, "duration_max": 0, "sort_by": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchYoutubeVideoRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "video_id": "string", "title": "string", "description": "string", "cover_url": "string", "create_at": "2019-08-24T14:15:22.123Z", "duration": "string", "video_url": "string", "channel_title": "string", "channel_id": "string", "channel_avatar": "string", "channel_follower_count": 0, "video_type": "string", "category_id": 0, "like_count": 0, "comment_count": 0, "play_count": 0, "engagement_rate": "string", "channel": { "channel_id": "string", "title": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_play_count": "string", "video_count": 0, "evaluation_min": "string", "evaluation_max": "string" } } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/tiktok/user": { "post": { "tags": [ "search" ], "summary": "Search TikTok Creators", "description": "Runs a filtered search over the TikTok creator database and returns matching accounts with summary metrics, paginated. Combine filters to narrow down by niche, size and geography. Search requests carry a higher quota cost than single lookups.", "operationId": "search_tiktok_user", "externalDocs": { "description": "Search TikTok Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-tiktok-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTiktokUserReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "category_ids": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "sort_by": "string", "has_product": 0 } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchTiktokUserRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "author_uid": "string", "author_unique_id": "string", "author_nickname": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_comment_count": "string", "avg_like_count": "string", "avg_play_count": "string", "video_count": 0, "last_publish_at": "string", "recent_month_publish_count": 0, "recent_week_publish_count": 0, "last_video": { "video_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "share_count": 0, "like_count": 0, "comment_count": 0, "play_count": 0 }, "evaluation_min": "string", "evaluation_max": "string" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/tiktok/video": { "post": { "tags": [ "search" ], "summary": "Search TikTok Videos", "description": "Runs a filtered search over indexed TikTok videos and returns matches with their creator and engagement counters, paginated. Search requests carry a higher quota cost than single lookups.", "operationId": "search_tiktok_video", "externalDocs": { "description": "Search TikTok Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-tiktok-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTiktokVideoReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "categorys": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "engagement_rate_min": 0, "engagement_rate_max": 0, "comment_count_min": 0, "comment_count_max": 0, "like_count_min": 0, "like_count_max": 0, "play_count_min": 0, "play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "creative_form": 0, "unique_author": 0, "author_unique_id": "string", "has_product": 0, "duration_min": 0, "duration_max": 0, "sort_by": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchTiktokVideoRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "video_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "author_uid": "string", "author_unique_id": "string", "author_nickname": "string", "author_avatar": "string", "author_follower_count": 0, "language": "string", "region": "string", "cover_url": "string", "duration": "string", "share_count": 0, "like_count": 0, "comment_count": 0, "play_count": 0, "engagement_rate": "string", "author": { "author_uid": "string", "author_unique_id": "string", "author_nickname": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_play_count": "string", "video_count": 0, "evaluation_min": "string", "evaluation_max": "string" } } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/instagram/user": { "post": { "tags": [ "search" ], "summary": "Search Instagram Creators", "description": "Runs a filtered search over the Instagram creator database and returns matching accounts with summary metrics, paginated. Combine filters to narrow down by niche, size and geography. Search requests carry a higher quota cost than single lookups.", "operationId": "search_instagram_user", "externalDocs": { "description": "Search Instagram Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-instagram-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInstagramUserReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "category_ids": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "sort_by": "string", "avg_engagement_count_min": 0, "avg_engagement_count_max": 0, "avg_video_engagement_rate_min": 0, "avg_video_engagement_rate_max": 0 } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchInstagramUserRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "user_id": "string", "username": "string", "full_name": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_video_engagement_rate": "string", "avg_comment_count": "string", "avg_like_count": "string", "avg_play_count": "string", "video_count": 0, "last_publish_at": "string", "recent_month_publish_count": 0, "recent_week_publish_count": 0, "last_media": { "media_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "like_count": 0, "comment_count": 0, "play_count": 0 }, "evaluation_min": "string", "evaluation_max": "string" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/instagram/media": { "post": { "tags": [ "search" ], "summary": "Search Instagram Posts", "description": "Runs a filtered search over indexed Instagram posts and returns matches with their creator and engagement counters, paginated. Search requests carry a higher quota cost than single lookups.", "operationId": "search_instagram_media", "externalDocs": { "description": "Search Instagram Posts - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-instagram-posts" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInstagramMediaReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "categorys": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "engagement_rate_min": 0, "engagement_rate_max": 0, "comment_count_min": 0, "comment_count_max": 0, "like_count_min": 0, "like_count_max": 0, "play_count_min": 0, "play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "creative_form": 0, "unique_author": 0, "author_username": "string", "media_type": 0, "avg_engagement_count_min": 0, "avg_engagement_count_max": 0, "avg_video_engagement_rate_min": 0, "avg_video_engagement_rate_max": 0, "sort_by": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchInstagramMediaRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "author_user_id": "string", "author_username": "string", "author_avatar": "string", "author_follower_count": 0, "media_id": "string", "create_at": "2019-08-24T14:15:22.123Z", "description": "string", "media_url": "string", "cover_url": "string", "language": "string", "region": "string", "media_type": 0, "like_count": 0, "comment_count": 0, "play_count": 0, "engagement_count": 0, "engagement_rate": "string", "author": { "user_id": "string", "username": "string", "full_name": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_video_engagement_rate": "string", "avg_like_count": "string", "media_count": 0, "evaluation_min": "string", "evaluation_max": "string" } } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/categories": { "get": { "tags": [ "search" ], "summary": "Get Creator Category Tree", "description": "Returns the hierarchical category taxonomy Scrumball assigns to creators, with parent and child ids. Category ids are accepted by the creator search endpoints on every platform.", "operationId": "get_categories", "externalDocs": { "description": "Get Creator Category Tree - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/get-creator-categories" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_CategoryTreeNode__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "id": 9001, "zh_name": "Beauty & personal care", "en_name": "Beauty & Personal Care", "level": 1, "selectable": false, "children": [ {} ] } ] } } } } } } }, "/api/v1/search/x/user": { "post": { "tags": [ "search" ], "summary": "Search X Creators", "description": "Runs a filtered search over the X creator database and returns matching accounts with summary metrics, paginated. Combine filters to narrow down by niche, size and geography. Search requests carry a higher quota cost than single lookups.", "operationId": "search_x_user", "externalDocs": { "description": "Search X Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-x-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchXUserReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "category_ids": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "sort_by": "string", "avg_engagement_count_min": 0, "avg_engagement_count_max": 0, "avg_video_engagement_rate_min": 0, "avg_video_engagement_rate_max": 0, "verified": 0, "retweet_ratio_max": 0 } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchXUserRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "user_id": "string", "username": "string", "full_name": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "is_verified": true, "avg_engagement_rate": "string", "avg_video_engagement_rate": "string", "avg_comment_count": "string", "avg_like_count": "string", "avg_retweet_count": "string", "avg_view_count": "string", "retweet_ratio": "string", "reply_ratio": "string", "post_count": 0, "video_count": 0, "last_publish_at": "string", "recent_month_publish_count": 0, "recent_week_publish_count": 0, "last_post": { "post_id": "string", "description": "string", "create_at": "2019-08-24T14:15:22.123Z", "cover_url": "string", "like_count": 0, "comment_count": 0, "retweet_count": 0, "view_count": 0 }, "evaluation_min": "string", "evaluation_max": "string" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/search/x/post": { "post": { "tags": [ "search" ], "summary": "Search X Posts", "description": "X timelines contain many reposts; pass `exclude_retweet=1` or `post_type=1` for an original-only view.", "operationId": "search_x_post", "externalDocs": { "description": "Search X Posts - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/search/search-x-posts" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchXPostReq" }, "example": { "page": 1, "page_size": 20, "query": "string", "categorys": [ 0 ], "locations": [ "string" ], "follower_count_min": 0, "follower_count_max": 0, "create_at_start": "2019-08-24T14:15:22.123Z", "create_at_end": "2019-08-24T14:15:22.123Z", "avg_engagement_rate_min": 0, "avg_engagement_rate_max": 0, "avg_comment_count_min": 0, "avg_comment_count_max": 0, "avg_like_count_min": 0, "avg_like_count_max": 0, "avg_play_count_min": 0, "avg_play_count_max": 0, "engagement_rate_min": 0, "engagement_rate_max": 0, "comment_count_min": 0, "comment_count_max": 0, "like_count_min": 0, "like_count_max": 0, "play_count_min": 0, "play_count_max": 0, "gender": 0, "recent_month_publish_count_min": 0, "recent_month_publish_count_max": 0, "has_email": 0, "languages": [ "string" ], "creative_form": 0, "unique_author": 0, "author_username": "string", "media_type": 0, "post_type": 0, "exclude_retweet": 0, "avg_engagement_count_min": 0, "avg_engagement_count_max": 0, "avg_video_engagement_rate_min": 0, "avg_video_engagement_rate_max": 0, "sort_by": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_SearchXPostRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "author_user_id": "string", "author_username": "string", "author_avatar": "string", "author_follower_count": 0, "post_id": "string", "create_at": "2019-08-24T14:15:22.123Z", "description": "string", "post_url": "string", "cover_url": "string", "video_url": "string", "language": "string", "region": "string", "media_type": 0, "post_type": 0, "is_retweet": true, "is_quote": true, "is_reply": true, "like_count": 0, "comment_count": 0, "retweet_count": 0, "quote_count": 0, "bookmark_count": 0, "view_count": 0, "engagement_count": 0, "engagement_rate": "string", "author": { "user_id": "string", "username": "string", "full_name": "string", "avatar": "string", "country": "string", "gender": "string", "follower_count": 0, "avg_engagement_rate": "string", "avg_video_engagement_rate": "string", "avg_like_count": "string", "post_count": 0, "evaluation_min": "string", "evaluation_max": "string" } } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/geography": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Geography", "description": "Returns the geographic distribution of a YouTube creator's followers, ranked by country and by city. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_geography", "externalDocs": { "description": "Get YouTube Audience Geography - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-geography" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "US": "43.99%", "IN": "15.07%", "GB": "9.76%", "CA": "8.63%", "AU": "5.18%", "DE": "4.41%", "FR": "3.79%", "MX": "3.66%", "BR": "3.16%", "JP": "2.35%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/language": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Languages", "description": "Returns the language distribution of a YouTube creator's followers. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_language", "externalDocs": { "description": "Get YouTube Audience Languages - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-language" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "en": "71.01%", "hi": "10.86%", "es": "8.94%", "pt": "5.17%", "de": "4.02%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/age": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Age Split", "description": "Returns the share of a YouTube creator's followers in each age bracket, derived from audience analysis. Audience insight endpoints are premium and carry a higher per-request quota cost.", "operationId": "audience_youtube_age", "externalDocs": { "description": "Get YouTube Audience Age Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-age" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": "20.04%", "18-24": "29.06%", "25-34": "24.27%", "35-44": "10.16%", "45-54": "8.28%", "55-64": "4.62%", "65+": "3.57%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/gender": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Gender Split", "description": "Returns the male / female share of a YouTube creator's followers within each age bracket. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_gender", "externalDocs": { "description": "Get YouTube Audience Gender Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-gender" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__Dict_str__str___" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": { "female": "55.45%", "male": "44.55%" }, "18-24": { "female": "50.76%", "male": "49.24%" }, "25-34": { "female": "45.90%", "male": "54.10%" }, "35-44": { "female": "40.48%", "male": "59.52%" }, "45-54": { "female": "35.73%", "male": "64.27%" }, "55-64": { "female": "30.97%", "male": "69.03%" }, "65+": { "female": "25.46%", "male": "74.54%" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/gender_overall": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Overall Gender Ratio", "description": "Returns one aggregated gender ratio for a YouTube creator's whole audience, without the age breakdown. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_gender_overall", "externalDocs": { "description": "Get YouTube Overall Gender Ratio - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-gender-overall" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "female": "50.00%", "male": "50.00%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/interest": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Interests", "description": "Returns the interest tags attributed to a YouTube creator's followers, with the share of the audience in each. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_interest", "externalDocs": { "description": "Get YouTube Audience Interests - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-interest" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInterestItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "interest": "Philanthropy", "value": "30.00", "illustration": "The audience is drawn to MrBeast's charitable acts, such as planting trees and helping those in need." }, { "interest": "Extreme Challenges", "value": "25.00", "illustration": "Viewers enjoy watching extreme challenges like surviving in harsh conditions or competing for large prizes." }, { "interest": "Gaming", "value": "20.00", "illustration": "Many fans are interested in gaming content, especially with MrBeast Gaming videos featuring popular games." }, { "interest": "Entertainment", "value": "15.00", "illustration": "The audience loves entertaining content that includes humor, surprises, and engaging storytelling." }, { "interest": "Food and Snacks", "value": "10.00", "illustration": "'Feastables' and food-related giveaways attract viewers who enjoy culinary experiences and unique snacks." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/interactive_behavior": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Audience Behavior", "description": "Returns behavioural metrics for a YouTube creator's audience: interaction rates by type, active hours and engagement depth. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_interactive_behavior", "externalDocs": { "description": "Get YouTube Audience Behavior - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-interactive-behavior" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInteractiveBehaviorItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "role": "Viewer", "value": "60.00", "demographic": "Primarily young adults and teenagers who enjoy entertaining content." }, { "role": "Content Creator", "value": "25.00", "demographic": "Individuals creating similar engaging videos or aspiring YouTubers." }, { "role": "Brand Collaborator", "value": "15.00", "demographic": "Companies looking to partner for promotions and sponsorships in videos." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/brand_opportunities": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Brand Fit Analysis", "description": "Analyses a YouTube creator's audience and content to score the fit with brand categories and outline promising marketing paths. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_brand_opportunities", "externalDocs": { "description": "Get YouTube Brand Fit Analysis - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-brand-opportunities" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceBrandOpportunitiesItem_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "audience_quality": { "real": { "score": "90.00", "reason": "Analysis shows high engagement rates with meaningful comments indicating authentic follower interaction across multiple videos." }, "interested": { "score": "75.00", "reason": "75% of comments discuss specific video features or express interest in related products, indicating strong purchase intent." }, "positive": { "score": "85.00", "reason": "Majority of comments reflect admiration for MrBeast's generosity and creativity, contributing to an overwhelmingly positive sentiment." } }, "purchase_influence": { "expertise": { "score": "4.70", "reason": "'Buy Feastables! It tastes amazing' effectively promotes products with engaging visuals and personal endorsements throughout videos." }, "credibility": { "score": "4.50", "reason": "High trust established through transparency about sponsorships, though some comments express skepticism about product authenticity." }, "likability": { "score": "4.80", "reason": "Strong positive engagement with followers through humor and relatability fosters a loyal community eager to support." } }, "personality_assessment": [ { "emoji": "🌟", "name": "Generosity", "persona": "Consistently engages in philanthropic activities, positively impacting communities and inspiring followers to contribute." }, { "emoji": "🎉", "name": "Creativity", "persona": "Innovatively designs entertaining content that captivates a wide audience, showcasing unique challenges and experiences." }, { "emoji": "⚠️", "name": "Controversial Stunts", "persona": "Occasionally engages in extreme challenges that may raise safety concerns or ethical questions among viewers." } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/content_style": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Creator Content Style", "description": "Classifies a YouTube creator's recent content into style dimensions and summarises the personality they project to their audience. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_content_style", "externalDocs": { "description": "Get YouTube Creator Content Style - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-content-style" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceContentStyleItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "Celebrity", "desc": "MrBeast is at the pinnacle of influence with a massive subscriber count and high engagement rates. His content spreads widely, and his audience is highly engaged, showing characteristics of a celebrity influencer. His followers are deeply invested in his content, and his influence extends globally." }, { "name": "Activist", "desc": "MrBeast demonstrates a strong commitment to philanthropy and social impact projects, which resonates deeply with his audience. His charitable acts and community-focused initiatives align with the traits of an activist influencer, as he actively champions causes and engages his audience in meaningful ways." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/follower_authenticity": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Follower Authenticity", "description": "Returns an authenticity assessment of a YouTube creator's follower base: the share of genuine, suspicious and inactive accounts plus an overall quality score. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_follower_authenticity", "externalDocs": { "description": "Get YouTube Follower Authenticity - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-follower-authenticity" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceFollowerAuthenticityRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "real": "90%", "fake": "10%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/youtube/rating_tier": { "get": { "tags": [ "audience" ], "summary": "Get YouTube Creator Rating Tier", "description": "Returns the tier assigned to a YouTube creator by Scrumball's rating model, together with the component scores behind it. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_youtube_rating_tier", "externalDocs": { "description": "Get YouTube Creator Rating Tier - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-youtube-rating-tier" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "channel_id", "in": "query", "required": true, "description": "Channel ID", "example": "UCX6OQ3DkcsbYNE6H8uQQuVA", "schema": { "type": "string", "description": "Channel ID", "title": "Channel Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceRatingTierRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "rating_tier": "HIGH" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/geography": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Geography", "description": "Returns the geographic distribution of a TikTok creator's followers, ranked by country and by city. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_geography", "externalDocs": { "description": "Get TikTok Audience Geography - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-geography" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "US": "43.99%", "IN": "15.07%", "GB": "9.76%", "CA": "8.63%", "AU": "5.18%", "DE": "4.41%", "FR": "3.79%", "MX": "3.66%", "BR": "3.16%", "JP": "2.35%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/language": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Languages", "description": "Returns the language distribution of a TikTok creator's followers. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_language", "externalDocs": { "description": "Get TikTok Audience Languages - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-language" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "en": "71.01%", "hi": "10.86%", "es": "8.94%", "pt": "5.17%", "de": "4.02%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/age": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Age Split", "description": "Returns the share of a TikTok creator's followers in each age bracket, derived from audience analysis. Audience insight endpoints are premium and carry a higher per-request quota cost.", "operationId": "audience_tiktok_age", "externalDocs": { "description": "Get TikTok Audience Age Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-age" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": "20.04%", "18-24": "29.06%", "25-34": "24.27%", "35-44": "10.16%", "45-54": "8.28%", "55-64": "4.62%", "65+": "3.57%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/gender": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Gender Split", "description": "Returns the male / female share of a TikTok creator's followers within each age bracket. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_gender", "externalDocs": { "description": "Get TikTok Audience Gender Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-gender" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__Dict_str__str___" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": { "female": "55.45%", "male": "44.55%" }, "18-24": { "female": "50.76%", "male": "49.24%" }, "25-34": { "female": "45.90%", "male": "54.10%" }, "35-44": { "female": "40.48%", "male": "59.52%" }, "45-54": { "female": "35.73%", "male": "64.27%" }, "55-64": { "female": "30.97%", "male": "69.03%" }, "65+": { "female": "25.46%", "male": "74.54%" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/gender_overall": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Overall Gender Ratio", "description": "Returns one aggregated gender ratio for a TikTok creator's whole audience, without the age breakdown. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_gender_overall", "externalDocs": { "description": "Get TikTok Overall Gender Ratio - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-gender-overall" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "female": "50.00%", "male": "50.00%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/interest": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Interests", "description": "Returns the interest tags attributed to a TikTok creator's followers, with the share of the audience in each. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_interest", "externalDocs": { "description": "Get TikTok Audience Interests - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-interest" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInterestItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "interest": "Philanthropy", "value": "30.00", "illustration": "The audience is drawn to MrBeast's charitable acts, such as planting trees and helping those in need." }, { "interest": "Extreme Challenges", "value": "25.00", "illustration": "Viewers enjoy watching extreme challenges like surviving in harsh conditions or competing for large prizes." }, { "interest": "Gaming", "value": "20.00", "illustration": "Many fans are interested in gaming content, especially with MrBeast Gaming videos featuring popular games." }, { "interest": "Entertainment", "value": "15.00", "illustration": "The audience loves entertaining content that includes humor, surprises, and engaging storytelling." }, { "interest": "Food and Snacks", "value": "10.00", "illustration": "'Feastables' and food-related giveaways attract viewers who enjoy culinary experiences and unique snacks." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/interactive_behavior": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Behavior", "description": "Returns behavioural metrics for a TikTok creator's audience: interaction rates by type, active hours and engagement depth. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_interactive_behavior", "externalDocs": { "description": "Get TikTok Audience Behavior - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-interactive-behavior" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInteractiveBehaviorItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "role": "Viewer", "value": "60.00", "demographic": "Primarily young adults and teenagers who enjoy entertaining content." }, { "role": "Content Creator", "value": "25.00", "demographic": "Individuals creating similar engaging videos or aspiring YouTubers." }, { "role": "Brand Collaborator", "value": "15.00", "demographic": "Companies looking to partner for promotions and sponsorships in videos." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/brand_opportunities": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Brand Fit Analysis", "description": "Analyses a TikTok creator's audience and content to score the fit with brand categories and outline promising marketing paths. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_brand_opportunities", "externalDocs": { "description": "Get TikTok Brand Fit Analysis - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-brand-opportunities" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceBrandOpportunitiesItem_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "audience_quality": { "real": { "score": "68.50", "reason": "Mixed authenticity with notable spam but also genuine fan interactions." }, "interested": { "score": "52.00", "reason": "Moderate product interest with some detailed inquiries amid generic reactions." }, "positive": { "score": "82.70", "reason": "Predominantly upbeat sentiment though diluted by repetitive/spammy comments." } }, "purchase_influence": { "expertise": { "score": "4.30", "reason": "High-quality product showcases with detailed features but lacks consistent demonstration depth." }, "credibility": { "score": "4.00", "reason": "Strong brand trust but occasional skepticism over sponsorship transparency in comments." }, "likability": { "score": "4.50", "reason": "Exceptional audience rapport with frequent positive interactions and community-building efforts." } }, "personality_assessment": [ { "emoji": "🏆", "name": "Inspirational", "persona": "Consistently motivates and uplifts followers with high-energy content and positive messaging." }, { "emoji": "🌍", "name": "Global Appeal", "persona": "Engages a diverse international audience with culturally inclusive content and multilingual interactions." }, { "emoji": "⚠️", "name": "Controversial", "persona": "Occasionally sparks debates or receives negative comments due to polarizing content or brand stances." } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/device": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Audience Devices", "description": "Returns the share of a TikTok creator's audience on each device type and operating system. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_device", "externalDocs": { "description": "Get TikTok Audience Devices - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-device" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceDevicePercentageItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "ios", "value": "0.4365" }, { "name": "android", "value": "0.5635" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/content_style": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Creator Content Style", "description": "Classifies a TikTok creator's recent content into style dimensions and summarises the personality they project to their audience. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_content_style", "externalDocs": { "description": "Get TikTok Creator Content Style - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-content-style" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceContentStyleItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "Announcer", "desc": "Nike fits the Announcer personality type because they broadcast great content that spreads widely, especially around major events like Breaking4. Their broad, diverse audience values their content, and they serve as an important source of information in the sports and fitness industry." }, { "name": "Tastemaker", "desc": "Nike also aligns with the Tastemaker personality type as they know what their audience likes and don't just follow trends—they set them. Their content, from sneaker releases to athlete showcases, earns respect and engagement from their network, demonstrating their ability to influence and lead in their niche." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/follower_authenticity": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Follower Authenticity", "description": "Returns an authenticity assessment of a TikTok creator's follower base: the share of genuine, suspicious and inactive accounts plus an overall quality score. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_follower_authenticity", "externalDocs": { "description": "Get TikTok Follower Authenticity - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-follower-authenticity" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceFollowerAuthenticityRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "real": "90%", "fake": "10%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/tiktok/rating_tier": { "get": { "tags": [ "audience" ], "summary": "Get TikTok Creator Rating Tier", "description": "Returns the tier assigned to a TikTok creator by Scrumball's rating model, together with the component scores behind it. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_tiktok_rating_tier", "externalDocs": { "description": "Get TikTok Creator Rating Tier - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-tiktok-rating-tier" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "unique_id", "in": "query", "required": true, "description": "unique_id", "example": "nike", "schema": { "type": "string", "description": "unique_id", "title": "Unique Id" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceRatingTierRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "rating_tier": "HIGH" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/geography": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Geography", "description": "Returns the geographic distribution of a Instagram creator's followers, ranked by country and by city. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_geography", "externalDocs": { "description": "Get Instagram Audience Geography - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-geography" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "US": "43.99%", "IN": "15.07%", "GB": "9.76%", "CA": "8.63%", "AU": "5.18%", "DE": "4.41%", "FR": "3.79%", "MX": "3.66%", "BR": "3.16%", "JP": "2.35%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/language": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Languages", "description": "Returns the language distribution of a Instagram creator's followers. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_language", "externalDocs": { "description": "Get Instagram Audience Languages - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-language" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "en": "71.01%", "hi": "10.86%", "es": "8.94%", "pt": "5.17%", "de": "4.02%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/age": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Age Split", "description": "Returns the share of a Instagram creator's followers in each age bracket, derived from audience analysis. Audience insight endpoints are premium and carry a higher per-request quota cost.", "operationId": "audience_instagram_age", "externalDocs": { "description": "Get Instagram Audience Age Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-age" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": "20.04%", "18-24": "29.06%", "25-34": "24.27%", "35-44": "10.16%", "45-54": "8.28%", "55-64": "4.62%", "65+": "3.57%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/gender": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Gender Split", "description": "Returns the male / female share of a Instagram creator's followers within each age bracket. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_gender", "externalDocs": { "description": "Get Instagram Audience Gender Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-gender" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__Dict_str__str___" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": { "female": "55.45%", "male": "44.55%" }, "18-24": { "female": "50.76%", "male": "49.24%" }, "25-34": { "female": "45.90%", "male": "54.10%" }, "35-44": { "female": "40.48%", "male": "59.52%" }, "45-54": { "female": "35.73%", "male": "64.27%" }, "55-64": { "female": "30.97%", "male": "69.03%" }, "65+": { "female": "25.46%", "male": "74.54%" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/gender_overall": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Overall Gender Ratio", "description": "Returns one aggregated gender ratio for a Instagram creator's whole audience, without the age breakdown. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_gender_overall", "externalDocs": { "description": "Get Instagram Overall Gender Ratio - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-gender-overall" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "female": "50.00%", "male": "50.00%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/interest": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Interests", "description": "Returns the interest tags attributed to a Instagram creator's followers, with the share of the audience in each. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_interest", "externalDocs": { "description": "Get Instagram Audience Interests - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-interest" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInterestItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "interest": "Philanthropy", "value": "30.00", "illustration": "The audience is drawn to MrBeast's charitable acts, such as planting trees and helping those in need." }, { "interest": "Extreme Challenges", "value": "25.00", "illustration": "Viewers enjoy watching extreme challenges like surviving in harsh conditions or competing for large prizes." }, { "interest": "Gaming", "value": "20.00", "illustration": "Many fans are interested in gaming content, especially with MrBeast Gaming videos featuring popular games." }, { "interest": "Entertainment", "value": "15.00", "illustration": "The audience loves entertaining content that includes humor, surprises, and engaging storytelling." }, { "interest": "Food and Snacks", "value": "10.00", "illustration": "'Feastables' and food-related giveaways attract viewers who enjoy culinary experiences and unique snacks." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/interactive_behavior": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Behavior", "description": "Returns behavioural metrics for a Instagram creator's audience: interaction rates by type, active hours and engagement depth. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_interactive_behavior", "externalDocs": { "description": "Get Instagram Audience Behavior - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-interactive-behavior" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInteractiveBehaviorItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "role": "Viewer", "value": "60.00", "demographic": "Primarily young adults and teenagers who enjoy entertaining content." }, { "role": "Content Creator", "value": "25.00", "demographic": "Individuals creating similar engaging videos or aspiring YouTubers." }, { "role": "Brand Collaborator", "value": "15.00", "demographic": "Companies looking to partner for promotions and sponsorships in videos." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/brand_opportunities": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Brand Fit Analysis", "description": "Analyses a Instagram creator's audience and content to score the fit with brand categories and outline promising marketing paths. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_brand_opportunities", "externalDocs": { "description": "Get Instagram Brand Fit Analysis - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-brand-opportunities" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceBrandOpportunitiesItem_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "audience_quality": { "real": { "score": "80.00", "reason": "Analysis shows that approximately 80% of comments are relevant and contextually engaged with Nike's content." }, "interested": { "score": "65.00", "reason": "65% of comments express interest in products or features, indicating a solid level of purchase intent." }, "positive": { "score": "70.00", "reason": "70% positive sentiment in comments suggests overall appreciation for Nike's branding efforts despite recent controversies." } }, "purchase_influence": { "expertise": { "score": "4.00", "reason": "'Breaking4' campaign effectively showcases product benefits through high-profile athlete endorsements, enhancing purchase intent." }, "credibility": { "score": "3.50", "reason": "'Nike's transparency in partnerships is commendable, but recent controversies have led to some skepticism among followers.'" }, "likability": { "score": "3.80", "reason": "'High engagement rates indicate positive community interaction; however, negative comments reflect divided opinions on brand actions.'" } }, "personality_assessment": [ { "emoji": "💪", "name": "Resilience", "persona": "Demonstrates strong perseverance and determination, inspiring followers to push their limits in sports and fitness." }, { "emoji": "🌍", "name": "Global Reach", "persona": "Engages a diverse audience across multiple cultures, promoting inclusivity and unity through sports." }, { "emoji": "⚠️", "name": "Controversial Stance", "persona": "Has faced backlash for political statements, leading to potential alienation of segments of the audience." } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/device": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Audience Devices", "description": "Returns the share of a Instagram creator's audience on each device type and operating system. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_device", "externalDocs": { "description": "Get Instagram Audience Devices - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-device" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceDevicePercentageItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "ios", "value": "0.4365" }, { "name": "android", "value": "0.5635" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/content_style": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Creator Content Style", "description": "Classifies a Instagram creator's recent content into style dimensions and summarises the personality they project to their audience. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_content_style", "externalDocs": { "description": "Get Instagram Creator Content Style - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-content-style" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceContentStyleItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "Announcer", "desc": "Nike fits the Announcer personality type because they broadcast great content that spreads widely, especially around major events like Breaking4. Their broad, diverse audience values their content, and they serve as an important source of information in the sports and fitness industry." }, { "name": "Tastemaker", "desc": "Nike also aligns with the Tastemaker personality type as they know what their audience likes and don't just follow trends—they set them. Their content, from sneaker releases to athlete showcases, earns respect and engagement from their network, demonstrating their ability to influence and lead in their niche." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/follower_authenticity": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Follower Authenticity", "description": "Returns an authenticity assessment of a Instagram creator's follower base: the share of genuine, suspicious and inactive accounts plus an overall quality score. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_follower_authenticity", "externalDocs": { "description": "Get Instagram Follower Authenticity - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-follower-authenticity" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceFollowerAuthenticityRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "real": "90%", "fake": "10%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/instagram/rating_tier": { "get": { "tags": [ "audience" ], "summary": "Get Instagram Creator Rating Tier", "description": "Returns the tier assigned to a Instagram creator by Scrumball's rating model, together with the component scores behind it. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_instagram_rating_tier", "externalDocs": { "description": "Get Instagram Creator Rating Tier - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-instagram-rating-tier" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "username", "example": "nike", "schema": { "type": "string", "description": "username", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceRatingTierRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "rating_tier": "HIGH" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/geography": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Geography", "description": "Returns the geographic distribution of a X creator's followers, ranked by country and by city. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_geography", "externalDocs": { "description": "Get X Audience Geography - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-geography" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "US": "43.99%", "IN": "15.07%", "GB": "9.76%", "CA": "8.63%", "AU": "5.18%", "DE": "4.41%", "FR": "3.79%", "MX": "3.66%", "BR": "3.16%", "JP": "2.35%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/language": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Languages", "description": "Returns the language distribution of a X creator's followers. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_language", "externalDocs": { "description": "Get X Audience Languages - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-language" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "en": "71.01%", "hi": "10.86%", "es": "8.94%", "pt": "5.17%", "de": "4.02%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/age": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Age Split", "description": "Returns the share of a X creator's followers in each age bracket, derived from audience analysis. Audience insight endpoints are premium and carry a higher per-request quota cost.", "operationId": "audience_x_age", "externalDocs": { "description": "Get X Audience Age Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-age" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": "20.04%", "18-24": "29.06%", "25-34": "24.27%", "35-44": "10.16%", "45-54": "8.28%", "55-64": "4.62%", "65+": "3.57%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/gender": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Gender Split", "description": "Returns the male / female share of a X creator's followers within each age bracket. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_gender", "externalDocs": { "description": "Get X Audience Gender Split - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-gender" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__Dict_str__str___" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "13-17": { "female": "55.45%", "male": "44.55%" }, "18-24": { "female": "50.76%", "male": "49.24%" }, "25-34": { "female": "45.90%", "male": "54.10%" }, "35-44": { "female": "40.48%", "male": "59.52%" }, "45-54": { "female": "35.73%", "male": "64.27%" }, "55-64": { "female": "30.97%", "male": "69.03%" }, "65+": { "female": "25.46%", "male": "74.54%" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/gender_overall": { "get": { "tags": [ "audience" ], "summary": "Get X Overall Gender Ratio", "description": "Returns one aggregated gender ratio for a X creator's whole audience, without the age breakdown. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_gender_overall", "externalDocs": { "description": "Get X Overall Gender Ratio - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-gender-overall" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Dict_str__str__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "female": "50.00%", "male": "50.00%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/interest": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Interests", "description": "Returns the interest tags attributed to a X creator's followers, with the share of the audience in each. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_interest", "externalDocs": { "description": "Get X Audience Interests - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-interest" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInterestItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "interest": "Philanthropy", "value": "30.00", "illustration": "The audience is drawn to MrBeast's charitable acts, such as planting trees and helping those in need." }, { "interest": "Extreme Challenges", "value": "25.00", "illustration": "Viewers enjoy watching extreme challenges like surviving in harsh conditions or competing for large prizes." }, { "interest": "Gaming", "value": "20.00", "illustration": "Many fans are interested in gaming content, especially with MrBeast Gaming videos featuring popular games." }, { "interest": "Entertainment", "value": "15.00", "illustration": "The audience loves entertaining content that includes humor, surprises, and engaging storytelling." }, { "interest": "Food and Snacks", "value": "10.00", "illustration": "'Feastables' and food-related giveaways attract viewers who enjoy culinary experiences and unique snacks." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/interactive_behavior": { "get": { "tags": [ "audience" ], "summary": "Get X Audience Behavior", "description": "Returns behavioural metrics for a X creator's audience: interaction rates by type, active hours and engagement depth. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_interactive_behavior", "externalDocs": { "description": "Get X Audience Behavior - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-interactive-behavior" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceInteractiveBehaviorItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "role": "Viewer", "value": "60.00", "demographic": "Primarily young adults and teenagers who enjoy entertaining content." }, { "role": "Content Creator", "value": "25.00", "demographic": "Individuals creating similar engaging videos or aspiring YouTubers." }, { "role": "Brand Collaborator", "value": "15.00", "demographic": "Companies looking to partner for promotions and sponsorships in videos." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/brand_opportunities": { "get": { "tags": [ "audience" ], "summary": "Get X Brand Fit Analysis", "description": "Analyses a X creator's audience and content to score the fit with brand categories and outline promising marketing paths. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_brand_opportunities", "externalDocs": { "description": "Get X Brand Fit Analysis - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-brand-opportunities" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceBrandOpportunitiesItem_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "audience_quality": { "real": { "score": "80.00", "reason": "Analysis shows that approximately 80% of comments are relevant and contextually engaged with Nike's content." }, "interested": { "score": "65.00", "reason": "65% of comments express interest in products or features, indicating a solid level of purchase intent." }, "positive": { "score": "70.00", "reason": "70% positive sentiment in comments suggests overall appreciation for Nike's branding efforts despite recent controversies." } }, "purchase_influence": { "expertise": { "score": "4.00", "reason": "'Breaking4' campaign effectively showcases product benefits through high-profile athlete endorsements, enhancing purchase intent." }, "credibility": { "score": "3.50", "reason": "'Nike's transparency in partnerships is commendable, but recent controversies have led to some skepticism among followers.'" }, "likability": { "score": "3.80", "reason": "'High engagement rates indicate positive community interaction; however, negative comments reflect divided opinions on brand actions.'" } }, "personality_assessment": [ { "emoji": "💪", "name": "Resilience", "persona": "Demonstrates strong perseverance and determination, inspiring followers to push their limits in sports and fitness." }, { "emoji": "🌍", "name": "Global Reach", "persona": "Engages a diverse audience across multiple cultures, promoting inclusivity and unity through sports." }, { "emoji": "⚠️", "name": "Controversial Stance", "persona": "Has faced backlash for political statements, leading to potential alienation of segments of the audience." } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/content_style": { "get": { "tags": [ "audience" ], "summary": "Get X Creator Content Style", "description": "Classifies a X creator's recent content into style dimensions and summarises the personality they project to their audience. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_content_style", "externalDocs": { "description": "Get X Creator Content Style - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-content-style" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } }, { "name": "X-Language", "in": "header", "required": false, "description": "Language code, supported: en, zh-CN, ja, ko", "example": "en", "schema": { "type": "string", "description": "Language code, supported: en, zh-CN, ja, ko", "default": "en", "title": "X-Language" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_AudienceContentStyleItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "Announcer", "desc": "Nike fits the Announcer personality type because they broadcast great content that spreads widely, especially around major events like Breaking4. Their broad, diverse audience values their content, and they serve as an important source of information in the sports and fitness industry." }, { "name": "Tastemaker", "desc": "Nike also aligns with the Tastemaker personality type as they know what their audience likes and don't just follow trends—they set them. Their content, from sneaker releases to athlete showcases, earns respect and engagement from their network, demonstrating their ability to influence and lead in their niche." } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/follower_authenticity": { "get": { "tags": [ "audience" ], "summary": "Get X Follower Authenticity", "description": "Returns an authenticity assessment of a X creator's follower base: the share of genuine, suspicious and inactive accounts plus an overall quality score. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_follower_authenticity", "externalDocs": { "description": "Get X Follower Authenticity - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-follower-authenticity" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceFollowerAuthenticityRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "real": "90%", "fake": "10%" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/audience/x/rating_tier": { "get": { "tags": [ "audience" ], "summary": "Get X Creator Rating Tier", "description": "Returns the tier assigned to a X creator by Scrumball's rating model, together with the component scores behind it. Premium audience insight endpoint with a higher quota cost.", "operationId": "audience_x_rating_tier", "externalDocs": { "description": "Get X Creator Rating Tier - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/audience/get-x-rating-tier" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle(username)", "example": "nasa", "schema": { "type": "string", "description": "X handle(username)", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_AudienceRatingTierRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "rating_tier": "HIGH" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/user/info": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Creator Profile", "description": "Looks up a Twitch channel by login name or user id and returns its public profile fields.", "operationId": "twitch_user_info", "externalDocs": { "description": "Get Twitch Creator Profile - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-creator-profile" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_login", "in": "query", "required": false, "description": "user_login", "example": "ninja", "schema": { "type": "string", "description": "user_login", "title": "User Login" } }, { "name": "user_id", "in": "query", "required": false, "description": "user_id", "example": "35739604", "schema": { "type": "string", "description": "user_id", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchUserInfo_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user_id": "string", "user_login": "string", "display_name": "string", "profile_url": "string", "description": "string", "avatar": "string", "follower_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/user/videos": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Creator Videos", "description": "Returns a paginated list of a Twitch channel's videos, newest first, with the metadata needed to pick representative content.", "operationId": "twitch_user_videos", "externalDocs": { "description": "Get Twitch Creator Videos - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-creator-videos" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "user_id", "in": "query", "required": true, "description": "user_id", "example": "19571641", "schema": { "type": "string", "description": "user_id", "title": "User Id" } }, { "name": "offset", "in": "query", "required": false, "description": "offset", "schema": { "type": "string", "description": "offset", "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchUserVideos_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "videos": [ { "video_id": "string", "stream_id": "string", "user_id": "string", "user_login": "string", "user_name": "string", "title": "string", "description": "string", "created_at": "2019-08-24T14:15:22.123Z", "published_at": "2019-08-24T14:15:22.123Z", "url": "string", "thumbnail_url": "string", "viewable": "string", "view_count": 0, "language": "string", "type": "string", "duration": "string" } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/video/detail": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Video Details", "description": "Looks up one Twitch video by id and returns its metadata and current view count.", "operationId": "twitch_video_detail", "externalDocs": { "description": "Get Twitch Video Details - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-video-details" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "Video ID", "example": "2300924413", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchVideoInfo_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "video_id": "string", "stream_id": "string", "user_id": "string", "user_login": "string", "user_name": "string", "title": "string", "description": "string", "created_at": "2019-08-24T14:15:22.123Z", "published_at": "2019-08-24T14:15:22.123Z", "url": "string", "thumbnail_url": "string", "viewable": "string", "view_count": 0, "language": "string", "type": "string", "duration": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/video/badges/data": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Video Badge Data", "description": "Aggregates the badges of everyone who chatted during a video, giving a proxy for how much of the audience is subscribed or otherwise invested.", "operationId": "twitch_video_badges_data", "externalDocs": { "description": "Get Twitch Video Badge Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-video-badges" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "Video ID", "example": "2300924413", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchVideoBadgesDataRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "badges": [ { "id": "string", "set_id": "string", "version": "string", "title": "string", "image1x": "string", "image2x": "string", "image4x": "string", "click_action": "string", "click_url": "string" } ], "video": { "id": "string", "broadcast_type": "string", "length_seconds": 0, "owner": { "id": "string", "login": "string", "broadcast_badges": [ { "id": "string", "set_id": "string", "version": "string", "title": "string", "image1x": "string", "image2x": "string", "image4x": "string", "click_action": "string", "click_url": "string" } ] } } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/video/messages": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Video Chat Messages", "description": "Returns the recorded chat of a video in pages ordered by time, so reactions can be aligned with what happened on stream.", "operationId": "twitch_video_messages_page", "externalDocs": { "description": "Get Twitch Video Chat Messages - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-video-chat-messages" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "Video ID", "example": "2300924413", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TwitchVideoMessageRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "message_id": "string", "commenter_id": 0, "commenter_name": "string", "commenter_display_name": "string", "content_offset_seconds": 0, "created_at": "2019-08-24T14:15:22.123Z", "message_fragments": "string", "message_user_badges": "string", "message_user_color": "string" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/video/download/url": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Video Download URL", "description": "Resolves a video id to a downloadable media URL. URLs are time-limited; fetch a fresh one right before downloading.", "operationId": "twitch_video_download_url", "externalDocs": { "description": "Get Twitch Video Download URL - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-video-download-url" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "video_id", "in": "query", "required": true, "description": "Video ID", "example": "2300924413", "schema": { "type": "string", "description": "Video ID", "title": "Video Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_TwitchVideoDownloadUrlRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "name": "string", "url": "string" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/search/categories": { "post": { "tags": [ "twitch" ], "summary": "Search Twitch Categories", "description": "Returns matching Twitch categories with id, name and box art. Use the id in the live and channel search endpoints.", "operationId": "search_categories", "externalDocs": { "description": "Search Twitch Categories - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/search-twitch-categories" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwitchSearchCategoriesReq" }, "example": { "query": "string", "first": 20, "after": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchSearchCategoriesRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "data": [ { "box_art_url": "string", "id": 0, "name": "string" } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/search/channels": { "post": { "tags": [ "twitch" ], "summary": "Search Twitch Channels", "description": "Runs a keyword search over Twitch channels and returns matches with their live state and channel metadata, paginated.", "operationId": "search_channels", "externalDocs": { "description": "Search Twitch Channels - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/search-twitch-channels" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwitchSearchChannelsReq" }, "example": { "query": "string", "live_only": false, "first": 20, "after": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchSearchChannelsRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "data": [ { "id": "string", "broadcaster_language": "string", "broadcaster_login": "string", "display_name": "string", "game_id": "string", "game_name": "string", "is_live": true, "tags": [ "string" ], "thumbnail_url": "string", "title": "string", "started_at": "2019-08-24T14:15:22.123Z" } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/search/live": { "post": { "tags": [ "twitch" ], "summary": "Search Twitch Live Streams", "description": "Returns live broadcasts matching the filters, ordered by viewer count, with title, game and streamer details.", "operationId": "search_live", "externalDocs": { "description": "Search Twitch Live Streams - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/search-twitch-live-streams" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwitchSearchLiveReq" }, "example": { "user_id": "string", "user_login": "string", "game_id": "string", "type": "string", "language": "string", "first": 20, "before": "string", "after": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_TwitchSearchLiveRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "more": true, "offset": "string", "data": [ { "id": "string", "user_id": "string", "user_login": "string", "user_name": "string", "game_id": "string", "game_name": "string", "type": "string", "title": "string", "viewer_count": 0, "started_at": "2019-08-24T14:15:22.123Z", "language": "string", "thumbnail_url": "string", "tags": [ "string" ], "is_mature": true } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/monitor/user": { "post": { "tags": [ "twitch" ], "summary": "Create Twitch Live Monitor", "description": "Registers a streamer for live monitoring. While the task is active, each broadcast is captured together with periodic viewer-count samples, readable through the monitored-streams and viewer-trend endpoints.", "operationId": "twitch_monitor_user", "externalDocs": { "description": "Create Twitch Live Monitor - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/create-twitch-live-monitor" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TwitchMonitorUserReq" }, "example": { "monitor_url": "http://example.com", "monitor_start_time": "2019-08-24T14:15:22.123Z", "monitor_end_time": "2019-08-24T14:15:22.123Z" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_Union_str__NoneType__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/monitor/list": { "get": { "tags": [ "twitch" ], "summary": "List Twitch Monitor Tasks", "description": "Returns the monitoring tasks owned by your account so you can audit what is tracked and obtain monitor ids for the other Twitch monitoring endpoints.", "operationId": "twitch_monitor_task_list", "externalDocs": { "description": "List Twitch Monitor Tasks - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/list-twitch-monitor-tasks" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TwitchMonitorTaskRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "monitor_id": "string", "monitor_url": "string", "user_login": "string", "user_id": 0, "monitor_start_time": "2019-08-24T14:15:22.123Z", "monitor_end_time": "2019-08-24T14:15:22.123Z" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/monitor/live/list": { "get": { "tags": [ "twitch" ], "summary": "List Twitch Monitored Streams", "description": "Returns the broadcasts recorded for one monitor id, newest first, with summary audience figures for each.", "operationId": "twitch_get_monitor_live_list_by_monitor_id", "externalDocs": { "description": "List Twitch Monitored Streams - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/list-twitch-monitored-streams" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "monitor_id", "in": "query", "required": true, "description": "monitor_id", "example": "db78ef84a28644b4983ce6c07b4eeec9", "schema": { "type": "string", "description": "monitor_id", "title": "Monitor Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_TwitchLiveInfoRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "live_id": 0, "user_id": 0, "user_login": "string", "user_name": "string", "game_id": 0, "game_name": "string", "type": "string", "title": "string", "viewer_count": 0, "started_at": "2019-08-24T14:15:22.123Z", "ended_at": "2019-08-24T14:15:22.123Z", "language": "string", "thumbnail_url": "string", "tags": "string", "is_mature": 0 } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/twitch/live/viewer_count/over_time": { "get": { "tags": [ "twitch" ], "summary": "Get Twitch Live Viewer Trend", "description": "Returns a time series of viewer-count samples for one captured broadcast so peaks can be matched to moments in the stream.", "operationId": "twitch_get_monitor_live_viewer_count_over_time", "externalDocs": { "description": "Get Twitch Live Viewer Trend - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitch/get-twitch-live-viewer-trend" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "live_id", "in": "query", "required": true, "description": "live_id", "example": "315722295417", "schema": { "type": "string", "description": "live_id", "title": "Live Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_TwitchLiveViewerCountOverTimeRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "count": 0, "monitor_time": "2019-08-24T14:15:22.123Z" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/monitor/video/tasks/create": { "post": { "tags": [ "monitor" ], "summary": "Create Video Monitoring Task", "description": "Registers a video for scheduled monitoring. Once created, the task collects engagement snapshots at regular intervals until it is stopped; results are read through the task detail endpoint. Task creation is a premium operation with a higher quota cost.", "operationId": "create_monitor_task", "externalDocs": { "description": "Create Video Monitoring Task - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/monitor/create-video-monitoring-task" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoMonitorTaskCreateReq" }, "example": { "platform": "string", "video_id": "string" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_VideoMonitorTaskRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "monitor_id": "string", "platform": "string", "video_id": "string", "video_title": "string", "video_description": "string", "video_publish_at": "2019-08-24T14:15:22.123Z", "video_url": "string", "video_cover": "string", "video_type": "string", "author_id": "string", "author_name": "string", "monitor_status": 0, "monitor_start_date": "2019-08-24", "monitor_end_date": "2019-08-24", "last_snapshot_time": "2019-08-24T14:15:22.123Z", "snapshot_count": 0, "created_time": "2019-08-24T14:15:22.123Z" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/monitor/video/tasks/list": { "get": { "tags": [ "monitor" ], "summary": "List Video Monitoring Tasks", "description": "Returns the monitoring tasks owned by your account, newest first, so you can audit what is being tracked and pick task ids for the detail, refresh and stop endpoints.", "operationId": "list_monitor_tasks", "externalDocs": { "description": "List Video Monitoring Tasks - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/monitor/list-video-monitoring-tasks" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "platform", "in": "query", "required": false, "description": "Platform filter: tiktok, youtube, instagram", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Platform filter: tiktok, youtube, instagram", "title": "Platform" } }, { "name": "monitor_status", "in": "query", "required": false, "description": "Status filter: 0 = monitoring, 10 = completed, 20 = stopped", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Status filter: 0 = monitoring, 10 = completed, 20 = stopped", "title": "Monitor Status" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Items per page", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_VideoMonitorTaskRep__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "monitor_id": "string", "platform": "string", "video_id": "string", "video_title": "string", "video_description": "string", "video_publish_at": "2019-08-24T14:15:22.123Z", "video_url": "string", "video_cover": "string", "video_type": "string", "author_id": "string", "author_name": "string", "monitor_status": 0, "monitor_start_date": "2019-08-24", "monitor_end_date": "2019-08-24", "last_snapshot_time": "2019-08-24T14:15:22.123Z", "snapshot_count": 0, "created_time": "2019-08-24T14:15:22.123Z" } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/monitor/video/tasks/detail": { "get": { "tags": [ "monitor" ], "summary": "Get Video Monitoring Task Details", "description": "Returns a single monitoring task with its configuration, current status and every engagement snapshot recorded so far, ordered by time.", "operationId": "get_monitor_task_detail", "externalDocs": { "description": "Get Video Monitoring Task Details - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/monitor/get-video-monitoring-task-details" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "monitor_id", "in": "query", "required": true, "description": "Monitor ID", "schema": { "type": "string", "description": "Monitor ID", "title": "Monitor Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_VideoMonitorTaskDetailRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "monitor_id": "string", "platform": "string", "video_id": "string", "video_title": "string", "video_description": "string", "video_publish_at": "2019-08-24T14:15:22.123Z", "video_url": "string", "video_cover": "string", "video_type": "string", "author_id": "string", "author_name": "string", "monitor_status": 0, "monitor_start_date": "2019-08-24", "monitor_end_date": "2019-08-24", "last_snapshot_time": "2019-08-24T14:15:22.123Z", "snapshot_count": 0, "created_time": "2019-08-24T14:15:22.123Z", "snapshots": [ { "id": 0, "snapshot_time": "2019-08-24T14:15:22.123Z", "snapshot_type": "string", "like_count": 0, "comment_count": 0, "play_count": 0, "share_count": 0, "collect_count": 0 } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/monitor/video/tasks/stop": { "get": { "tags": [ "monitor" ], "summary": "Stop Video Monitoring Task", "description": "Ends the collection schedule of a task. Stopped tasks keep their history and can still be read through the task detail endpoint.", "operationId": "stop_monitor_task", "externalDocs": { "description": "Stop Video Monitoring Task - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/monitor/stop-video-monitoring-task" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "monitor_id", "in": "query", "required": true, "description": "Monitor ID", "schema": { "type": "string", "description": "Monitor ID", "title": "Monitor Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": null } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/monitor/video/tasks/refresh": { "post": { "tags": [ "monitor" ], "summary": "Refresh Video Monitoring Data", "description": "Forces an out-of-schedule snapshot for an existing task and appends it to the task's series. Manual refreshes consume quota like a scheduled collection.", "operationId": "refresh_monitor_task", "externalDocs": { "description": "Refresh Video Monitoring Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/monitor/refresh-video-monitoring-data" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "monitor_id", "in": "query", "required": true, "description": "Monitor ID", "schema": { "type": "string", "description": "Monitor ID", "title": "Monitor Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_VideoMonitorSnapshotRep_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "id": 0, "snapshot_time": "2019-08-24T14:15:22.123Z", "snapshot_type": "string", "like_count": 0, "comment_count": 0, "play_count": 0, "share_count": 0, "collect_count": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/facebook/realtime/page/info": { "get": { "tags": [ "facebook" ], "summary": "Get Facebook Page Profile (Realtime)", "description": "Collects a Facebook page directly from the platform at request time and returns its public profile fields. Realtime collection consumes more quota than database reads.", "operationId": "facebook_page_info", "externalDocs": { "description": "Get Facebook Page Profile (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/facebook/get-facebook-page-profile-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page_url", "in": "query", "required": true, "description": "page url", "example": "https://www.facebook.com/nike", "schema": { "type": "string", "description": "page url", "title": "Page Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_FacebookPageInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "page_id": "string", "page_name": "string", "page_username": "string", "page_url": "string", "avatar": "string", "cover_url": "string", "description": "string", "category": "string", "follower_count": 0, "following_count": 0, "email": "string", "phone": "string", "website": "string", "creation_date": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/facebook/realtime/post/detail": { "get": { "tags": [ "facebook" ], "summary": "Get Facebook Post Details (Realtime)", "description": "Collects one Facebook post directly from the platform and returns its content and engagement counters as of the call.", "operationId": "facebook_post_detail", "externalDocs": { "description": "Get Facebook Post Details (Realtime) - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/facebook/get-facebook-post-details-realtime" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "post_url", "in": "query", "required": true, "description": "post url", "example": "https://www.facebook.com/nike/posts/pfbid0Z2KUg35AkAJeQJ6NRMyZViPnZD1b6wDMNP8L1UUNUFuYryVnw5DJUZGskYSWue4kl", "schema": { "type": "string", "description": "post url", "title": "Post Url" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_FacebookPostDetailRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "post_id": "string", "post_url": "string", "description": "string", "cover_url": "string", "publish_at": "string", "like_count": 0, "comment_count": 0, "share_count": 0, "view_count": 0, "media_type": "string", "resources": [ "string" ], "author_id": "string", "author_name": "string", "author_url": "string", "caption_text": "string", "duration_seconds": 0, "video_sd_url": "string", "video_hd_url": "string", "caption_urls": [ "string" ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/facebook/task/page/posts": { "get": { "tags": [ "facebook" ], "summary": "Collect Facebook Page Posts", "description": "Page collection runs asynchronously: this call creates the task and returns its id; poll the task-result endpoint until it completes.", "operationId": "facebook_task_page_posts", "externalDocs": { "description": "Collect Facebook Page Posts - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/facebook/collect-facebook-page-posts" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page_url", "in": "query", "required": true, "description": "page url", "example": "https://www.facebook.com/nike", "schema": { "type": "string", "description": "page url", "title": "Page Url" } }, { "name": "limit", "in": "query", "required": false, "description": "Number of results", "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Number of results", "default": 20, "title": "Limit" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2026-01-01", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2026-01-31", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Publish time to", "title": "Publish At End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_FacebookTaskRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "task_id": "string", "task_status": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/facebook/task/post/search": { "get": { "tags": [ "facebook" ], "summary": "Collect Facebook Posts by Keyword", "description": "Keyword collection runs asynchronously: this call creates the task and returns its id; read the matched posts from the task-result endpoint.", "operationId": "facebook_task_post_search", "externalDocs": { "description": "Collect Facebook Posts by Keyword - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/facebook/collect-facebook-posts-by-keyword" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "query", "in": "query", "required": true, "description": "Search keyword", "schema": { "type": "string", "description": "Search keyword", "title": "Query" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of results", "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "Maximum number of results", "default": 20, "title": "Limit" } }, { "name": "recent_posts", "in": "query", "required": false, "description": "Only search recent posts (0 = no, 1 = yes)", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Only search recent posts (0 = no, 1 = yes)", "default": 1, "title": "Recent Posts" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2026-01-01", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2026-01-31", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Publish time to", "title": "Publish At End" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_FacebookTaskRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "task_id": "string", "task_status": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/facebook/task/result": { "get": { "tags": [ "facebook" ], "summary": "Get Facebook Collection Task Result", "description": "Returns the task's current status and, once finished, the posts it gathered with their engagement counters. Poll until the status reports completion.", "operationId": "facebook_task_result", "externalDocs": { "description": "Get Facebook Collection Task Result - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/facebook/get-facebook-task-result" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "task_id", "in": "query", "required": true, "description": "Task ID", "schema": { "type": "string", "description": "Task ID", "title": "Task Id" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_FacebookTaskResultRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "task_id": "string", "task_status": "string", "data": { "items": [ {} ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/x/user/info": { "get": { "tags": [ "twitter" ], "summary": "Get X Creator Profile", "description": "Returns the stored public profile of a X creator: identity and bio, follower and following counts, verification flag, linked accounts on other platforms and rolling engagement averages over recent posts. Records come from the persisted database, which suits batch screening; use the realtime variant when you need up-to-the-minute values.", "operationId": "x_db_user_info", "externalDocs": { "description": "Get X Creator Profile - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitter/get-x-creator-profile" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle", "example": "elonmusk", "schema": { "type": "string", "description": "X handle", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_XUserInfoRes_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "user_id": "string", "related_platforms": [ { "platform": "string", "platform_url": "string" } ], "username": "string", "nickname": "string", "avatar": "string", "banner": "string", "description": "string", "bio_url": "string", "channel_url": "string", "follower_count": 0, "following_count": 0, "favourites_count": 0, "country": "string", "location": "string", "language": "string", "gender": "string", "is_business_account": true, "is_verified": true, "verified_type": "string", "is_private": true, "register_at": "string", "tags": [ "string" ], "categories": [ { "level1": { "id": 9044, "zh_name": "Sports", "en_name": "Sports" }, "level2": { "id": 9044, "zh_name": "Sports", "en_name": "Sports" }, "level3": { "id": 9044, "zh_name": "Sports", "en_name": "Sports" } } ], "publish_count_month": 0, "publish_count_week": 0, "last_publish_at": "string", "total_post_count": 0, "total_media_count": 0, "total_video_count": 0, "original_post_count": 0, "retweet_ratio": "string", "reply_ratio": "string", "top_source": "string", "avg_engagement_rate_5": "string", "avg_view_rate_5": "string", "avg_view_count_5": "string", "avg_like_count_5": "string", "avg_comment_count_5": "string", "avg_retweet_count_5": "string", "avg_quote_count_5": "string", "avg_engagement_rate_10": "string", "avg_view_rate_10": "string", "avg_view_count_10": "string", "avg_like_count_10": "string", "avg_comment_count_10": "string", "avg_retweet_count_10": "string", "avg_quote_count_10": "string", "avg_engagement_rate_30": "string", "avg_view_rate_30": "string", "avg_view_count_30": "string", "avg_like_count_30": "string", "avg_comment_count_30": "string", "avg_retweet_count_30": "string", "avg_quote_count_30": "string", "med_engagement_rate_30": "string", "med_view_rate_30": "string", "med_view_count_30": "string", "med_like_count_30": "string", "med_comment_count_30": "string", "med_retweet_count_30": "string", "med_quote_count_30": "string", "avg_engagement_rate_5_video": "0%", "avg_engagement_rate_10_video": "0%", "avg_engagement_rate_30_video": "0%", "med_engagement_rate_30_video": "0%", "cooperation_score": { "score": 0, "score_level": "string", "tags": [ { "label": "string", "polarity": "positive" } ] }, "evaluation_min": "string", "evaluation_max": "string", "last_update_at": "string" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/x/user/posts": { "get": { "tags": [ "twitter" ], "summary": "Get X Creator Posts", "description": "X timelines contain many reposts; pass `exclude_retweet=1` or `post_type=1` for an original-only view.", "operationId": "x_db_user_posts", "externalDocs": { "description": "Get X Creator Posts - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitter/get-x-creator-posts" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle", "example": "elonmusk", "schema": { "type": "string", "description": "X handle", "title": "Username" } }, { "name": "publish_at_start", "in": "query", "required": false, "description": "Publish time from", "example": "2026-01-01", "schema": { "type": "string", "description": "Publish time from", "title": "Publish At Start" } }, { "name": "publish_at_end", "in": "query", "required": false, "description": "Publish time to", "example": "2026-09-01", "schema": { "type": "string", "description": "Publish time to", "title": "Publish At End" } }, { "name": "post_id", "in": "query", "required": false, "description": "Post ID", "example": "1519480761749016577", "schema": { "type": "string", "description": "Post ID", "title": "Post Id" } }, { "name": "media_type", "in": "query", "required": false, "description": "Media type (0 = text, 1 = image, 2 = video, 3 = GIF)", "example": "2", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Media type (0 = text, 1 = image, 2 = video, 3 = GIF)", "title": "Media Type" } }, { "name": "post_type", "in": "query", "required": false, "description": "Post type (1 = original, 2 = repost, 3 = quote, 4 = thread, 5 = reply)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Post type (1 = original, 2 = repost, 3 = quote, 4 = thread, 5 = reply)", "title": "Post Type" } }, { "name": "exclude_retweet", "in": "query", "required": false, "description": "Exclude reposts (1 = exclude)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Exclude reposts (1 = exclude)", "title": "Exclude Retweet" } }, { "name": "is_paid", "in": "query", "required": false, "description": "Sponsored post (1 = yes)", "example": "1", "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Sponsored post (1 = yes)", "title": "Is Paid" } }, { "name": "sort_by", "in": "query", "required": false, "description": "Sort field (publish_at, view_count, like_count, engagement_rate)", "example": "publish_at", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort field (publish_at, view_count, like_count, engagement_rate)", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "description": "Sort direction (asc, desc), default desc", "example": "desc", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Sort direction (asc, desc), default desc", "title": "Sort Order" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Page size", "schema": { "type": "integer", "maximum": 200, "exclusiveMinimum": 0, "description": "Page size", "default": 20, "title": "Page Size", "minimum": 0 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_XUserPostItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "post_id": "1519480761749016577", "post_url": "https://x.com/elonmusk/status/1519480761749016577", "description": "Next I’m buying Coca-Cola to put the cocaine back in", "duration": 0, "publish_at": "2022-04-28 08:56:58", "language": "en", "media_type": "text", "post_type": "original", "is_pinned": false, "is_sensitive": false, "is_paid": false, "view_count": 0, "like_count": 4198044, "comment_count": 167757, "retweet_count": 577720, "quote_count": 168195, "bookmark_count": 22534, "engagement_count": 5111716, "engagement_rate": "2.12", "source": "Twitter for iPhone", "post_username": "elonmusk", "post_user_url": "https://x.com/elonmusk", "post_user_follower_count": 241536070, "last_update_at": "2026-09-02 16:22:17" } ], "total": 112, "page": 1, "page_size": 1, "total_pages": 112 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/x/user/brands": { "get": { "tags": [ "twitter" ], "summary": "Get X Creator Brand Deals", "description": "Detects brand collaborations in the account's posts and aggregates them by brand. Only original posts count; reposts are not attributed to the reposter. The first query for an account may return empty results; retry shortly after.", "operationId": "x_user_brands", "externalDocs": { "description": "Get X Creator Brand Deals - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitter/get-x-creator-brand-deals" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle", "example": "elonmusk", "schema": { "type": "string", "description": "X handle", "title": "Username" } }, { "name": "page", "in": "query", "required": false, "description": "Page number", "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "description": "Items per page", "schema": { "type": "integer", "maximum": 50, "minimum": 1, "description": "Items per page", "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BasePage_VideoBrandCollaborationItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "brand_name": "string", "collaboration_count": 0, "last_collaboration_at": "string", "engagement_rate": "string", "total_view_count": 0, "total_like_count": 0, "total_comment_count": 0, "videos": [ { "video_id": "string", "title": "string", "description": "string", "cover_url": "string", "video_url": "string", "publish_at": "string", "view_count": 0, "like_count": 0, "comment_count": 0, "engagement_rate": 0 } ] } ], "total": 0, "page": 0, "page_size": 0, "total_pages": 0 } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/x/user/similar": { "get": { "tags": [ "twitter" ], "summary": "Find Similar X Creators", "description": "Recommends similar accounts based on the account profile and recent posts.", "operationId": "x_user_similar", "externalDocs": { "description": "Find Similar X Creators - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitter/find-similar-x-creators" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle", "example": "elonmusk", "schema": { "type": "string", "description": "X handle", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_XUserSimilarItem__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "username": "SpaceX", "nickname": "SpaceX", "avatar": "https://img-us.scrumball.ai/twitter/34743251/avatar/xxx.jpg", "description": "SpaceX designs, manufactures and launches the world’s most advanced rockets and spacecraft", "follower_count": 41900588 }, { "username": "NASA", "nickname": "NASA", "avatar": "https://img-us.scrumball.ai/twitter/11348282/avatar/xxx.jpg", "description": "Explore the universe and discover our home planet.", "follower_count": 92384026 } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/x/user/hashtag/engagement": { "get": { "tags": [ "twitter" ], "summary": "Get X Hashtag Engagement Data", "description": "Engagement of the top 10 hashtags in recent posts", "operationId": "x_user_hashtag_engagement", "externalDocs": { "description": "Get X Hashtag Engagement Data - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/twitter/get-x-hashtag-engagement" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "username", "in": "query", "required": true, "description": "X handle", "example": "elonmusk", "schema": { "type": "string", "description": "X handle", "title": "Username" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_list_KolHashtagEngagementRes__" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": [ { "hashtag": "#PetrichorTheSeries", "frequency": 8, "engagement_rate_median": "5.06%", "engagement_rate_mean": "5.42%", "views_median": 27517, "interactions_median": "1509.00", "interactions_total": 12563, "grade": "S" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } }, "/api/v1/billing/usage": { "get": { "tags": [ "billing" ], "summary": "Get API Usage and Quota", "description": "Returns the usage counters of the API key making the call. Use it to watch quota from your own systems instead of the dashboard; the call itself does not consume quota.", "operationId": "get_billing_usage", "externalDocs": { "description": "Get API Usage and Quota - Scrumball API Documentation", "url": "https://platform.scrumball.com/docs/billing/get-api-usage" }, "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "start_time", "in": "query", "required": false, "description": "Start date", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Start date", "examples": [ "2026-06-01" ], "title": "Start Time" } }, { "name": "end_time", "in": "query", "required": false, "description": "End date", "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "End date", "examples": [ "2026-06-10" ], "title": "End Time" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseModel_BillingUsageResponse_" }, "example": { "success": true, "code": 200, "message": "Request successful", "data": { "items": [ { "product_name": "Creator basic data", "used_qty": 128 }, { "product_name": "Creator advanced data", "used_qty": 3421 } ] } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" }, "example": { "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ] } } } } } } } }, "components": { "schemas": { "AudienceAudienceQualityItem": { "properties": { "real": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Authenticity" }, "interested": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Interest level" }, "positive": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Positive sentiment" } }, "type": "object", "title": "AudienceAudienceQualityItem", "description": "Audience quality" }, "AudienceBrandOpportunitiesItem": { "properties": { "audience_quality": { "anyOf": [ { "$ref": "#/components/schemas/AudienceAudienceQualityItem" }, { "type": "null" } ], "description": "Audience quality" }, "purchase_influence": { "anyOf": [ { "$ref": "#/components/schemas/AudiencePurchaseInfluenceItem" }, { "type": "null" } ], "description": "Purchase influence" }, "personality_assessment": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AudiencePersonalityAssessmentItem" }, "type": "array" }, { "type": "null" } ], "title": "Personality Assessment", "description": "Personality assessment" } }, "type": "object", "title": "AudienceBrandOpportunitiesItem", "description": "Brand opportunities" }, "AudienceContentStyleItem": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Personality", "examples": [ "xxx" ] }, "desc": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Desc", "description": "Description", "examples": [ "xxx" ] } }, "type": "object", "title": "AudienceContentStyleItem", "description": "Content style" }, "AudienceDevicePercentageItem": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Device", "examples": [ "xxx" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value", "description": "Value", "examples": [ "10.12" ] } }, "type": "object", "title": "AudienceDevicePercentageItem", "description": "Device share" }, "AudienceFollowerAuthenticityRep": { "properties": { "real": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Real", "description": "Genuine followers", "examples": [ "90%" ] }, "fake": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fake", "description": "Suspicious followers", "examples": [ "10%" ] } }, "type": "object", "title": "AudienceFollowerAuthenticityRep", "description": "Follower authenticity" }, "AudienceInteractiveBehaviorItem": { "properties": { "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role", "description": "Role", "examples": [ "US" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value", "description": "Value", "examples": [ "10.12" ] }, "demographic": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Demographic", "description": "Demographics", "examples": [ "xxx" ] } }, "type": "object", "title": "AudienceInteractiveBehaviorItem", "description": "Audience behavior" }, "AudienceInterestItem": { "properties": { "interest": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Interest", "description": "Interest", "examples": [ "US" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Value", "description": "Value", "examples": [ "10.12" ] }, "illustration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Illustration", "description": "Note", "examples": [ "xxx" ] } }, "type": "object", "title": "AudienceInterestItem", "description": "Audience interests" }, "AudiencePersonalityAssessmentItem": { "properties": { "emoji": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emoji", "description": "Emoji", "examples": [ "xxx" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name", "examples": [ "xxx" ] }, "persona": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Persona", "description": "Personality", "examples": [ "xxx" ] } }, "type": "object", "title": "AudiencePersonalityAssessmentItem", "description": "Audience personality assessment" }, "AudiencePurchaseInfluenceItem": { "properties": { "expertise": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Expertise" }, "credibility": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Credibility" }, "likability": { "anyOf": [ { "$ref": "#/components/schemas/CommonScoreReasonItem" }, { "type": "null" } ], "description": "Affinity" } }, "type": "object", "title": "AudiencePurchaseInfluenceItem", "description": "Audience purchase influence" }, "AudienceRatingTierRep": { "properties": { "rating_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rating Tier", "description": "Rating tier (HIGH / MEDIUM / LOW)", "examples": [ "HIGH", "MEDIUM", "LOW" ] } }, "type": "object", "title": "AudienceRatingTierRep", "description": "Rating tier" }, "BasePage_dict_": { "properties": { "items": { "items": { "type": "object" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[dict]" }, "BasePage_InstagramUserMediaItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/InstagramUserMediaItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[InstagramUserMediaItem]" }, "BasePage_SearchInstagramMediaRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchInstagramMediaRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchInstagramMediaRep]" }, "BasePage_SearchInstagramUserRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchInstagramUserRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchInstagramUserRep]" }, "BasePage_SearchTiktokUserRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchTiktokUserRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchTiktokUserRep]" }, "BasePage_SearchTiktokVideoRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchTiktokVideoRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchTiktokVideoRep]" }, "BasePage_SearchXPostRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchXPostRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchXPostRep]" }, "BasePage_SearchXUserRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchXUserRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchXUserRep]" }, "BasePage_SearchYoutubeUserRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchYoutubeUserRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchYoutubeUserRep]" }, "BasePage_SearchYoutubeVideoRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SearchYoutubeVideoRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[SearchYoutubeVideoRep]" }, "BasePage_TiktokUserShopGoodsItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TiktokUserShopGoodsItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TiktokUserShopGoodsItem]" }, "BasePage_TiktokUserShopLiveItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TiktokUserShopLiveItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TiktokUserShopLiveItem]" }, "BasePage_TiktokUserShopVideoAdItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TiktokUserShopVideoAdItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TiktokUserShopVideoAdItem]" }, "BasePage_TiktokUserVideoInfoItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TiktokUserVideoInfoItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TiktokUserVideoInfoItem]" }, "BasePage_TwitchLiveInfoRes_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TwitchLiveInfoRes" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TwitchLiveInfoRes]" }, "BasePage_TwitchMonitorTaskRes_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TwitchMonitorTaskRes" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TwitchMonitorTaskRes]" }, "BasePage_TwitchVideoMessageRes_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/TwitchVideoMessageRes" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[TwitchVideoMessageRes]" }, "BasePage_VideoBrandCollaborationItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VideoBrandCollaborationItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[VideoBrandCollaborationItem]" }, "BasePage_VideoMonitorTaskRep_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/VideoMonitorTaskRep" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[VideoMonitorTaskRep]" }, "BasePage_XUserPostItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/XUserPostItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[XUserPostItem]" }, "BasePage_YoutubeUserVideoInfoItem_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/YoutubeUserVideoInfoItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total_pages": { "type": "integer", "title": "Total Pages" } }, "type": "object", "required": [ "items", "total", "page", "page_size", "total_pages" ], "title": "BasePage[YoutubeUserVideoInfoItem]" }, "BillingUsageItem": { "properties": { "product_name": { "type": "string", "title": "Product Name", "description": "Product name", "examples": [ "Creator basic data" ] }, "used_qty": { "type": "integer", "title": "Used Qty", "description": "Used amount", "examples": [ 3421 ] } }, "type": "object", "required": [ "product_name", "used_qty" ], "title": "BillingUsageItem", "description": "Usage line item" }, "BillingUsageResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/BillingUsageItem" }, "type": "array", "title": "Items", "description": "Usage per product" } }, "type": "object", "title": "BillingUsageResponse", "description": "Billing usage snapshot" }, "CategoryTreeNode": { "properties": { "id": { "type": "integer", "title": "Id", "description": "Category ID", "examples": [ 9001 ] }, "zh_name": { "type": "string", "title": "Zh Name", "description": "Chinese name", "examples": [ "Beauty & personal care" ] }, "en_name": { "type": "string", "title": "En Name", "description": "English name", "examples": [ "Beauty & Personal Care" ] }, "level": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "Level", "description": "Level (1 = top, 2 = second, 3 = third)", "examples": [ 1 ] }, "selectable": { "type": "boolean", "title": "Selectable", "description": "Usable in search (top-level categories are for grouping only and cannot be selected)", "examples": [ false ] }, "children": { "items": { "$ref": "#/components/schemas/CategoryTreeNode" }, "type": "array", "title": "Children", "description": "Child categories; empty for third-level categories" } }, "type": "object", "required": [ "id", "zh_name", "en_name", "level", "selectable" ], "title": "CategoryTreeNode", "description": "Creator category tree node" }, "CommonScoreReasonItem": { "properties": { "score": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Score", "description": "Score", "examples": [ "10.12" ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason", "description": "Reason", "examples": [ "xxx" ] } }, "type": "object", "title": "CommonScoreReasonItem", "description": "General score reason" }, "CooperationScoreSummary": { "properties": { "score": { "type": "integer", "maximum": 10, "minimum": 0, "title": "Score", "description": "Integer score from 0 to 10" }, "score_level": { "type": "string", "title": "Score Level", "description": "Score tier with a short explanation, e.g. 'Good - open to collaboration'" }, "tags": { "items": { "$ref": "#/components/schemas/CooperationScoreTag" }, "type": "array", "title": "Tags", "description": "Behavior tags" } }, "type": "object", "required": [ "score", "score_level" ], "title": "CooperationScoreSummary", "description": "Compact score object" }, "CooperationScoreTag": { "properties": { "label": { "type": "string", "title": "Label" }, "polarity": { "type": "string", "enum": [ "positive", "negative", "neutral" ], "title": "Polarity" } }, "type": "object", "required": [ "label", "polarity" ], "title": "CooperationScoreTag" }, "FacebookPageInfoRes": { "properties": { "page_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Id", "description": "Page ID" }, "page_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Name", "description": "Page name" }, "page_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Username", "description": "Page username" }, "page_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Url", "description": "Page URL" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Page description" }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category", "description": "Page category" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count" }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count", "description": "Following count" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email", "description": "Email" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone", "description": "Phone" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Website", "description": "Website URL" }, "creation_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Creation Date", "description": "Created at" } }, "type": "object", "title": "FacebookPageInfoRes" }, "FacebookPostDetailRes": { "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Id", "description": "Post ID" }, "post_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Url", "description": "Post URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Post text" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image URL" }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Publish time" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "Play count" }, "media_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Type", "description": "Media type" }, "resources": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Resources", "description": "Resource URLs" }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Id", "description": "Author ID" }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Name", "description": "Author name" }, "author_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Url", "description": "Author URL" }, "caption_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Caption Text", "description": "Caption text" }, "duration_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Seconds", "description": "Duration (seconds)" }, "video_sd_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Sd Url", "description": "SD video URL" }, "video_hd_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Hd Url", "description": "HD video URL" }, "caption_urls": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Caption Urls", "description": "Subtitle URLs" } }, "type": "object", "title": "FacebookPostDetailRes" }, "FacebookTaskRes": { "properties": { "task_id": { "type": "string", "title": "Task Id", "description": "Task ID" }, "task_status": { "type": "string", "title": "Task Status", "description": "Task status" } }, "type": "object", "required": [ "task_id", "task_status" ], "title": "FacebookTaskRes", "description": "Facebook async task creation response" }, "FacebookTaskResultRes": { "properties": { "task_id": { "type": "string", "title": "Task Id", "description": "Task ID" }, "task_status": { "type": "string", "title": "Task Status", "description": "Task status" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_dict_" }, { "type": "null" } ], "description": "Collected results (paginated)" } }, "type": "object", "required": [ "task_id", "task_status" ], "title": "FacebookTaskResultRes", "description": "Facebook async task polling response" }, "FormatMetricItem": { "properties": { "avg_engagement_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 5", "description": "Last 5 items: average engagement rate" }, "avg_view_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 5", "description": "Last 5 items: average view rate" }, "avg_view_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 5", "description": "Last 5 items: average plays" }, "avg_comment_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 5", "description": "Last 5 items: average comments" }, "avg_like_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 5", "description": "Last 5 items: average likes" }, "avg_engagement_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 10", "description": "Last 10 items: average engagement rate" }, "avg_view_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 10", "description": "Last 10 items: average view rate" }, "avg_view_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 10", "description": "Last 10 items: average plays" }, "avg_comment_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 10", "description": "Last 10 items: average comments" }, "avg_like_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 10", "description": "Last 10 items: average likes" }, "avg_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 30", "description": "Last 30 items: average engagement rate" }, "avg_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 30", "description": "Last 30 items: average view rate" }, "avg_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 30", "description": "Last 30 items: average plays" }, "avg_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 30", "description": "Last 30 items: average comments" }, "avg_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 30", "description": "Last 30 items: average likes" }, "med_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Engagement Rate 30", "description": "Last 30 items: median engagement rate" }, "med_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Rate 30", "description": "Last 30 items: median view rate" }, "med_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Count 30", "description": "Last 30 items: median plays" }, "med_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Comment Count 30", "description": "Last 30 items: median comments" }, "med_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Like Count 30", "description": "Last 30 items: median likes" } }, "type": "object", "title": "FormatMetricItem", "description": "Core metrics for a single content format (mirrors the top-level metric set of user/info)" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InfluencerCategoryItem": { "properties": { "level1": { "anyOf": [ { "$ref": "#/components/schemas/InfluencerCategoryNode" }, { "type": "null" } ], "description": "Top-level category" }, "level2": { "anyOf": [ { "$ref": "#/components/schemas/InfluencerCategoryNode" }, { "type": "null" } ], "description": "Second-level category" }, "level3": { "$ref": "#/components/schemas/InfluencerCategoryNode", "description": "Third-level category; its ID can be used as a category filter in search endpoints" } }, "type": "object", "required": [ "level3" ], "title": "InfluencerCategoryItem", "description": "One category assigned to the creator, with its top, second and third level in the taxonomy" }, "InfluencerCategoryNode": { "properties": { "id": { "type": "integer", "title": "Id", "description": "Category ID", "examples": [ 9044 ] }, "zh_name": { "type": "string", "title": "Zh Name", "description": "Chinese name", "examples": [ "Sports" ] }, "en_name": { "type": "string", "title": "En Name", "description": "English name", "examples": [ "Sports" ] } }, "type": "object", "required": [ "id", "zh_name", "en_name" ], "title": "InfluencerCategoryNode", "description": "Creator category node" }, "InstagramCoCreatorItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Co-author user_id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Co-author username" } }, "type": "object", "title": "InstagramCoCreatorItem", "description": "Instagram co-author" }, "InstagramContentFormatMetrics": { "properties": { "image": { "anyOf": [ { "$ref": "#/components/schemas/FormatMetricItem" }, { "type": "null" } ], "description": "Image posts (single image + carousel)" }, "reels": { "anyOf": [ { "$ref": "#/components/schemas/FormatMetricItem" }, { "type": "null" } ], "description": "Reels" } }, "type": "object", "title": "InstagramContentFormatMetrics", "description": "Instagram core metrics split by content format (the all-formats view is in the top-level user/info fields)" }, "InstagramMediaTypeNameEnum": { "type": "string", "enum": [ "video", "sidecar", "image" ], "title": "InstagramMediaTypeNameEnum", "description": "video, sidecar = carousel, image = single image", "name": "InstagramMediaTypeNameEnum" }, "InstagramUserInfoRes": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Account ID", "examples": [ "173560420" ] }, "related_platforms": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RelatedPlatformItem" }, "type": "array" }, { "type": "null" } ], "title": "Related Platforms", "description": "Related platforms" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Account name", "examples": [ "cristiano" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "Cristiano Ronaldo" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Account avatar URL", "examples": [ "https://img.scrumball.cn/instagram/FhwkIHBAVZE3Sk-ca7NnK3WMs2qj" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio", "examples": [ "SIUUUbscribe to my Youtube Channel!" ] }, "channel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Url", "description": "Account URL", "examples": [ "https://www.instagram.com/cristiano/" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 649804870 ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "Portugal" ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language", "examples": [ "en" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender", "examples": [ "male" ] }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Business Account", "description": "Business account", "examples": [ true ] }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "description": "Verified", "examples": [ true ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Tags", "examples": [ "vexbolts", "tseries" ] }, "publish_count_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Month", "description": "Posts per month", "examples": [ 10 ] }, "publish_count_week": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Week", "description": "Posts per week", "examples": [ 10 ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2024-12-12" ] }, "total_media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Media Count", "description": "Total posts", "examples": [ 3839 ] }, "total_video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Video Count", "description": "Total videos", "examples": [ 5 ] }, "avg_engagement_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 5", "description": "Last 5 posts: average engagement rate", "examples": [ "1.02%" ] }, "avg_view_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 5", "description": "Last 5 posts: average view rate", "examples": [ "1.02%" ] }, "avg_like_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 5", "description": "Last 5 posts: average likes", "examples": [ "6559191.53" ] }, "avg_comment_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 5", "description": "Last 5 posts: average comments", "examples": [ "57404.47" ] }, "avg_engagement_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 10", "description": "Last 10 posts: average engagement rate", "examples": [ "1.02%" ] }, "avg_view_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 10", "description": "Last 10 posts: average view rate", "examples": [ "1.02%" ] }, "avg_like_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 10", "description": "Last 10 posts: average likes", "examples": [ "6559191.53" ] }, "avg_comment_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 10", "description": "Last 10 posts: average comments", "examples": [ "57404.47" ] }, "avg_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 30", "description": "Last 30 posts: average engagement rate", "examples": [ "1.02%" ] }, "avg_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 30", "description": "Last 30 posts: average view rate", "examples": [ "1.02%" ] }, "avg_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 30", "description": "Last 30 posts: average likes", "examples": [ "6559191.53" ] }, "avg_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 30", "description": "Last 30 posts: average comments", "examples": [ "57404.47" ] }, "med_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Engagement Rate 30", "description": "Last 30 posts: median engagement rate", "examples": [ "1.02%" ] }, "med_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Rate 30", "description": "Last 30 posts: median view rate", "examples": [ "1.02%" ] }, "med_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Like Count 30", "description": "Last 30 posts: median likes", "examples": [ "6559191.53" ] }, "med_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Comment Count 30", "description": "Last 30 posts: median comments", "examples": [ "57404.47" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "InstagramUserInfoRes", "description": "Instagram user profile" }, "InstagramUserMediaItem": { "properties": { "media_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Code", "description": "Post ID", "examples": [ "DEXD7lKIUFy" ] }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url", "description": "Post URL", "examples": [ "https://www.instagram.com/p/DEXD7lKIUFy/" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Post caption", "examples": [ "Back to work" ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Post cover image", "examples": [ "https://img.scrumball.cn/instagram/Fv6NZWs-mTJZ1NU1q6YPYKGaWz9H" ] }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Post publish time", "examples": [ "2025-01-03 18:37:09" ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Post tags", "examples": [ "uflgame", "ksi" ] }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count", "examples": [ 8367498 ] }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count", "examples": [ 57050 ] }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "View count", "examples": [ 100000000 ] }, "media_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Type", "description": "Post type (video, sidecar = carousel, image = single image)", "examples": [ "sidecar" ] }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate", "examples": [ "1.3" ] }, "media_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Username", "description": "Post author name", "examples": [ "cristiano" ] }, "media_user_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media User Url", "description": "Post author URL", "examples": [ "https://www.instagram.com/cristiano/" ] }, "media_user_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media User Follower Count", "description": "Post author followers", "examples": [ 649804870 ] }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "InstagramUserMediaItem", "description": "Instagram user posts" }, "InstagramUserMonitorMetricsRes": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 649804870 ] } }, "type": "object", "title": "InstagramUserMonitorMetricsRes", "description": "Instagram creator growth metrics" }, "InstagramUserSimilarItem": { "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Account name", "examples": [ "cristiano" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "Cristiano Ronaldo" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Account avatar URL", "examples": [ "https://img.scrumball.cn/instagram/FhwkIHBAVZE3Sk-ca7NnK3WMs2qj" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio", "examples": [ "SIUUUbscribe to my Youtube Channel!" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 649804870 ] } }, "type": "object", "title": "InstagramUserSimilarItem", "description": "Similar Instagram creators" }, "KolHashtagEngagementRes": { "properties": { "hashtag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hashtag", "description": "hashtag", "examples": [ "#hashtag" ] }, "frequency": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Frequency", "description": "Frequency", "examples": [ 100 ] }, "engagement_rate_median": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate Median", "description": "Median engagement rate", "examples": [ "3.95%" ] }, "engagement_rate_mean": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate Mean", "description": "Mean engagement rate", "examples": [ "3.95%" ] }, "views_median": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Views Median", "description": "Median plays", "examples": [ 26817 ] }, "interactions_median": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Interactions Median", "description": "Median engagement", "examples": [ 2548.5 ] }, "interactions_total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Interactions Total", "description": "Total engagement", "examples": [ 27655 ] }, "grade": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grade", "description": "Rating", "examples": [ "A" ] } }, "type": "object", "title": "KolHashtagEngagementRes", "description": "Creator hashtag engagement data" }, "RealTimeInstagramLocationItem": { "properties": { "location_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location Id", "description": "Location ID" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Location name" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address", "description": "Location address" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City", "description": "City" }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Latitude", "description": "Latitude" }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Longitude", "description": "Longitude" } }, "type": "object", "title": "RealTimeInstagramLocationItem", "description": "Instagram location" }, "RealTimeInstagramMediaInfoRes": { "properties": { "author_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author User Id", "description": "user_id" }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Username", "description": "username" }, "media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Id", "description": "media ID" }, "media_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Code", "description": "media code" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image URL" }, "resources": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Resources", "description": "Resource URLs" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Content" }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accessibility Caption", "description": "Accessibility captions" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url", "description": "Post URL" }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Post type: 1 = single image, 2 = video, 8 = carousel" }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration", "description": "Video duration in seconds" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Video plays" } }, "type": "object", "title": "RealTimeInstagramMediaInfoRes", "description": "Instagram post" }, "RealTimeInstagramStoryItem": { "properties": { "media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Id", "description": "media ID" }, "media_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Code", "description": "media code" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "expiring_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expiring At", "description": "Expiry time" }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Post type: 1 = single image, 2 = video, 8 = carousel" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image URL" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL" }, "video_duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Duration", "description": "Video duration (seconds)" }, "mention_users": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeInstagramStoryUserItem" }, "type": "array" }, { "type": "null" } ], "title": "Mention Users", "description": "Mentioned users" }, "locations": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeInstagramLocationItem" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Location" } }, "type": "object", "title": "RealTimeInstagramStoryItem", "description": "Instagram user stories" }, "RealTimeInstagramStoryUserItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "full_name" }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private", "description": "Private account" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "description": "Verified" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar" } }, "type": "object", "title": "RealTimeInstagramStoryUserItem", "description": "Instagram stories user" }, "RealTimeInstagramUserInfoRes": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "full_name" }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Url", "description": "Profile URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Bio" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count" }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count", "description": "Following count" }, "media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Count", "description": "Post count" }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private", "description": "Private account" } }, "type": "object", "title": "RealTimeInstagramUserInfoRes", "description": "Realtime - Instagram user profile" }, "RealTimeInstagramUserMediasRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "medias": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeInstagramMediaInfoRes" }, "type": "array" }, { "type": "null" } ], "title": "Medias", "description": "medias" } }, "type": "object", "title": "RealTimeInstagramUserMediasRes", "description": "Instagram user posts" }, "RealTimeInstagramUserStoriesRes": { "properties": { "user": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeInstagramStoryUserItem" }, { "type": "null" } ], "description": "user" }, "stories": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeInstagramStoryItem" }, "type": "array" }, { "type": "null" } ], "title": "Stories", "description": "stories" } }, "type": "object", "title": "RealTimeInstagramUserStoriesRes", "description": "Instagram user stories" }, "RealTimeTiktokUserInfoRes": { "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uid", "description": "uid" }, "unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Id", "description": "unique_id" }, "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sec Uid", "description": "sec_uid" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Nickname" }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Url", "description": "Profile URL" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Bio" }, "verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Verified", "description": "Verified" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count" }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count", "description": "Following count" }, "total_favorited": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Favorited", "description": "Like count" }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count" } }, "type": "object", "title": "RealTimeTiktokUserInfoRes", "description": "Realtime - TikTok user profile" }, "RealTimeTiktokUserVideosRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "videos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeTiktokVideoInfoRes" }, "type": "array" }, { "type": "null" } ], "title": "Videos", "description": "videos" } }, "type": "object", "title": "RealTimeTiktokUserVideosRes", "description": "TikTok user videos" }, "RealTimeTiktokVideoInfoRes": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "author_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Uid", "description": "Author UID" }, "author_unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Unique Id", "description": "Author unique_id" }, "author_nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Nickname", "description": "Author nickname" }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration", "description": "Video duration" }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" }, "collect_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Collect Count", "description": "Save count" } }, "type": "object", "title": "RealTimeTiktokVideoInfoRes", "description": "TikTok video" }, "RealTimeYoutubeUserInfoRes": { "properties": { "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Channel handle" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Channel name" }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Url", "description": "Channel URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Channel description" }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Subscriber Count", "description": "Subscriber count" }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country" } }, "type": "object", "title": "RealTimeYoutubeUserInfoRes", "description": "Realtime YouTube user profile" }, "RealTimeYoutubeUserVideosRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "videos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RealTimeYoutubeVideoInfoShortRes" }, "type": "array" }, { "type": "null" } ], "title": "Videos", "description": "videos" } }, "type": "object", "title": "RealTimeYoutubeUserVideosRes", "description": "Realtime YouTube user videos" }, "RealTimeYoutubeVideoInfoRes": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "Video duration" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL" }, "channel_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Title", "description": "Channel name" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" }, "video_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Type", "description": "Content format (video, short)" }, "category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Category Id", "description": "Category" }, "caption": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Caption", "description": "Captions" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" } }, "type": "object", "title": "RealTimeYoutubeVideoInfoRes", "description": "Realtime YouTube video" }, "RealTimeYoutubeVideoInfoShortRes": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "channel_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Title", "description": "Channel name" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" } }, "type": "object", "title": "RealTimeYoutubeVideoInfoShortRes", "description": "Realtime YouTube video (brief)" }, "RelatedPlatformItem": { "properties": { "platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform", "description": "Platform", "examples": [ "youtube" ] }, "platform_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform Url", "description": "Platform URL", "examples": [ "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA" ] } }, "type": "object", "title": "RelatedPlatformItem", "description": "Related platforms" }, "ResponseModel": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ {}, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel", "description": "Standard response envelope: success flag, status code, message and data payload." }, "ResponseModel_AudienceBrandOpportunitiesItem_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/AudienceBrandOpportunitiesItem" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[AudienceBrandOpportunitiesItem]" }, "ResponseModel_AudienceFollowerAuthenticityRep_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/AudienceFollowerAuthenticityRep" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[AudienceFollowerAuthenticityRep]" }, "ResponseModel_AudienceRatingTierRep_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/AudienceRatingTierRep" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[AudienceRatingTierRep]" }, "ResponseModel_BasePage_InstagramUserMediaItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_InstagramUserMediaItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[InstagramUserMediaItem]]" }, "ResponseModel_BasePage_SearchInstagramMediaRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchInstagramMediaRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchInstagramMediaRep]]" }, "ResponseModel_BasePage_SearchInstagramUserRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchInstagramUserRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchInstagramUserRep]]" }, "ResponseModel_BasePage_SearchTiktokUserRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchTiktokUserRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchTiktokUserRep]]" }, "ResponseModel_BasePage_SearchTiktokVideoRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchTiktokVideoRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchTiktokVideoRep]]" }, "ResponseModel_BasePage_SearchXPostRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchXPostRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchXPostRep]]" }, "ResponseModel_BasePage_SearchXUserRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchXUserRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchXUserRep]]" }, "ResponseModel_BasePage_SearchYoutubeUserRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchYoutubeUserRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchYoutubeUserRep]]" }, "ResponseModel_BasePage_SearchYoutubeVideoRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_SearchYoutubeVideoRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[SearchYoutubeVideoRep]]" }, "ResponseModel_BasePage_TiktokUserShopGoodsItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TiktokUserShopGoodsItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TiktokUserShopGoodsItem]]" }, "ResponseModel_BasePage_TiktokUserShopLiveItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TiktokUserShopLiveItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TiktokUserShopLiveItem]]" }, "ResponseModel_BasePage_TiktokUserShopVideoAdItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TiktokUserShopVideoAdItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TiktokUserShopVideoAdItem]]" }, "ResponseModel_BasePage_TiktokUserVideoInfoItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TiktokUserVideoInfoItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TiktokUserVideoInfoItem]]" }, "ResponseModel_BasePage_TwitchLiveInfoRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TwitchLiveInfoRes_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TwitchLiveInfoRes]]" }, "ResponseModel_BasePage_TwitchMonitorTaskRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TwitchMonitorTaskRes_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TwitchMonitorTaskRes]]" }, "ResponseModel_BasePage_TwitchVideoMessageRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_TwitchVideoMessageRes_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[TwitchVideoMessageRes]]" }, "ResponseModel_BasePage_VideoBrandCollaborationItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_VideoBrandCollaborationItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[VideoBrandCollaborationItem]]" }, "ResponseModel_BasePage_VideoMonitorTaskRep__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_VideoMonitorTaskRep_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[VideoMonitorTaskRep]]" }, "ResponseModel_BasePage_XUserPostItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_XUserPostItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[XUserPostItem]]" }, "ResponseModel_BasePage_YoutubeUserVideoInfoItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BasePage_YoutubeUserVideoInfoItem_" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BasePage[YoutubeUserVideoInfoItem]]" }, "ResponseModel_BillingUsageResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BillingUsageResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[BillingUsageResponse]" }, "ResponseModel_Dict_str__Dict_str__str___": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[Dict[str, Dict[str, str]]]" }, "ResponseModel_Dict_str__str__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[Dict[str, str]]" }, "ResponseModel_FacebookPageInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/FacebookPageInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[FacebookPageInfoRes]" }, "ResponseModel_FacebookPostDetailRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/FacebookPostDetailRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[FacebookPostDetailRes]" }, "ResponseModel_FacebookTaskRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/FacebookTaskRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[FacebookTaskRes]" }, "ResponseModel_FacebookTaskResultRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/FacebookTaskResultRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[FacebookTaskResultRes]" }, "ResponseModel_InstagramUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/InstagramUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[InstagramUserInfoRes]" }, "ResponseModel_list_AudienceContentStyleItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AudienceContentStyleItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[AudienceContentStyleItem]]" }, "ResponseModel_list_AudienceDevicePercentageItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AudienceDevicePercentageItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[AudienceDevicePercentageItem]]" }, "ResponseModel_list_AudienceInteractiveBehaviorItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AudienceInteractiveBehaviorItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[AudienceInteractiveBehaviorItem]]" }, "ResponseModel_list_AudienceInterestItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AudienceInterestItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[AudienceInterestItem]]" }, "ResponseModel_list_CategoryTreeNode__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CategoryTreeNode" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[CategoryTreeNode]]" }, "ResponseModel_list_InstagramUserMonitorMetricsRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InstagramUserMonitorMetricsRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[InstagramUserMonitorMetricsRes]]" }, "ResponseModel_list_InstagramUserSimilarItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InstagramUserSimilarItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[InstagramUserSimilarItem]]" }, "ResponseModel_list_KolHashtagEngagementRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/KolHashtagEngagementRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[KolHashtagEngagementRes]]" }, "ResponseModel_list_TiktokUserMonitorMetricsRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TiktokUserMonitorMetricsRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[TiktokUserMonitorMetricsRes]]" }, "ResponseModel_list_TiktokUserSimilarItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TiktokUserSimilarItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[TiktokUserSimilarItem]]" }, "ResponseModel_list_TwitchLiveViewerCountOverTimeRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchLiveViewerCountOverTimeRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[TwitchLiveViewerCountOverTimeRes]]" }, "ResponseModel_list_TwitchVideoDownloadUrlRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchVideoDownloadUrlRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[TwitchVideoDownloadUrlRes]]" }, "ResponseModel_list_XUserSimilarItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/XUserSimilarItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[XUserSimilarItem]]" }, "ResponseModel_list_YoutubeUserMonitorMetricsRes__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/YoutubeUserMonitorMetricsRes" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[YoutubeUserMonitorMetricsRes]]" }, "ResponseModel_list_YoutubeUserSimilarItem__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/YoutubeUserSimilarItem" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[list[YoutubeUserSimilarItem]]" }, "ResponseModel_RealTimeInstagramMediaInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeInstagramMediaInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeInstagramMediaInfoRes]" }, "ResponseModel_RealTimeInstagramUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeInstagramUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeInstagramUserInfoRes]" }, "ResponseModel_RealTimeInstagramUserMediasRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeInstagramUserMediasRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeInstagramUserMediasRes]" }, "ResponseModel_RealTimeInstagramUserStoriesRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeInstagramUserStoriesRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeInstagramUserStoriesRes]" }, "ResponseModel_RealTimeTiktokUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeTiktokUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeTiktokUserInfoRes]" }, "ResponseModel_RealTimeTiktokUserVideosRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeTiktokUserVideosRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeTiktokUserVideosRes]" }, "ResponseModel_RealTimeTiktokVideoInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeTiktokVideoInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeTiktokVideoInfoRes]" }, "ResponseModel_RealTimeYoutubeUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeYoutubeUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeYoutubeUserInfoRes]" }, "ResponseModel_RealTimeYoutubeUserVideosRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeYoutubeUserVideosRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeYoutubeUserVideosRes]" }, "ResponseModel_RealTimeYoutubeVideoInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/RealTimeYoutubeVideoInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[RealTimeYoutubeVideoInfoRes]" }, "ResponseModel_TiktokUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TiktokUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TiktokUserInfoRes]" }, "ResponseModel_TiktokUserShopSaleRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TiktokUserShopSaleRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TiktokUserShopSaleRes]" }, "ResponseModel_TwitchSearchCategoriesRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchSearchCategoriesRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchSearchCategoriesRes]" }, "ResponseModel_TwitchSearchChannelsRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchSearchChannelsRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchSearchChannelsRes]" }, "ResponseModel_TwitchSearchLiveRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchSearchLiveRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchSearchLiveRes]" }, "ResponseModel_TwitchUserInfo_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchUserInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchUserInfo]" }, "ResponseModel_TwitchUserVideos_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchUserVideos" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchUserVideos]" }, "ResponseModel_TwitchVideoBadgesDataRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchVideoBadgesDataRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchVideoBadgesDataRes]" }, "ResponseModel_TwitchVideoInfo_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/TwitchVideoInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[TwitchVideoInfo]" }, "ResponseModel_Union_str__NoneType__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[Union[str, NoneType]]" }, "ResponseModel_VideoMonitorSnapshotRep_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VideoMonitorSnapshotRep" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[VideoMonitorSnapshotRep]" }, "ResponseModel_VideoMonitorTaskDetailRep_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VideoMonitorTaskDetailRep" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[VideoMonitorTaskDetailRep]" }, "ResponseModel_VideoMonitorTaskRep_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VideoMonitorTaskRep" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[VideoMonitorTaskRep]" }, "ResponseModel_XUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/XUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[XUserInfoRes]" }, "ResponseModel_YoutubeUserInfoRes_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "code": { "type": "integer", "title": "Code", "default": 200 }, "message": { "type": "string", "title": "Message", "default": "Request successful" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/YoutubeUserInfoRes" }, { "type": "null" } ] } }, "type": "object", "required": [ "data" ], "title": "ResponseModel[YoutubeUserInfoRes]" }, "SearchInstagramMediaRep": { "properties": { "author_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author User Id", "description": "user_id" }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Username", "description": "username" }, "author_avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Avatar", "description": "Author avatar" }, "author_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Author Follower Count", "description": "Follower count" }, "media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Id", "description": "media ID" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Content" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Url", "description": "Post URL" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region", "description": "Region" }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Post type (1 = single image, 2 = video, 8 = carousel)" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Video plays" }, "engagement_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Engagement Count", "description": "Engagement count" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/SearchInstagramUserShortInfoItem" }, { "type": "null" } ], "description": "Author" } }, "type": "object", "title": "SearchInstagramMediaRep", "description": "Search Instagram posts response" }, "SearchInstagramMediaReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "nike" ] }, "categorys": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Categorys", "description": "Category", "examples": [ [ 8636, 8646 ] ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-01-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-01-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Post type (1 = single image, 2 = video, 8 = carousel)", "examples": [ "1", "2", "8" ] } }, "type": "object", "title": "SearchInstagramMediaReq", "description": "Search Instagram posts" }, "SearchInstagramMediaShortInfoItem": { "properties": { "media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Id", "description": "media ID" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Content" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Video plays" } }, "type": "object", "title": "SearchInstagramMediaShortInfoItem", "description": "Post" }, "SearchInstagramUserRep": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id", "examples": [ "173560420" ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username", "examples": [ "nike" ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "full_name", "examples": [ "Nike" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_comment_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count", "description": "Average comments", "examples": [ "100" ] }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes", "examples": [ "100" ] }, "avg_play_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Play Count", "description": "Average plays", "examples": [ "1000" ] }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count", "examples": [ "100" ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2025-01-01" ] }, "recent_month_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Month Publish Count", "description": "Posts in the last month", "examples": [ "10" ] }, "recent_week_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Week Publish Count", "description": "Posts in the last week", "examples": [ "10" ] }, "last_media": { "anyOf": [ { "$ref": "#/components/schemas/SearchInstagramMediaShortInfoItem" }, { "type": "null" } ], "description": "Latest post" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchInstagramUserRep", "description": "Search Instagram creators response" }, "SearchInstagramUserReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "" ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-07-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-07-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] } }, "type": "object", "title": "SearchInstagramUserReq", "description": "Search Instagram creators" }, "SearchInstagramUserShortInfoItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id", "examples": [ "173560420" ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username", "examples": [ "nike" ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "full_name", "examples": [ "Nike" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes", "examples": [ "100" ] }, "media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Count", "description": "Post count", "examples": [ "100" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchInstagramUserShortInfoItem", "description": "User profile" }, "SearchTiktokUserRep": { "properties": { "author_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Uid", "description": "Author UID" }, "author_unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Unique Id", "description": "Author unique_id" }, "author_nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Nickname", "description": "Author nickname" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_comment_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count", "description": "Average comments", "examples": [ "100" ] }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes", "examples": [ "100" ] }, "avg_play_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Play Count", "description": "Average plays", "examples": [ "1000" ] }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count", "examples": [ "100" ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2025-01-01" ] }, "recent_month_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Month Publish Count", "description": "Posts in the last month", "examples": [ "10" ] }, "recent_week_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Week Publish Count", "description": "Posts in the last week", "examples": [ "10" ] }, "last_video": { "anyOf": [ { "$ref": "#/components/schemas/SearchTiktokVideoShortInfoItem" }, { "type": "null" } ], "description": "Latest video" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchTiktokUserRep", "description": "Search TikTok creators response" }, "SearchTiktokUserReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "" ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-07-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-07-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] } }, "type": "object", "title": "SearchTiktokUserReq", "description": "Search TikTok creators" }, "SearchTiktokUserShortInfoItem": { "properties": { "author_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Uid", "description": "Author UID" }, "author_unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Unique Id", "description": "Author unique_id" }, "author_nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Nickname", "description": "Author nickname" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_play_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Play Count", "description": "Average plays", "examples": [ "1000" ] }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count", "examples": [ "100" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchTiktokUserShortInfoItem", "description": "User profile" }, "SearchTiktokVideoRep": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "author_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Uid", "description": "Author UID" }, "author_unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Unique Id", "description": "Author unique_id" }, "author_nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Nickname", "description": "Author nickname" }, "author_avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Avatar", "description": "Author avatar" }, "author_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Author Follower Count", "description": "Follower count" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region", "description": "Region" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "Video duration" }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/SearchTiktokUserShortInfoItem" }, { "type": "null" } ], "description": "Author" } }, "type": "object", "title": "SearchTiktokVideoRep", "description": "Search TikTok videos response" }, "SearchTiktokVideoReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "nike" ] }, "categorys": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Categorys", "description": "Category", "examples": [ [ 8636, 8646 ] ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-01-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-01-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] } }, "type": "object", "title": "SearchTiktokVideoReq", "description": "Search TikTok videos" }, "SearchTiktokVideoShortInfoItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" } }, "type": "object", "title": "SearchTiktokVideoShortInfoItem", "description": "Video" }, "SearchXPostRep": { "properties": { "author_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author User Id", "description": "Author user_id" }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Username", "description": "Author handle" }, "author_avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Avatar", "description": "Author avatar" }, "author_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Author Follower Count", "description": "Author followers" }, "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Id", "description": "Post ID" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Post text" }, "post_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Url", "description": "Post URL" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Direct video URL" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region", "description": "Region" }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Media type (0 = text, 1 = image, 2 = video, 3 = GIF)" }, "post_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Post Type", "description": "Post type (1 = original, 2 = repost, 3 = quote, 4 = thread, 5 = reply)" }, "is_retweet": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Retweet", "description": "Is repost" }, "is_quote": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Quote", "description": "Is quote post" }, "is_reply": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Reply", "description": "Is reply" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Reply count" }, "retweet_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retweet Count", "description": "Repost count" }, "quote_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quote Count", "description": "Quote count" }, "bookmark_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bookmark Count", "description": "Save count" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "Impressions" }, "engagement_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Engagement Count", "description": "Engagement count" }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate = engagements on this post (likes + replies + reposts + quotes) / author followers × 100" }, "author": { "anyOf": [ { "$ref": "#/components/schemas/SearchXUserShortInfoItem" }, { "type": "null" } ], "description": "Author" } }, "type": "object", "title": "SearchXPostRep", "description": "Search X posts response" }, "SearchXPostReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "nike" ] }, "categorys": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Categorys", "description": "Category", "examples": [ [ 8636, 8646 ] ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-01-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-01-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Engagement Rate Min", "description": "Minimum per-post engagement rate", "examples": [ "0" ] }, "engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Engagement Rate Max", "description": "Maximum per-post engagement rate", "examples": [ "1" ] }, "comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Comment Count Min", "description": "Minimum per-post comments", "examples": [ "0" ] }, "comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Comment Count Max", "description": "Maximum per-post comments", "examples": [ "10" ] }, "like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Like Count Min", "description": "Minimum per-post likes", "examples": [ "0" ] }, "like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Like Count Max", "description": "Maximum per-post likes", "examples": [ "200" ] }, "play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Play Count Min", "description": "Minimum per-post plays", "examples": [ "1000" ] }, "play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Play Count Max", "description": "Maximum per-post plays", "examples": [ "1000000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] }, "has_email": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Has Email", "description": "Has contact details (1 = yes)", "examples": [ 1 ] }, "languages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Languages", "description": "Language", "examples": [ [ "en", "zh" ] ] }, "creative_form": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Creative Form", "description": "Creative format (1571 = unboxing, 1572 = shopping guide, 1573 = try-on, 1574 = free trial, 1576 = tutorial, 1578 = vlog, 1580 = review)" }, "unique_author": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Unique Author", "description": "Deduplicate creators, one video per author (1 = on)", "examples": [ 1 ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Username", "description": "Author handle", "examples": [ "elonmusk" ] }, "media_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Media Type", "description": "Media type (0 = text, 1 = image, 2 = video, 3 = GIF)", "examples": [ 2 ] }, "post_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Post Type", "description": "Post type (1 = original, 2 = repost, 3 = quote, 4 = thread, 5 = reply)", "examples": [ 1 ] }, "exclude_retweet": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exclude Retweet", "description": "Exclude reposts (1 = exclude). X timelines contain many reposts, which dilute results if kept", "examples": [ 1 ] }, "avg_engagement_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Count Min", "description": "Minimum average engagement" }, "avg_engagement_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Count Max", "description": "Maximum average engagement" }, "avg_video_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Video Engagement Rate Min", "description": "Minimum average video post engagement rate" }, "avg_video_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Video Engagement Rate Max", "description": "Maximum average video post engagement rate" }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By", "description": "Sort by (relevance, publish_at, comment_count, like_count, follower_count, engagement_rate)", "examples": [ "relevance" ] } }, "type": "object", "title": "SearchXPostReq", "description": "Search X posts" }, "SearchXPostShortInfoItem": { "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Id", "description": "Post ID" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Post text" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Reply count" }, "retweet_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retweet Count", "description": "Repost count" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "Impressions" } }, "type": "object", "title": "SearchXPostShortInfoItem", "description": "Post" }, "SearchXUserRep": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id", "examples": [ "44196397" ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username", "examples": [ "elonmusk" ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "Nickname", "examples": [ "Elon Musk" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 241536070 ] }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "description": "Verified" }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate = average engagements of the last 30 posts (likes + replies + reposts + quotes) / followers × 100" }, "avg_video_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Video Engagement Rate", "description": "Average video post engagement rate = average (likes + replies) of the last 30 video posts / average impressions × 100" }, "avg_comment_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count", "description": "Average replies" }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes" }, "avg_retweet_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Retweet Count", "description": "Average reposts" }, "avg_view_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count", "description": "Average impressions" }, "retweet_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Retweet Ratio", "description": "Repost share (%)" }, "reply_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply Ratio", "description": "Reply share (%)" }, "post_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Post Count", "description": "Total posts ever (including reposts)" }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video post count" }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2026-09-02" ] }, "recent_month_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Month Publish Count", "description": "Posts in the last month" }, "recent_week_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Week Publish Count", "description": "Posts in the last week" }, "last_post": { "anyOf": [ { "$ref": "#/components/schemas/SearchXPostShortInfoItem" }, { "type": "null" } ], "description": "Latest post" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchXUserRep", "description": "Search X creators response" }, "SearchXUserReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "" ] }, "category_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array", "maxItems": 100 }, { "type": "null" } ], "title": "Category Ids", "description": "Creator category IDs; second- and third-level IDs may be mixed and are combined as a union; top-level categories cannot be used; at most 100", "examples": [ [ 9001001, 9002 ] ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-07-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-07-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] }, "has_email": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Has Email", "description": "Has contact details (1 = yes)", "examples": [ 1 ] }, "languages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Languages", "description": "Language", "examples": [ [ "en", "zh" ] ] }, "sort_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort By", "description": "Sort by (relevance, follower_count, engagement_rate)", "examples": [ "relevance" ] }, "avg_engagement_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Count Min", "description": "Minimum average engagement" }, "avg_engagement_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Count Max", "description": "Maximum average engagement" }, "avg_video_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Video Engagement Rate Min", "description": "Minimum average video post engagement rate" }, "avg_video_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Video Engagement Rate Max", "description": "Maximum average video post engagement rate" }, "verified": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Verified", "description": "Verified (1 = yes)", "examples": [ 1 ] }, "retweet_ratio_max": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Retweet Ratio Max", "description": "Maximum repost share (%)", "examples": [ 30 ] } }, "type": "object", "title": "SearchXUserReq", "description": "Search X creators" }, "SearchXUserShortInfoItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id", "examples": [ "44196397" ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "username", "examples": [ "elonmusk" ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Full Name", "description": "Nickname", "examples": [ "Elon Musk" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 241536070 ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate = average engagements of the last 30 posts (likes + replies + reposts + quotes) / followers × 100", "examples": [ "0.12" ] }, "avg_video_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Video Engagement Rate", "description": "Average video post engagement rate = average (likes + replies) of the last 30 video posts / average impressions × 100" }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes" }, "post_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Post Count", "description": "Total posts ever (including reposts)" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchXUserShortInfoItem", "description": "User profile" }, "SearchYoutubeUserRep": { "properties": { "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Channel name" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Channel username" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_comment_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count", "description": "Average comments", "examples": [ "100" ] }, "avg_like_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count", "description": "Average likes", "examples": [ "100" ] }, "avg_play_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Play Count", "description": "Average plays", "examples": [ "1000" ] }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count", "examples": [ "100" ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2025-01-01" ] }, "recent_month_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Month Publish Count", "description": "Posts in the last month", "examples": [ "10" ] }, "recent_week_publish_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recent Week Publish Count", "description": "Posts in the last week", "examples": [ "10" ] }, "last_video": { "anyOf": [ { "$ref": "#/components/schemas/SearchYoutubeVideoShortInfoItem" }, { "type": "null" } ], "description": "Latest video" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchYoutubeUserRep", "description": "Search YouTube creators response" }, "SearchYoutubeUserReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "" ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-07-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-07-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] } }, "type": "object", "title": "SearchYoutubeUserReq", "description": "Search YouTube creators" }, "SearchYoutubeUserShortInfoItem": { "properties": { "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Channel name" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender (male, female, unknown)", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ "10000" ] }, "avg_engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate", "description": "Average engagement rate", "examples": [ "0.12" ] }, "avg_play_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Play Count", "description": "Average plays", "examples": [ "1000" ] }, "video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Count", "description": "Video count", "examples": [ "100" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" } }, "type": "object", "title": "SearchYoutubeUserShortInfoItem", "description": "User profile" }, "SearchYoutubeVideoRep": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "Video duration" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL" }, "channel_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Title", "description": "Channel name" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID" }, "channel_avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Avatar", "description": "Channel avatar" }, "channel_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Channel Follower Count", "description": "Channel subscribers" }, "video_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Type", "description": "Content format (video, short)" }, "category_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Category Id", "description": "Category" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" }, "channel": { "anyOf": [ { "$ref": "#/components/schemas/SearchYoutubeUserShortInfoItem" }, { "type": "null" } ], "description": "Channel" } }, "type": "object", "title": "SearchYoutubeVideoRep", "description": "Search YouTube videos response" }, "SearchYoutubeVideoReq": { "properties": { "page": { "type": "integer", "minimum": 1, "title": "Page", "description": "page number", "default": 1 }, "page_size": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0, "title": "Page Size", "description": "page size", "default": 20 }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query", "description": "Search term", "examples": [ "nike" ] }, "categorys": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Categorys", "description": "Category", "examples": [ [ 8636, 8646 ] ] }, "locations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Locations", "description": "Country", "examples": [ [ "US", "VN" ] ] }, "follower_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Min", "description": "Minimum follower count", "examples": [ "10000" ] }, "follower_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Follower Count Max", "description": "Maximum follower count", "examples": [ "1000000" ] }, "create_at_start": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At Start", "description": "Publish time from", "examples": [ "2025-01-01" ] }, "create_at_end": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At End", "description": "Publish time to", "examples": [ "2025-01-07" ] }, "avg_engagement_rate_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Min", "description": "Minimum average engagement rate", "examples": [ "0" ] }, "avg_engagement_rate_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Engagement Rate Max", "description": "Maximum average engagement rate", "examples": [ "1" ] }, "avg_comment_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Min", "description": "Minimum average comments", "examples": [ "0" ] }, "avg_comment_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Comment Count Max", "description": "Maximum average comments", "examples": [ "10" ] }, "avg_like_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Min", "description": "Minimum average likes", "examples": [ "0" ] }, "avg_like_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Like Count Max", "description": "Maximum average likes", "examples": [ "200" ] }, "avg_play_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Min", "description": "Minimum average plays", "examples": [ "0" ] }, "avg_play_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Avg Play Count Max", "description": "Maximum average plays", "examples": [ "2000" ] }, "gender": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Gender", "description": "Gender (0 = unknown, 1 = male, 2 = female)", "examples": [ "1" ] }, "recent_month_publish_count_min": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Min", "description": "Minimum posts in the last month", "examples": [ "10" ] }, "recent_month_publish_count_max": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Recent Month Publish Count Max", "description": "Maximum posts in the last month", "examples": [ "20" ] }, "video_type": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Type", "description": "Video type (1 = video, 2 = short)", "examples": [ "1", "2" ] } }, "type": "object", "title": "SearchYoutubeVideoReq", "description": "Search YouTube videos" }, "SearchYoutubeVideoShortInfoItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "create_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Create At", "description": "Publish time" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Play count" } }, "type": "object", "title": "SearchYoutubeVideoShortInfoItem", "description": "Video" }, "TiktokCoCreatorItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Co-author user_id" }, "unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Id", "description": "Co-author unique_id" } }, "type": "object", "title": "TiktokCoCreatorItem", "description": "TikTok co-creator" }, "TiktokUserInfoRes": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Account ID", "examples": [ "6614519312189947909" ] }, "related_platforms": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RelatedPlatformItem" }, "type": "array" }, { "type": "null" } ], "title": "Related Platforms", "description": "Related platforms" }, "unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Id", "description": "Account name", "examples": [ "mrbeast" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "MrBeast" ] }, "channel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Url", "description": "Account URL", "examples": [ "https://www.tiktok.com/@mrbeast" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio", "examples": [ "New CEO of Tiktok?" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/tiktok/Fvh23MkwSALmrOIv-SeniGj37D0v" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language", "examples": [ "en" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender", "examples": [ "male" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 115036093 ] }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count", "description": "Following count", "examples": [ 340 ] }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "description": "Verified", "examples": [ true ] }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private", "description": "Private account", "examples": [ false ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Tags", "examples": [ "vexbolts", "tseries" ] }, "publish_count_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Month", "description": "Videos per month", "examples": [ 10 ] }, "publish_count_week": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Week", "description": "Videos per week", "examples": [ 10 ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2024-12-12" ] }, "total_video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Video Count", "description": "Total videos", "examples": [ 390 ] }, "total_like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Like Count", "description": "Total likes", "examples": [ 1125987016 ] }, "avg_engagement_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 5", "description": "Last 5 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 5", "description": "Last 5 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 5", "description": "Last 5 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 5", "description": "Last 5 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 5", "description": "Last 5 videos: average likes", "examples": [ "3896196.6" ] }, "avg_share_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Share Count 5", "description": "Last 5 videos: average shares", "examples": [ "3896196.6" ] }, "avg_engagement_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 10", "description": "Last 10 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 10", "description": "Last 10 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 10", "description": "Last 10 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 10", "description": "Last 10 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 10", "description": "Last 10 videos: average likes", "examples": [ "3896196.6" ] }, "avg_share_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Share Count 10", "description": "Last 10 videos: average shares", "examples": [ "3896196.6" ] }, "avg_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 30", "description": "Last 30 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 30", "description": "Last 30 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 30", "description": "Last 30 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 30", "description": "Last 30 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 30", "description": "Last 30 videos: average likes", "examples": [ "3896196.6" ] }, "avg_share_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Share Count 30", "description": "Last 30 videos: average shares", "examples": [ "3896196.6" ] }, "med_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Engagement Rate 30", "description": "Last 30 videos: median engagement rate", "examples": [ "3.95%" ] }, "med_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Rate 30", "description": "Last 30 videos: median view rate", "examples": [ "3.95%" ] }, "med_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Count 30", "description": "Last 30 videos: median plays", "examples": [ "99490577.2" ] }, "med_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Comment Count 30", "description": "Last 30 videos: median comments", "examples": [ "34415.2" ] }, "med_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Like Count 30", "description": "Last 30 videos: median likes", "examples": [ "3896196.6" ] }, "med_share_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Share Count 30", "description": "Last 30 videos: median shares", "examples": [ "3896196.6" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "TiktokUserInfoRes", "description": "TikTok user profile" }, "TiktokUserMonitorMetricsRes": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 115036093 ] } }, "type": "object", "title": "TiktokUserMonitorMetricsRes", "description": "TikTok creator growth metrics" }, "TiktokUserShopGoodsItem": { "properties": { "goods_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Id", "description": "Product ID", "examples": [ "1234567890" ] }, "goods_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Name", "description": "Product name", "examples": [ "Product name" ] }, "goods_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Pic Url", "description": "Product image URL", "examples": [ "https://www.tiktok.com/goods/1234567890" ] }, "currency_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Symbol", "description": "Currency symbol", "examples": [ "$" ] }, "goods_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Price", "description": "Product price", "examples": [ 100 ] }, "goods_sales_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Goods Sales Revenue", "description": "Product revenue (last 30 days)", "examples": [ 100 ] }, "goods_sales_volumn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Goods Sales Volumn", "description": "Product units sold (last 30 days)", "examples": [ 100 ] } }, "type": "object", "title": "TiktokUserShopGoodsItem", "description": "TikTok creator product data" }, "TiktokUserShopLiveItem": { "properties": { "live_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Name", "description": "Livestream title", "examples": [ "Livestream title" ] }, "live_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Cover Url", "description": "Livestream cover URL", "examples": [ "https://www.tiktok.com/live/1234567890" ] }, "live_start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Start Time", "description": "Livestream start time", "examples": [ "08/22 05:00" ] }, "live_end_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live End Time", "description": "Livestream end time", "examples": [ "08/22 17:08" ] }, "live_duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Duration", "description": "Livestream duration", "examples": [ "12.1h" ] }, "live_revenue_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Revenue Amount", "description": "Livestream revenue", "examples": [ 100000 ] }, "live_view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Live View Count", "description": "Livestream views", "examples": [ 100000 ] }, "live_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Price", "description": "Average selling price", "examples": [ 100 ] }, "live_revenue_per_thousand": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Revenue Per Thousand", "description": "Revenue per thousand views", "examples": [ 100 ] } }, "type": "object", "title": "TiktokUserShopLiveItem", "description": "TikTok creator livestream data" }, "TiktokUserShopSaleRes": { "properties": { "currency_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency Symbol", "description": "Currency symbol", "examples": [ "$" ] }, "revenue_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revenue Amount", "description": "Revenue (last 30 days)", "examples": [ 100000 ] }, "sales_volumn": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sales Volumn", "description": "Units sold (last 30 days)", "examples": [ 100 ] }, "video_revenue_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Revenue Amount", "description": "Video revenue (last 30 days)", "examples": [ 100000 ] }, "live_revenue_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Live Revenue Amount", "description": "Livestream revenue (last 30 days)", "examples": [ 100000 ] }, "avg_sales_price": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Sales Price", "description": "Average selling price (last 30 days)", "examples": [ 1000 ] }, "live_views_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Live Views Number", "description": "Livestream views (last 30 days)", "examples": [ 100000 ] }, "video_views_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Views Number", "description": "Video views (last 30 days)", "examples": [ 100000 ] }, "new_followers_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "New Followers Number", "description": "New followers (last 30 days)", "examples": [ 100 ] }, "start_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Time", "description": "Start time", "examples": [ "2025-01-01" ] }, "end_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Time", "description": "End time", "examples": [ "2025-01-01" ] } }, "type": "object", "title": "TiktokUserShopSaleRes", "description": "TikTok creator sales data" }, "TiktokUserShopVideoAdItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID", "examples": [ "1234567890" ] }, "video_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Description", "description": "Video description", "examples": [ "Video description" ] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL", "examples": [ "https://www.tiktok.com/@nike/video/1234567890" ] }, "video_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Cover Url", "description": "Video cover URL", "examples": [ "https://xxx.com/xxx.png" ] }, "video_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Publish At", "description": "Video publish time", "examples": [ "2025-01-01" ] }, "revenue_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revenue Amount", "description": "Video revenue (last 30 days)", "examples": [ 100000 ] }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "Video plays (last 30 days)", "examples": [ 100000 ] }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Video likes", "examples": [ 100000 ] }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Video comments", "examples": [ 100000 ] }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Video shares", "examples": [ 100000 ] }, "ads_deal_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ads Deal Rate", "description": "Ad revenue share (last 30 days)", "examples": [ 0.1 ] }, "ads_view_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ads View Rate", "description": "Ad view share (last 30 days)", "examples": [ 0.1 ] }, "ads_roas_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ads Roas Rate", "description": "Ad ROAS (last 30 days)", "examples": [ 0.1 ] } }, "type": "object", "title": "TiktokUserShopVideoAdItem", "description": "TikTok creator ad video data" }, "TiktokUserSimilarItem": { "properties": { "unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unique Id", "description": "Account name", "examples": [ "mrbeast" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "MrBeast" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio", "examples": [ "New CEO of Tiktok?" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Avatar URL", "examples": [ "https://img.scrumball.cn/tiktok/Fvh23MkwSALmrOIv-SeniGj37D0v" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 115036093 ] } }, "type": "object", "title": "TiktokUserSimilarItem", "description": "Similar TikTok creators" }, "TiktokUserVideoInfoItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID", "examples": [ "7437208265911455006" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description", "examples": [ "The camera man really stood still..." ] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL", "examples": [ "https://www.tiktok.com/@mrbeast/video/7437208265911455006" ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Video cover image", "examples": [ "https://img.scrumball.cn/FqYtaXLVBq9UrepKDrQ1dgyCGQr4" ] }, "duration_second": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Second", "description": "Duration (seconds)", "examples": [ 13167 ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Video tags", "examples": [ "talktuah", "ksi" ] }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Video publish time", "examples": [ "2024-11-15 02:46:41" ] }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "View count", "examples": [ 726988 ] }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count", "examples": [ 6570 ] }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count", "examples": [ 726988 ] }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count", "examples": [ 14209 ] }, "like_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Like Rate", "description": "Like rate (likes / plays)", "examples": [ "0.77" ] }, "view_follower_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Follower Rate", "description": "View-to-subscriber ratio (views / subscribers)", "examples": [ "0.63" ] }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate", "examples": [ "4.9" ] }, "comment_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment Rate", "description": "Comment rate (comments / plays)", "examples": [ "0.19" ] }, "video_author_nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Author Nickname", "description": "Video author account", "examples": [ "mrbeast" ] }, "video_author_unique_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Author Unique Id", "description": "Video author name", "examples": [ "MrBeast" ] }, "video_author_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Author Url", "description": "Video author URL", "examples": [ "https://www.tiktok.com/@mrbeast" ] }, "video_author_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Video Author Follower Count", "description": "Video author followers", "examples": [ 115036093 ] }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "TiktokUserVideoInfoItem", "description": "TikTok user videos" }, "TwitchLiveInfoRes": { "properties": { "live_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Live Id", "description": "Stream ID" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id", "description": "User ID" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "User name" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name", "description": "User nickname" }, "game_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Game Id", "description": "Game category ID" }, "game_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Name", "description": "Game category name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Type" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Stream title" }, "viewer_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Viewer Count", "description": "Viewer count" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At", "description": "Stream start time" }, "ended_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Ended At", "description": "Stream end time" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Stream language" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url", "description": "Avatar" }, "tags": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tags", "description": "Tags" }, "is_mature": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Is Mature", "description": "is_mature" } }, "type": "object", "title": "TwitchLiveInfoRes", "description": "Stream" }, "TwitchLiveViewerCountOverTimeRes": { "properties": { "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count", "description": "Viewer count" }, "monitor_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Monitor Time", "description": "Monitoring time" } }, "type": "object", "title": "TwitchLiveViewerCountOverTimeRes", "description": "Live viewer count over time" }, "TwitchMonitorTaskRes": { "properties": { "monitor_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Monitor Id", "description": "Monitor ID" }, "monitor_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Monitor Url", "description": "Monitored URL" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "User login" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "User Id", "description": "User ID" }, "monitor_start_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Monitor Start Time", "description": "Monitoring start time" }, "monitor_end_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Monitor End Time", "description": "Monitoring end time" } }, "type": "object", "title": "TwitchMonitorTaskRes", "description": "Monitoring task" }, "TwitchMonitorUserReq": { "properties": { "monitor_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Monitor Url", "description": "Monitored URL" }, "monitor_start_time": { "type": "string", "format": "date-time", "title": "Monitor Start Time", "description": "Monitoring start time" }, "monitor_end_time": { "type": "string", "format": "date-time", "title": "Monitor End Time", "description": "Monitoring end time" } }, "type": "object", "required": [ "monitor_url", "monitor_start_time", "monitor_end_time" ], "title": "TwitchMonitorUserReq", "description": "Monitor user request" }, "TwitchSearchCategoriesItem": { "properties": { "box_art_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Box Art Url", "description": "Image URL" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Id", "description": "Game or category ID" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Game or category name" } }, "type": "object", "title": "TwitchSearchCategoriesItem", "description": "Category search result" }, "TwitchSearchCategoriesReq": { "properties": { "query": { "type": "string", "title": "Query", "description": "Search query" }, "first": { "type": "integer", "maximum": 100, "exclusiveMinimum": 0, "title": "First", "description": "Maximum number of items per page. Minimum 1, maximum 100, default 20", "default": 20 }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After", "description": "Next page cursor" } }, "type": "object", "required": [ "query" ], "title": "TwitchSearchCategoriesReq", "description": "Search categories" }, "TwitchSearchCategoriesRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchSearchCategoriesItem" }, "type": "array" }, { "type": "null" } ], "title": "Data", "description": "data" } }, "type": "object", "title": "TwitchSearchCategoriesRes", "description": "Search categories" }, "TwitchSearchChannelsItem": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "Channel ID" }, "broadcaster_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Broadcaster Language", "description": "Language" }, "broadcaster_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Broadcaster Login", "description": "Login name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name" }, "game_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Id", "description": "ID of the game being played or last played" }, "game_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Name", "description": "Name of the game being played or last played" }, "is_live": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Live", "description": "Is live" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Tags" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url", "description": "Thumbnail" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Title" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At", "description": "Stream start time" } }, "type": "object", "title": "TwitchSearchChannelsItem", "description": "Channel search result" }, "TwitchSearchChannelsReq": { "properties": { "query": { "type": "string", "title": "Query", "description": "Search query" }, "live_only": { "type": "boolean", "title": "Live Only", "description": "Only search live channels", "default": false }, "first": { "type": "integer", "maximum": 100, "exclusiveMinimum": 0, "title": "First", "description": "Maximum number of items per page. Minimum 1, maximum 100, default 20", "default": 20 }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After", "description": "Next page cursor" } }, "type": "object", "required": [ "query" ], "title": "TwitchSearchChannelsReq", "description": "Search channels" }, "TwitchSearchChannelsRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchSearchChannelsItem" }, "type": "array" }, { "type": "null" } ], "title": "Data", "description": "data" } }, "type": "object", "title": "TwitchSearchChannelsRes", "description": "Search channels" }, "TwitchSearchLiveItem": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "Stream ID" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "User ID" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "User login" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name", "description": "Username" }, "game_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Id", "description": "Game ID" }, "game_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Name", "description": "Game name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Stream type" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Stream title" }, "viewer_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Viewer Count", "description": "Viewer count" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At", "description": "Livestream start time" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Stream language" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url", "description": "Stream thumbnail URL" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Tags" }, "is_mature": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Mature", "description": "Stream is for mature audiences" } }, "type": "object", "title": "TwitchSearchLiveItem", "description": "Live stream search data" }, "TwitchSearchLiveReq": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "User ID" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "User login name" }, "game_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Game Id", "description": "Game (category) ID" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Stream type filter for the live list. Possible values: all, live; default all" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language" }, "first": { "type": "integer", "maximum": 100, "exclusiveMinimum": 0, "title": "First", "description": "Page size, maximum 100, default 20", "default": 20 }, "before": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Before", "description": "Previous page cursor" }, "after": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "After", "description": "Next page cursor" } }, "type": "object", "title": "TwitchSearchLiveReq", "description": "Search live streams" }, "TwitchSearchLiveRes": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchSearchLiveItem" }, "type": "array" }, { "type": "null" } ], "title": "Data", "description": "data" } }, "type": "object", "title": "TwitchSearchLiveRes", "description": "Live stream search result" }, "TwitchUserInfo": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user id" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "Channel identifier" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Channel name" }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Url", "description": "Channel URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Channel description" }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Channel avatar" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count" } }, "type": "object", "title": "TwitchUserInfo", "description": "Twitch user profile" }, "TwitchUserVideos": { "properties": { "more": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "More", "description": "Has more" }, "offset": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Offset", "description": "offset" }, "videos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchVideoInfo" }, "type": "array" }, { "type": "null" } ], "title": "Videos", "description": "videos" } }, "type": "object", "title": "TwitchUserVideos", "description": "Twitch user videos" }, "TwitchVideoBadgesDataRes": { "properties": { "badges": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchVideoMessageBadgesItem" }, "type": "array" }, { "type": "null" } ], "title": "Badges", "description": "Badges" }, "video": { "anyOf": [ { "$ref": "#/components/schemas/TwitchVideoMessageVideo" }, { "type": "null" } ], "description": "Video" } }, "type": "object", "title": "TwitchVideoBadgesDataRes", "description": "Video badge data" }, "TwitchVideoDownloadUrlRes": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "name" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "url" } }, "type": "object", "title": "TwitchVideoDownloadUrlRes", "description": "Video download URL" }, "TwitchVideoInfo": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "stream_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stream Id", "description": "stream_id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "user_id" }, "user_login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Login", "description": "user_login" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name", "description": "user_name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "description" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "created_at" }, "published_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Published At", "description": "published_at" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "url" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thumbnail Url", "description": "thumbnail_url" }, "viewable": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Viewable", "description": "viewable" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "view_count" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "language" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "type" }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duration", "description": "duration" } }, "type": "object", "title": "TwitchVideoInfo", "description": "Twitch video" }, "TwitchVideoMessageBadgesItem": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "Badge ID" }, "set_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Set Id", "description": "Badge set ID" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "Badge version" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Badge title" }, "image1x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image1X", "description": "Badge image 1x" }, "image2x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image2X", "description": "Badge image 2x" }, "image4x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image4X", "description": "Badge image 4x" }, "click_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Click Action", "description": "Click action" }, "click_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Click Url", "description": "Click URL" } }, "type": "object", "title": "TwitchVideoMessageBadgesItem", "description": "Video badge" }, "TwitchVideoMessageRes": { "properties": { "message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Id", "description": "message_id" }, "commenter_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Commenter Id", "description": "User ID" }, "commenter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commenter Name", "description": "User name" }, "commenter_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Commenter Display Name", "description": "User nickname" }, "content_offset_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Content Offset Seconds", "description": "Content offset (seconds)" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "Content time" }, "message_fragments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Fragments", "description": "Message text" }, "message_user_badges": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message User Badges", "description": "Message user badges" }, "message_user_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message User Color", "description": "Message user color" } }, "type": "object", "title": "TwitchVideoMessageRes", "description": "Video chat message" }, "TwitchVideoMessageVideo": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "Video ID" }, "broadcast_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Broadcast Type", "description": "Type" }, "length_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Length Seconds", "description": "Length (seconds)" }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/TwitchVideoMessageVideoOwner" }, { "type": "null" } ], "description": "Owner" } }, "type": "object", "title": "TwitchVideoMessageVideo", "description": "Video message" }, "TwitchVideoMessageVideoOwner": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "User ID" }, "login": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Login", "description": "Login name" }, "broadcast_badges": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TwitchVideoMessageBadgesItem" }, "type": "array" }, { "type": "null" } ], "title": "Broadcast Badges", "description": "Badges" } }, "type": "object", "title": "TwitchVideoMessageVideoOwner", "description": "Video message owner" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VideoBrandCollaborationItem": { "properties": { "brand_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Brand Name", "description": "Brand deals" }, "collaboration_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Collaboration Count", "description": "Collaboration count" }, "last_collaboration_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Collaboration At", "description": "Last collaboration time" }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate" }, "total_view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total View Count", "description": "Total plays" }, "total_like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Like Count", "description": "Total likes" }, "total_comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Comment Count", "description": "Total comments" }, "videos": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VideoBrandCollaborationVideoItem" }, "type": "array" }, { "type": "null" } ], "title": "Videos", "description": "Collaboration videos" } }, "type": "object", "title": "VideoBrandCollaborationItem", "description": "Brand deals" }, "VideoBrandCollaborationVideoItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description" }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Cover image" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL" }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Publish time" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "View count" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "engagement_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate" } }, "type": "object", "title": "VideoBrandCollaborationVideoItem", "description": "Brand collaboration video summary" }, "VideoMonitorSnapshotRep": { "properties": { "id": { "type": "integer", "title": "Id", "description": "Snapshot ID" }, "snapshot_time": { "type": "string", "format": "date-time", "title": "Snapshot Time", "description": "Snapshot time" }, "snapshot_type": { "type": "string", "title": "Snapshot Type", "description": "Collection type: auto / manual" }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count" }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count" }, "play_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Play Count", "description": "Plays / views" }, "share_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Share Count", "description": "Share count" }, "collect_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Collect Count", "description": "Save count" } }, "type": "object", "required": [ "id", "snapshot_time", "snapshot_type" ], "title": "VideoMonitorSnapshotRep", "description": "Video monitoring snapshot response" }, "VideoMonitorTaskCreateReq": { "properties": { "platform": { "type": "string", "title": "Platform", "description": "Platform: tiktok, youtube, instagram" }, "video_id": { "type": "string", "title": "Video Id", "description": "Video identifier (TikTok video_id / YouTube video_id / Instagram media_code)" } }, "type": "object", "required": [ "platform", "video_id" ], "title": "VideoMonitorTaskCreateReq", "description": "Create video monitoring task request" }, "VideoMonitorTaskDetailRep": { "properties": { "monitor_id": { "type": "string", "title": "Monitor Id", "description": "Monitor ID" }, "platform": { "type": "string", "title": "Platform", "description": "Platform" }, "video_id": { "type": "string", "title": "Video Id", "description": "Video identifier" }, "video_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Title", "description": "Video title" }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Id", "description": "Author identifier" }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Name", "description": "Author name" }, "monitor_status": { "type": "integer", "title": "Monitor Status", "description": "Monitoring status: 0 = monitoring, 10 = completed, 20 = stopped, -1 = error" }, "monitor_start_date": { "type": "string", "format": "date", "title": "Monitor Start Date", "description": "Monitoring start date" }, "monitor_end_date": { "type": "string", "format": "date", "title": "Monitor End Date", "description": "Monitoring end date" }, "last_snapshot_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Snapshot Time", "description": "Last collected at" }, "snapshot_count": { "type": "integer", "title": "Snapshot Count", "description": "Snapshots collected", "default": 0 }, "created_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Time", "description": "Created at" }, "snapshots": { "items": { "$ref": "#/components/schemas/VideoMonitorSnapshotRep" }, "type": "array", "title": "Snapshots", "description": "Snapshot list" } }, "type": "object", "required": [ "monitor_id", "platform", "video_id", "monitor_status", "monitor_start_date", "monitor_end_date" ], "title": "VideoMonitorTaskDetailRep", "description": "Video monitoring task details (with snapshots)" }, "VideoMonitorTaskRep": { "properties": { "monitor_id": { "type": "string", "title": "Monitor Id", "description": "Monitor ID" }, "platform": { "type": "string", "title": "Platform", "description": "Platform" }, "video_id": { "type": "string", "title": "Video Id", "description": "Video identifier" }, "video_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Title", "description": "Video title" }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Id", "description": "Author identifier" }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Author Name", "description": "Author name" }, "monitor_status": { "type": "integer", "title": "Monitor Status", "description": "Monitoring status: 0 = monitoring, 10 = completed, 20 = stopped, -1 = error" }, "monitor_start_date": { "type": "string", "format": "date", "title": "Monitor Start Date", "description": "Monitoring start date" }, "monitor_end_date": { "type": "string", "format": "date", "title": "Monitor End Date", "description": "Monitoring end date" }, "last_snapshot_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Snapshot Time", "description": "Last collected at" }, "snapshot_count": { "type": "integer", "title": "Snapshot Count", "description": "Snapshots collected", "default": 0 }, "created_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Time", "description": "Created at" } }, "type": "object", "required": [ "monitor_id", "platform", "video_id", "monitor_status", "monitor_start_date", "monitor_end_date" ], "title": "VideoMonitorTaskRep", "description": "Video monitoring task response" }, "XMentionItem": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Mentioned account ID" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Mentioned account handle" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Mentioned account nickname" } }, "type": "object", "title": "XMentionItem", "description": "Accounts mentioned in the post" }, "XUserInfoRes": { "properties": { "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id", "description": "Account ID", "examples": [ "44196397" ] }, "related_platforms": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RelatedPlatformItem" }, "type": "array" }, { "type": "null" } ], "title": "Related Platforms", "description": "Related platforms" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Account name", "examples": [ "elonmusk" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "Elon Musk" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Account avatar URL" }, "banner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Banner", "description": "Profile banner URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio" }, "bio_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bio Url", "description": "External link in bio" }, "channel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Url", "description": "Account URL", "examples": [ "https://x.com/elonmusk" ] }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 241536070 ] }, "following_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Following Count", "description": "Following count", "examples": [ 1163 ] }, "favourites_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Favourites Count", "description": "Number of posts the account has liked; an activity signal" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Country", "examples": [ "US" ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location", "description": "Self-reported location text", "examples": [ "Austin, Texas" ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language", "examples": [ "en" ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Gender", "examples": [ "male" ] }, "is_business_account": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Business Account", "description": "Business account" }, "is_verified": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Verified", "description": "Verified" }, "verified_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verified Type", "description": "Verification type (Government / Business / Blue, etc.)", "examples": [ "Blue" ] }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private", "description": "Private account; posts of private accounts cannot be fetched" }, "register_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Register At", "description": "Account creation time", "examples": [ "2009-06-02 20:12:29" ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Top 10 hashtags in recent posts" }, "categories": { "items": { "$ref": "#/components/schemas/InfluencerCategoryItem" }, "type": "array", "title": "Categories", "description": "Category" }, "publish_count_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Month", "description": "Posts per month" }, "publish_count_week": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Week", "description": "Posts per week" }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2026-09-02" ] }, "total_post_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Post Count", "description": "Total posts ever (including reposts)", "examples": [ 107959 ] }, "total_media_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Media Count", "description": "Posts with images or video" }, "total_video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Video Count", "description": "Video posts in the sample window" }, "original_post_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Original Post Count", "description": "Original posts in the sample window (excluding reposts and replies)" }, "retweet_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Retweet Ratio", "description": "Repost share in the window", "examples": [ "12.50%" ] }, "reply_ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply Ratio", "description": "Reply share in the window", "examples": [ "30.00%" ] }, "top_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Top Source", "description": "Most used posting client", "examples": [ "Twitter Web App" ] }, "avg_engagement_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 5", "description": "Last 5 posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / followers × 100", "examples": [ "1.02%" ] }, "avg_view_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 5", "description": "Last 5 posts: average reach rate = average impressions / followers × 100", "examples": [ "1.02%" ] }, "avg_view_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 5", "description": "Last 5 posts: average impressions" }, "avg_like_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 5", "description": "Last 5 posts: average likes" }, "avg_comment_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 5", "description": "Last 5 posts: average replies" }, "avg_retweet_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Retweet Count 5", "description": "Last 5 posts: average reposts" }, "avg_quote_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Quote Count 5", "description": "Last 5 posts: average quotes" }, "avg_engagement_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 10", "description": "Last 10 posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / followers × 100" }, "avg_view_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 10", "description": "Last 10 posts: average reach rate = average impressions / followers × 100" }, "avg_view_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 10", "description": "Last 10 posts: average impressions" }, "avg_like_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 10", "description": "Last 10 posts: average likes" }, "avg_comment_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 10", "description": "Last 10 posts: average replies" }, "avg_retweet_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Retweet Count 10", "description": "Last 10 posts: average reposts" }, "avg_quote_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Quote Count 10", "description": "Last 10 posts: average quotes" }, "avg_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 30", "description": "Last 30 posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / followers × 100" }, "avg_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 30", "description": "Last 30 posts: average reach rate = average impressions / followers × 100" }, "avg_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 30", "description": "Last 30 posts: average impressions" }, "avg_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 30", "description": "Last 30 posts: average likes" }, "avg_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 30", "description": "Last 30 posts: average replies" }, "avg_retweet_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Retweet Count 30", "description": "Last 30 posts: average reposts" }, "avg_quote_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Quote Count 30", "description": "Last 30 posts: average quotes" }, "med_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Engagement Rate 30", "description": "Last 30 posts: median engagement rate = median engagements (likes + replies + reposts + quotes) / followers × 100" }, "med_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Rate 30", "description": "Last 30 posts: median reach rate = median impressions / followers × 100" }, "med_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Count 30", "description": "Last 30 posts: median impressions" }, "med_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Like Count 30", "description": "Last 30 posts: median likes" }, "med_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Comment Count 30", "description": "Last 30 posts: median replies" }, "med_retweet_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Retweet Count 30", "description": "Last 30 posts: median reposts" }, "med_quote_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Quote Count 30", "description": "Last 30 posts: median quotes" }, "avg_engagement_rate_5_video": { "type": "string", "title": "Avg Engagement Rate 5 Video", "description": "Last 5 video posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / average impressions × 100", "default": "0%" }, "avg_engagement_rate_10_video": { "type": "string", "title": "Avg Engagement Rate 10 Video", "description": "Last 10 video posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / average impressions × 100", "default": "0%" }, "avg_engagement_rate_30_video": { "type": "string", "title": "Avg Engagement Rate 30 Video", "description": "Last 30 video posts: average engagement rate = average engagements (likes + replies + reposts + quotes) / average impressions × 100", "default": "0%" }, "med_engagement_rate_30_video": { "type": "string", "title": "Med Engagement Rate 30 Video", "description": "Last 30 video posts: median engagement rate = median engagements (likes + replies + reposts + quotes) / median impressions × 100", "default": "0%" }, "cooperation_score": { "anyOf": [ { "$ref": "#/components/schemas/CooperationScoreSummary" }, { "type": "null" } ], "description": "Collaboration propensity score" }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2026-09-02 00:20:26" ] } }, "type": "object", "title": "XUserInfoRes", "description": "X user profile.\n\nThe avg_* / med_* series below are computed over the account's last N original posts (original / quote / thread), excluding reposts, replies to others and the pinned post.\nEngagements = likes + replies + reposts + quotes (bookmarks excluded)." }, "XUserPostItem": { "properties": { "post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Id", "description": "Post ID", "examples": [ "2095064324477960594" ] }, "post_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Url", "description": "Post URL", "examples": [ "https://x.com/elonmusk/status/2095064324477960594" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Post text", "examples": [ "New feature" ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Post cover / first image; multi-image posts return the cover only" }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Direct video URL" }, "duration": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration", "description": "Video duration (seconds)" }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Post publish time", "examples": [ "2026-09-02 16:22:17" ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Language", "examples": [ "en" ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Post hashtags", "examples": [ "AI", "Tesla" ] }, "mentions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/XMentionItem" }, "type": "array" }, { "type": "null" } ], "title": "Mentions", "description": "Accounts mentioned in the post" }, "links": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Links", "description": "External links in the text" }, "media_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Media Type", "description": "Media type (text, image, video, gif)", "examples": [ "video" ] }, "post_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Type", "description": "Post type (original, retweet = repost, quote, thread, reply)", "examples": [ "original" ] }, "is_pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Pinned", "description": "Is pinned post" }, "is_sensitive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Sensitive", "description": "Is sensitive content" }, "is_paid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Paid", "description": "Is sponsored" }, "retweet_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Retweet Of", "description": "ID of the reposted original post" }, "retweet_author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Retweet Author", "description": "Handle of the reposted original author" }, "quoted_post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quoted Post Id", "description": "ID of the quoted post" }, "quoted_author": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quoted Author", "description": "Handle of the quoted author" }, "reply_to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply To", "description": "Handle being replied to; equals the author for threads" }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "Impressions (X views)", "examples": [ 1231424 ] }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count", "examples": [ 5055 ] }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Reply count", "examples": [ 812 ] }, "retweet_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Retweet Count", "description": "Repost count", "examples": [ 524 ] }, "quote_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quote Count", "description": "Quote count", "examples": [ 31 ] }, "bookmark_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bookmark Count", "description": "Save count", "examples": [ 97 ] }, "engagement_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Engagement Count", "description": "Engagements = likes + replies + reposts + quotes" }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate = engagements (likes + replies + reposts + quotes) / author followers × 100", "examples": [ "1.3" ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "Posting client", "examples": [ "Twitter for iPhone" ] }, "post_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post Username", "description": "Post author handle", "examples": [ "elonmusk" ] }, "post_user_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Post User Url", "description": "Post author URL", "examples": [ "https://x.com/elonmusk" ] }, "post_user_follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Post User Follower Count", "description": "Post author followers", "examples": [ 241536070 ] }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2026-09-02 16:22:17" ] } }, "type": "object", "title": "XUserPostItem", "description": "X user posts" }, "XUserSimilarItem": { "properties": { "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username", "description": "Account name", "examples": [ "elonmusk" ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname", "description": "Account nickname", "examples": [ "Elon Musk" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Account avatar URL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Account bio" }, "follower_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Follower Count", "description": "Follower count", "examples": [ 241536070 ] } }, "type": "object", "title": "XUserSimilarItem", "description": "Similar X creators" }, "YoutubeContentFormatMetrics": { "properties": { "long_video": { "anyOf": [ { "$ref": "#/components/schemas/FormatMetricItem" }, { "type": "null" } ], "description": "Long-form videos" }, "short_video": { "anyOf": [ { "$ref": "#/components/schemas/FormatMetricItem" }, { "type": "null" } ], "description": "Shorts" } }, "type": "object", "title": "YoutubeContentFormatMetrics", "description": "YouTube core metrics split by content format (the all-formats view is in the top-level user/info fields)" }, "YoutubeUserInfoRes": { "properties": { "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID", "examples": [ "UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "related_platforms": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RelatedPlatformItem" }, "type": "array" }, { "type": "null" } ], "title": "Related Platforms", "description": "Related platforms" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Channel name", "examples": [ "MrBeast" ] }, "channel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Url", "description": "Channel URL", "examples": [ "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Channel avatar", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Channel bio", "examples": [ "Go Watch Beast Games! https://unfur.ly/BeastGames..." ] }, "gender": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gender", "description": "Channel gender (male, female, unknown)", "examples": [ "male" ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country", "description": "Channel region", "examples": [ "US" ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Channel language", "examples": [ "en" ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Channel tags", "examples": [ [ "tseries", "tseries songs", "bollywood movies 2025" ] ] }, "register_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Register At", "description": "Channel created at", "examples": [ "2012-02-20" ] }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Subscriber Count", "description": "Subscriber count", "examples": [ 364000000 ] }, "publish_count_month": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Month", "description": "Videos per month", "examples": [ 10 ] }, "publish_count_week": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Publish Count Week", "description": "Videos per week", "examples": [ 10 ] }, "last_publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Publish At", "description": "Last publish time", "examples": [ "2025-02-20" ] }, "total_video_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total Video Count", "description": "Total videos", "examples": [ 848 ] }, "total_view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total View Count", "description": "Total views", "examples": [ 73310408734 ] }, "avg_view_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count", "description": "Overall average plays", "examples": [ "182969994.63" ] }, "avg_engagement_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 5", "description": "Last 5 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 5", "description": "Last 5 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 5", "description": "Last 5 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 5", "description": "Last 5 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_5": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 5", "description": "Last 5 videos: average likes", "examples": [ "3896196.6" ] }, "avg_engagement_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 10", "description": "Last 10 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 10", "description": "Last 10 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 10", "description": "Last 10 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 10", "description": "Last 10 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_10": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 10", "description": "Last 10 videos: average likes", "examples": [ "3896196.6" ] }, "avg_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Engagement Rate 30", "description": "Last 30 videos: average engagement rate", "examples": [ "3.95%" ] }, "avg_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Rate 30", "description": "Last 30 videos: average view rate", "examples": [ "3.95%" ] }, "avg_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg View Count 30", "description": "Last 30 videos: average plays", "examples": [ "99490577.2" ] }, "avg_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Comment Count 30", "description": "Last 30 videos: average comments", "examples": [ "34415.2" ] }, "avg_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avg Like Count 30", "description": "Last 30 videos: average likes", "examples": [ "3896196.6" ] }, "med_engagement_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Engagement Rate 30", "description": "Last 30 videos: median engagement rate", "examples": [ "3.95%" ] }, "med_view_rate_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Rate 30", "description": "Last 30 videos: median view rate", "examples": [ "3.95%" ] }, "med_view_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med View Count 30", "description": "Last 30 videos: median plays", "examples": [ "99490577.2" ] }, "med_comment_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Comment Count 30", "description": "Last 30 videos: median comments", "examples": [ "34415.2" ] }, "med_like_count_30": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Med Like Count 30", "description": "Last 30 videos: median likes", "examples": [ "3896196.6" ] }, "evaluation_min": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Min", "description": "Estimated minimum collaboration rate (USD)" }, "evaluation_max": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Evaluation Max", "description": "Estimated maximum collaboration rate (USD)" }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "YoutubeUserInfoRes", "description": "YouTube user profile" }, "YoutubeUserMonitorMetricsRes": { "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date" }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Subscriber Count", "description": "Subscriber count", "examples": [ 364000000 ] } }, "type": "object", "title": "YoutubeUserMonitorMetricsRes", "description": "YouTube creator growth metrics" }, "YoutubeUserSimilarItem": { "properties": { "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id", "description": "Channel ID", "examples": [ "UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Channel name", "examples": [ "MrBeast" ] }, "avatar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar", "description": "Channel avatar", "examples": [ "https://img.scrumball.cn/FpiY4unAm7NroQ3dS4heDOp89moK" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Channel bio", "examples": [ "Go Watch Beast Games! https://unfur.ly/BeastGames..." ] }, "subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Subscriber Count", "description": "Subscriber count", "examples": [ 364000000 ] } }, "type": "object", "title": "YoutubeUserSimilarItem", "description": "Similar YouTube creators" }, "YoutubeUserVideoInfoItem": { "properties": { "video_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Id", "description": "Video ID", "examples": [ "L5ihmu87xTE" ] }, "video_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Url", "description": "Video URL", "examples": [ "https://www.youtube.com/watch?v=L5ihmu87xTE" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Video title", "examples": [ "Find This Stranger, Win $10,000" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Video description", "examples": [ "..." ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cover Url", "description": "Video cover image", "examples": [ "https://img.scrumball.cn/FqYtaXLVBq9UrepKDrQ1dgyCGQr4" ] }, "publish_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Publish At", "description": "Video publish time", "examples": [ "2025-02-15 02:15:00" ] }, "duration_second": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Duration Second", "description": "Duration (seconds)", "examples": [ 61 ] }, "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Like Count", "description": "Like count", "examples": [ 1795400 ] }, "comment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Comment Count", "description": "Comment count", "examples": [ 3282 ] }, "view_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "View Count", "description": "View count", "examples": [ 24668372 ] }, "video_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Video Type", "description": "Video type (short, video)", "examples": [ "short" ] }, "like_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Like Rate", "description": "Like rate (likes / plays)", "examples": [ "0.28" ] }, "view_subscriber_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Subscriber Rate", "description": "View-to-subscriber ratio (views / subscribers)", "examples": [ "0.78" ] }, "engagement_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Engagement Rate", "description": "Engagement rate", "examples": [ "7.29" ] }, "comment_rate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment Rate", "description": "Comment rate (comments / plays)", "examples": [ "0.13" ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "Video tags", "examples": [ [ "magic tricks", "experiment" ] ] }, "channel_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Title", "description": "Video author name", "examples": [ "MrBeast" ] }, "channel_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Url", "description": "Video author URL", "examples": [ "https://www.youtube.com/channel/UCX6OQ3DkcsbYNE6H8uQQuVA" ] }, "channel_subscriber_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Channel Subscriber Count", "description": "Video author followers", "examples": [ 364000000 ] }, "last_update_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Update At", "description": "Data updated at", "examples": [ "2025-02-21 00:20:26" ] } }, "type": "object", "title": "YoutubeUserVideoInfoItem", "description": "YouTube user videos" } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "authorization" } } } }