Skip to content

README.md

Latest commit

 

History

History
156 lines (111 loc) · 7.38 KB

README.md

File metadata and controls

156 lines (111 loc) · 7.38 KB
Raw

Search

Overview

Available Operations

advanced

Perform advanced Twitter search with 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. 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

require 'x_api_scraper'

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

req = Models::Components::AdvancedSearchCursorQuery.new(
  search_terms: [
    '<value 1>',
    '<value 2>',
    '<value 3>',
  ],
  sort_by: '<value>',
  next_cursor: ''
)
res = s.search.advanced(request: req)

unless res.advanced_search_cursor_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

cashtags

Search for tweets containing specific cashtags (stock symbols), $0.10/1000 tweets. 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

require 'x_api_scraper'

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

req = Models::Components::CashtagsQuery.new(
  cashtags: [
    'AAPL',
    'TSLA',
  ],
  start_time: '1775726400',
  end_time: '1775727300',
  language: Models::Components::CashtagsQueryLanguage::EN
)
res = s.search.cashtags(request: req)

unless res.search_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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

hashtags

Search for tweets containing specific hashtags. 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

require 'x_api_scraper'

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

req = Models::Components::HashtagsQuery.new(
  hashtags: [
    'btc',
    'eth',
  ],
  start_time: '1775726400',
  end_time: '1775727300',
  language: Models::Components::HashtagsQueryLanguage::EN
)
res = s.search.hashtags(request: req)

unless res.search_response.nil?
  # handle response
end

Parameters

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

Response

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

Errors

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