Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Search User by Keyword

サーバー:https://openapi.felo.ai
クライアントライブラリ

Twitter / X

​

Query public users, posts, communities and trends.

Search User by Keyword

​

Search X user accounts by keyword and get back matching profiles. Use this when you know roughly who you are looking for — a company name, a topic, a partial handle — but not the exact @handle. Cursor-paginated; returns full user objects under users. This searches accounts, not posts; to search tweet content use get_twitter_tweet_advanced_search.

クエリパラメーター
  • query
    型: string
    必須

    The keyword to search.

  • cursor
    型: string

    The cursor to paginate through the results. First page is empty.

レスポンス
  • 200
    型: object · SearchUserResponse

    Successful response

    • has_next_page
      型: boolean
    • msg
      型: string
    • next_cursor
      型: string
    • status
      型: string 列挙値
      値
      • success
      • error
    • users
      型: array object[] · User[]
      • automatedBy
        型: string
      • canDm
        型: boolean
      • coverPicture
        型: string
      • createdAt
        型: string
      • description
        型: string
      • favouritesCount
        型: integer

        Integer numbers.

      • followers
        型: integer

        Integer numbers.

      • following
        型: integer

        Integer numbers.

      • hasCustomTimelines
        型: boolean
      • id
        型: string
      • isAutomated
        型: boolean
      • isBlueVerified
        型: boolean
      • isTranslator
        型: boolean
      • location
        型: string
      • mediaCount
        型: integer

        Integer numbers.

      • message
        型: string
      • name
        型: string
      • pinnedTweetIds
        型: array string[]
      • possiblySensitive
        型: boolean
      • profile_bio
        型: object
        • description
          型: string
        • entities
          型: object
          • description
            型: object
            • urls
              型: array object[]
              • display_url
                型: string
              • expanded_url
                型: string
              • indices
                型: array integer[]
              • url
                型: string
          • url
            型: object
            • urls
              型: array object[]
              • display_url
                型: string
              • expanded_url
                型: string
              • indices
                型: array integer[]
              • url
                型: string
      • profilePicture
        型: string
      • statusesCount
        型: integer

        Integer numbers.

      • type
        型: string
      • unavailable
        型: boolean
      • unavailableReason
        型: string
      • url
        型: string
      • userName
        型: string
      • verifiedType
        型: string
      • withheldInCountries
        型: array string[]
    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for get/v1/beta/twitter/user/search
curl 'https://openapi.felo.ai/v1/beta/twitter/user/search?query=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "users": [
    {
      "type": "string",
      "userName": "string",
      "url": "string",
      "id": "string",
      "name": "string",
      "isBlueVerified": true,
      "verifiedType": "string",
      "profilePicture": "string",
      "coverPicture": "string",
      "description": "string",
      "location": "string",
      "followers": 1,
      "following": 1,
      "canDm": true,
      "createdAt": "string",
      "favouritesCount": 1,
      "hasCustomTimelines": true,
      "isTranslator": true,
      "mediaCount": 1,
      "statusesCount": 1,
      "withheldInCountries": [
        "string"
      ],
      "possiblySensitive": true,
      "pinnedTweetIds": [
        "string"
      ],
      "isAutomated": true,
      "automatedBy": "string",
      "unavailable": true,
      "message": "string",
      "unavailableReason": "string",
      "profile_bio": {
        "description": "string",
        "entities": {
          "description": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          },
          "url": {
            "urls": [
              {
                "display_url": "string",
                "expanded_url": "string",
                "indices": [
                  1
                ],
                "url": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "has_next_page": true,
  "next_cursor": "string",
  "status": "success",
  "msg": "string"
}
Search User by Keyword