Skip to Content
API ReferenceREST APIOverview

REST API Reference

The Nord API provides direct HTTP access to 01 Exchange functionality. This is useful for integrations that don’t use the TypeScript SDK.

Base URLs

EnvironmentURL
Mainnethttps://zo-mainnet.n1.xyz
Devnethttps://zo-devnet.n1.xyz

API Documentation

The API provides an OpenAPI specification and interactive documentation:

  • OpenAPI Spec: {BASE_URL}/openapi.json
  • Interactive Docs: {BASE_URL}/docs
  • Protobuf Schema: {BASE_URL}/schema.proto

Authentication

Most read-only endpoints (market data, orderbook, trades) do not require authentication. However, trading operations require a session-based authentication flow.

Session-Based Authentication

Trading actions use a two-step authentication process:

  1. Create Session: Sign a CreateSession action with your user wallet key
  2. Execute Actions: Sign subsequent actions with the session key
Client Server | | |----- CreateSession (user-signed) ----->| | | |<---- session_id -----------------------| | | |----- PlaceOrder (session-signed) ----->| | | |<---- Receipt / Confirmation -----------| | |

Signing Actions

Actions are signed using Ed25519 signatures. The signing scheme differs based on the action type:

Action TypeSigning Scheme
CreateSessionUser signing (hex-encoded message)
PlaceOrder, CancelOrder, etc.Session signing (raw bytes)

See the POST /action endpoint for detailed signing instructions.

Common Response Format

Successful responses return a Receipt protobuf message containing:

  • action_id: Unique identifier for the action
  • Action-specific result (e.g., place_order_result, cancel_order_result)
  • err: Error code if the action failed

Endpoints Overview

EndpointMethodAuthDescription
/infoGETNoMarkets and tokens information
/market/\{id\}/statsGETNoMarket statistics and funding rates
/orderbookGETNoCurrent orderbook snapshot
/tradesGETNoRecent trade history
/timestampGETNoServer timestamp for action signing
/actionPOSTYesExecute trading actions (protobuf)

Rate Limits

Contact support for rate limit information specific to your use case.

Last updated on