- members - Get Community Members
- members_page - Get Community Members by Page
- tweets - Get Community Tweets
- tweets_page - Get Community Tweets by Page
- search - Search Community
- get - Get Community
- search_tweets - Search Community Tweets
Get community members
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Operations::CommunitiesMembersRequest.new(
community_id: '<id>',
target_count: 298_640
)
res = s.communities.members(request: req)
unless res.search_user_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Operations::CommunitiesMembersRequest | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesMembersResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Retrieve a paginated list of community members using cursor-based pagination. Each page returns up to 20 members. Pass next_cursor from the previous response to continue. Pricing: $0.10 per 1,000 members.
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Components::GetCommunityMembersCursorQuery.new(
next_cursor: '1234567890',
community_id: '<id>'
)
res = s.communities.members_page(request: req)
unless res.get_community_members_cursor_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Components::GetCommunityMembersCursorQuery | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesMembersPageResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Get community tweets
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Operations::CommunitiesTweetsRequest.new(
community_id: '<id>',
tweet_type: Models::Operations::TweetType::MEDIA,
target_count: 682_850
)
res = s.communities.tweets(request: req)
unless res.community_tweets_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Operations::CommunitiesTweetsRequest | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesTweetsResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Retrieve a paginated list of community tweets using cursor-based pagination. Each page returns up to 20 tweets. Pass next_cursor from the previous response to continue. Pricing: $0.10 per 1,000 tweets.
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Components::GetCommunityTweetsCursorQuery.new(
next_cursor: '1234567890',
community_id: '<id>',
tweet_type: Models::Components::TweetType::TOP
)
res = s.communities.tweets_page(request: req)
unless res.get_community_tweets_cursor_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Components::GetCommunityTweetsCursorQuery | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesTweetsPageResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Search community
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Components::SearchCommunityQuery.new(
query: '<value>',
target_count: 761_546
)
res = s.communities.search(request: req)
unless res.search_community_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Components::SearchCommunityQuery | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesSearchResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Get community
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Operations::CommunitiesGetRequest.new(
community_id: '<id>'
)
res = s.communities.get(request: req)
unless res.get_community_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Operations::CommunitiesGetRequest | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesGetResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |
Search community tweets
require 'x_api_scraper'
Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
req = Models::Components::SearchCommunityTweetsQuery.new(
community_id: '<id>',
target_count: 687_977,
query: '<value>'
)
res = s.communities.search_tweets(request: req)
unless res.community_tweets_response.nil?
# handle response
end| Parameter | Type | Required | Description |
|---|---|---|---|
request |
Models::Components::SearchCommunityTweetsQuery | ✔️ | The request object to use for the request. |
T.nilable(Models::Operations::CommunitiesSearchTweetsResponse)
| Error Type | Status Code | Content Type |
|---|---|---|
| Models::Errors::HTTPValidationError | 422 | application/json |
| Errors::APIError | 4XX, 5XX | */* |