Headers
Your API key. Session cookie authentication is also supported. Generate a key from the dashboard.
Path parameters
Extraction job ID returned from Create Extraction or List Extractions.
Query parameters
Export file format. One of:
csv, xlsx, md.Export columns
All export formats include the same columns in this order:| Column | Description |
|---|---|
| User ID | X user ID |
| Username | X handle |
| Display Name | Profile display name |
| Followers | Follower count at time of extraction |
| Following | Following count |
| Posts | Total post count |
| Verified | Whether the user has a verified badge |
| Description | Profile bio text |
| Location | Profile location |
| Profile Image | URL to the profile image |
| Tweet ID | Associated tweet ID (tweet-based tools only) |
| Tweet Text | Tweet content (tweet-based tools only) |
| Tweet Created At | ISO 8601 timestamp of the tweet (tweet-based tools only) |
Response
- 200 OK
- 400 Invalid ID
- 400 Invalid Format
- 401 Unauthenticated
- 404 Not Found
Returns a file download. The response includes a
Results are capped at 50,000 rows. For extractions with more results, the export includes the first 50,000 rows ordered by result ID.
Content-Disposition header with the filename.| Format | Content-Type | Filename Example |
|---|---|---|
csv | text/csv; charset=utf-8 | extraction-reply_extractor-77777.csv |
xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | extraction-reply_extractor-77777.xlsx |
md | text/markdown; charset=utf-8 | extraction-reply_extractor-77777.md |
Next steps: Get Extraction to access results via the API with pagination, or List Extractions to find other extraction jobs to export.