Datasets

Facet the X users dataset

Returns value counts for the X users dataset by the required facet: is_blue_verified, has_bio, has_external_url or source_tier. The counts follow the search filters, including q, follower and ratio ranges, and creation or crawl dates. At most 50 values come back, largest count first.

get/datasets/x-users/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/x-users/facets
  • Auth: API key in header x-api-key

Query parameters

facet'is_blue_verified' | 'has_bio' | 'has_external_url' | 'source_tier' required

Facet enum: is_blue_verified, has_bio, has_external_url, source_tier

qstring

Full-text query over username, name, bio and location, max 256 characters

usernamestring

Exact username filter (case-insensitive), max 128 characters

source_tierstring

Exact filter for which seed tier discovered this account

is_blue_verifiedboolean

Filter by the X blue-check verification flag

has_bioboolean

Filter by a non-empty profile bio

has_external_urlboolean

Filter by a linked external URL

min_followersinteger

Minimum follower count

max_followersinteger

Maximum follower count

min_rationumber

Minimum follower-to-following ratio

max_rationumber

Maximum follower-to-following ratio

created_afterstring

Accounts created on or after this date (RFC3339 or YYYY-MM-DD)

created_beforestring

Accounts created on or before this date (RFC3339 or YYYY-MM-DD)

crawled_afterstring

Records last refreshed on or after this date (RFC3339 or YYYY-MM-DD)

crawled_beforestring

Records last refreshed on or before this date (RFC3339 or YYYY-MM-DD)

sort'relevance' | 'followers_desc' | 'followers_asc' | 'crawled_at_desc' | 'crawled_at_asc' | 'created_at_desc' | 'created_at_asc'

Sort enum: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.