Skip to main content
Use the Notional API to read protocol state, submit signed trading actions, and receive live updates across integrated markets. Your client communicates with Notional, not the underlying execution venue. Use Notional AssetIds and order IDs even when a trade executes on Hyperliquid or Polymarket.

Environments

Examples use mainnet unless stated otherwise. HTTP requests and responses use JSON. Sidebar badges identify venue coverage: HL means Hyperliquid and PM means Polymarket. Pages covering both venues show two separate badges. Check the endpoint’s admission rules and current deployment availability before submitting requests; a badge does not mean every operation is enabled.

HTTP Endpoints

Most /info requests are unsigned. Isolated Operation Status requires a signed read. Portfolio and leaderboard requests use their dedicated paths without a type field and depend on the deployment’s read replica being available. Amounts are decimal strings unless the endpoint explicitly requires integer base units. Example addresses, IDs, timestamps, and signatures illustrate the format; replace them with current values and real signatures when submitting an action. Required table fields are marked with *.

Make Your First Request

Fetch market metadata to discover supported perpetuals, spot pairs, collateral assets, and their Notional AssetIds. This read does not require a signature.
The response provides the identifiers and precision rules needed to construct later requests. See Market Metadata and Products and Asset IDs.

Submit an Action

Most POST /exchange actions require an EIP-712 signature and a nonce. A typical integration:
  1. Read the current market and account state.
  2. Build the action exactly as its endpoint page defines it.
  3. Sign the action without changing any field afterward.
  4. Submit it to POST /exchange and inspect every returned result.
  5. Confirm the final state through POST /info or a WebSocket subscription.
Account reads and user-scoped subscriptions use the account owner’s address. An approved API wallet signs eligible actions for that account; it is not a separate trading account. See Signing, Nonces, and API Wallets and Place Order.

Stream Updates

The WebSocket API is for subscriptions. Send reads through HTTP and signed actions through POST /exchange. Subscribe before submitting an action when you need its live updates. After a disconnect, resubscribe and read the current state over HTTP before retrying. See the WebSocket API.