Skip to content

README.md

Latest commit

 

History

History
255 lines (168 loc) · 13.1 KB

README.md

File metadata and controls

255 lines (168 loc) · 13.1 KB
Raw

Lists

Overview

Available Operations

Tweets

Get list tweets

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;
using XapiScraper.Models.Requests;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

ListsTweetsRequest req = new ListsTweetsRequest() {
    ListId = "<id>",
    TargetCount = 277741,
};

var res = await sdk.Lists.TweetsAsync(req);

// handle response

Parameters

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

Response

ListsTweetsResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*

TweetsPage

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

using XapiScraper;
using XapiScraper.Models.Components;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

GetListTweetsCursorQuery req = new GetListTweetsCursorQuery() {
    NextCursor = "1234567890",
    ListId = "<id>",
};

var res = await sdk.Lists.TweetsPageAsync(req);

// handle response

Parameters

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

Response

ListsTweetsPageResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*

Subscribers

Get list subscribers

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;
using XapiScraper.Models.Requests;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

ListsSubscribersRequest req = new ListsSubscribersRequest() {
    ListId = "<id>",
    TargetCount = 440492,
};

var res = await sdk.Lists.SubscribersAsync(req);

// handle response

Parameters

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

Response

ListsSubscribersResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*

Members

Get list members

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;
using XapiScraper.Models.Requests;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

ListsMembersRequest req = new ListsMembersRequest() {
    ListId = "<id>",
    TargetCount = 685648,
};

var res = await sdk.Lists.MembersAsync(req);

// handle response

Parameters

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

Response

ListsMembersResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*

MembersPage

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

using XapiScraper;
using XapiScraper.Models.Components;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

GetListMembersCursorQuery req = new GetListMembersCursorQuery() {
    NextCursor = "1234567890",
    ListId = "<id>",
};

var res = await sdk.Lists.MembersPageAsync(req);

// handle response

Parameters

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

Response

ListsMembersPageResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*

Search

Search list

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;

var sdk = new XapiScraperSDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

SearchListQuery req = new SearchListQuery() {
    Query = "<value>",
    TargetCount = 810476,
};

var res = await sdk.Lists.SearchAsync(req);

// handle response

Parameters

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

Response

ListsSearchResponse

Errors

Error Type Status Code Content Type
XapiScraper.Models.Errors.HTTPValidationError 422 application/json
XapiScraper.Models.Errors.APIException 4XX, 5XX */*