Skip to main content
GET
Observed native wallet-token PnL

Authorizations

Authorization
string
header
required

An OceanX API key, created in the app under Settings → Developer API. Send it as Authorization: Bearer ox_live_…. Required scopes are operation-specific: market reads use md.read, tracker uses tracker.read, copy reads use copy.read, and alert operations use alerts.read or alerts.write. New scopes require explicit selection and grant no trading authority. Existing perps operations retain their documented scopes.

Path Parameters

wallet
string
required
Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
token
string
required
Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Query Parameters

currency
enum<string>
default:usd
Available options:
usd,
sol,
eur
pnlMode
enum<string>
default:unknown-basis-null
Available options:
unknown-basis-null

Response

Observed position or explicit unknown; never lifetime completeness.

data
object
required