Skip to main content
GET
cURL
Get one JSON briefing for a trader: the full profile, a position summary, and a freshness clock. Use it when an agent or a panel needs one current trader summary.

Read the briefing

  • address accepts a 0x... wallet address, a known username, or a trd_-prefixed trader ID.
  • trader has the same shape as Get Trader, with strategy and category_strengths always present. It never includes quant_metrics or trust.
  • position_summary is absent, not null, when the trader is not in the local database.
  • position_summary.sync_coverage is markets_synced divided by markets_total, capped at 1.0. When markets_total is null, any synced market yields 1.0, so check markets_total before you read 1.0 as full coverage.
  • position_summary.total_realized_pnl covers synced markets only. It is not provider all-time realized P&L when sync_coverage is below 1.0.
  • data_as_of is the open-position clock: the latest positions snapshot, else the last completed sync. Resolved and closed aggregates date to the last full sync.
  • An unknown trader returns 200 with trader.sync_status: "unknown" and no position_summary.

Cache the briefing

The response carries an ETag. Send it as If-None-Match to get 304 Not Modified with an empty body when nothing changed. Get Trader Context as Markdown returns the same briefing as one Markdown document.

Authorizations

Authorization
string
header
required

API key authentication. Send your key in the Authorization header as Bearer oxi_sk_live_.... Live keys require an active Pro subscription and return live data.

Headers

If-None-Match
string

Conditional GET validator from a previous ETag. Matching values return 304 Not Modified with an empty body.

Path Parameters

address
string
required

Ethereum wallet address (0x...), known trader username, or trd_-prefixed trader ID emitted by this API.

Response

Trader context

object
string
required
Allowed value: "trader_context"
data
object
required
meta
object
required