Skip to content

Latest commit

 

History

History
186 lines (127 loc) · 10.2 KB

File metadata and controls

186 lines (127 loc) · 10.2 KB

Tweets.Engagement

Overview

Available Operations

retweeters

Retrieve retweeters in a single request. Automatically paginates until count is reached or no more results. Minimum 10, maximum 5000 users.

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::TweetsEngagementRetweetersRequest.new(
  tweet_id: '<id>',
  target_count: 100
)
res = s.tweets.engagement.retweeters(request: req)

unless res.search_user_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::TweetsEngagementRetweetersRequest ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::TweetsEngagementRetweetersResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*

retweeters_page

Retrieve retweeters using cursor-based pagination. Each page returns up to 20 users. Pass next_cursor from the previous response to continue.

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Components::GetRetweetersCursorQuery.new(
  tweet_id: '<id>',
  next_cursor: 'eyJpZCI6IjIwNjAwNTE1Mzg3OTQ0Mzg2NzciLCJmbG9ja0N1cnNvciI6IjQ2MTE2ODYwMTg2Mjg5ODcxNzkiLCJvcmlnaW5hbERpcmVjdGlvbiI6IkRlc2NlbmRpbmcifQ==-999995'
)
res = s.tweets.engagement.retweeters_page(request: req)

unless res.get_retweeters_cursor_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Components::GetRetweetersCursorQuery ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::TweetsEngagementRetweetersPageResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*

quotes

Retrieve quote tweets in a single request. Automatically paginates until count is reached or no more results. Use Latest for chronological order or Top for ranked results. Minimum 10, maximum 5000 tweets.

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Components::GetQuotesQuery.new(
  tweet_id: '<id>',
  count: 100
)
res = s.tweets.engagement.quotes(request: req)

unless res.get_quotes_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Components::GetQuotesQuery ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::TweetsEngagementQuotesResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*

quotes_page

Retrieve quote tweets using cursor-based pagination. Each page returns up to 20 tweets. Use Latest for chronological order or Top for ranked results. Pass next_cursor from the previous response to continue.

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Components::GetQuotesCursorQuery.new(
  tweet_id: '<id>',
  next_cursor: 'scroll:thGQYTMwMjU5NDA4ODc4ODc6MjU5NDA4ODc4ODc6'
)
res = s.tweets.engagement.quotes_page(request: req)

unless res.get_quotes_cursor_response.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Components::GetQuotesCursorQuery ✔️ The request object to use for the request.

Response

T.nilable(Models::Operations::TweetsEngagementQuotesPageResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*