X API endpoint
Use Crawlora's Retrieve an X profile API to extract supported public X data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/x/profile/{username}Returns public profile details for an X username, including visible counts and profile media when available. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| username (path) | string | Yes | X username | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/x/profile/%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 is executed through Crawlora's managed scraping infrastructure.
- Returns 404 when the profile is not public or the returned profile does not match the requested username. - Returns 503 when X does not provide the public page payload or the payload shape is not parseable. - `verified_type` distinguishes the flavor of the checkmark (e.g. `Business`, `Government`) and is only present for gold/grey verified accounts; ordinary blue-verified accounts omit it. - `affiliate_label` is the small highlighted-affiliation badge X shows next to the display name (e.g. `Prime Video`) and is only present when the account has one. Example response: ```json { "code": 200, "msg": "OK", "data": { "id": "1634026666518519808", "username": "Ansel_Flipradio", "name": "Fear_Nation_世界苦茶", "url": "https://x.com/Ansel_Flipradio", "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, "verified_type": "Business", "affiliate_label": "Prime Video", "description": "Public profile description", "external_url": "https://example.com", "metrics": { "followers": 39608, "following": 188, "posts": 5498 } } } ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Missing or invalid parameters | #/definitions/app.Response |
| 404 | Profile not found | #/definitions/app.Response |
| 503 | Upstream error or parser drift | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"id": "1634026666518519808",
"username": "Ansel_Flipradio",
"name": "Fear_Nation_世界苦茶",
"url": "https://x.com/Ansel_Flipradio",
"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,
"verified_type": "Business",
"affiliate_label": "Prime Video",
"description": "Public profile description",
"external_url": "https://example.com",
"metrics": {
"followers": 39608,
"following": 188,
"posts": 5498
}
}
}Request schema
No body schema
Response schema
#/definitions/x.profileResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | x.Profile | No | ||||
| data.affiliate_label | string | No | AffiliateLabel is the small highlighted-affiliation badge X shows next to the display name (e.g. "Prime Video" for an account run on behalf of that brand). Distinct from VerifiedType; empty when the account has no highlighted affiliation. | |||
| data.avatar_url | string | No | ||||
| data.banner_url | string | No | ||||
| data.bio_urls | array | No | BioURLs are links written inside the bio, expanded from their t.co form. Distinct from ExternalURL, which is the single profile-header link. | |||
| data.created_at | string | No | ||||
| data.description | string | No | ||||
| data.email | string | No | Email is an address the account self-published in its own bio text. It is only ever extracted, never inferred or de-obfuscated. Empty for the vast majority of profiles. | |||
| data.external_url | string | No | ||||
| data.id | string | No | ||||
| data.is_blue_verified | boolean | No | ||||
| data.is_default_profile_image | boolean | No | IsDefaultProfileImage marks accounts still on the placeholder avatar -- a strong shell/abandoned-account signal. | |||
| data.is_protected | boolean | No | ||||
| data.is_unavailable | boolean | No | ||||
| data.location | string | No | ||||
| data.metrics | x.ProfileMetrics | No | ||||
| data.metrics.followers | integer | No | ||||
| data.metrics.following | integer | No | ||||
| data.metrics.likes | integer | No | ||||
| data.metrics.listed | integer | No | Listed is how many curated lists include this account -- the best authority proxy in the payload. Media/Likes are activity signals. Only the syndication source populates these; the x.com page parser leaves them zero. | |||
| data.metrics.media | integer | No | ||||
| data.metrics.posts | integer | No | ||||
| data.name | string | No | ||||
| data.url | string | No | ||||
| data.username | string | No | ||||
| data.verified_type | string | No | VerifiedType distinguishes the flavour of verification (e.g. "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/x/profile/%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