Skip to content

README.md

Latest commit

 

History

History
212 lines (145 loc) · 7.8 KB

README.md

File metadata and controls

212 lines (145 loc) · 7.8 KB
Raw

Tweets

Overview

Available Operations

detail

Retrieve detailed information for one or more tweets by ID (no cookie required). 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

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;

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

$request = [
    '2076874251915743687',
];

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

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

Parameters

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

Response

?Operations\TweetsDetailResponse

Errors

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

thread

Retrieve all tweets in a thread by tweet ID, sorted by latest.

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\TweetThreadByIdBody(
    tweetId: '<id>',
);

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

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

Parameters

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

Response

?Operations\TweetsThreadResponse

Errors

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

lookup

Retrieve detailed information for multiple Tweets by their IDs. 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

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;

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

$request = [
    '1803006263529541838',
];

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

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

Parameters

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

Response

?Operations\TweetsLookupResponse

Errors

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

similar

Get similar tweets

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\TweetsSimilarRequest(
    tweetId: '<id>',
);

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

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

Parameters

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

Response

?Operations\TweetsSimilarResponse

Errors

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