Skip to main content
GET
/
v1
/
account
Get account summary
curl --request GET \
  --url https://joyride.exchange/api/v1/account
{
  "wallet": "GmQozSzrtMjXt5F1Bed8Vrt55zCbiga8vDZr47RX9wC8",
  "available": 9500000000,
  "locked": 500000000,
  "deficit": 25000000,
  "total_pnl": 250000000,
  "return_pct": 2.5,
  "positions": [
    {
      "instrument_id": "SOL_USDC-28FEB26-150-C",
      "quantity": 1000,
      "avg_price": 1500000,
      "price_decimals": 6,
      "size_decimals": 3,
      "contract_size": 1
    }
  ],
  "price_decimals": 6,
  "quote_asset": "USDC"
}

Documentation Index

Fetch the complete documentation index at: https://docs.joyride.exchange/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-wallet
string

Wallet address — primary user identification method

​
x-device-id
string

Device identifier — mobile fallback when x-wallet is not set

Query Parameters

​
wallet
string

Wallet address — fallback if neither x-wallet nor x-device-id headers are set

Response

Account summary

​
wallet
string
required
Example:

"GmQozSzrtMjXt5F1Bed8Vrt55zCbiga8vDZr47RX9wC8"

​
available
integer
required

Available balance in USDC micros

Example:

9500000000

​
locked
integer
required

Locked balance reserved for resting bid orders (USDC micros)

Example:

500000000

​
deficit
integer
required

Outstanding settlement shortfall tracked on the account (USDC micros).

Example:

25000000

​
total_pnl
integer
required

Total P&L derived from balance: (available + locked) - initial_balance (USDC micros).

Example:

250000000

​
return_pct
number<double>
required

Percentage return: total_pnl / initial_balance * 100.

Example:

2.5

​
positions
object[]
required
​
price_decimals
integer
required

Decimals applied to balance/PnL/margin fields (always 6).

Example:

6

​
quote_asset
string
required

Quote asset of the cash balance (always "USDC").

Example:

"USDC"