Skip to content

README.md

Latest commit

 

History

History
218 lines (151 loc) · 9.96 KB

README.md

File metadata and controls

218 lines (151 loc) · 9.96 KB
Raw

Tweets.Engagement

Overview

Available Operations

retweeters

Retrieve retweeters in a single request. Automatically paginates until count is reached or no more results. Minimum 10, maximum 5000 users.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Operations;

$sdk = XapiScraper\XapiScraper::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\TweetsEngagementRetweetersRequest(
    tweetId: '<id>',
    targetCount: 100,
);

$response = $sdk->tweets->engagement->retweeters(
    request: $request
);

if ($response->searchUserResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\TweetsEngagementRetweetersRequest ✔️ The request object to use for the request.

Response

?Operations\TweetsEngagementRetweetersResponse

Errors

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

retweetersPage

Retrieve retweeters using cursor-based pagination. Each page returns up to 20 users. Pass next_cursor from the previous response to continue.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Components;

$sdk = XapiScraper\XapiScraper::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\GetRetweetersCursorQuery(
    tweetId: '<id>',
    nextCursor: 'eyJpZCI6IjIwNjAwNTE1Mzg3OTQ0Mzg2NzciLCJmbG9ja0N1cnNvciI6IjQ2MTE2ODYwMTg2Mjg5ODcxNzkiLCJvcmlnaW5hbERpcmVjdGlvbiI6IkRlc2NlbmRpbmcifQ==-999995',
);

$response = $sdk->tweets->engagement->retweetersPage(
    request: $request
);

if ($response->getRetweetersCursorResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Components\GetRetweetersCursorQuery ✔️ The request object to use for the request.

Response

?Operations\TweetsEngagementRetweetersPageResponse

Errors

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

quotes

Retrieve quote tweets in a single request. Automatically paginates until count is reached or no more results. Use Latest for chronological order or Top for ranked results. Minimum 10, maximum 5000 tweets.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Components;

$sdk = XapiScraper\XapiScraper::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\GetQuotesQuery(
    tweetId: '<id>',
    count: 100,
);

$response = $sdk->tweets->engagement->quotes(
    request: $request
);

if ($response->getQuotesResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Components\GetQuotesQuery ✔️ The request object to use for the request.

Response

?Operations\TweetsEngagementQuotesResponse

Errors

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

quotesPage

Retrieve quote tweets using cursor-based pagination. Each page returns up to 20 tweets. Use Latest for chronological order or Top for ranked results. Pass next_cursor from the previous response to continue.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Components;

$sdk = XapiScraper\XapiScraper::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\GetQuotesCursorQuery(
    tweetId: '<id>',
    nextCursor: 'scroll:thGQYTMwMjU5NDA4ODc4ODc6MjU5NDA4ODc4ODc6',
);

$response = $sdk->tweets->engagement->quotesPage(
    request: $request
);

if ($response->getQuotesCursorResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Components\GetQuotesCursorQuery ✔️ The request object to use for the request.

Response

?Operations\TweetsEngagementQuotesPageResponse

Errors

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