API Specification

The V3 gateway is a typed REST API served from https://pro-gateway.pearprotocol.io.

Every endpoint below has its own page, generated from the gateway's OpenAPI spec. Each page lists the parameters, the request body, and the response schemas, with request examples in cURL, JavaScript, Go, Python, Java, C#, and Rust. You can also send the request from the page itself.

Pick a group in the sidebar, or start with Authentication.

Download the spec

The OpenAPI 3.1 document these pages are generated from is served at /openapi.json.

curl -O https://docs.pear.garden/openapi.json

It is the gateway's own spec, published verbatim, so it stays in step with the pages beside it. Point a client generator at it, or import it into Postman, Insomnia, or Bruno:

npx @openapitools/openapi-generator-cli generate \
  -i https://docs.pear.garden/openapi.json \
  -g typescript-fetch \
  -o ./pear-client

For TypeScript you rarely need to: @pear-protocol/core-sdk is already generated from this spec and ships the types with it.

Using the SDK instead

For TypeScript, prefer the SDK over raw HTTP: it wraps authentication, x-trade-account-id scoping, and returns fully typed results.

• @pear-protocol/core-sdk, the typed REST client for everything below (sdk.auth, sdk.core, sdk.external).
• @pear-protocol/types, Zod schemas and DTOs for every request, response, and entity.

sdk.external is the third namespace, and covers no group in the table below. It searches prediction markets for a prediction_market trigger condition: sdk.external.triggers.kalshi.{search, marketNames} and sdk.external.triggers.polymarket.{search, marketNames}. See Trigger Order.

Two more SDKs read the exchanges directly rather than this gateway: @pear-protocol/market-sdk for charts, order books, and historical funding, and @pear-protocol/exchanges-sdk for venue account state and basket sizing. See Market Data and Venue Accounts.

Endpoint groups

Real-time updates (prices, funding, trades, positions, executions, triggers) come over the WebSocket, which is not part of the REST spec.

The OAuth 2.0 protocol endpoints are not in the spec either. /.well-known/oauth-authorization-server, /register, /authorize, /token, and /revoke are excluded from it, so the reference generates no page for them. The OAuth Consent group above covers only the /interaction/{uid} screen the user sees. See Access Management.

Conventions