# Nexus Docs

## Exchange

- [Exchange](https://docs.nexus.xyz/readme.md): A perpetual futures exchange: what it trades, how it prices, and how it manages risk.
- [Introduction](https://docs.nexus.xyz/overview/introduction.md): What the Nexus Exchange is, what is live on testnet today, and what comes next.
- [Architecture](https://docs.nexus.xyz/overview/architecture.md): The components the Exchange is built from, and what runs today.
- [Exchange testnet](https://docs.nexus.xyz/overview/exchange-testnet.md): Trade the testnet venue: authenticate, mint a key, claim synthetic USDX, and place an order.
- [Dollar balances](https://docs.nexus.xyz/overview/usdx.md): How money works on the Exchange: dollar balances, and what USDX means where you see it.
- [Trading](https://docs.nexus.xyz/trading/trading.md): What the Exchange trades, how orders are matched, and what is live on testnet today.
- [Quickstart](https://docs.nexus.xyz/trading/trading/quickstart.md): The shortest path from a wallet to a filled order when trading the Exchange over the API.
- [Perpetuals](https://docs.nexus.xyz/trading/trading/perpetuals.md): Perpetual futures on the Exchange: no expiry, tethered by funding, cross-margined in USDX.
- [Market Specifications](https://docs.nexus.xyz/trading/trading/perpetuals/market-specifications.md): Contract specifications for every listed perpetual — tick and lot size, margin rates, open-interest caps, funding, and fees.
- [Margining](https://docs.nexus.xyz/trading/trading/perpetuals/margining.md): Initial and maintenance margin, leverage as a standing per-market setting, and the liquidation threshold.
- [Order types](https://docs.nexus.xyz/trading/trading/perpetuals/order-types.md): The eight order types and four time-in-force policies, and what each one requires.
- [Positions](https://docs.nexus.xyz/trading/trading/perpetuals/positions.md): Position state: size, entry, unrealized and realized PnL, funding, and liquidation price.
- [Funding rates](https://docs.nexus.xyz/trading/trading/perpetuals/funding-rates.md): How funding is measured against the index, when it settles, and what caps it.
- [Liquidations](https://docs.nexus.xyz/trading/trading/perpetuals/liquidations.md): When a position is liquidated, how to compute your own liquidation price, the order the engine sends, and the waterfall that absorbs a shortfall.
- [Price oracles](https://docs.nexus.xyz/trading/trading/perpetuals/price-oracles.md): How the mark and index prices are built, and the freshness and deviation guards on them.
- [Discovery bounds](https://docs.nexus.xyz/trading/trading/perpetuals/discovery-bounds.md): The price band and the max-move circuit breaker, the two bounds that decide which orders and which marks the venue accepts.
- [Trading hours](https://docs.nexus.xyz/trading/trading/perpetuals/trading-hours.md): Which markets trade continuously, how calendared markets are configured, and what the venue does and does not yet enforce.
- [Spot](https://docs.nexus.xyz/trading/trading/spot.md): In development
- [Overview](https://docs.nexus.xyz/terminal/terminal.md): The Exchange's web client at nexus.xyz/trade, and how to start trading in it.
- [Wallet and funding](https://docs.nexus.xyz/terminal/wallet-and-funding.md): Log in, enable trading and claim test funds.
- [Trading](https://docs.nexus.xyz/terminal/trading.md): Find a market, read the chart and order book, and place orders.
- [Portfolio](https://docs.nexus.xyz/terminal/portfolio.md): Track your account, positions, orders and history.
- [API keys](https://docs.nexus.xyz/terminal/api-keys.md): Create keys so a bot or script can trade for your account.
- [Referrals](https://docs.nexus.xyz/terminal/referrals.md): How a referral link connects a new trader to the trader who invited them.
- [Market data](https://docs.nexus.xyz/terminal/market-data.md): The public Data dashboard and each market's trading rules.
- [Settings](https://docs.nexus.xyz/terminal/settings.md): Language, notifications, confirmations, keyboard shortcuts and the phone layout.
- [Asset directory](https://docs.nexus.xyz/asset-directory/asset-directory.md): The markets that are live on the Nexus Exchange today, and the asset classes that follow.
- [Roll schedules](https://docs.nexus.xyz/consolidated-resources/roll-schedules.md): Nexus perpetuals do not expire, so there is no roll schedule.
- [Parameter changes](https://docs.nexus.xyz/consolidated-resources/parameter-changes.md): A dated record of every change to a listed market's risk, fee and oracle parameters since per-market configuration began.
- [APIs & rates](https://docs.nexus.xyz/apis-and-rates/apis-and-rates.md): The REST and WebSocket gateway: base URL, authentication, and the rate-limit model.
- [Exchange REST](https://docs.nexus.xyz/apis-and-rates/apis-and-rates/exchange-rest.md): The REST API at a glance: authentication and keys, account, orders, market data, and stats.
- [Exchange WebSocket](https://docs.nexus.xyz/apis-and-rates/apis-and-rates/exchange-websocket.md): Real-time order book, trade and account streams: subscriptions, tokens, and reconnection.
- [Rate & connection limits](https://docs.nexus.xyz/apis-and-rates/apis-and-rates/rate-limits.md): Weight-per-second budgets, the three independent buckets, and the per-tier ceilings.
- [Market maker guide](https://docs.nexus.xyz/apis-and-rates/apis-and-rates/market-maker-guide.md): Quoting on the Exchange: post-only, cancel-on-disconnect, rate-limit tiers, and maker rebates.
- [API versioning](https://docs.nexus.xyz/apis-and-rates/apis-and-rates/api-versioning.md): How the API is versioned, which version a client is served, and how a deprecation is signalled.
- [Legal & Disclaimers](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers.md): Where the Exchange's terms, policies and risk disclosures live.
- [Terms of Use](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers/terms-of-use.md): Terms governing use of Nexus websites, services, and infrastructure.
- [Privacy Policy](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers/privacy-policy.md): How Nexus handles user data and privacy.
- [Restricted Jurisdictions](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers/restricted-jurisdictions.md)
- [Cookie Policy](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers/cookie-policy.md): How the Nexus Site uses cookies and similar technologies, and how to manage them.
- [Data Processors](https://docs.nexus.xyz/legal-and-disclaimers/legal-and-disclaimers/data-processors.md): The Nexus Foundation's current sub-processors, what each handles, and where it processes data.

## API Reference

- [API Reference](https://docs.nexus.xyz/api-reference/readme.md): The Nexus Exchange API, with a page per endpoint, guides, and the official clients.
- [Get Started](https://docs.nexus.xyz/api-reference/guides/get-started.md)
- [SDKs & Tools](https://docs.nexus.xyz/api-reference/guides/sdks.md): Every official way to connect to the Nexus Exchange, the Rust, TypeScript, Python and Go SDKs, the CLI, the MCP server and agent skills, with the repository and install line for each.
- [Authentication](https://docs.nexus.xyz/api-reference/guides/authentication.md)
- [Agent Keys](https://docs.nexus.xyz/api-reference/guides/agent-keys.md)
- [Rate Limits](https://docs.nexus.xyz/api-reference/guides/rate-limits.md): What a request costs, what the rate-limit headers mean, which budgets are independent of which, and what happens when you exceed each.
- [Networks](https://docs.nexus.xyz/api-reference/guides/networks.md): How every Nexus Exchange interface selects a network, whether testnet, mainnet, or a custom target you describe yourself.
- [Order Types](https://docs.nexus.xyz/api-reference/guides/order-types.md): The eight order types, the four time-in-force policies, and which fields each one requires.
- [Portfolio & Account State](https://docs.nexus.xyz/api-reference/guides/portfolio.md): Consolidated account state, withdrawable balance, fee schedule, enriched positions, and the portfolio time-series, across the SDKs and CLI.
- [Venue Statistics](https://docs.nexus.xyz/api-reference/guides/statistics.md)
- [Errors](https://docs.nexus.xyz/api-reference/guides/errors.md): The status codes the contract declares, the rate-limit headers, and why a 401 tells you nothing.
- [Known Gaps](https://docs.nexus.xyz/api-reference/guides/known-gaps.md): Gaps and inconsistencies in the API contract, flagged rather than filled.
- [Schema Reference](https://docs.nexus.xyz/api-reference/guides/schemas.md)
- [POST /keys](https://docs.nexus.xyz/api-reference/authentication/create-api-key.md): Create an API key
- [DELETE /keys/{key\_id}](https://docs.nexus.xyz/api-reference/authentication/delete-api-key.md): Delete an API key
- [GET /keys](https://docs.nexus.xyz/api-reference/authentication/fetch-api-keys.md): List your API keys
- [POST /auth/login](https://docs.nexus.xyz/api-reference/authentication/login.md): Sign in with EVM wallet
- [GET /agents](https://docs.nexus.xyz/api-reference/agents/fetch-agents.md): List your agents
- [POST /agents/register](https://docs.nexus.xyz/api-reference/agents/register-agent.md): Register an agent key
- [PATCH /agents/{address}](https://docs.nexus.xyz/api-reference/agents/rename-agent.md): Rename an agent
- [DELETE /agents/{address}](https://docs.nexus.xyz/api-reference/agents/revoke-agent.md): Revoke an agent
- [GET /markets/{market\_id}/adl-events](https://docs.nexus.xyz/api-reference/markets/fetch-adl-events.md): Get ADL settlement history for a market (v0.21)
- [GET /metadata](https://docs.nexus.xyz/api-reference/markets/fetch-api-version-metadata.md): API version and network metadata
- [GET /markets/{market\_id}/mark-price](https://docs.nexus.xyz/api-reference/markets/fetch-mark-price.md): Get mark price
- [GET /api/v1/markets/{market\_id}/mark-price](https://docs.nexus.xyz/api-reference/markets/fetch-mark-price-v1.md): Get mark price
- [GET /markets/changes](https://docs.nexus.xyz/api-reference/markets/fetch-market-changes.md): List scheduled market-parameter changes
- [GET /markets/{market\_id}/changes](https://docs.nexus.xyz/api-reference/markets/fetch-market-changes-for-market.md): List scheduled changes for one market
- [GET /markets/{market\_id}/risk-params](https://docs.nexus.xyz/api-reference/markets/fetch-market-risk-params.md): Get market risk parameters
- [GET /markets/{market\_id}/status](https://docs.nexus.xyz/api-reference/markets/fetch-market-status.md): Get market status and halt info (v0.21)
- [GET /api/v1/markets/{market\_id}/status](https://docs.nexus.xyz/api-reference/markets/fetch-market-status-v1.md): Get market status and halt info (v0.21)
- [GET /markets](https://docs.nexus.xyz/api-reference/markets/fetch-markets.md): List all markets
- [GET /markets/summary](https://docs.nexus.xyz/api-reference/markets/fetch-markets-summary.md): Market summaries with volume
- [GET /api/v1/markets/summary](https://docs.nexus.xyz/api-reference/markets/fetch-markets-summary-v1.md): Market summaries with volume
- [GET /markets/next-funding](https://docs.nexus.xyz/api-reference/markets/fetch-next-funding.md): When each market's next funding settlement is due
- [GET /stats](https://docs.nexus.xyz/api-reference/markets/fetch-stats.md): Venue statistics
- [GET /stats/history](https://docs.nexus.xyz/api-reference/markets/fetch-stats-history.md): Venue throughput history
- [GET /api/v1/stats/history](https://docs.nexus.xyz/api-reference/markets/fetch-stats-history-v1.md): Venue throughput history
- [GET /api/v1/stats](https://docs.nexus.xyz/api-reference/markets/fetch-stats-v1.md): Venue statistics
- [GET /status](https://docs.nexus.xyz/api-reference/markets/fetch-status.md): Aggregate service health
- [GET /markets/{market\_id}/ticker](https://docs.nexus.xyz/api-reference/tickers/fetch-ticker.md): Get ticker for a market
- [GET /api/v1/markets/{market\_id}/ticker](https://docs.nexus.xyz/api-reference/tickers/fetch-ticker-v1.md): Get ticker for a market
- [GET /tickers](https://docs.nexus.xyz/api-reference/tickers/fetch-tickers.md): Get tickers for all markets
- [GET /api/v1/tickers](https://docs.nexus.xyz/api-reference/tickers/fetch-tickers-v1.md): Get tickers for all markets
- [GET /markets/{market\_id}/orderbook](https://docs.nexus.xyz/api-reference/order-book/fetch-order-book.md): Get order book
- [GET /api/v1/markets/{market\_id}/orderbook](https://docs.nexus.xyz/api-reference/order-book/fetch-order-book-v1.md): Get order book
- [GET /markets/{market\_id}/trades](https://docs.nexus.xyz/api-reference/trades/fetch-trades.md): Get recent trades
- [GET /api/v1/markets/{market\_id}/trades](https://docs.nexus.xyz/api-reference/trades/fetch-trades-v1.md): Get recent trades
- [GET /markets/{market\_id}/candles](https://docs.nexus.xyz/api-reference/candles/fetch-o-h-l-c-v.md): Get OHLCV candles
- [GET /api/v1/markets/{market\_id}/candles](https://docs.nexus.xyz/api-reference/candles/fetch-o-h-l-c-v-v1.md): Get OHLCV candles
- [GET /funding](https://docs.nexus.xyz/api-reference/funding/fetch-funding-history.md): Account funding payments
- [GET /markets/{market\_id}/funding](https://docs.nexus.xyz/api-reference/funding/fetch-funding-rate-history.md): Get funding rate history
- [GET /api/v1/markets/{market\_id}/funding](https://docs.nexus.xyz/api-reference/funding/fetch-funding-rate-history-v1.md): Get funding rate history
- [GET /markets/{market\_id}/funding-samples](https://docs.nexus.xyz/api-reference/funding/fetch-funding-samples.md): Funding premium-index samples
- [GET /api/v1/markets/{market\_id}/funding-samples](https://docs.nexus.xyz/api-reference/funding/fetch-funding-samples-v1.md): Funding premium-index samples
- [GET /stats/balance-distribution](https://docs.nexus.xyz/api-reference/statistics/fetch-balance-distribution.md): Aggregate balance distribution
- [GET /stats/volume](https://docs.nexus.xyz/api-reference/statistics/fetch-cumulative-volume.md): Cumulative traded volume
- [GET /stats/open-interest](https://docs.nexus.xyz/api-reference/statistics/fetch-open-interest.md): Open interest, long and short reported separately
- [GET /stats/referrals](https://docs.nexus.xyz/api-reference/statistics/fetch-referral-stats.md): Referral programme aggregate
- [DELETE /orders](https://docs.nexus.xyz/api-reference/trading/cancel-all-orders.md): Cancel all orders
- [DELETE /api/v1/orders](https://docs.nexus.xyz/api-reference/trading/cancel-all-orders-v1.md): Cancel all orders
- [DELETE /orders/{order\_id}](https://docs.nexus.xyz/api-reference/trading/cancel-order.md): Cancel an order
- [DELETE /api/v1/orders/{order\_id}](https://docs.nexus.xyz/api-reference/trading/cancel-order-v1.md): Cancel an order
- [POST /orders](https://docs.nexus.xyz/api-reference/trading/create-order.md): Submit an order
- [POST /api/v1/orders](https://docs.nexus.xyz/api-reference/trading/create-order-v1.md): Submit an order
- [POST /orders/batch](https://docs.nexus.xyz/api-reference/trading/create-orders.md): Submit multiple orders
- [POST /api/v1/orders/batch](https://docs.nexus.xyz/api-reference/trading/create-orders-v1.md): Submit multiple orders
- [PATCH /orders/{order\_id}](https://docs.nexus.xyz/api-reference/trading/edit-order.md): Amend an order
- [PATCH /api/v1/orders/{order\_id}](https://docs.nexus.xyz/api-reference/trading/edit-order-v1.md): Amend an order
- [POST /orders/preview](https://docs.nexus.xyz/api-reference/trading/preview-order.md): Preview an order
- [POST /api/v1/orders/preview](https://docs.nexus.xyz/api-reference/trading/preview-order-v1.md): Preview an order
- [GET /positions](https://docs.nexus.xyz/api-reference/positions/fetch-positions.md): List open positions
- [GET /positions/closed](https://docs.nexus.xyz/api-reference/positions/fetch-positions-history.md): List closed positions
- [GET /api/v1/positions/closed](https://docs.nexus.xyz/api-reference/positions/fetch-positions-history-v1.md): List closed positions
- [GET /positions/pnl](https://docs.nexus.xyz/api-reference/positions/fetch-positions-pnl.md): Per-position P\&L decomposition
- [GET /api/v1/positions/pnl](https://docs.nexus.xyz/api-reference/positions/fetch-positions-pnl-v1.md): Per-position P\&L decomposition
- [GET /api/v1/positions](https://docs.nexus.xyz/api-reference/positions/fetch-positions-v1.md): List open positions
- [POST /account/margin](https://docs.nexus.xyz/api-reference/account/add-margin.md): Add or remove isolated margin on an open position
- [POST /account/credit](https://docs.nexus.xyz/api-reference/account/claim-credit.md): Claim synthetic USDX credit
- [POST /api/v1/account/credit](https://docs.nexus.xyz/api-reference/account/claim-credit-v1.md): Claim synthetic USDX credit
- [POST /faucet](https://docs.nexus.xyz/api-reference/account/claim-faucet.md): Claim testnet faucet
- [POST /deposits](https://docs.nexus.xyz/api-reference/account/create-deposit.md): Submit a deposit
- [POST /transfers](https://docs.nexus.xyz/api-reference/account/create-ordinary-transfer.md): Transfer USDX to another ordinary account
- [POST /subaccounts](https://docs.nexus.xyz/api-reference/account/create-subaccount.md): Create a subaccount
- [POST /account/deposit](https://docs.nexus.xyz/api-reference/account/deposit.md): Deposit USDX collateral
- [POST /transfers/enroll](https://docs.nexus.xyz/api-reference/account/enroll-ordinary-transfer-account.md): Enroll an ordinary transfer account
- [GET /account/activity](https://docs.nexus.xyz/api-reference/account/fetch-account-activity.md): Account activity
- [GET /api/v1/account/activity](https://docs.nexus.xyz/api-reference/account/fetch-account-activity-v1.md): Account activity
- [GET /account/funding-snapshot](https://docs.nexus.xyz/api-reference/account/fetch-account-funding-snapshot.md): Authoritative account funding snapshot
- [GET /api/v1/account/funding-snapshot](https://docs.nexus.xyz/api-reference/account/fetch-account-funding-snapshot-v1.md): Authoritative account funding snapshot
- [GET /account/referrals](https://docs.nexus.xyz/api-reference/account/fetch-account-referrals.md): Account referrals summary
- [GET /api/v1/account/referrals](https://docs.nexus.xyz/api-reference/account/fetch-account-referrals-v1.md): Account referrals summary
- [GET /account/state](https://docs.nexus.xyz/api-reference/account/fetch-account-state.md): Consolidated account state
- [GET /api/v1/account/state](https://docs.nexus.xyz/api-reference/account/fetch-account-state-v1.md): Consolidated account state
- [GET /account/summary](https://docs.nexus.xyz/api-reference/account/fetch-account-summary.md): Account portfolio summary
- [GET /api/v1/account/summary](https://docs.nexus.xyz/api-reference/account/fetch-account-summary-v1.md): Account portfolio summary
- [GET /account/{address}/adl-history](https://docs.nexus.xyz/api-reference/account/fetch-adl-history.md): Get ADL events touching an account (v0.21)
- [GET /account](https://docs.nexus.xyz/api-reference/account/fetch-balance.md): Get account summary
- [GET /api/v1/account](https://docs.nexus.xyz/api-reference/account/fetch-balance-v1.md): Get account summary
- [GET /account/cancel-on-disconnect](https://docs.nexus.xyz/api-reference/account/fetch-cancel-on-disconnect.md): Get cancel-on-disconnect status
- [GET /api/v1/account/cancel-on-disconnect](https://docs.nexus.xyz/api-reference/account/fetch-cancel-on-disconnect-v1.md): Get cancel-on-disconnect status
- [GET /account/deposit-target](https://docs.nexus.xyz/api-reference/account/fetch-deposit-address.md): How to fund this account
- [GET /api/v1/account/deposit-target](https://docs.nexus.xyz/api-reference/account/fetch-deposit-address-v1.md): How to fund this account
- [GET /deposits](https://docs.nexus.xyz/api-reference/account/fetch-deposits.md): List deposits
- [GET /account/equity-history](https://docs.nexus.xyz/api-reference/account/fetch-equity-history.md): Account equity history
- [GET /api/v1/account/equity-history](https://docs.nexus.xyz/api-reference/account/fetch-equity-history-v1.md): Account equity history
- [GET /fills](https://docs.nexus.xyz/api-reference/account/fetch-my-trades.md): List your fills
- [GET /api/v1/fills](https://docs.nexus.xyz/api-reference/account/fetch-my-trades-v1.md): List your fills
- [GET /orders](https://docs.nexus.xyz/api-reference/account/fetch-open-orders.md): List open orders
- [GET /api/v1/orders](https://docs.nexus.xyz/api-reference/account/fetch-open-orders-v1.md): List open orders
- [GET /orders/{order\_id}](https://docs.nexus.xyz/api-reference/account/fetch-order.md): Get order by ID
- [GET /api/v1/orders/{order\_id}](https://docs.nexus.xyz/api-reference/account/fetch-order-v1.md): Get order by ID
- [GET /orders/history](https://docs.nexus.xyz/api-reference/account/fetch-orders.md): Order history
- [GET /api/v1/orders/history](https://docs.nexus.xyz/api-reference/account/fetch-orders-v1.md): Order history
- [GET /transfers/{id}](https://docs.nexus.xyz/api-reference/account/fetch-ordinary-transfer.md): Read a committed ordinary transfer
- [GET /transfers](https://docs.nexus.xyz/api-reference/account/fetch-ordinary-transfers.md): Read ordinary USDX transfer history
- [GET /account/portfolio-history](https://docs.nexus.xyz/api-reference/account/fetch-portfolio-history.md): Account portfolio time-series
- [GET /api/v1/account/portfolio-history](https://docs.nexus.xyz/api-reference/account/fetch-portfolio-history-v1.md): Account portfolio time-series
- [GET /account/rate-limit](https://docs.nexus.xyz/api-reference/account/fetch-rate-limit-status.md): Get rate limit status
- [GET /api/v1/account/rate-limit](https://docs.nexus.xyz/api-reference/account/fetch-rate-limit-status-v1.md): Get rate limit status
- [GET /account/fees](https://docs.nexus.xyz/api-reference/account/fetch-trading-fees.md): Account fee schedule
- [GET /api/v1/account/fees](https://docs.nexus.xyz/api-reference/account/fetch-trading-fees-v1.md): Account fee schedule
- [GET /whoami](https://docs.nexus.xyz/api-reference/account/fetch-whoami.md): Get the authenticated principal
- [GET /api/v1/whoami](https://docs.nexus.xyz/api-reference/account/fetch-whoami-v1.md): Get the authenticated principal
- [GET /withdrawals](https://docs.nexus.xyz/api-reference/account/fetch-withdrawals.md): List your withdrawals
- [GET /account/margin-mode](https://docs.nexus.xyz/api-reference/account/get-margin-mode.md): Read the account default and effective margin mode
- [POST /subaccounts/rename](https://docs.nexus.xyz/api-reference/account/rename-subaccount.md): Rename a subaccount
- [PUT /account/cancel-on-disconnect](https://docs.nexus.xyz/api-reference/account/set-cancel-on-disconnect.md): Set cancel-on-disconnect
- [PUT /api/v1/account/cancel-on-disconnect](https://docs.nexus.xyz/api-reference/account/set-cancel-on-disconnect-v1.md): Set cancel-on-disconnect
- [POST /leverage](https://docs.nexus.xyz/api-reference/account/set-leverage.md): Set per-market leverage for the connected account
- [POST /account/margin-mode](https://docs.nexus.xyz/api-reference/account/set-margin-mode.md): Set the account default margin mode
- [POST /withdrawals](https://docs.nexus.xyz/api-reference/account/withdraw.md): Submit a withdrawal
- [GET /stream](https://docs.nexus.xyz/api-reference/websocket/connect-stream.md): Public WebSocket stream (legacy)
- [GET /ws](https://docs.nexus.xyz/api-reference/websocket/connect-web-socket.md): Per-account WebSocket stream
- [POST /ws/token](https://docs.nexus.xyz/api-reference/websocket/create-ws-token.md): Mint a WebSocket token
- [POST /ws-tokens](https://docs.nexus.xyz/api-reference/websocket/create-ws-token-legacy.md): Mint a WebSocket token (legacy)
- [POST /bridge/withdrawals](https://docs.nexus.xyz/api-reference/bridge/create-bridge-withdrawal.md): Trigger a bridge withdrawal
- [POST /api/v1/bridge/withdrawals](https://docs.nexus.xyz/api-reference/bridge/create-bridge-withdrawal-v1.md): Trigger a bridge withdrawal
- [GET /bridge/assets](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-assets.md): List bridgeable chains and assets
- [GET /api/v1/bridge/assets](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-assets-v1.md): List bridgeable chains and assets
- [GET /bridge/deposits/{id}](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-deposit.md): Get a bridge deposit
- [GET /api/v1/bridge/deposits/{id}](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-deposit-v1.md): Get a bridge deposit
- [GET /bridge/deposits](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-deposits.md): List bridge deposits
- [GET /api/v1/bridge/deposits](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-deposits-v1.md): List bridge deposits
- [GET /bridge/withdrawals/{id}](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-withdrawal.md): Get a bridge withdrawal
- [GET /api/v1/bridge/withdrawals/{id}](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-withdrawal-v1.md): Get a bridge withdrawal
- [GET /bridge/withdrawals](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-withdrawals.md): List bridge withdrawals
- [GET /api/v1/bridge/withdrawals](https://docs.nexus.xyz/api-reference/bridge/fetch-bridge-withdrawals-v1.md): List bridge withdrawals

## Math Engine

- [Overview](https://docs.nexus.xyz/math-engine/readme.md)
- [The Engine, Formally](https://docs.nexus.xyz/math-engine/engine.md)
- [Global Model](https://docs.nexus.xyz/math-engine/global.md)
- [System](https://docs.nexus.xyz/math-engine/system.md)
- [Closed Loop](https://docs.nexus.xyz/math-engine/closed-loop.md)
- [Funding Rate](https://docs.nexus.xyz/math-engine/funding-rate.md)
- [Margin Math](https://docs.nexus.xyz/math-engine/margin-math.md)
- [Liquidation Engine](https://docs.nexus.xyz/math-engine/liquidation-engine.md)
- [Oracle](https://docs.nexus.xyz/math-engine/oracle.md)
- [Order Book](https://docs.nexus.xyz/math-engine/order-book.md)
- [Position Tracker](https://docs.nexus.xyz/math-engine/position-tracker.md)
- [Insurance Fund](https://docs.nexus.xyz/math-engine/insurance-fund.md)
- [Settlement](https://docs.nexus.xyz/math-engine/settlement.md)
- [Performance](https://docs.nexus.xyz/math-engine/performance.md)

## Network

- [Introduction](https://docs.nexus.xyz/exchange-layer-1/overview/readme.md)
- [Tokenomics](https://docs.nexus.xyz/exchange-layer-1/overview/tokenomics.md)
- [Roadmap](https://docs.nexus.xyz/exchange-layer-1/overview/roadmap.md)
- [Contributors & partners](https://docs.nexus.xyz/exchange-layer-1/overview/contributors-and-partners.md)
- [Overview](https://docs.nexus.xyz/exchange-layer-1/architecture/architecture.md)
- [Tokens and bridges](https://docs.nexus.xyz/exchange-layer-1/nex-token/tokens-and-bridges.md)
- [NEX](https://docs.nexus.xyz/exchange-layer-1/nex-token/tokens-and-bridges/usdnex.md)
- [Bridging](https://docs.nexus.xyz/exchange-layer-1/nex-token/tokens-and-bridges/bridging.md)
- [Security audits](https://docs.nexus.xyz/exchange-layer-1/extra/security-audits.md)

## Research

- [The Nexus zkVM](https://docs.nexus.xyz/research/overview/the-nexus-zkvm.md)
- [zkVM Overview](https://docs.nexus.xyz/research/overview/zkvm-overview.md)
- [Architecture](https://docs.nexus.xyz/research/overview/architecture.md)
- [Getting Started](https://docs.nexus.xyz/research/development/getting-started.md)
- [SDK Quick Start](https://docs.nexus.xyz/research/development/sdk-quick-start.md)
- [SDK Documentation](https://docs.nexus.xyz/research/development/sdk-documentation.md)
- [Runtime](https://docs.nexus.xyz/research/development/runtime.md)
- [Precompiles](https://docs.nexus.xyz/research/development/precompiles.md)
- [Benchmarking](https://docs.nexus.xyz/research/development/benchmarking.md)
- [Use Case: Stable Matching](https://docs.nexus.xyz/research/walkthroughs/use-case-stable-matching.md)
- [Use Case: Program Execution](https://docs.nexus.xyz/research/walkthroughs/use-case-program-execution.md)
- [The Nexus Whitepaper](https://docs.nexus.xyz/research/specifications/the-nexus-whitepaper.md)
- [The Complete Specification](https://docs.nexus.xyz/research/specifications/the-complete-specification.md): The Nexus zkVM 3.0 Specification defines its architecture, memory model, constraints, and proving integration. Download the complete specification below.
- [Machine Architecture](https://docs.nexus.xyz/research/specifications/machine-architecture.md)
- [Proving Instructions](https://docs.nexus.xyz/research/specifications/proving-instructions.md)
- [Proving the CPU](https://docs.nexus.xyz/research/specifications/proving-the-cpu.md)
- [Proving Memory](https://docs.nexus.xyz/research/specifications/proving-memory.md)
- [Proving — An Example](https://docs.nexus.xyz/research/specifications/proving-an-example.md)
- [Licensing](https://docs.nexus.xyz/research/licensing/licensing.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.nexus.xyz/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
