prospex

Read Swiss company data, markets and watches from the shell or from an AI agent.

npx -y prospex login --key pxk_…
npx -y prospex usage
npx -y prospex companies search --q "precision machining" --canton VD
npx -y prospex markets rows 41 --band strong,good --all --format csv > core.csv
# Prospect pilot:
npx -y prospex prospects decide project_7 prospect_42 --decision pin \
  --idempotency-key review-42

Mint a key at https://prospex.ch/app/api-keys/. Full reference: https://prospex.ch/docs/cli/.

Install

Nothing to install: npx -y prospex runs the published version. For a global install, npm install -g prospex. Node 22.12 or newer, zero runtime dependencies.

Credentials

A key resolves in this order:

--key  >  PROSPEX_API_KEY  >  --credentials  >  PROSPEX_CREDENTIALS
       >  ${XDG_CONFIG_HOME:-~/.config}/prospex/credentials.json

prospex login writes the last of these with mode 0600. In CI, set PROSPEX_API_KEY and store nothing. prospex whoami prints the 12-character prefix and never the key.

Output

Every command prints the API payload on stdout unchanged. --format takes json (the default), compact, table, ndjson and csv; the format never changes based on whether stdout is a terminal. Rate-limit state is one line on stderr, silenced by --quiet.

Errors are one JSON object on stderr carrying request_id.

Exit codes

0 worked · 2 usage · 3 no or bad key · 4 missing scope · 5 subscription inactive · 6 not found · 7 cycle active · 8 refused · 9 out of allowance · 10 switched off · 11 network

Budgets

5,000 rows and 10,000 requests a day, shared with every other way the account downloads data, both resetting at local midnight in Switzerland. Run prospex usage before --all, which stops at --max-pages (default 10) and at half of whatever remains.

For AI agents

npx -y prospex skill install     # writes ./.claude/skills/prospex
npx -y prospex mcp add           # prints the `claude mcp add` line

The skill is what stops an agent promising email addresses Prospex does not hold, treating a market as a change feed, or inventing a fit score.

Contributing

This repository is a one-way mirror of cli/ in the Prospex monorepo. Pull requests here cannot be merged; open an issue instead and we will take it from there.

Licence

MIT.