stophy command calls the Stophy API from your terminal. It reads the endpoint list from the API at run time, so a new endpoint shows up as a command without an update. stophy <command> --help lists the options your version takes.
Install
~/.local/bin. On Windows, use PowerShell.
npm install -g @stophy/cli works too. Check the install.
Try it without an API key
Without logging in, you can run the commands thatstophy endpoints marks free, up to 10 calls a minute and 50 calls a day per IP address.
--json.
Set up your agent
init logs you in with your browser, installs the Stophy skills with npx -y skills add stophydotdev/stophy, and adds the MCP server. With Claude Code on your PATH it runs claude mcp add. For any other agent it prints the command or snippet to use, and leaves your config files alone.
Log in
STOPHY_API_KEY from your secret store.
stophy logout logs out and revokes the key. Never pass a key as a command argument. See API keys.
Make a request
--json for the data as JSON, --raw for the full response and -o <path> to write the output to a file. With --json, the CLI also prints credits used: <n> to stderr.
- Give a list as
--urls a,bor--urls a --urls b. - Turn a yes-or-no option on with
--flagand off with--no-flag. - Options that take JSON, like
--formats '["markdown","links"]', take it as one quoted argument. - A value the command does not take stops the CLI before it calls Stophy, and it prints the values that work.
- A failed call ends with
Request id: <id>, which support will ask for.
crawl and batch scrape answer at once with an id. Read the pages with status <id> until the status is completed, and stop a running job with cancel <id>. A status answer holds up to 100 finished pages or 2 MB. When it has a next link, run status again with --cursor and the cursor from that link. extract answers when the fields are ready, and extract status <id> reads the result again for 24 hours. See Read a crawl.
Read a site with a parser
A parser returns a site’s own data as JSON: posts, videos, places, products, jobs, listings and more.stophy parsers [word] lists them, with the kind of page each one takes.
cursor, get the next page with --parserOptions '{"cursor":"<cursor>"}'. See Pre-built parsers.
Find a command
stophy endpoints [word] lists every command with its price, and stophy describe <id> shows one command’s options, cost and an example. Besides the data commands above, there are parse, agent, browser task, batch scrape and webhook secret. The CLI has no command for browser sessions or monitors. Call those over HTTP.
Commands
The CLI tells you when a newer version is out. Set
STOPHY_NO_UPDATE_CHECK=1 to turn that off.