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(), getAllSpot(), getByName()
  • Spot asset contexts (24h stats + live mid per spot market): read.spotAssetContexts.getAll()
  • Prices: read.marketPrices.getAll(), getByName(), subscribeByName(), subscribeAllSpotMids()
  • Depth: read.marketDepth.subscribeByName(), subscribeByAddr()
  • Trades: read.marketTrades.getByName(), getByAddr(), subscribeByName(), subscribeByAddr()
  • Candlesticks: read.candlesticks.getByName(), getByAddr(), subscribeByName(), subscribeByAddr()
  • Accounts and orders:
    • read.accountOverview.getByAddr()
    • read.userFees.getByAddr()
    • read.userOpenOrders.getByAddr() / read.userOrderHistory.getByAddr()
    • read.userOrders.getOrder() (single order by orderId / clientOrderId)
    • read.userBulkOrders.getByAddr() / getStatus() / getFills()
    • read.userPositions.getByAddr()
    • read.userTradeHistory.getByAddr()
    • read.userSubaccounts.getByAddr()
  • 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()
  • Chain views: read.tokenBalance(), read.fungibleAssetMetadata() (symbol/decimals/name for any fungible-asset address, e.g. secondary_collateral entries), read.spotMarketAssets() (a spot market’s base/quote asset addresses — not exposed by /markets)

Examples

Markets

Spot on the shared order endpoints

The order endpoints serve perp and spot on shared routes, with each row tagged asset_type ("perp" | "spot"). The account-scoped list readers (userOpenOrders, userOrderHistory, userTradeHistory, userBulkOrders, and userBulkOrders.getFills) default to assetType: "perp", so existing perp consumers keep their exact pre-spot responses and pagination. Pass "spot" to scope to spot, or "all" to receive both products merged (server-side union pagination):
Spot trade rows also carry fee_asset, the FA address fee_amount is denominated in (base asset for the buyer, quote for the seller); it is absent on perp rows, where fees are implicitly USDC.

Prices and candlesticks

Name-based market-data methods (candlesticks, marketDepth, marketTrades) derive the market address from the name, which differs between perp and spot markets even when they share a name. They accept an optional assetType ("perp" default, or "spot"):

Account views

User fees

User positions

Notes

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