Skip to content

CLI

The scrapesocial command

Every endpoint from your terminal: one command per route, JSON, table or CSV output, automatic paging with a credit cap, batches from a file and media downloads.

Not published yet

The packages are ready and will be published on npm, PyPI, Go modules and Homebrew shortly. Until then, call the HTTP API directly: every endpoint page has cURL, Python and Node.js examples.

01Install

brew install scrapesocial/tap/scrapesocial

02Log in

Your key is checked and stored in the system keychain. --api-key or the SCRAPESOCIAL_API_KEY variable also work.

scrapesocial login
scrapesocial whoami
scrapesocial credits

03Call any endpoint

scrapesocial <platform> <action> with the parameters as flags (userId becomes --user-id). Add --help to any command for its flags and price. Credits charged and left are printed after each call.

scrapesocial instagram profile --handle nasa
scrapesocial instagram basic-profile --user-id 787132
scrapesocial youtube video-transcript --url "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
scrapesocial tiktok profile-videos --help

04Output, paging and batches

JSON by default; -o table, csv or jsonl prints the result rows, --fields picks columns. --all follows the cursor until the list ends or --max-credits is reached. --input runs one call per line of a file.

scrapesocial github user-repositories --username torvalds -o table --fields name,stars_count

05Download media

Saves every photo, video and sound of a post to the current folder (or --dir).

scrapesocial download https://www.instagram.com/p/DezCi1foMVV/ --dir ./media