Skip to content
Docs

Norynta public docs

Norynta Integration Start Here

Start integrating Norynta APIs, SDKs, CLI tools, MCP servers, and agent discovery surfaces.

Integration Start Here (Developers, Bots, and AI Agents)

Current product mode (2026-07-28): Norynta is play-only. Real-money trading, deposits, withdrawals, cash payouts, yield, and mainnet execution are postponed until further notice. Any such workflow retained below is historical or implementation reference, not an available product capability. See PLAY_MODE_GUIDE.md.

Purpose

This is the fastest onboarding path for teams integrating Norynta programmatically.

If you are building with APIs, bots, automation, or AI agents, start here first.

Audience

  • external developers and API integrators
  • bot and quant teams
  • AI assistant / agent operators
  • partner engineering teams doing technical evaluation

5-minute startup path

No-code production preview:

npx --yes --package https://norynta.com/sdk/norynta-bot-sdk-0.2.6.tgz \
  norynta easy-start --plain

This is preview-only. It scans active markets, chooses one currently reward-qualified bounded resting CLOB opportunity, and reports live reward requirements without signing or submitting.

Optional dedicated-wallet setup, with no Solana CLI required:

npx --yes --package https://norynta.com/sdk/norynta-bot-sdk-0.2.6.tgz \
  norynta wallet-create --plain

For an unattended, single-order run after human signup, eligibility, API-key, wallet backup, and funding are complete:

NORYNTA_LIVE_ACK=I_ACCEPT_REAL_MONEY_LOSS \
npx --yes --package https://norynta.com/sdk/norynta-bot-sdk-0.2.6.tgz \
  norynta earn-watch --submit --plain

It rate-limits checks, waits without submitting when reward rules do not qualify, persists one exact intent, and exits after submission or reconciliation. It cannot guarantee a fill, reward, or profit. Stop its exact remembered open order with norynta earn-stop --submit --plain.

  1. Start the app locally:
npm run dev
  1. Run the one-command integration smoke flow:
npm run agent:quickstart

Optional (also verifies MCP servers):

npm run agent:quickstart -- --with-mcp

Machine-readable compatibility probe:

npm run bot:cli -- doctor

Installed SDK package equivalent:

norynta doctor

Copyable starter bot:

cp -R examples/starter-bot ../norynta-starter-bot
cd ../norynta-starter-bot
cp .env.example .env
npm install
npm run easy-start
npm run watch
npm run plan -- --event-pubkey EVENT_PUBKEY --outcome-index 0

First-maker quote planner from the main repo:

npm run bot:auto-trader
AUTOTRADER_MAX_TOTAL_NOTIONAL_USD=2 npm run bot:auto-trader

This verifies:

  • discovery endpoints (/.well-known/agent.json, /api/agent/card, /api/agent/access, /api/bot/config)
  • core bot data endpoints (/api/events/health, /api/events/snapshots)
  • required schema/version headers (X-Agent-Schema-Version, X-Api-Schema)
  • standards-first compatibility metadata
  • OpenAPI contract consistency (npm run openapi:check)
  • docs/surface consistency (npm run check:agent-docs)
  • MCP tool registration when --with-mcp is enabled (npm run mcp:smoke)

Pick your integration profile

1) Read-only observer bot

Start with:

  • docs/public/DEVELOPER_QUICKSTART.md
  • docs/public/API_OVERVIEW.md
  • docs/public/API_REFERENCE.md
  • docs/public/MARKET_DATA_DISCOVERY.md
  • docs/public/STREAMING_AND_RECONCILIATION.md

2) Active trading bot

Start with:

  • docs/public/AGENT_BOT_READINESS_CHECKLIST.md
  • docs/public/AUTH_AND_RATE_LIMITS.md
  • docs/public/ORDERBOOK_AND_PRICING.md
  • docs/public/ERROR_CODES.md
  • docs/public/TRADING_INTEGRATION_WORKFLOW.md
  • docs/AGENT_INTEGRATION.md

3) Capability-aware AI agent

Start with:

  • docs/AGENT_INTEGRATION.md
  • public/agents.md
  • .mcp.json

Canonical machine-readable surfaces

  • OpenAPI: public/openapi.json
  • AsyncAPI: public/asyncapi.json
  • Stable schema: public/api-schema.json
  • Human API reference: docs/public/API_REFERENCE.md
  • Discovery contract: /.well-known/agent.json, /api/agent/card, /api/agent/access
  • Runtime onboarding and country-gated error metadata: /api/bot/config → execution.onboarding, execution.errorTaxonomy, execution.internationalAccess
  • Stream contract and sequence policy: /api/v1/streams/manifest
  • Endpoint cost contract: /api/v1/developer/endpoint-costs
  • Standards-first compatibility metadata: /api/bot/config, /api/agent/access, and /api/agent/card → compatibility

SDK, CLI, and MCP

  • External SDK: packages/bot-sdk/src/sdk.ts
  • Class-based API client: NoryntaClient from @norynta/bot-sdk
  • CLI: norynta ... from the SDK package, or npm run bot:cli -- discover locally
  • MCP servers:
    • npm run mcp-public
    • npm run mcp-trading
    • npm run mcp-ops
    • config file: .mcp.json
    • read-only compatibility tool: integration_compatibility

OSS and agent framework compatibility

OpenClaw/OpenClaws-style clients should integrate through OpenAPI, stable schema headers, MCP, SDK, or CLI today. A bespoke adapter should wait until the exact OpenClaw/OpenClaws repository, version, and adapter contract are pinned.

For trading and research frameworks, use the Python adapter kit covering CCXT, Hummingbot, Freqtrade, NautilusTrader, LEAN, Backtrader, Backtesting.py, vectorbt, vn.py, Qlib, FinRL/FinRL-X, Jesse, OpenBB, Lumibot, QuantStats, TensorTrade, Zipline Reloaded, and OctoBot:

python -m pip install -e packages/python-sdk
norynta-adapters list
norynta-adapters doctor

Copy a working setup from examples/oss-trading-adapters and inspect compatibility.ossAdapters before selecting research, paper, or the explicitly caller-signed live path. See docs/public/OSS_TRADING_FRAMEWORKS.md.

Related docs

  • docs/public/DEVELOPER_QUICKSTART.md
  • docs/public/API_REFERENCE.md
  • docs/public/MARKET_DATA_DISCOVERY.md
  • docs/public/ORDERBOOK_AND_PRICING.md
  • docs/public/ERROR_CODES.md
  • docs/public/SDK_AND_EXAMPLES.md
  • docs/public/OSS_TRADING_FRAMEWORKS.md
  • docs/public/AGENT_BOT_READINESS_CHECKLIST.md
  • docs/public/MCP_GUIDE.md
  • docs/public/INTEGRATION_COMPATIBILITY_MATRIX.md
  • docs/public/INTEGRATION_STABILITY_POLICY.md
  • docs/public/INTEGRATION_SNIPPETS.md
  • docs/public/INTEGRATOR_CHANGELOG.md
  • docs/DEVELOPERS.md
  • docs/AGENT_INTEGRATION.md