Browsable Browsable Docs

X Lists API

Scrape a public X or Twitter list page.

POST /v1/x/lists

Also available at /v1/twitter/lists.

Authentication

Requires a managed x.com login on kernel. Browsable automatically uses a saved login when one is available.

If your team does not already have a usable login, the API returns 428 Authentication required with a hosted_url. Open that URL, finish sign-in, then retry the same request.

Request Parameters

Name In Type Required Description
url body string Yes URL returned by the matching search endpoint.

Response Structure

Async kickoff response

Polled run result response

Sync response

Authentication required response

Declared output schema

Code Examples

Async + polling

RUN=$(curl -s -X POST "https://api.browsable.app/v1/x/lists" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/item-1"}')
RUN_ID=$(echo "$RUN" | jq -r '.run_id')
POLL_DELAY=3
while true; do
RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api.browsable.app/v1/runs/$RUN_ID")
STATUS=$(echo "$RESULT" | jq -r '.run_status')
if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
echo "$RESULT"
break
fi
sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
[ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done

Sync

curl -X POST "https://api.browsable.app/v1/x/lists" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/item-1","_run":{"async":false}}'