Skip to content

README.md

Latest commit

 

History

History
378 lines (249 loc) · 18.2 KB

README.md

File metadata and controls

378 lines (249 loc) · 18.2 KB
Raw

Users

Overview

Available Operations

GetByUsernames

Retrieve detailed profile information for multiple Twitter users by their usernames or profile URLs, $0.10/1000 users. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.

Example Usage

using System.Collections.Generic;
using XapiScraper;
using XapiScraper.Models.Components;

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

List<string> req = new List<string>() {
    "elonmusk",
};

var res = await sdk.Users.GetByUsernamesAsync(req);

// handle response

Parameters

Parameter Type Required Description
request List<string> ✔️ The request object to use for the request.

Response

UsersGetByUsernamesResponse

Errors

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

GetByIds

Users Details by ID. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.

Example Usage

using System.Collections.Generic;
using XapiScraper;
using XapiScraper.Models.Components;

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

List<string> req = new List<string>() {
    "44196397",
    "1696160451770429440",
};

var res = await sdk.Users.GetByIdsAsync(req);

// handle response

Parameters

Parameter Type Required Description
request List<string> ✔️ The request object to use for the request.

Response

UsersGetByIdsResponse

Errors

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

VerifyAccount

Retrieves the verification metadata for a specific account. This endpoint identifies whether an account holds a Blue Verified status (authenticity check) or is an Official Organization Affiliate (gold/grey labels). The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.

Example Usage

using System.Collections.Generic;
using XapiScraper;
using XapiScraper.Models.Components;

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

List<string> req = new List<string>() {
    "1696160451770429440",
};

var res = await sdk.Users.VerifyAccountAsync(req);

// handle response

Parameters

Parameter Type Required Description
request List<string> ✔️ The request object to use for the request.

Response

UsersVerifyAccountResponse

Errors

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

GetStatuses

Retrieve detailed account status for multiple Twitter users by their usernames. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.

Example Usage

using System.Collections.Generic;
using XapiScraper;
using XapiScraper.Models.Components;

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

List<string> req = new List<string>() {
    "elonmusk",
    "sundarpichai",
};

var res = await sdk.Users.GetStatusesAsync(req);

// handle response

Parameters

Parameter Type Required Description
request List<string> ✔️ The request object to use for the request.

Response

UsersGetStatusesResponse

Errors

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

Search

Search user

Example Usage

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

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

UsersSearchRequest req = new UsersSearchRequest() {
    Keyword = "<value>",
    TargetCount = 794044,
};

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

// handle response

Parameters

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

Response

UsersSearchResponse

Errors

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

Follow

Follow a user, $0.001 per call.

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;

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

FollowUserQuery req = new FollowUserQuery() {
    Username = "Mckenna.Roberts",
    Cookie = "ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7",
};

var res = await sdk.Users.FollowAsync(req);

// handle response

Parameters

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

Response

UsersFollowResponse

Errors

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

Unfollow

Unfollow a user, $0.001 per call.

Example Usage

using XapiScraper;
using XapiScraper.Models.Components;

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

UnfollowUserQuery req = new UnfollowUserQuery() {
    Username = "Casandra47",
    Cookie = "ct0=abc123... or 2c4a4e1832096aa694c739b83c83b6d96d43eba7",
};

var res = await sdk.Users.UnfollowAsync(req);

// handle response

Parameters

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

Response

UsersUnfollowResponse

Errors

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

GetAccountBased

Get Twitter Account Based in. The maximum input quantity is limited by your plan's QPS. To pass larger input quantity limits, upgrade your plan to get higher QPS.

Example Usage

using System.Collections.Generic;
using XapiScraper;
using XapiScraper.Models.Components;

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

List<string> req = new List<string>() {
    "screen_name",
};

var res = await sdk.Users.GetAccountBasedAsync(req);

// handle response

Parameters

Parameter Type Required Description
request List<string> ✔️ The request object to use for the request.

Response

UsersGetAccountBasedResponse

Errors

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

GetAbout

Get Twitter User About for a specific twitter user. get account_based_in,location_accurate

Example Usage

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

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

UsersGetAboutRequest req = new UsersGetAboutRequest() {
    ScreenName = "elonmusk",
};

var res = await sdk.Users.GetAboutAsync(req);

// handle response

Parameters

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

Response

UsersGetAboutResponse

Errors

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