Skip to content

README.md

Latest commit

 

History

History
94 lines (61 loc) · 6.44 KB

README.md

File metadata and controls

94 lines (61 loc) · 6.44 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

import os
from x_api_scraper import XapiScraper


with XapiScraper(
    bearer_auth=os.getenv("X_API_SCRAPER_BEARER_AUTH", ""),
) as xapi_scraper:

    res = xapi_scraper.users.followers.list(username="elonmusk", count=20, cursor="1870681402093130182|2076960004551737340")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
username str ✔️ Twitter username (with or without @). elonmusk
count OptionalNullable[int] ➖ Number of users to return per page (min 10, max 100). 20
cursor OptionalNullable[str] ➖ Cursor from previous next_cursor to fetch the next page. 1870681402093130182|2076960004551737340
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.VerifiedFollowersResponse

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.XapiScraperDefaultError 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

import os
from x_api_scraper import XapiScraper


with XapiScraper(
    bearer_auth=os.getenv("X_API_SCRAPER_BEARER_AUTH", ""),
) as xapi_scraper:

    res = xapi_scraper.users.followers.verified(username="elonmusk", count=20, cursor="1870681402093130182|2076960004551737340")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
username str ✔️ Twitter username (with or without @). elonmusk
count OptionalNullable[int] ➖ Number of users to return per page (min 10, max 100). 20
cursor OptionalNullable[str] ➖ Cursor from previous next_cursor to fetch the next page. 1870681402093130182|2076960004551737340
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.VerifiedFollowersResponse

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.XapiScraperDefaultError 4XX, 5XX */*