curl --request POST \
--url https://api.scrapebento.com/v1/public/scrape/x/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"wait": true,
"waitTimeoutMs": 123,
"webhookUrl": "<string>",
"idempotencyKey": "<string>",
"cacheTtlSec": 302400,
"fresh": true,
"url": "<string>",
"deep": true,
"cursor": "<string>",
"maxPages": 3,
"limit": 50,
"knownTweetIds": [
"<string>"
]
}
'import requests
url = "https://api.scrapebento.com/v1/public/scrape/x/profile"
payload = {
"username": "<string>",
"wait": True,
"waitTimeoutMs": 123,
"webhookUrl": "<string>",
"idempotencyKey": "<string>",
"cacheTtlSec": 302400,
"fresh": True,
"url": "<string>",
"deep": True,
"cursor": "<string>",
"maxPages": 3,
"limit": 50,
"knownTweetIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: '<string>',
wait: true,
waitTimeoutMs: 123,
webhookUrl: '<string>',
idempotencyKey: '<string>',
cacheTtlSec: 302400,
fresh: true,
url: '<string>',
deep: true,
cursor: '<string>',
maxPages: 3,
limit: 50,
knownTweetIds: ['<string>']
})
};
fetch('https://api.scrapebento.com/v1/public/scrape/x/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapebento.com/v1/public/scrape/x/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'wait' => true,
'waitTimeoutMs' => 123,
'webhookUrl' => '<string>',
'idempotencyKey' => '<string>',
'cacheTtlSec' => 302400,
'fresh' => true,
'url' => '<string>',
'deep' => true,
'cursor' => '<string>',
'maxPages' => 3,
'limit' => 50,
'knownTweetIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scrapebento.com/v1/public/scrape/x/profile"
payload := strings.NewReader("{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scrapebento.com/v1/public/scrape/x/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapebento.com/v1/public/scrape/x/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"jobId": "<string>",
"status": "succeeded",
"creditsCharged": 123,
"result": {},
"kind": "url",
"cached": true,
"completedAt": "2023-11-07T05:31:56Z",
"resultTruncated": true,
"pricingDecision": {
"outcome": "complete",
"stage": "admission",
"reason": "<string>",
"unitCount": 24
}
}
}Fetch an X profile by username or URL
Requires api.write.
curl --request POST \
--url https://api.scrapebento.com/v1/public/scrape/x/profile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"wait": true,
"waitTimeoutMs": 123,
"webhookUrl": "<string>",
"idempotencyKey": "<string>",
"cacheTtlSec": 302400,
"fresh": true,
"url": "<string>",
"deep": true,
"cursor": "<string>",
"maxPages": 3,
"limit": 50,
"knownTweetIds": [
"<string>"
]
}
'import requests
url = "https://api.scrapebento.com/v1/public/scrape/x/profile"
payload = {
"username": "<string>",
"wait": True,
"waitTimeoutMs": 123,
"webhookUrl": "<string>",
"idempotencyKey": "<string>",
"cacheTtlSec": 302400,
"fresh": True,
"url": "<string>",
"deep": True,
"cursor": "<string>",
"maxPages": 3,
"limit": 50,
"knownTweetIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
username: '<string>',
wait: true,
waitTimeoutMs: 123,
webhookUrl: '<string>',
idempotencyKey: '<string>',
cacheTtlSec: 302400,
fresh: true,
url: '<string>',
deep: true,
cursor: '<string>',
maxPages: 3,
limit: 50,
knownTweetIds: ['<string>']
})
};
fetch('https://api.scrapebento.com/v1/public/scrape/x/profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scrapebento.com/v1/public/scrape/x/profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'wait' => true,
'waitTimeoutMs' => 123,
'webhookUrl' => '<string>',
'idempotencyKey' => '<string>',
'cacheTtlSec' => 302400,
'fresh' => true,
'url' => '<string>',
'deep' => true,
'cursor' => '<string>',
'maxPages' => 3,
'limit' => 50,
'knownTweetIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.scrapebento.com/v1/public/scrape/x/profile"
payload := strings.NewReader("{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.scrapebento.com/v1/public/scrape/x/profile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scrapebento.com/v1/public/scrape/x/profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"username\": \"<string>\",\n \"wait\": true,\n \"waitTimeoutMs\": 123,\n \"webhookUrl\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"cacheTtlSec\": 302400,\n \"fresh\": true,\n \"url\": \"<string>\",\n \"deep\": true,\n \"cursor\": \"<string>\",\n \"maxPages\": 3,\n \"limit\": 50,\n \"knownTweetIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"jobId": "<string>",
"status": "succeeded",
"creditsCharged": 123,
"result": {},
"kind": "url",
"cached": true,
"completedAt": "2023-11-07T05:31:56Z",
"resultTruncated": true,
"pricingDecision": {
"outcome": "complete",
"stage": "admission",
"reason": "<string>",
"unitCount": 24
}
}
}Authorizations
Send a workspace API token in the Authorization: Bearer <token> header.
Keys carry the satk_ prefix and spend your organization's credit
balance. GET /v1/public/balance reports what is left.
Test-mode keys (satk_test_), which drew on a separate self-refilling
allowance, have been retired and no longer authenticate.
Headers
Optional deduplication key, scoped to your organization. Re-sending a request with a key that was already used returns the original job instead of creating and charging for a second one.
Supersedes the idempotencyKey body field, which remains supported as
a deprecated alias. If both are present, this header wins.
255Body
- Option 1
- Option 2
Wait for a terminal response before falling back to async job polling.
Optional client-requested sync wait timeout, bounded by the server maximum.
Optional public callback URL for terminal job delivery. Available to every organization.
Naming a URL here registers it as a webhook endpoint if it is not
registered already, so the signing secret exists before the first
delivery does. Fetch it from
GET /v1/public/webhooks/endpoints/{endpointId}/secret, or register
the endpoint up front with POST /v1/public/webhooks/endpoints to
have the secret in hand before you run anything.
Deliveries carry X-Scrapebento-Signature, an HMAC-SHA256 over
"<timestamp>.<body>" under that endpoint's own secret, so the
secret you need to verify your deliveries cannot forge anyone
else's. Every attempt is recorded in
GET /v1/public/webhooks/deliveries and can be re-sent from there.
Deprecated alias for the Idempotency-Key header, which is the
conventional transport and takes precedence when both are sent.
Still honoured so existing integrations keep working.
255How long this result may be reused, in seconds. Capped at 7 days (604800); larger values are clamped.
Omit it to accept the per-kind server default. Slow-moving kinds
cache by default — infra and brand for 6h, seo, sitemap,
site, and producthunt for 1h, and hn_search, hn_post, and
rss for 5m. Everything else defaults to no caching.
A cached result is charged at the same rate as a fresh scrape, so
the TTL is how stale an answer you can be billed for. Send 0 to
prevent this result being cached, and fresh: true to bypass an
existing cache entry on read.
0 <= x <= 604800Bypass cache and force a new scrape or search execution.
Legacy single-job deep crawl. Prefer timelineMode for resumable history. Requires the extended-ceiling entitlement; ignored without it (and ignored alongside timelineMode), so a request always returns a bounded page rather than an error.
Incremental starts at the newest page; backfill resumes the supplied cursor.
incremental, backfill Opaque nextCursor returned by the previous bounded timeline page.
4096Incremental timelines accept at most 5 pages; backfills accept at most 10.
1 <= x <= 10Items per page, and the quantity the call is billed on. Callers needing more paginate with cursor; extended per-call ceilings are available to entitled organizations. When omitted, the route's own page size is used and billed: 20, or 120 with timelineMode, or 200 for an entitled deep crawl, never above the caller's ceiling. A value above what the chosen route can return (100 without timelineMode or deep, 200 with timelineMode) is refused.
1 <= x <= 100IDs already stored by an incremental caller; a wholly known page ends the sync.
1000Response
X profile scrape completed and returned a terminal response.
- Option 1
- Option 2
Show child attributes
Show child attributes