Use This When
Do Not Use This When
Base URL
data, error, and code fields.
Flow
1
Call the compatible path
Use either root paths such as
/address/{address} or Go proxy-compatible /v1.0/... paths when migrating existing code.2
Let the Gateway route
Address-based requests are routed from the bech32 public key. Metachain requests use shard ID
4294967295.3
Check the response body
A
200 HTTP response can still contain a non-empty error field from the observer. Validate both HTTP status and body fields.4
Use historical query params when needed
Add
onFinalBlock, onStartOfEpoch, blockNonce, blockHash, blockRootHash, hintEpoch, or forced-shard-id only on endpoints that support historical state.Limits And Behavior
Next Steps
Quickstart
Query an account, simulate a transaction, and inspect the response.
Shard routing
How addresses, metachain requests, and fan-out endpoints are routed.
Caching and deduplication
Which calls are cached or coalesced, and how that affects freshness.
API reference
OpenAPI pages for all Gateway endpoint shapes.

