Skip to content

README.md

Latest commit

 

History

History
247 lines (164 loc) · 8.78 KB

README.md

File metadata and controls

247 lines (164 loc) · 8.78 KB
Raw

Trending

Overview

Available Operations

countries

Get the supported country and global options that can be used to filter trending tweets.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;

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



$response = $sdk->trending->countries(

);

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

Response

?Operations\TrendingCountriesResponse

Errors

Error Type Status Code Content Type
Errors\APIException 4XX, 5XX */*

topics

Get the topic categories available for filtering global trending tweets.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use XapiScraper;

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



$response = $sdk->trending->topics(

);

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

Response

?Operations\TrendingTopicsResponse

Errors

Error Type Status Code Content Type
Errors\APIException 4XX, 5XX */*

contents

Get content tags for a selected country and topic so tweets can be filtered more precisely.

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\TrendingContentsRequest(
    country: 'Monaco',
    topic: '<value>',
);

$response = $sdk->trending->contents(
    request: $request
);

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

Parameters

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

Response

?Operations\TrendingContentsResponse

Errors

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

tweets

Get trending tweets for a country, with optional topic and content tag filters.

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\TrendingTweetsRequest(
    country: 'Lithuania',
);

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

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

Parameters

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

Response

?Operations\TrendingTweetsResponse

Errors

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

byCountry

Get X Explore trending topics for a given country. Use 'worldwide' for account-default trends or a country slug such as 'united-states'.

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\TrendingByCountryRequest(
    country: Operations\Country::Worldwide,
);

$response = $sdk->trending->byCountry(
    request: $request
);

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

Parameters

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

Response

?Operations\TrendingByCountryResponse

Errors

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