Skip to main content
GET
Read a trader's PnL across whole wallets

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

traderId
string
required

A trader id: tdr_ and 26 characters. GET /v3/traders/lookup finds it by handle.

Pattern: ^tdr_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

window
enum<string>

One window: 24h, 7d, 30d or all. Leave it out for all four. status stays the same either way.

Available options:
24h,
7d,
30d,
all

Response

OK

A trader's profit and loss over the wallets we verified for them, per window.

trader
string
required

The tdr_ id of the trader, after merges.

status
enum<string>
required

ready: figures present. Only this status takes a reveal. pending: no reading yet; call again after retryAfterSeconds. failed: the last read failed; call again after retryAfterSeconds. no_wallet: the trader holds no verified wallet (tier proven, account or partial) that no other trader also holds. unavailable: provider reads are off or this month's provider budget is spent.

Available options:
ready,
pending,
failed,
no_wallet,
unavailable
retryAfterSeconds
integer | null
required

Seconds to wait before you ask again while status is pending or failed; else null.

Required range: -9007199254740991 <= x <= 9007199254740991
wallets
string[]
required

The wal_ ids the figures cover, at most one per address family. Empty unless status is ready.

windows
object
required

One entry per window. With window set, only that key is present.

unrealized
object | null
required

Unrealized profit or loss over the wallets, from our data provider. null without a reading.

asOf
string<date-time> | null
required

The oldest asOf among the ready windows, else the ranking time of all, else null.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$
nextUpdateAt
string<date-time> | null
required

When the first figure from our data provider falls due to be read again: its asOf plus its refresh interval. The first call after that time reads it again. Earlier than now when stale is true. null unless status is ready.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}(?:Z))$
stale
boolean
required

true when at least one figure from our data provider is past its refresh interval and this call could not read it again: the read failed, did not finish within the 8 second wait, or this month's provider budget is spent. A later call can carry newer figures. The computed all window does not count. false unless status is ready.