Skip to main content
GET
Read one wallet's PnL across the whole wallet

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
family
enum<string>
required

The address family: svm for Solana, evm for EVM networks.

Available options:
svm,
evm
​
address
string
required

The wallet address. An EVM address matches in any letter case.

Required string length: 1 - 128

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

The profit and loss of one wallet, per window. Names no owner.

​
wallet
string
required

The wal_ id of the wallet asked for.

​
wallets
string[]
required

The wal_ ids the figures cover, one per address family, Solana first: the wallet asked for and, when a platform keys it to an account of one trader, the wallet of the other family the same trader holds as an account key on that platform. Listed whatever the status.

​
status
enum<string>
required

ready: figures present. pending: no reading yet; call again after retryAfterSeconds. failed: the last read failed; call again after retryAfterSeconds. unavailable: provider reads are off or this month's provider budget is spent.

Available options:
ready,
pending,
failed,
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
​
windows
object
required

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

​
unrealized
object | null
required

Unrealized profit or loss of the wallet, 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.

​
boards
object[]
required

Where the accounts keyed by these wallets stand on the newest capture of each platform board that ranks accounts, as the platform shows it, for reference. The platform computes these itself; they need not match the windows above. Empty when no board lists them.