Datasets API endpoint
Use Crawlora's Facet the X users dataset API to search or inspect stored structured datasets as JSON. This page includes request parameters, cURL examples, response schema, validation behavior, credit cost, and a Playground link for testing before integration. Dataset endpoints read indexed records and do not apply proxy routing.
/datasets/x-users/facetsReturns terms aggregation counts for the X users dataset. Facet enum: `is_blue_verified`, `has_bio`, `has_external_url`, `source_tier`. Developers commonly use this endpoint for repeatable dataset search, filtering, facets, local business enrichment, analytics, exports, and internal tools that need structured records beyond the limited manual refinement available in the Google Maps app. Authentication uses the x-api-key header, usage is metered with the credit cost shown on this page, and the request does not trigger live scraping or proxy routing.
Request parameters are generated from the active endpoint catalog. Dataset parameters filter, page, facet, or locate stored structured records; they do not configure a live scraper or proxy path.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| facet | string | Yes | Facet enum: is_blue_verified, has_bio, has_external_url, source_tier Allowed values: is_blue_verified, has_bio, has_external_url, source_tier | ||
| q | string | No | Full-text query over username, name, bio and location, max 256 characters | ||
| username | string | No | Exact username filter (case-insensitive), max 128 characters | ||
| source_tier | string | No | Exact filter for which seed tier discovered this account | ||
| is_blue_verified | boolean | No | Filter by the X blue-check verification flag | ||
| has_bio | boolean | No | Filter by a non-empty profile bio | ||
| has_external_url | boolean | No | Filter by a linked external URL | ||
| min_followers | integer | No | Minimum follower count | ||
| max_followers | integer | No | Maximum follower count | ||
| min_ratio | number | No | Minimum follower-to-following ratio | ||
| max_ratio | number | No | Maximum follower-to-following ratio | ||
| created_after | string | No | Accounts created on or after this date (RFC3339 or YYYY-MM-DD) | ||
| created_before | string | No | Accounts created on or before this date (RFC3339 or YYYY-MM-DD) | ||
| crawled_after | string | No | Records last refreshed on or after this date (RFC3339 or YYYY-MM-DD) | ||
| crawled_before | string | No | Records last refreshed on or before this date (RFC3339 or YYYY-MM-DD) | ||
| sort | string | No | Sort enum: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc Allowed values: relevance, followers_desc, followers_asc, crawled_at_desc, crawled_at_asc, created_at_desc, created_at_asc | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/x-users/facets?facet=is_blue_verified&q=coffee&is_blue_verified=true&has_bio=true&has_external_url=true&sort=relevance" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint reads stored indexed dataset records. It does not execute a live upstream Google Maps request, browser session, or proxy-routed scraping job.
- Returns up to `50` buckets ordered by descending count. - `facet` is required; unsupported values return the standard invalid params envelope. - Boolean facets (`is_blue_verified`, `has_bio`, `has_external_url`) return `true`/`false` bucket values. - `source_tier` bucket values are the seed tier names, e.g. `github-users`, `wikidata`, `tiktok-creators`, `journalists`. `unknown` labels records whose discovery tier was not recorded. - Returns an empty `items` array (not an error) when the dataset has no data yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "x-users", "facet": "source_tier", "items": [ { "value": "wikidata", "count": 427709 }, { "value": "github-users", "count": 54790 }, { "value": "tiktok-creators", "count": 4466 }, { "value": "journalists", "count": 840 } ] } } ```
Crawlora does not silently return invalid dataset search results when filters, pagination, coordinates, or stored record lookups cannot be satisfied.
| Status | Common failure case |
|---|---|
| 400 | Invalid input, missing required parameter, invalid enum, bad coordinate pair, or result window beyond the dataset limit |
| 404 | Requested stored dataset item is not present |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal dataset query or storage error |
When possible, Crawlora returns structured error context so your integration can adjust filters, page size, location inputs, or lookup identifiers.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"dataset": "x-users",
"facet": "source_tier",
"items": [
{
"value": "wikidata",
"count": 427709
},
{
"value": "github-users",
"count": 54790
},
{
"value": "tiktok-creators",
"count": 4466
},
{
"value": "journalists",
"count": 840
}
]
}
}Request schema
No body schema
Response schema
#/definitions/datasets.xUsersFacetResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.XUserFacetResponse | No | ||||
| data.dataset | string | No | ||||
| data.facet | string | No | ||||
| data.items | array | No | ||||
| data.items[].count | integer | No | ||||
| data.items[].value | string | No | ||||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/datasets/x-users/facets?facet=is_blue_verified&q=coffee&is_blue_verified=true&has_bio=true&has_external_url=true&sort=relevance" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms