Create an Export Job
/api/v3/jobCreate a new export job. The API automatically detects the platform from the URL and begins processing.
Request Body
urlrequiredstringURL to export (must be from a supported platform) optionsobjectExport configuration options (see below)
Options Object
Pass additional options in the options field:
options.limitintegerMaximum items to export (up to your tier's max) options.formatstringOutput file format: xlsx (default) or csv. CSV includes extra columns (ids, profile URLs) that the Excel layout hides and is the better choice for automated processing. The download_link extension follows the format. options.repliesbooleanInclude replies/nested comments (default: false) options.likesbooleanInclude likes data options.sharesbooleanInclude shares data options.followersbooleanExport followers instead of comments options.followingbooleanExport following instead of comments options.tweetsbooleanExport tweets (Twitter/X) options.livebooleanExport live chat data options.vpnstringVPN location name (see VPN Locations) options.poolstring (uuid)Proxy pool UUID to use options.cursorstringPagination cursor for continuing a previous export options.minTimestampintegerMinimum Unix timestamp filter options.maxTimestampintegerMaximum Unix timestamp filter options.cookiesobjectAuthentication cookies for private content options.facebookAdsbooleanExport Facebook Ads data only options.profileIdsbooleanFacebook comments: convert each commenter's masked pfbid id to the numeric profile id, returned in profile_id_numeric (default: false). profile_id keeps the value Facebook returned (numeric, pfbid or username), so read profile_id_numeric first and fall back to profile_id. Usernames are not converted. Website exports always do this conversion. It adds one lookup per 50 commenters, so large jobs take longer. options.advancedbooleanEnable advanced search (Google)
Cookies Object
Some platforms require authentication cookies to access private or restricted content:
options.cookies.sessionidstringSession ID (Instagram, general) options.cookies.auth_tokenstringAuth token (Twitter/X) options.cookies.cookie_userstringFacebook c_user cookie options.cookies.cookie_xsstringFacebook xs cookie
curl -X POST https://exportcomments.com/api/v3/job \-H "X-AUTH-TOKEN: your-api-key" \-H "Content-Type: application/json" \-d '{"url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ","options": {"limit": 500,"replies": true}}'
{"guid": "b4219d47-3138-5efd-9762-2ef9f9495084"}
Add the X-Sandbox: true header to get an instantly finished job with fixed sample data for the URL's platform. Nothing is exported and nothing is counted. See Sandbox Mode for the exact responses.
The creation response only returns the guid. To get the full job object (status, download links, etc.) use the Retrieve Job endpoint with that guid.
Batch Job Creation
Send {"urls": [...]} instead of {"url": "..."} to create multiple jobs in a single request.
{"data": [{"guid": "b4219d47-3138-5efd-9762-2ef9f9495084","item": {}},{"guid": "c7341e58-4249-6fae-0873-3fg0g0506195","item": {}}]}
A newly created job starts in queueing status. Use the Retrieve Job endpoint to poll for status changes, or set up a webhook to be notified when the job completes.
