Skip to content

README.md

Latest commit

 

History

History
379 lines (264 loc) · 16.7 KB

README.md

File metadata and controls

379 lines (264 loc) · 16.7 KB
Raw

Communities

Overview

Available Operations

members

Get community members

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\CommunitiesMembersRequest(
    communityId: '<id>',
    targetCount: 298640,
);

$response = $sdk->communities->members(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesMembersResponse

Errors

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

membersPage

Retrieve a paginated list of community members using cursor-based pagination. Each page returns up to 20 members. Pass next_cursor from the previous response to continue. Pricing: $0.10 per 1,000 members.

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\GetCommunityMembersCursorQuery(
    nextCursor: '1234567890',
    communityId: '<id>',
);

$response = $sdk->communities->membersPage(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesMembersPageResponse

Errors

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

tweets

Get community 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\CommunitiesTweetsRequest(
    communityId: '<id>',
    tweetType: Operations\TweetType::Media,
    targetCount: 682850,
);

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

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

Parameters

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

Response

?Operations\CommunitiesTweetsResponse

Errors

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

tweetsPage

Retrieve a paginated list of community tweets using cursor-based pagination. Each page returns up to 20 tweets. Pass next_cursor from the previous response to continue. Pricing: $0.10 per 1,000 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\GetCommunityTweetsCursorQuery(
    nextCursor: '1234567890',
    communityId: '<id>',
    tweetType: Components\TweetType::Top,
);

$response = $sdk->communities->tweetsPage(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesTweetsPageResponse

Errors

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

search

Search community

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\SearchCommunityQuery(
    query: '<value>',
    targetCount: 761546,
);

$response = $sdk->communities->search(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesSearchResponse

Errors

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

get

Get community

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

$response = $sdk->communities->get(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesGetResponse

Errors

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

searchTweets

Search community 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\SearchCommunityTweetsQuery(
    communityId: '<id>',
    targetCount: 687977,
    query: '<value>',
);

$response = $sdk->communities->searchTweets(
    request: $request
);

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

Parameters

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

Response

?Operations\CommunitiesSearchTweetsResponse

Errors

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