Datasets API endpoint
Use Crawlora's Search 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/searchSearches public X (Twitter) user profiles stored in a search index. Sort enum: `relevance`, `followers_desc`, `followers_asc`, `crawled_at_desc`, `crawled_at_asc`, `created_at_desc`, `created_at_asc`. 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 |
|---|---|---|---|---|---|
| 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, e.g. github-users, wikidata, tiktok-creators, journalists | ||
| 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 (low values surface follow-spam / bot-like accounts) | ||
| 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 | ||
| page | integer | No | 1 | Page number, defaults to 1 | |
| page_size | integer | No | 20 and maxes at 100 | Page size, defaults to 20 and maxes at 100; page * page_size must be <= 10000 | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/x-users/search?q=coffee&is_blue_verified=true&has_bio=true&has_external_url=true&sort=relevance&page=1" \ -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.
- Defaults to `relevance` sort when `q` is supplied, otherwise `followers_desc`. - `crawled_at_asc` returns the stalest records first; `created_at_asc` the oldest accounts first. - `min_followers` must not exceed `max_followers`, and `min_ratio` must not exceed `max_ratio`. - Date filters accept an RFC3339 timestamp or a bare `YYYY-MM-DD` calendar date; other formats return the invalid params envelope. - The maximum result window is `10000`; `page * page_size` must not exceed `10000`. - Invalid enum values return the standard invalid params envelope. - Returns an empty `items` array (not an error) when the dataset has no matches yet. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "x-users", "items": [ { "username": "octodev", "name": "Octo Dev", "bio": "Building things in public", "location_raw": "Berlin, Germany", "external_url": "https://octo.dev", "avatar_url": "https://pbs.twimg.com/profile_images/example_normal.jpg", "is_blue_verified": true, "has_bio": true, "has_external_url": true, "followers": 12000, "following": 800, "posts": 3400, "follower_following_ratio": 15.0, "source_tier": "github-users", "crawled_at": "2026-07-14T09:53:36Z", "schema_version": 1 } ], "page": 1, "page_size": 20, "total": 1, "sort": "followers_desc" } } ```
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",
"items": [
{
"username": "octodev",
"name": "Octo Dev",
"bio": "Building things in public",
"location_raw": "Berlin, Germany",
"external_url": "https://octo.dev",
"avatar_url": "https://pbs.twimg.com/profile_images/example_normal.jpg",
"is_blue_verified": true,
"has_bio": true,
"has_external_url": true,
"followers": 12000,
"following": 800,
"posts": 3400,
"follower_following_ratio": 15,
"source_tier": "github-users",
"crawled_at": "2026-07-14T09:53:36Z",
"schema_version": 1
}
],
"page": 1,
"page_size": 20,
"total": 1,
"sort": "followers_desc"
}
}Request schema
No body schema
Response schema
#/definitions/datasets.xUsersSearchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | datasets.XUserSearchResponse | No | ||||
| data.dataset | string | No | ||||
| data.items | array | No | ||||
| data.items[].avatar_url | string | No | ||||
| data.items[].banner_url | string | No | ||||
| data.items[].bio | string | No | ||||
| data.items[].bio_url_host | array | No | ||||
| data.items[].bio_urls | array | No | BioURLs are links written in the bio text, expanded from t.co. Distinct from ExternalURL (the single profile-header link). | |||
| data.items[].crawled_at | string | No | ||||
| data.items[].created_at | string | No | ||||
| data.items[].email | string | No | Email is an address the account self-published in its own bio. Extracted verbatim, never inferred or de-obfuscated. HasEmail is the faceting flag (an exists query on a keyword is fine, but a bool keeps parity with the other has_* fields and is cheaper to aggregate). | |||
| data.items[].external_url | string | No | ||||
| data.items[].follower_following_ratio | number | No | ||||
| data.items[].followers | integer | No | ||||
| data.items[].following | integer | No | ||||
| data.items[].has_bio | boolean | No | ||||
| data.items[].has_bio_url | boolean | No | ||||
| data.items[].has_email | boolean | No | ||||
| data.items[].has_external_url | boolean | No | ||||
| data.items[].id | string | No | ||||
| data.items[].is_blue_verified | boolean | No | ||||
| data.items[].is_default_profile_image | boolean | No | IsDefaultProfileImage marks never-customized shells. | |||
| data.items[].likes | integer | No | ||||
| data.items[].listed | integer | No | Listed is how many curated lists include the account -- the best authority proxy available. Media/Likes are activity signals. | |||
| data.items[].location_raw | string | No | ||||
| data.items[].media | integer | No | ||||
| data.items[].name | string | No | ||||
| data.items[].posts | integer | No | ||||
| data.items[].schema_version | integer | No | ||||
| data.items[].source_tier | string | No | ||||
| data.items[].username | string | No | ||||
| data.items[].verified_type | string | No | VerifiedType is the verification flavour ("Business", "Government", ...); empty for ordinary/blue accounts. | |||
| data.page | integer | No | ||||
| data.page_size | integer | No | ||||
| data.sort | string | No | ||||
| data.total | integer | 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/search?q=coffee&is_blue_verified=true&has_bio=true&has_external_url=true&sort=relevance&page=1" \
-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