API Reference

Complete documentation for the Realm gRPC API. 29 endpoints covering market data, trading, account management, and real-time streaming.

Protocol

Realm uses gRPC (not REST). Web clients connect via gRPC-Web through our Envoy proxy. This provides type-safe, bidirectional streaming with 10x less latency than REST+WebSocket.

Base URL

Network	gRPC-Web (browsers)	Native gRPC
Mainnet	`https://api.realm.software`	`grpc://api.realm.software:9090`

Authentication

Realm uses Dilithium-3 signatures for authentication (no API keys). Each request includes your public key, a signature of the request payload, a timestamp, and a monotonic nonce.

Read the full authentication guide →

Protocol Buffers

All messages are serialized using Protocol Buffers. The canonical definitions are available in our GitHub repository:

realm_api.protoprotobuf

syntax = "proto3";

service RealmApi {
  // Public (no auth)
  rpc Ping(PingRequest) returns (PongResponse);
  rpc GetChainInfo(GetChainInfoRequest) returns (ChainInfoResponse);
  rpc GetMarkets(GetMarketsRequest) returns (MarketsResponse);
  // ... 26 more endpoints
}

View full proto file on GitHub →

Endpoints

Public Endpoints

No authentication required

GETGetChainInfo

Block height, validators

GETGetMarkets

List available markets

GETGetOrderbook

L2 orderbook snapshot

GETGetFundingRate

Current funding rate

GETGetMarkPrice

Current mark price

Account Endpoints

Authentication required

GETGetBalance

All token balances

GETGetAccountSummary

Account overview

GETGetOpenOrders

Single order details

GETGetOrderHistory

Historical orders

GETGetPositions

GETGetFundingHistory

Funding payments

GETGetConditionalOrdersnew

Pending conditionals

GETGetPortfolioMarginnew

Cross-margin status

Trading Endpoints

Authentication required

POSTPlaceOrder

Submit an order

POSTAmendOrder

Modify existing order

POSTCancelOrder

Cancel single order

POSTCancelAll

Cancel all orders

POSTCancelConditionalOrdernew

Cancel conditional

POSTBatchOrders

Batch order operations

Internal transfer

L1 → Exchange

Exchange → L1

Streaming Endpoints

Authentication required

STREAMSubscribe

Real-time updates

STREAMTradingStream

Bidirectional HFT

Faucet

Authentication required (testnet only)

POSTClaimFaucet

Claim testnet tokens

Error Handling

All responses include a success boolean and an optionalerror string. When success is false, check the error message for details.

Error Code	Description
`INVALID_SIGNATURE`	Signature verification failed
`INVALID_NONCE`	Nonce is not monotonically increasing
`INSUFFICIENT_BALANCE`	Not enough funds for the operation
`INVALID_ORDER`	Order parameters are invalid
`MARKET_NOT_FOUND`	Requested market does not exist
`RATE_LIMITED`	Too many requests

Rate Limits

Rate limits are generous and designed for HFT. Current limits:

Public endpoints: 1000 req/min per IP
Authenticated endpoints: 10000 req/min per address
Order submission: 100 req/sec per address