Skip to content

README.md

Latest commit

 

History

History
222 lines (155 loc) · 10.3 KB

README.md

File metadata and controls

222 lines (155 loc) · 10.3 KB
Raw

Timelines

Overview

Available Operations

tweetsAndReplies

Get all tweets and replies posted by a specific Twitter user. Returns a comprehensive list including both original tweets and reply tweets posted by the user. $0.10/1000 items.

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\TimelinesTweetsAndRepliesRequest(
    screenName: 'elonmusk',
    count: 50,
);

$response = $sdk->timelines->tweetsAndReplies(
    request: $request
);

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

Parameters

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

Response

?Operations\TimelinesTweetsAndRepliesResponse

Errors

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

userPage

Fetch a single page from a user's timeline using POST. Pass next_cursor in the body to continue.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Components;
use XapiScraper\Models\Operations;

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

$request = new Operations\TimelinesUserPageRequest(
    screenName: 'axiaisacat',
    body: new Components\UserTimelinePageQuery(
        nextCursor: 'DAAHCgABHFeD5h9__-cLAAIAAAATMjAzODIzMzA5NTM4ODY4MDU5NAgAAwAAAAIAAA',
    ),
);

$response = $sdk->timelines->userPage(
    request: $request
);

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

Parameters

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

Response

?Operations\TimelinesUserPageResponse

Errors

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

user

Fetch a user's timeline across pages using POST and try to fill the requested count.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;
use XapiScraper\Models\Components;
use XapiScraper\Models\Operations;

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

$request = new Operations\TimelinesUserRequest(
    screenName: 'axiaisacat',
    body: new Components\UserTimelineFillQuery(),
);

$response = $sdk->timelines->user(
    request: $request
);

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

Parameters

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

Response

?Operations\TimelinesUserResponse

Errors

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

tweetsAndRepliesPage

Retrieve a paginated list of a user's tweets and replies using cursor-based pagination. Each page returns up to 20 items. Pass next_cursor from the previous response to continue. Pricing: $0.10 per 1,000 items.

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\GetAllTweetsRepliesCursorQuery(
    nextCursor: '1234567890',
    screenName: 'elonmusk',
);

$response = $sdk->timelines->tweetsAndRepliesPage(
    request: $request
);

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

Parameters

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

Response

?Operations\TimelinesTweetsAndRepliesPageResponse

Errors

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