Datasets

Facet the GitHub users dataset

Returns terms aggregation counts for the GitHub users dataset. Facet enum: influence_tier, type, country, country_code, state, city, domains, company, reachable, has_email, has_twitter, has_blog, active_90d, hireable, is_org, is_bot, is_suspected_automation. influence_tier enum: nano, micro, mid, macro, mega. Suspected-automation records are excluded by default unless is_suspected_automation is set.

get/datasets/github-users/facets

Request

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

Query parameters

facet'influence_tier' | 'type' | 'country' | 'country_code' | 'state' | 'city' | 'domains' | 'company' | 'reachable' | 'has_email' | 'has_twitter' | 'has_blog' | 'active_90d' | 'hireable' | 'is_org' | 'is_bot' | 'is_suspected_automation' required

Facet enum: influence_tier, type, country, country_code, state, city, domains, company, reachable, has_email, has_twitter, has_blog, active_90d, hireable, is_org, is_bot, is_suspected_automation

qstring

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

loginstring

Exact login filter, max 128 characters

companystring

Exact normalized-company filter, max 128 characters

influence_tier'nano' | 'micro' | 'mid' | 'macro' | 'mega'

Follower-tier enum: nano, micro, mid, macro, mega

countrystring

Exact geocoded country filter, max 128 characters

country_codestring

Exact ISO country-code filter, max 128 characters

statestring

Exact geocoded state filter, max 128 characters

citystring

Exact geocoded city filter, max 128 characters

domainstring

Interest-domain tag filter, max 128 characters

has_emailboolean

Filter by public email presence

has_twitterboolean

Filter by public Twitter/X handle presence

has_blogboolean

Filter by public blog/website presence

reachableboolean

Filter by any public contact channel

active_90dboolean

Filter by activity within the last 90 days

hireableboolean

Filter by the GitHub available-for-hire flag

is_orgboolean

Organization filter

is_botboolean

Bot filter

is_suspected_automationboolean

Suspected automation filter; omitted these are hidden by default

min_followersinteger

Minimum follower count

max_followersinteger

Maximum follower count

min_reposinteger

Minimum public repository count

min_rank_scoreinteger

Minimum composite rank score

min_account_age_yearsnumber

Minimum account age in years

max_account_age_yearsnumber

Maximum account age in years

latnumber

Latitude for radius filtering

lonnumber

Longitude for radius filtering

radius_minteger

Radius in meters, 1 through 50000; requires lat and lon when supplied

sort'relevance' | 'rank_score_desc' | 'followers_desc' | 'account_age_desc' | 'account_age_asc' | 'distance_asc'

Sort enum: relevance, rank_score_desc, followers_desc, account_age_desc, account_age_asc, distance_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.