Datasets API endpoint
Use Crawlora's X users dataset item 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/items/{username}Returns one X user record by username from dataset id enum value `x-users`. 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 |
|---|---|---|---|---|---|
| username (path) | string | Yes | X username, with or without a leading @, max 128 characters | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/datasets/x-users/items/%3Cusername%3E" \ -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 `404` when the username is not present in the stored dataset. - Does not trigger live scraping. Example response: ```json { "code": 200, "msg": "OK", "data": { "username": "octodev", "id": "1634026666518519808", "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", "banner_url": "https://pbs.twimg.com/profile_banners/example/banner", "is_blue_verified": true, "has_bio": true, "has_external_url": true, "followers": 12000, "following": 800, "posts": 3400, "follower_following_ratio": 15.0, "created_at": "2020-01-02T03:04:05Z", "source_tier": "github-users", "crawled_at": "2026-07-14T09:53:36Z", "schema_version": 1 } } ```
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 |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 500 | Internal Server Error | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"username": "octodev",
"id": "1634026666518519808",
"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",
"banner_url": "https://pbs.twimg.com/profile_banners/example/banner",
"is_blue_verified": true,
"has_bio": true,
"has_external_url": true,
"followers": 12000,
"following": 800,
"posts": 3400,
"follower_following_ratio": 15,
"created_at": "2020-01-02T03:04:05Z",
"source_tier": "github-users",
"crawled_at": "2026-07-14T09:53:36Z",
"schema_version": 1
}
}Request schema
No body schema
Response schema
#/definitions/datasets.xUserResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | es.XUserRecord | No | ||||
| data.avatar_url | string | No | ||||
| data.banner_url | string | No | ||||
| data.bio | string | No | ||||
| data.bio_url_host | array | No | ||||
| data.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.crawled_at | string | No | ||||
| data.created_at | string | No | ||||
| data.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.external_url | string | No | ||||
| data.follower_following_ratio | number | No | ||||
| data.followers | integer | No | ||||
| data.following | integer | No | ||||
| data.has_bio | boolean | No | ||||
| data.has_bio_url | boolean | No | ||||
| data.has_email | boolean | No | ||||
| data.has_external_url | boolean | No | ||||
| data.id | string | No | ||||
| data.is_blue_verified | boolean | No | ||||
| data.is_default_profile_image | boolean | No | IsDefaultProfileImage marks never-customized shells. | |||
| data.likes | integer | No | ||||
| data.listed | integer | No | Listed is how many curated lists include the account -- the best authority proxy available. Media/Likes are activity signals. | |||
| data.location_raw | string | No | ||||
| data.media | integer | No | ||||
| data.name | string | No | ||||
| data.posts | integer | No | ||||
| data.schema_version | integer | No | ||||
| data.source_tier | string | No | ||||
| data.username | string | No | ||||
| data.verified_type | string | No | VerifiedType is the verification flavour ("Business", "Government", ...); empty for ordinary/blue accounts. | |||
| 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/items/%3Cusername%3E" \
-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