---
generated_by: "publish-markdown-twins.mjs"
schema_version: "nexus.agent-readable-page.v1"
source_route: "/api"
source_commit: "2681878375533043b0648702ce53a9b7ebc3d8e1"
---

# API explorer | Nexus

Every call in the Nexus API, generated from the OpenAPI spec. Run market data live from your browser, watch the WebSocket stream, and copy each call as curl, TypeScript, Python or CLI.

TESTNET

[Trade](/trade)[Portfolio](/portfolio)[Seasons](/seasons)[Referrals](/referrals)[API Keys](/api-keys)

More

Search markets K
Get funds

API explorer
v0.9.148

Search endpoints K
Testnet Production

[Docs](https://docs.nexus.xyz/api-reference)[OpenAPI](/openapi.json)

Live stream
WebSocket, no key

### Markets

- GET List all markets
- GET Market summaries with volume
- GET When each market's next funding settlement is due
- GET Get market status and halt info (v0.21)
- GET Get mark price
- GET List scheduled market-parameter changes
- GET List scheduled changes for one market
- GET Get market risk parameters
- GET Venue statistics
- GET Venue throughput history
- GET Aggregate service health
- GET API version and network metadata
- GET Get ADL settlement history for a market (v0.21)

### Tickers

- GET Get ticker for a market
- GET Get tickers for all markets

### Order Book

- GET Get order book

### Trades

- GET Get recent trades

### Candles

- GET Get OHLCV candles

### Funding

- GET Get funding rate history
- GET Funding premium-index samples
- GET Account funding payments

### Trading

- POST Submit an order
- DEL Cancel all orders
- POST Submit multiple orders
- PATCH Amend an order
- DEL Cancel an order
- POST Preview an order

### Account

- GET Get ADL events touching an account (v0.21)
- GET List open orders
- GET Get order by ID
- GET Get account summary
- GET Account activity
- POST Add or remove isolated margin on an open position
- POST Set per-market leverage for the connected account
- POST Claim synthetic USDX credit
- GET How to fund this account
- GET Get rate limit status
- GET Get cancel-on-disconnect status
- PUT Set cancel-on-disconnect
- GET Get the authenticated principal
- GET List your fills
- GET List your withdrawals
- POST Submit a withdrawal
- GET Account fee schedule
- GET Account portfolio summary
- GET Consolidated account state
- GET Account equity history
- GET Account portfolio time-series
- GET Order history
- GET List deposits
- POST Submit a deposit
- POST Claim testnet faucet
- GET Authoritative account funding snapshot
- GET Account referrals summary
- GET Read ordinary USDX transfer history
- POST Transfer USDX to another ordinary account
- GET Read a committed ordinary transfer
- POST Enroll an ordinary transfer account
- GET Read the account default and effective margin mode
- POST Set the account default margin mode
- POST Create a subaccount
- POST Rename a subaccount

### Positions

- GET List open positions
- GET List closed positions
- GET Per-position P&L decomposition

### WebSocket

- POST Mint a WebSocket token (legacy)
- POST Mint a WebSocket token

### Authentication

- POST Sign in with EVM wallet
- GET List your API keys
- POST Create an API key
- DEL Delete an API key

### Agent keys

- POST Register an agent key
- GET List your agents
- PATCH Rename an agent
- DEL Revoke an agent

### Deposits and withdrawals

- GET List bridge deposits
- GET Get a bridge deposit
- GET List bridge withdrawals
- POST Trigger a bridge withdrawal
- GET Get a bridge withdrawal
- GET List bridgeable chains and assets

### Statistics

- GET Aggregate balance distribution
- GET Cumulative traded volume
- GET Referral programme aggregate
- GET Open interest, long and short reported separately

GET /markets/ {market_id} /ticker

## Get ticker for a market

Runs live

Copy URL Copy link to this call Copy as Markdown

Path

market_id * string

Market ID, for example `BTC-USDX-PERP`: uppercase letters and digits in hyphen-separated segments, up to 64 characters. A malformed ID returns `400` (`INVALID_MARKET_ID`). A well-formed ID that names no…

https://api.testnet.nexus.xyz/v1 Reset to example Send request

Response Schema Code

Send the request to see a live response from Testnet.
Example from the spec
200
`{
"symbol": "BTC-USDX-PERP" ,
"timestamp": 1776033911836 ,
"datetime": "2026-04-12T22:45:11.836Z" ,
"high": 50500 ,
"low": 49200 ,
"bid": 50100.5 ,
"bidVolume": 1.4 ,
"ask": 50102 ,
"askVolume": 0.8 ,
"open": 49800 ,
"close": 50100 ,
"last": 50100 ,
"change": 300 ,
"percentage": 0.602 ,
"baseVolume": 1250.5 ,
"quoteVolume": 62525000 ,
"markPrice": 50101.5 ,
"indexPrice": null ,
"info": {}
}`

Recent

Calls you send appear here.

[Status](https://status.nexus.xyz)[Get in touch](/contact)[llms.txt](/llms.txt)

TESTNET RTT — BUILD 2681878 VER 1.2.0

/ Shortcuts Support [Releases](/releases)[Status](https://status.nexus.xyz/)[Docs](https://docs.nexus.xyz)[Terms](https://docs.nexus.xyz/legal-and-disclaimers/terms-of-use)[Privacy](https://docs.nexus.xyz/legal-and-disclaimers/privacy-policy)

markets trade account portfolio more