Get started · For developers

HTTP API

No SDK required. Every API in the marketplace is reachable with a plain HTTP request and your Pikeway key, from any language or tool.

1

Get a key

Sign in, top up your balance, and create a key in Console → API Keys. Keys start with pk- and work for every API.

bash
export PIKEWAY_API_KEY=pk-...
Keep keys on the server. For browser apps, use a restricted browser key instead. Browser keys
2

Call an API

Take the API's slug from the marketplace and append the provider's own path and query. Pikeway forwards the method, query, headers and body, and returns the provider's response as is.

ANYhttps://gw.pikeway.ai/gw/<slug>/<path>
bash
curl -i "https://gw.pikeway.ai/gw/dexscreener/latest/dex/search?q=WBTC" \
  -H "Authorization: Bearer $PIKEWAY_API_KEY"
3

Read the cost

Every response from the gateway carries headers that tell you what happened:

X-Pikeway-Coststring
What this call cost in USD, e.g. 0.002. It is 0 when the call failed (HTTP 400 or above), because failed calls are never charged.
X-Pikeway-Call-Idstring
A unique id for the call. Find it in your usage logs, or quote it when contacting support.
X-Pikeway-CacheHIT | MISS
Present on cacheable GET endpoints. A HIT was served from cache.

Error codes

4

Test for free with mock

Replace /gw/ with /mock/ to get the endpoint's example response without calling the provider. No key, no charge, limited to 30 requests a minute per IP.

bash
curl "https://gw.pikeway.ai/mock/dexscreener/latest/dex/search?q=WBTC"

More on mock responses

Let the gateway pick the endpoint

If you don't know which API to call, the agent endpoints do the discover → inspect → run loop over HTTP. Discover and inspect are free and need no key.

bash
curl -X POST https://gw.pikeway.ai/v1/discover -H "Content-Type: application/json" \
  -d '{"query":"token price on solana","limit":3}'

curl -X POST https://gw.pikeway.ai/v1/inspect -H "Content-Type: application/json" \
  -d '{"provider":"birdeye","endpoint":"/defi/price"}'

curl -X POST https://gw.pikeway.ai/v1/run -H "Content-Type: application/json" \
  -H "Authorization: Bearer $PIKEWAY_API_KEY" \
  -d '{"provider":"birdeye","endpoint":"/defi/price","input":{"address":"So11111111111111111111111111111111111111112"}}'

Next