Xのポストを検索

インデックス済みのXのポストに対してフィルタ付き検索を実行し、一致するコンテンツをクリエイター情報とエンゲージメント数付きでページ単位で返します。検索リクエストは単一の照会よりクォータ消費が大きくなります。

POST/api/v1/search/x/post

クォータ消費: このエンドポイントへの成功したリクエスト 1 件あたり、プランのクォータが 100 単位消費されます。

リクエストパラメータ

必須パラメータ

このエンドポイントに必須パラメータはありません。

任意パラメータ

名前	位置	型	説明
`page`	body	integer	page number example: 0
`page_size`	body	integer	page size example: 0
`query`	body	object	Search term example: string
`categorys`	body	object	Category
`locations`	body	object	Country
`follower_count_min`	body	object	Minimum follower count example: 0
`follower_count_max`	body	object	Maximum follower count example: 0
`create_at_start`	body	object	Publish time from example: string
`create_at_end`	body	object	Publish time to example: string
`avg_engagement_rate_min`	body	object	Minimum average engagement rate example: 0
`avg_engagement_rate_max`	body	object	Maximum average engagement rate example: 0
`avg_comment_count_min`	body	object	Minimum average comments example: 0
`avg_comment_count_max`	body	object	Maximum average comments example: 0
`avg_like_count_min`	body	object	Minimum average likes example: 0
`avg_like_count_max`	body	object	Maximum average likes example: 0
`avg_play_count_min`	body	object	Minimum average plays example: 0
`avg_play_count_max`	body	object	Maximum average plays example: 0
`engagement_rate_min`	body	object	Minimum per-post engagement rate example: 0
`engagement_rate_max`	body	object	Maximum per-post engagement rate example: 0
`comment_count_min`	body	object	Minimum per-post comments example: 0
`comment_count_max`	body	object	Maximum per-post comments example: 0
`like_count_min`	body	object	Minimum per-post likes example: 0
`like_count_max`	body	object	Maximum per-post likes example: 0
`play_count_min`	body	object	Minimum per-post plays example: 0
`play_count_max`	body	object	Maximum per-post plays example: 0
`gender`	body	object	Gender (0 = unknown, 1 = male, 2 = female) example: 0
`recent_month_publish_count_min`	body	object	Minimum posts in the last month example: 0
`recent_month_publish_count_max`	body	object	Maximum posts in the last month example: 0
`has_email`	body	object	Has contact details (1 = yes) example: 0
`languages`	body	object	Language
`creative_form`	body	object	Creative format (1571 = unboxing, 1572 = shopping guide, 1573 = try-on, 1574 = free trial, 1576 = tutorial, 1578 = vlog, 1580 = review) example: 0
`unique_author`	body	object	Deduplicate creators, one video per author (1 = on) example: 0
`author_username`	body	object	Author handle example: string
`media_type`	body	object	Media type (0 = text, 1 = image, 2 = video, 3 = GIF) example: 0
`post_type`	body	object	Post type (1 = original, 2 = repost, 3 = quote, 4 = thread, 5 = reply) example: 0
`exclude_retweet`	body	object	Exclude reposts (1 = exclude). X timelines contain many reposts, which dilute results if kept example: 0
`avg_engagement_count_min`	body	object	Minimum average engagement example: 0
`avg_engagement_count_max`	body	object	Maximum average engagement example: 0
`avg_video_engagement_rate_min`	body	object	Minimum average video post engagement rate example: 0
`avg_video_engagement_rate_max`	body	object	Maximum average video post engagement rate example: 0
`sort_by`	body	object	Sort by (relevance, publish_at, comment_count, like_count, follower_count, engagement_rate) example: string

レスポンスフィールド

名前	型	説明
`success`	boolean	Success
`code`	integer	Code
`message`	string	Message
`data`	object	-
`data.items`	array<object>	Items
`data.total`	integer	Total
`data.page`	integer	Page
`data.page_size`	integer	Page Size
`data.total_pages`	integer	Total Pages

お試し実行

リクエストURL

https://openapi.scdata.cc/api/v1/search/x/post

Authorization

ダッシュボードのAPIキーを選択

リクエストを送信する前にAPIキーを入力してください。ダッシュボードを開く

JSONボディ

cURL の例

bash

curl -X POST "https://openapi.scdata.cc/api/v1/search/x/post" \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":0,"page_size":0,"query":"string","categorys":[0],"locations":["string"],"follower_count_min":0,"follower_count_max":0,"create_at_start":"string","create_at_end":"string","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"}'

レスポンス例 (200 application/json)

json

{
  "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
  }
}

ユースケース

トピック調査 — 商品キーワードに関して既にどんなコンテンツがあり、どう反応されているかを把握します。
コンテンツ経由のクリエイター発掘 — プロフィール文ではなく、公開しているポストからクリエイターを特定します。