Skip to main content
A Node API token is required. Without one, requests return 401 Unauthorized.

Purpose

  • Fetch market data (prices, depth, trades, candlesticks) and account views (orders, positions, Trading Accounts).
  • Works over REST and Aptos views. No signing or private keys required.

When to use

  • Use for dashboards, analytics, and read-heavy server/frontend use cases.
  • Do not use for submitting transactions; use the Write SDK instead.

Initialization

Main readers

  • Markets: read.markets.getAll(), getByName()
  • Prices: read.marketPrices.getAll(), getByName(), subscribeByName()
  • Depth: read.marketDepth.getByName()
  • Trades: read.marketTrades.getByName()
  • Candlesticks: read.candlesticks.getByName(), subscribeByName()
  • Accounts and orders:
    • read.accountOverview.getByAddr()
    • read.userFees.getByAddr()
    • read.userOpenOrders.getBySubaccount() / read.userOrderHistory.getBySubaccount()
    • read.userPositions.getBySubaccount()
    • read.userTradeHistory.getBySubaccount()
    • read.userSubaccounts.getByOwner()
  • Portfolio and leaderboard:
    • read.portfolioChart.getByAddr()
    • read.leaderboard.getTopUsers()
  • Vaults and delegations:
    • read.vaults.getUserOwned() / getAll()
    • read.delegations.getForSubaccount()
  • Funded First Trade:
    • read.fundedFirstTrade.getEligibility() / getActiveTrial()
    • read.fundedFirstTrade.getTrialHistory() / getCampaignLocks() (count-based pagination)
    • read.fundedFirstTrade.subscribeByAddr()

Examples

Markets

Prices and candlesticks

Account views

User fees

User positions

Notes

  • For raw REST/WS endpoints, see the API Reference tabs.