Skip to content

README.md

Latest commit

 

History

History
98 lines (67 loc) · 5.02 KB

README.md

File metadata and controls

98 lines (67 loc) · 5.02 KB
Raw

Users.Followers

Overview

Available Operations

  • list - Get Followers (v3)
  • verified - Get Verified Followers

list

Get followers of a user. Page size 10-100; use cursor for more pages. $0.10/1000 users.

Example Usage

require 'x_api_scraper'

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

req = Models::Components::FollowersFollowingV3Query.new(
  username: 'elonmusk',
  count: 20,
  cursor: '1870681402093130182|2076960004551737340'
)
res = s.users.followers.list(request: req)

unless res.verified_followers_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

verified

Get blue-verified followers of a user. Page size 10-100; use cursor for more pages. $0.10/1000 users.

Example Usage

require 'x_api_scraper'

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

req = Models::Components::FollowersFollowingV3Query.new(
  username: 'elonmusk',
  count: 20,
  cursor: '1870681402093130182|2076960004551737340'
)
res = s.users.followers.verified(request: req)

unless res.verified_followers_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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