コミュニティの検索

コミュニティの検索.

APIリファレンスに戻る

/Communities Endpoints

TwexAPI REST

POST/twitter/community/search

API 認証

AuthorizationBearer token · header必須

TwexAPIのグローバル認証トークン (Bearer Token)。ヘッダーに含める必要があります：Authorization: Bearer <YOUR_TWEXAPI_KEY>。

リクエストボディ

必須application/json

querystring必須

The query to search for.

target_countinteger必須

The number of communities to search.

レスポンス

200A list of community objects.

codeinteger必須

HTTP ステータスコード（200 は成功）

msgstring必須

レスポンスメッセージ（例: 'success'）

dataCommunityModel[]必須

返却されるコアデータオブジェクトまたは配列

プロパティを表示

Array of CommunityModel

idstring必須

The ID of the community

namestring必須

ユーザー表示名

descriptionstring必須

プロフィール自己紹介文（Bio）

member_countinteger必須

The number of members in the community

is_nsfwboolean | any

Indicates if the community is NSFW.

プロパティを表示

Any of:

boolean

boolean

any

any

members_facepile_resultsstring[]

The profile image URLs of members.

bannerobject | any

The banner information of the community.

プロパティを表示

Any of:

object

object

any

any

is_memberboolean | any

Indicates if the user is a member of the community.

プロパティを表示

Any of:

boolean

boolean

any

any

rolestring | any

The role of the user in the community.

プロパティを表示

Any of:

string

string

any

any

adminUserModel | any

The admin of the community.

プロパティを表示

Any of:

UserModel

idstring必須

User ID

namestring必須

ユーザー表示名

screen_namestring必須

Twitterユーザー名（Handle、@なし）

created_atstring | any

作成日時（UTC標準時）

プロパティを表示

Any of:

string

string

any

any

created_at_datetimestring | any

Account creation datetime in ISO format

プロパティを表示

Any of:

string

string

any

any

can_dmboolean | any

Whether the user can be direct messaged

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

can_media_tagboolean | any

Whether the user can be tagged in media

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

default_profileboolean | any

Whether the user has a default profile

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

default_profile_imageboolean | any

Whether the user has a default profile image

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

descriptionstring | any

プロフィール自己紹介文（Bio）

default: ""

プロパティを表示

Any of:

string

string

any

any

description_urlsstring[]

List of URLs found in the user's description

default: []

urlsurlModel[] | any

List of URLs found in the user's profile

プロパティを表示

Any of:

urlModel[]

Array of urlModel

urlstring必須

URL

expanded_urlstring | any

Expanded URL

プロパティを表示

Any of:

string

string

any

any

display_urlstring | any

Display URL

プロパティを表示

Any of:

string

string

any

any

any

any

fast_followers_countinteger | any

Count of fast followers

default: 0

プロパティを表示

Any of:

integer

integer

any

any

favourites_countinteger | any

Number of tweets the user has liked

default: 0

プロパティを表示

Any of:

integer

integer

any

any

followers_countinteger | any

フォロワー総数

default: 0

プロパティを表示

Any of:

integer

integer

any

any

following_countinteger | any

フォロー中の総数

default: 0

プロパティを表示

Any of:

integer

integer

any

any

has_custom_timelinesboolean | any

Whether the user has custom timelines

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

is_blue_verifiedboolean | any

Blue verification status

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

verified_typestring | any

Verification badge type when not blue-only: blue, business, government, etc.

プロパティを表示

Any of:

string

string

any

any

is_verifiedboolean | any

True if the account has any verification badge (blue, business, government, or legacy verified)

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

profile_image_shapestring | any

Profile image shape (Circle or Square; Square often indicates business/government)

プロパティを表示

Any of:

string

string

any

any

is_translatorboolean | any

Whether the user is a translator

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

listed_countinteger | any

Number of public lists the user is a member of

default: 0

プロパティを表示

Any of:

integer

integer

any

any

locationstring | any

User's location

default: ""

プロパティを表示

Any of:

string

string

any

any

media_countinteger | any

Number of media tweets posted by the user

default: 0

プロパティを表示

Any of:

integer

integer

any

any

normal_followers_countinteger | any

Count of normal followers

default: 0

プロパティを表示

Any of:

integer

integer

any

any

pinned_tweet_idsstring[]

List of pinned tweet IDs

default: []

possibly_sensitiveboolean | any

Whether the user's profile may contain sensitive content

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

profile_banner_urlstring | any

URL of the user's profile banner

プロパティを表示

Any of:

string

string

any

any

profile_image_urlstring | any

URL of the user's profile image

プロパティを表示

Any of:

string

string

any

any

protectedboolean | any

Whether the user's tweets are protected

default: false

プロパティを表示

Any of:

boolean

boolean

any

any

statuses_countinteger | any

Number of tweets posted by the user

default: 0

プロパティを表示

Any of:

integer

integer

any

any

any

any

join_policystring | any

The join policy of the community.

プロパティを表示

Any of:

string

string

any

any

created_atinteger | any

作成日時（UTC標準時）

プロパティを表示

Any of:

integer

integer

any

any

invites_policystring | any

The invites policy of the community.

プロパティを表示

Any of:

string

string

any

any

is_pinnedboolean | any

Indicates if the community is pinned.

プロパティを表示

Any of:

boolean

boolean

any

any

422パラメータバリデーションエラー

detailValidationError[]

プロパティを表示

Array of ValidationError

locstring | integer[]必須

プロパティを表示

Array of string | integer

Any of:

string

string

integer

integer

msgstring必須

レスポンスメッセージ（例: 'success'）

typestring必須

inputany

ctxobject

⚡インタラクティブテスト / Try APIPOST/twitter/community/search

Live Console

🌐対象サーバー:https://api.twexapi.io

● 本番環境レディ

🔍

公開データ取得（TwexAPIキーのみ、Twitter Cookie不要）

本エンドポイントは公開Twitterデータの検索・取得用です。TwitterアカウントやCookieは一切不要です！下記の「API認証」に TwexAPIプラットフォームキー (Bearer Token) を入力するだけで即座にテストできます。

🔑API 認証

キーを記憶コード例に同期

TwexAPI プラットフォームキー Bearer Token必須

すべてのTwexAPIエンドポイントで使用されるAPIキー。ダッシュボードで取得できます。

📝リクエストボディapplication/json

querystring

必須The query to search for.

target_countinteger

必須The number of communities to search.

💡 クイック送信:⌘ / Ctrl+Enter

📡

暂无响应数据

请在「请求配置」中确认参数后，点击底部的「发送请求」按钮。

リクエスト例

curl -X POST "https://api.twexapi.io/twitter/community/search" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "string",
  "target_count": 0
}'

const response = await fetch("https://api.twexapi.io/twitter/community/search", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "query": "string",
  "target_count": 0
})
});

import requests

response = requests.post(
    "https://api.twexapi.io/twitter/community/search",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "query": "string",
  "target_count": 0
},
)

レスポンス例

{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "member_count": 0,
      "is_nsfw": true,
      "members_facepile_results": [
        "string"
      ],
      "banner": {},
      "is_member": true,
      "role": "string",
      "admin": {
        "id": "1717001045992251392",
        "name": "Cryptoklepto",
        "screen_name": "CK_Cryptoklepto",
        "created_at": "Mon Oct 28 02:32:47 +0000 2024",
        "created_at_datetime": "2024-10-28T02:32:47.000Z",
        "can_dm": false,
        "can_media_tag": false,
        "default_profile": false,
        "default_profile_image": false,
        "description": "",
        "description_urls": [],
        "urls": [
          {
            "url": "https://www.google.com",
            "expanded_url": "https://www.google.com",
            "display_url": "www.google.com"
          }
        ],
        "fast_followers_count": 0,
        "favourites_count": 0,
        "followers_count": 0,
        "following_count": 0,
        "has_custom_timelines": false,
        "is_blue_verified": false,
        "verified_type": "government",
        "is_verified": false,
        "profile_image_shape": "Circle",
        "is_translator": false,
        "listed_count": 0,
        "location": "New York, USA",
        "media_count": 0,
        "normal_followers_count": 0,
        "pinned_tweet_ids": [],
        "possibly_sensitive": false,
        "profile_banner_url": "string",
        "profile_image_url": "string",
        "protected": false,
        "statuses_count": 0
      },
      "join_policy": "string",
      "created_at": 0,
      "invites_policy": "string",
      "is_pinned": true
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}