Skip to content

API Reference

The ARKONIX backend exposes a small, unauthenticated, read-only public API for vault data, plus a discovery API for supported chains and protocols. Anything that changes state — orders, vault operations, administration — lives behind authenticated surfaces and is not part of the public API.

Base URL

https://api.arkonix.xyz

All endpoints are HTTPS GET and return JSON with snake_case field names. (The Vault SDK wraps these endpoints and normalizes responses to camelCase types — if you're building in React or Node, prefer the SDK to raw HTTP.)

Surfaces

Surface Auth Purpose Docs
/public/* None Vault & share-class data: listings, financials, history, holdings, fees, per-user activity Public Vaults API
/discovery/* None Supported chains and available protocols Discovery API
/health None Liveness check — returns service status —
Partner API HMAC-signed Programmatic institutional access (orders, vault management) Partner API
App API JWT bearer Powers the Earn app and partner portal; not for third-party integration —

Conventions

  • Identifiers. Endpoints are keyed either by vault address (the on-chain contract address, 0x…) or by share-class id (a hex string). You never need to know a share-class id in advance: fetching a vault by address returns its share-class id. The distinction is explained in SDK Concepts.
  • Return semantics. Return fields are percentages, nullable, and window returns are cumulative (only all-time is annualized). Read Financial Data & Charting before building anything that displays returns — the semantics are easy to get wrong.
  • Errors. Standard HTTP status codes: 404 unknown vault/share class, 400 malformed identifiers, 422 invalid query parameters.
  • Rate limiting. Public endpoints are rate-limited per client. Cache responses (headline financials change at most every few minutes) and back off on 429.

Looking for a full OpenAPI spec?

A machine-readable OpenAPI document covering the public surface is maintained alongside the backend. Partner-specific API documentation is provided during partner onboarding — see Partner API.