CLI Reference

pikeway discover

Search every endpoint on the marketplace in plain words and get a ranked list with prices. Free, no key needed.

Synopsis

bash

pikeway discover -q "<what you need>" [--limit 5] [--category <name>] [--max-price <usd>] [--json]
pikeway discover <words...>

Description

Sends your query to POST /v1/discover and prints one entry per match: relevance score, API slug, method, endpoint path and price, followed by the endpoint's description. The last line suggests the pikeway inspect command for the top result.

English and Chinese queries both work. If you leave out -q, the words after discover are joined into the query. A key is never required; if one is configured it is sent along.

Options

--query, -qstringrequired

What you need, 1–1000 characters. Positional words are used when -q is omitted.

--limit, -linteger

Max results. Default 5, the gateway caps it at 40.

--categorystring

Only endpoints from APIs in this category, e.g. Crypto.

--max-pricenumber

Only endpoints that cost at most this many USD per call.

Examples

bash

# basic search
pikeway discover -q "token price on solana"

# no -q: the remaining words become the query
pikeway discover holders of a token

# narrow it down
pikeway discover -q "token price on solana" --limit 10 --category Crypto --max-price 0.01

# Chinese works too
pikeway discover -q "股票实时行情"

# take the top hit's endpoint in a script
pikeway discover -q "weather forecast" -l 1 --json | jq -r '.results[0] | "\(.provider) \(.endpoint)"'

Output

text

0.87  birdeye GET /defi/price  $0.001/call
      Current price of a token by mint address
0.71  birdeye GET /defi/history_price  $0.002/call
      Historical price series of a token
0.58  coingecko GET /simple/price  $0.0005/call
      Price of one or more coins in any currency

next: pikeway inspect -p birdeye -e '/defi/price'

The score (0–1) combines relevance, reliability, price and popularity; results are sorted by it.
The price is shown as $X/call, free, or per token for metered AI endpoints.
When nothing matches: No endpoints matched "…". Try other words. (exit 0).

--json

The full /v1/discover response, including scoreBreakdown, stats and hints for each result:

json

{
  "results": [
    {
      "provider": "birdeye",
      "providerName": "Birdeye",
      "endpoint": "/defi/price",
      "method": "GET",
      "name": "Token price",
      "description": "Current price of a token by mint address",
      "category": "Crypto",
      "score": 0.874,
      "price": { "type": "PER_CALL", "amount": { "value": 0.001, "currency": "USD" } },
      "stats": { "successRate30d": 0.991, "p50Ms": 182 },
      "hints": { "inspect": "…", "run": "…", "docs": "…" }
    }
  ],
  "query": "token price on solana",
  "count": 1
}

Errors and exit codes

Exit	Message	When
2	usage: pikeway discover -q "what you need"	No -q and no positional words.
1	query is required (1-1000 characters)	The gateway rejected the query, e.g. it is longer than 1000 characters.
1	cannot reach <gateway>: ECONNREFUSED	The gateway could not be reached (DNS, network, wrong PIKEWAY_API_BASE_URL). The code after the colon comes from Node.

Also accepts the global flags -j, --json and -k, --key. See Global flags and Exit codes.