Skip to content

README.md

Latest commit

 

History

History
276 lines (189 loc) · 14 KB

README.md

File metadata and controls

276 lines (189 loc) · 14 KB
Raw

Lists

Overview

Available Operations

tweets

Get list tweets

Example Usage

require 'x_api_scraper'

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

req = Models::Operations::ListsTweetsRequest.new(
  list_id: '<id>',
  target_count: 277_741
)
res = s.lists.tweets(request: req)

unless res.list_tweets_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

tweets_page

Retrieve a paginated list of list 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.

Example Usage

require 'x_api_scraper'

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

req = Models::Components::GetListTweetsCursorQuery.new(
  next_cursor: '1234567890',
  list_id: '<id>'
)
res = s.lists.tweets_page(request: req)

unless res.get_list_tweets_cursor_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

subscribers

Get list subscribers

Example Usage

require 'x_api_scraper'

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

req = Models::Operations::ListsSubscribersRequest.new(
  list_id: '<id>',
  target_count: 440_492
)
res = s.lists.subscribers(request: req)

unless res.list_subscribers_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

members

Get list members

Example Usage

require 'x_api_scraper'

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

req = Models::Operations::ListsMembersRequest.new(
  list_id: '<id>',
  target_count: 685_648
)
res = s.lists.members(request: req)

unless res.list_members_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

members_page

Retrieve a paginated list of list 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.

Example Usage

require 'x_api_scraper'

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

req = Models::Components::GetListMembersCursorQuery.new(
  next_cursor: '1234567890',
  list_id: '<id>'
)
res = s.lists.members_page(request: req)

unless res.get_list_members_cursor_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

search

Search list

Example Usage

require 'x_api_scraper'

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

req = Models::Components::SearchListQuery.new(
  query: '<value>',
  target_count: 810_476
)
res = s.lists.search(request: req)

unless res.search_list_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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