The Polymarket Exchange exposes all API functionality via gRPC using Protocol Buffers. This section covers unary (request/response) methods - for streaming services, see gRPC Streaming.Documentation Index
Fetch the complete documentation index at: https://docs.polymarket.us/llms.txt
Use this file to discover all available pages before exploring further.
Why Use gRPC?
gRPC offers several advantages over REST:- Performance: Binary protocol with smaller payloads and faster serialization
- Type Safety: Strongly-typed messages defined in Protocol Buffers
- Streaming: Native support for bidirectional streaming (covered in gRPC Streaming tab)
- Code Generation: Auto-generate client libraries in any language
Download Proto Files
Get the complete Protocol Buffer definitions to generate client libraries in any language
Server Endpoints
Development Environment (dev01)
Pre-Production Environment
Production Environment
All gRPC connections use TLS/SSL. Ensure your client is configured for secure connections.
Authentication
All gRPC calls require an access token passed in theauthorization metadata header:
Available Services
Trading Services
| Service | Description |
|---|---|
| OrderEntryAPI | Insert, cancel, and preview orders |
| ReportAPI | Search orders, trades, and executions |
| PositionAPI | Query account balances and positions |
Market Data Services
| Service | Description |
|---|---|
| RefDataAPI | List instruments, symbols, and metadata |
| OrderBookAPI | Get order book snapshots and BBO |
Account Services
| Service | Description |
|---|---|
| AccountsAPI | Get user info, list accounts |
| HealthAPI | Health check endpoint |
Funding Services
| Service | Description |
|---|---|
| KYCAPI | KYC verification status and referral codes |
| AeropayAPI | ACH bank linking via Aeropay |
| CheckoutAPI | Card payments via Checkout.com |
| FundingAPI | Funding accounts and transactions |
Execution Feed
| Service | Description |
|---|---|
| DropCopyAPI | Trade capture and execution feed |
Drop Copy & Trade Capture gRPC Streaming
TheDropCopyAPI service provides real-time streaming endpoints for execution reports, trade capture, and position changes. These are gRPC streaming only - there are no REST equivalents.
For complete documentation including code examples, see DropCopy & Trade Capture Streaming.
Available Streaming Endpoints
Drop Copy Subscription
Stream execution reports as they occur for your firm. Use this for:- Real-time order execution monitoring
- Fill notifications across all firm accounts
- Cancel and reject tracking
symbols- Filter by specific symbols (empty = all)resume_token- Resume from previous position after disconnect
Trade Capture Report Subscription
Stream completed trades for reconciliation and compliance. Each trade contains:aggressor- The incoming (taker) executionpassive- The resting (maker) executiontrade_type- Type of trade (REGULAR, CROSS, etc.)state- Trade state (NEW, CLEARED, etc.)
Quick Example
Package Structure
All services are in thepolymarket.v1 package:
Quick Start
1. Install gRPC Libraries
2. Obtain Proto Files
Download the proto files directly: polymarket-protos.zip Alternatively, use gRPC server reflection to discover services at runtime.3. Generate Client Code
4. Make Your First Call
REST vs gRPC
Both REST and gRPC access the same underlying services. Choose based on your needs:| Aspect | REST | gRPC |
|---|---|---|
| Protocol | HTTP/JSON | HTTP/2 + Protobuf |
| Performance | Good | Better |
| Type Safety | Schema optional | Built-in |
| Browser Support | Native | Requires proxy |
| Tooling | curl, Postman | grpcurl, Bloom RPC |
Next Steps
gRPC Streaming
Real-time market data and order subscriptions
Authentication
Access token setup for gRPC
REST API
Equivalent REST endpoints
Proto Reference
Proto message definitions