Skip to content

README.md

Latest commit

 

History

History
205 lines (138 loc) · 8.91 KB

README.md

File metadata and controls

205 lines (138 loc) · 8.91 KB
Raw

Trending

Overview

Available Operations

countries

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

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.trending.countries

unless res.standard_response.nil?
  # handle response
end

Response

T.nilable(Models::Operations::TrendingCountriesResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*

topics

Get the topic categories available for filtering global trending tweets.

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.trending.topics

unless res.standard_response.nil?
  # handle response
end

Response

T.nilable(Models::Operations::TrendingTopicsResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*

contents

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

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::TrendingContentsRequest.new(
  country: 'Monaco',
  topic: '<value>'
)
res = s.trending.contents(request: req)

unless res.standard_response.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::TrendingContentsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*

tweets

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

Example Usage

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::TrendingTweetsRequest.new(
  country: 'Lithuania'
)
res = s.trending.tweets(request: req)

unless res.search_response.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::TrendingTweetsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*

by_country

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

require 'x_api_scraper'

Models = ::XapiScraper::Models
s = ::XapiScraper::Client.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::TrendingByCountryRequest.new(
  country: Models::Operations::Country::WORLDWIDE
)
res = s.trending.by_country(request: req)

unless res.standard_response.nil?
  # handle response
end

Parameters

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

Response

T.nilable(Models::Operations::TrendingByCountryResponse)

Errors

Error Type Status Code Content Type
Models::Errors::HTTPValidationError 422 application/json
Errors::APIError 4XX, 5XX */*