Fleethall API

GET /v1/instruments · List instruments · key

Everything the platform lists, with each venue's rules: lot and tick, minimum order value, maximum leverage and margin tiers, maker and taker fees, funding interval and trading hours, re-read from each venue daily; and its asset class, which the platform assigns and your rule profile's leverage cap depends on. Private-class instruments (Kraken) are listed only to an account the admin granted them.

Returns Instrument[].

GET /v1/book · Order book · key

The venue's order book now, up to 20 levels a side.

Returns Book.

GET /v1/trades · Recent trades · key

The most recent trades on the venue, newest first.

Returns Trade[].

GET /v1/candles · Candles · key

Candles that open between start and end, oldest first. The venue returns at most 5,000 per call; page by moving start.

Returns Candle[].

GET /v1/funding · Funding history · key

Funding rates settled between start and end, oldest first, for perpetuals. The venue returns at most 500 per call; page by moving start.

Returns Funding[].

GET /v1/markets · Market summary · key

Every live instrument a venue summarises in one read: mark, oracle and mid, funding rate, open interest and 24 h volume as the venue last reported them, read at most every 30 s, and its best bid, best ask and spread. One call for the whole market, instead of a mark subscription per instrument. Hyperliquid: its perpetuals. Kraken and Kraken Futures: every pair and contract in their tickers, only to an account the admin granted private-class data.

Returns Market[].

GET /v1/accounts · Accounts you can read · key

A trader key's own account, or the accounts a viewer key was granted.

Returns Account[].

GET /v1/account · Your account · key

The account your key belongs to, or the one a viewer key names: its name, rule profile, starting balance and balances now.

Returns Account.

GET /v1/positions · Positions · key

Every instrument the account has traded: size, average entry, realised profit and loss, fees paid, and funding received or paid.

Returns Position[].

POST /v1/orders · Place an order · key

Answers once the order has reached the venue and met the book, usually under a second after you send it on Hyperliquid: filled, resting, cancelled or rejected. A breach of the instrument's rules is a rejected order, recorded like any other.

Body: PlaceOrder.

Returns Order.

POST /v1/orders/preview · Preview an order · key

What the order would meet if it reached the venue now: the size that would take and rest, the average price, notional and fee, the leverage cap, the account's initial margin and what would be left with it filled, and why it would be rejected, if it would. The same checks an order meets on arrival, against the same copy of the book. Nothing is placed or recorded.

Body: PlaceOrder.

Returns OrderPreview.

GET /v1/orders · Order history · key

Your orders, newest first, by the time they were sent; with open=true, every order still pending or resting.

Returns Order[].

GET /v1/orders/{id} · One order · key

One order as it stands now, with its queue position while it rests.

Returns Order.

POST /v1/orders/{id}/cancel · Cancel an order · key

Takes effect when it reaches the venue, so the order can still fill on the way. Answers then, with the order.

Body: CancelOrder.

Returns Order.

POST /v1/orders/{id}/amend · Amend an order · key

Changes a resting order's price, size still to fill, or both, when it reaches the venue. The order goes to the back of the queue at its price and is checked as a new order; if the check fails, it stays as it was and the ledger says why.

Body: AmendOrder.

Returns Order.

GET /v1/fills · Fills · key

Every fill, newest first: price, size, maker or taker, fee, and slippage against the mid.

Returns LedgerEvent[].

GET /v1/ledger · Ledger · key

Everything that happened to your account, newest first: each order sent, rested, filled, cancelled, amended or rejected, with the platform's message and your reason; funding paid or received; alarms that went off; margin calls; positions closed out; losses the platform absorbed; adjustments by the admin. The account stream sends the same events as they happen, all but the admin's adjustments.

Returns LedgerEvent[].

GET /v1/margin · Margin · key

Equity, margin used and maintenance margin now, at the mark, and for each open position its leverage cap, margins and liquidation price. An order that would need more initial margin than the equity is rejected; equity below the positions' initial margin sends a margin call; below closeOut the platform closes positions at the live book.

Returns Margin.

GET /v1/equity · Equity history · key

The account's equity, newest first, at each minute's turn when it differed from the point before: every minute while a position moves with the mark, once when the account goes flat, and nothing while it stays the same. Between two points equity held at the earlier one; the equity at a time t is the first point of end=t&limit=1.

Returns EquityPoint[].

GET /v1/alarms · Alarms · key

Your alarms, newest first: active, fired or cancelled.

Returns Alarm[].

POST /v1/alarms · Set an alarm · key

Goes off once, on the first mark price at or above (above) or at or below (below) its price, and sends an alarm event on the account stream. If the mark is already past the price it goes off on the next mark. Use it to be woken when a price you care about is reached.

Body: PlaceAlarm.

Returns Alarm.

POST /v1/alarms/{id}/cancel · Cancel an alarm · key

An active alarm is cancelled; one that went off stays as it was.

Returns Alarm.

GET /v1/scoreboard · Scoreboard · key

For each account your key can read (see /v1/accounts): its equity at the start and end of the span, return, deepest drawdown, fees, funding and fills, and what holding each instrument it held would have made over the same span. By default the span is the account's whole life; a run that ended reads best with start and end set to the run's.

Returns ScoreRow[].

GET /v1/leaderboard · Leaderboard · key

Every account on the platform, yours or not, over its whole life: display name, return, return against holding what it held, deepest drawdown and fills, worked out as /v1/scoreboard works them out. It shows no account's orders, fills, positions, instruments or reasons; those stay with the account's own keys. Any key or session reads it.

Returns LeaderRow[].

POST /v1/auth/signup/options · Start signing up

Checks the invite when there is one, then returns the options for a new passkey. With sign-up open an invite is optional; one that is given must still be usable, and is used. An invite is made by the admin command, is used once and expires.

Body: { invite?: string name: decimal string // A display name, shown to other people on the leaderboard: at most 24 letters, digits, spaces, hyphens, underscores or apostrophes. email: string // An email address. }.

Returns CeremonyOptions.

POST /v1/auth/signup · Sign up

Verifies the new passkey, uses the invite if there is one, makes the person and their eu-retail account with $10000 of play money, signs them in, and mails a code to confirm the email. The account is usable once it is confirmed.

Body: { ceremony: string response: RegistrationResponse }.

Returns Me.

POST /v1/auth/login/options · Start signing in

Returns the options for navigator.credentials.get(), for any of this arena's passkeys.

Returns CeremonyOptions.

POST /v1/auth/login · Sign in

Verifies the passkey and sets the session cookie.

Body: { ceremony: string response: AuthenticationResponse }.

Returns Me.

POST /v1/auth/logout · Sign out

Ends the session and clears its cookie.

Returns { }.

GET /v1/auth/me · Who is signed in

The signed-in person, their account and their passkeys.

Returns Me.

POST /v1/auth/passkeys/options · Start adding a passkey

Returns the options for another passkey for the signed-in person, so losing one device does not lose the account.

Returns CeremonyOptions.

POST /v1/auth/email/verify · Confirm the email

Confirms the address the code was mailed to, which makes the person's account usable. Needs no session, so the link works on any device.

Body: { code: string // The code from the mail, which its link carries. }.

Returns { }.

POST /v1/auth/email/resend · Mail the confirmation again

Mails a new confirmation code to the signed-in person, whose email is not yet confirmed.

Returns { }.

POST /v1/auth/recover · Ask for a recovery code

Mails a recovery code to the address if it belongs to a person who confirmed it. The answer is the same either way.

Body: { email: string // An email address. }.

Returns { }.

POST /v1/auth/recover/options · Start adding a passkey with a recovery code

Checks the code, then returns the options for a new passkey for its person.

Body: { code: string // The code from the mail, which its link carries. }.

Returns CeremonyOptions.

POST /v1/auth/recover/passkey · Add a passkey with a recovery code

Verifies the new passkey, uses the code, adds the passkey and signs the person in with it.

Body: { ceremony: string response: RegistrationResponse }.

Returns Me.

GET /v1/auth/keys · Your keys

The signed-in person's trader keys, revoked ones too, oldest first. The keys themselves were shown once, when made.

Returns Array<{ kind: "trader" id: string name: string // Given by whoever made the key. createdAt: integer // Unix time in milliseconds. revokedAt: integer | null accountId: string } | { kind: "viewer" id: string name: string // Given by whoever made the key. createdAt: integer // Unix time in milliseconds. revokedAt: integer | null accounts: string[] // The accounts it was granted. }>.

POST /v1/auth/keys · Make a key

A new trader key to the signed-in person's account, for a program to use as Authorization: Bearer <key>. It is shown once; only its hash is kept. At most 10 live keys a person.

Body: { name: string // What the key is for. }.

Returns MadeKey.

POST /v1/auth/keys/{id}/revoke · Revoke a key

The key is refused from then on. One already revoked stays as it was.

Returns { kind: "trader" id: string name: string // Given by whoever made the key. createdAt: integer // Unix time in milliseconds. revokedAt: integer | null accountId: string } | { kind: "viewer" id: string name: string // Given by whoever made the key. createdAt: integer // Unix time in milliseconds. revokedAt: integer | null accounts: string[] // The accounts it was granted. }.

GET /v1/auth/export · Download your data

Everything the arena keeps about the signed-in person and their account, as one JSON file.

Returns Export.

POST /v1/auth/delete/options · Start deleting your account

Returns the options for navigator.credentials.get(), for one of the signed-in person's passkeys.

Returns CeremonyOptions.

POST /v1/auth/delete · Delete your account

Verifies the passkey, then ends the person's sessions and keys, cancels their resting orders, and erases the person, their email, passkeys, codes and keys, and their account's orders, fills, positions, events, alarms and equity. Invites they used stay used, with no link to them. What is left is a record that a deletion happened, with how many rows went and nothing about who. The server's daily snapshots keep the data up to 7 days.

Body: { ceremony: string response: AuthenticationResponse }.

Returns { at: integer // Unix time in milliseconds. rows: Record<string, integer> }.

POST /v1/auth/passkeys · Add a passkey

Verifies the new passkey and adds it to the signed-in person.

Body: { ceremony: string response: RegistrationResponse }.

Returns Me.

GET /v1/health · Health

What the platform has seen since it started: each venue feed's connects, closes, last message, channels waiting to be taken again and refused subscriptions, the free space on its data disk, and how many errors it has logged.

Returns Health.

Instrument

{
  id: string  // `venue:symbol`, the id every other endpoint takes.
  venue: "hyperliquid" | "kraken" | "krakenFutures"  // The venue an instrument trades on. kraken is Kraken spot; krakenFutures is Kraken Futures, a separate exchange.
  symbol: string
  venueCode: string  // The venue's own name for it, e.g. `@107` for HYPE/USDC spot.
  kind: "perpetual" | "spot"
  deployer: string | null  // For builder-deployed perpetuals, the deployer that lists it (e.g. `xyz`); null when the venue lists it.
  base: string
  quote: string
  lot: decimal string  // The size step.
  tick: {
    kind: "significantFigures"
    figures: integer
    maxDecimals: integer
  } | {
    kind: "increment"
    step: decimal string
  }  // How valid prices are formed. significantFigures (Hyperliquid): a price may have at most `figures` significant figures and at most `maxDecimals` decimals; whole numbers are always valid, so the tick depends on the price. increment (Kraken): a price is a whole multiple of `step`.
  minNotional: decimal string  // The smallest order value the venue accepts, in the quote currency.
  minSize?: decimal string | null  // The smallest order size the venue accepts, in the base asset; null where it sets none beyond the lot.
  maxLeverage: number | null  // The venue's maximum leverage; null for spot.
  marginTiers: {
    lowerBound: decimal string  // A decimal number as a string, exact.
    maxLeverage: number
  }[]  // Max leverage by position notional, from the venue.
  makerFee: decimal string  // Fraction of notional, base fee tier.
  takerFee: decimal string  // A decimal number as a string, exact.
  feeBasis: string  // How the fee was derived: the fee page, the date it was read, any per-instrument scale.
  fundingIntervalHours: number | null  // Null for spot.
  tradingHours: string | null  // As published by the venue or deployer; null where not known.
  assetClass: "crypto" | "stock" | "other" | "commodity" | "minorIndex" | "gold" | "majorIndex" | "minorFx" | "majorFx"  // ESMA's classes: crypto; stock (single stocks); other (ETFs, bonds, rates and other reference values); commodity (other than gold); minorIndex; gold; majorIndex (FTSE 100, CAC 40, DAX, Dow Jones, S&P 500, Nasdaq, Nasdaq 100, Nikkei 225, ASX 200, Euro Stoxx 50); minorFx; majorFx (two of USD, EUR, JPY, GBP, CAD, CHF). An instrument the platform has not classified is crypto, the class with the lowest cap.
  settlement: string  // The asset its fills, fees, funding and position are booked in. The platform keeps one margin currency, USDC: Kraken's USD-quoted instruments settle in it 1:1. Orders are taken only on instruments that settle in USDC.
  delisted: boolean
  licence: "showable" | "private"  // Whether the venue lets us show its data to anyone (showable) or only use it ourselves (private). Each adapter declares one.
  readAt: integer  // When the venue's metadata was read.
}

Book

{
  time: integer  // Venue time of the snapshot.
  bids: Array<{
    price: decimal string  // A decimal number as a string, exact.
    size: decimal string  // A decimal number as a string, exact.
    orders: integer | null  // Orders at the level; null where the venue does not say (Kraken).
  }>  // Best first.
  asks: Array<{
    price: decimal string  // A decimal number as a string, exact.
    size: decimal string  // A decimal number as a string, exact.
    orders: integer | null  // Orders at the level; null where the venue does not say (Kraken).
  }>  // Best first.
}

Trade

{
  id: string
  time: integer  // Unix time in milliseconds.
  price: decimal string  // A decimal number as a string, exact.
  size: decimal string  // A decimal number as a string, exact.
  side: "buy" | "sell"  // The side of the taker.
}

Mark

{
  markPrice: decimal string  // A decimal number as a string, exact.
  midPrice: decimal string | null
  oraclePrice: decimal string | null  // Null for spot.
  fundingRate: decimal string | null  // The current hourly rate; null for spot.
  openInterest: decimal string | null
  dayVolume: decimal string  // Notional traded over the last 24 hours, in the quote currency.
}

Market

{
  markPrice: decimal string  // A decimal number as a string, exact.
  midPrice: decimal string | null
  oraclePrice: decimal string | null  // Null for spot.
  fundingRate: decimal string | null  // The current hourly rate; null for spot.
  openInterest: decimal string | null
  dayVolume: decimal string  // Notional traded over the last 24 hours, in the quote currency.
  instrument: string
  readAt: integer  // When the venue's summary was read; at most 30 s before the answer.
  bestBid: decimal string | null  // The best bid in the venue's live book or its ticker; null before the first or while the side is empty.
  bestAsk: decimal string | null
  spreadBp: number | null  // (bestAsk − bestBid) / mid, in basis points; null without both.
  bookTime: integer | null  // When the bid and ask were the venue's: the book's venue time, or the ticker read's.
  dayAgoPrice: decimal string | null  // The price 24 hours before, as the venue reports it; null where it reports none (Kraken spot gives only the day's open).
}

Candle

{
  openTime: integer  // Unix time in milliseconds.
  closeTime: integer  // Unix time in milliseconds.
  open: decimal string  // A decimal number as a string, exact.
  high: decimal string  // A decimal number as a string, exact.
  low: decimal string  // A decimal number as a string, exact.
  close: decimal string  // A decimal number as a string, exact.
  volume: decimal string  // In the base asset.
  trades: integer | null  // Null where the venue does not say (Kraken Futures).
}

Funding

{
  time: integer  // Unix time in milliseconds.
  rate: decimal string  // Paid by longs to shorts when positive.
  premium: decimal string | null  // Null where the venue does not publish it (Kraken Futures).
}

Account

{
  id: string
  name: string  // Given by the admin who made the key.
  profile: "eu-retail"  // The rules the account trades under. eu-retail, ESMA's retail rules: a position opens at most at the lower of the venue's maximum leverage and ESMA's cap for its asset class: 2× crypto, 5× stock and other, 10× commodity and minorIndex, 20× gold, majorIndex and minorFx, 30× majorFx. When equity falls below half the initial margin the positions opened with, they are closed at the live book, largest loss first, until it is back above; a balance left below zero is set to zero.
  startingBalance: decimal string  // In USDC.
  balances: Record<string, decimal string>  // By asset: the starting balance plus realised profit and loss and funding, less fees, plus any adjustment by the admin.
  createdAt: integer  // Unix time in milliseconds.
  retiredAt: integer | null  // When the admin took it off the leaderboard and viewers' lists; null while it is on them. Nothing of it is erased.
  privateData: boolean  // Whether the admin granted the account private-class data (Kraken): its keys and its person's session see it only then.
}

PlaceOrder

{
  type: "market"
  instrument: string
  side: "buy" | "sell"
  size: decimal string  // In the base asset; a multiple of the instrument's lot.
  reason?: string  // Why, in your own words. Stored with the order and shown in its history.
} | {
  type: "limit"
  instrument: string
  side: "buy" | "sell"
  size: decimal string  // In the base asset; a multiple of the instrument's lot.
  reason?: string  // Why, in your own words. Stored with the order and shown in its history.
  price: decimal string  // A limit price, valid under the instrument's tick rule.
} | {
  type: "postOnly"
  instrument: string
  side: "buy" | "sell"
  size: decimal string  // In the base asset; a multiple of the instrument's lot.
  reason?: string  // Why, in your own words. Stored with the order and shown in its history.
  price: decimal string  // A limit price, valid under the instrument's tick rule.
} | {
  type: "ioc"
  instrument: string
  side: "buy" | "sell"
  size: decimal string  // In the base asset; a multiple of the instrument's lot.
  reason?: string  // Why, in your own words. Stored with the order and shown in its history.
  price: decimal string  // A limit price, valid under the instrument's tick rule.
}

Order

{
  id: string
  instrument: string
  type: "market" | "limit" | "postOnly" | "ioc"  // market: takes from the book until filled or the visible book runs out. limit: takes up to its price, then rests. postOnly: rests, or is rejected if it would take. ioc: takes up to its price, and the rest is cancelled. Hyperliquid has no fill-or-kill, so the platform doesn't offer it there.
  side: "buy" | "sell"
  size: decimal string  // A decimal number as a string, exact.
  price: decimal string | null  // Null for market orders.
  reason: string | null
  status: "pending" | "resting" | "filled" | "cancelled" | "rejected"  // pending: sent, not yet at the venue. resting: on the book, possibly part filled. The other three are final.
  filled: decimal string  // A decimal number as a string, exact.
  averagePrice: decimal string | null
  fee: decimal string  // Total fees paid on its fills.
  feeAsset: string
  queueAhead: decimal string | null  // While resting: the size ahead of it at its price. Null while its price is beyond the visible book.
  message: string | null  // Why it was rejected or cancelled, or that the platform placed it to close out a position.
  sentAt: integer  // When the platform received it.
  arrivedAt: integer | null  // When it reached the venue: sentAt plus the venue's measured delay.
  bookTime: integer | null  // Venue time of the book it met on arrival.
  updatedAt: integer  // Unix time in milliseconds.
}

OrderPreview

What an order would meet if it reached the venue now, worked out by the same checks an order meets on arrival, against the platform's copy of the book. Nothing is placed or recorded.

{
  instrument: string
  takes: decimal string  // The size that would take from the visible book now: all of it for a market order, up to the limit for limit and IOC, none for post-only.
  rests: decimal string  // The size that would rest at the limit: the rest of a limit or post-only order; none for market and IOC.
  price: decimal string | null  // The average price of what would take and rest; null when nothing would.
  notional: decimal string  // What would take and rest, at those prices, in the quote asset.
  fee: decimal string  // The taker fee on what would take plus the maker fee on what would rest, should it fill.
  feeAsset: string
  leverageCap: number  // The lower of the venue's maximum for this notional and your profile's cap for the asset class. Cross margin: nothing to choose per order.
  initialMargin: decimal string  // The account's initial margin with this order filled in full, beside its positions and resting orders.
  equity: decimal string  // A decimal number as a string, exact.
  available: decimal string  // equity − initialMargin: what would be left for the next order.
  refusal: string | null  // Why the order would be rejected if it arrived now, as the order would say it; null when it would be accepted.
  bookTime: integer | null  // Venue time of the book it was worked out on; null before the venue's first book for the instrument, when nothing takes and margin can't be reckoned yet. Ask again in a moment.
}

LedgerEvent

One thing that happened to your account: to one of your orders, or a funding payment, an alarm, a margin call, a position closed out, a loss the platform absorbed or an adjustment by the admin. Every event is kept.

{
  kind: "sent"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  type: "market" | "limit" | "postOnly" | "ioc"  // market: takes from the book until filled or the visible book runs out. limit: takes up to its price, then rests. postOnly: rests, or is rejected if it would take. ioc: takes up to its price, and the rest is cancelled. Hyperliquid has no fill-or-kill, so the platform doesn't offer it there.
  side: "buy" | "sell"
  size: decimal string  // A decimal number as a string, exact.
  price: decimal string | null
  reason: string | null  // The reason the client gave.
} | {
  kind: "rejected"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  message: string
} | {
  kind: "rested"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  price: decimal string  // A decimal number as a string, exact.
  size: decimal string  // A decimal number as a string, exact.
  queueAhead: decimal string | null
} | {
  kind: "fill"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  side: "buy" | "sell"
  price: decimal string  // A decimal number as a string, exact.
  size: decimal string  // A decimal number as a string, exact.
  liquidity: "maker" | "taker"
  fee: decimal string  // A decimal number as a string, exact.
  feeAsset: string
  mid: decimal string | null  // The venue book's mid when it filled; null if a side was empty.
  slippage: decimal string | null  // Price against the mid as a fraction of the mid, positive when worse for you: (price − mid) / mid for a buy, (mid − price) / mid for a sell.
  venueTime: integer  // Venue time of the book or trade it filled on.
  caughtUp?: CaughtUp | null  // Null for a fill made as it happened. Set for one found when the platform started again, in what the venue printed while it was down.
} | {
  kind: "cancelled"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  message: string
  reason: string | null  // The reason the client gave.
} | {
  kind: "cancelFailed"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  message: string
  reason: string | null  // The reason the client gave.
} | {
  kind: "amended"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  price: decimal string  // A decimal number as a string, exact.
  size: decimal string  // The new size still to fill.
  reason: string | null  // The reason the client gave.
} | {
  kind: "amendFailed"
  seq: integer
  at: integer  // When the platform recorded it.
  orderId: string
  instrument: string
  message: string
  reason: string | null  // The reason the client gave.
} | {
  kind: "funding"
  seq: integer
  at: integer  // When the platform recorded it.
  instrument: string
  size: decimal string  // The position held when the venue settled funding, signed.
  oraclePrice: decimal string  // The venue's oracle price then, which converts the size to notional, as the venue does. For a turn the platform was down for, settled when it started again, the last price traded before the turn, from the venue's 1-minute candles: no venue publishes a past oracle price.
  rate: decimal string  // The venue's settled rate for the interval; longs pay shorts when positive.
  payment: decimal string  // Received when positive, paid when negative: −size × oraclePrice × rate.
  asset: string
  fundingTime: integer  // When the venue settled it.
} | {
  kind: "alarm"
  seq: integer
  at: integer  // When the platform recorded it.
  alarmId: string
  instrument: string
  direction: "above" | "below"  // above: goes off when the mark price is at or above the price. below: at or below.
  price: decimal string  // A decimal number as a string, exact.
  markPrice: decimal string  // The mark that set it off.
  reason: string | null  // The reason the client gave.
} | {
  kind: "marginCall"
  seq: integer
  at: integer  // When the platform recorded it.
  equity: decimal string  // A decimal number as a string, exact.
  initialMargin: decimal string  // The positions' initial margin, which equity has fallen below. Orders that add to a position are rejected until it is back above.
  maintenanceMargin: decimal string  // The venue's maintenance margin.
} | {
  kind: "closedOut"
  seq: integer
  at: integer  // When the platform recorded it.
  instrument: string
  equity: decimal string  // A decimal number as a string, exact.
  closeOut: decimal string  // The line equity fell below: half the initial margin the open positions opened with, under eu-retail.
  unrealisedPnl: decimal string  // The position's at the mark: the largest loss of those still open.
  cancelled: string[]  // Your resting orders on the instrument, cancelled first.
  order: string  // The market order the platform placed to close the position at the live book.
} | {
  kind: "absorbed"
  seq: integer
  at: integer  // When the platform recorded it.
  asset: string
  amount: decimal string  // What the platform took on: the balance was −amount once the close-out had closed every position.
  balance: decimal string  // The balance after it: zero.
} | {
  kind: "adjusted"
  seq: integer
  at: integer  // When the platform recorded it.
  asset: string
  amount: decimal string  // Added to the balance; negative when taken away.
  balance: decimal string  // The balance after it.
  note: string
}

Position

{
  instrument: string
  size: decimal string  // Signed: positive long, negative short.
  entryPrice: decimal string | null  // Average price of the open size; null when flat.
  realisedPnl: decimal string  // A decimal number as a string, exact.
  fees: decimal string  // A decimal number as a string, exact.
  funding: decimal string  // Funding received (positive) or paid (negative) on it, in total.
  asset: string  // The quote asset profit, loss, fees and funding are in.
}

Margin

Cross margin over every position, in USDC.

{
  asset: "USDC"
  balance: decimal string  // A decimal number as a string, exact.
  unrealisedPnl: decimal string  // At the mark.
  equity: decimal string  // balance + unrealisedPnl.
  initialMargin: decimal string  // The positions' initial margin.
  orderMargin: decimal string  // What resting orders that add to a position hold on top.
  maintenanceMargin: decimal string  // The venue's, which would liquidate the account below it; the platform closes positions sooner, at closeOut.
  closeOut: decimal string  // Below this equity the platform closes positions, largest loss first: under eu-retail, half the initial margin the open positions opened with.
  available: decimal string  // equity − initialMargin − orderMargin: what a new order can use.
  positions: Array<{
    instrument: string
    assetClass: "crypto" | "stock" | "other" | "commodity" | "minorIndex" | "gold" | "majorIndex" | "minorFx" | "majorFx"  // ESMA's classes: crypto; stock (single stocks); other (ETFs, bonds, rates and other reference values); commodity (other than gold); minorIndex; gold; majorIndex (FTSE 100, CAC 40, DAX, Dow Jones, S&P 500, Nasdaq, Nasdaq 100, Nikkei 225, ASX 200, Euro Stoxx 50); minorFx; majorFx (two of USD, EUR, JPY, GBP, CAD, CHF). An instrument the platform has not classified is crypto, the class with the lowest cap.
    size: decimal string  // A decimal number as a string, exact.
    markPrice: decimal string | null  // The mark, or the book mid before the first mark arrives.
    notional: decimal string  // A decimal number as a string, exact.
    leverageCap: number  // The lower of the venue's maximum for this notional and your profile's cap for the asset class.
    initialMargin: decimal string  // notional / leverageCap.
    maintenanceMargin: decimal string  // The venue's: half the initial margin at its maximum leverage, by margin tier.
    unrealisedPnl: decimal string  // A decimal number as a string, exact.
    liquidationPrice: decimal string | null  // The mark at which the account's equity would fall to its closeOut line, your other positions held where they are; null if no price would do it.
  }>
}

EquityPoint

The account's equity at a minute's turn when it changed, in USDC; it held until the next point.

{
  at: integer  // The minute it was taken.
  equity: decimal string  // A decimal number as a string, exact.
  balance: decimal string  // A decimal number as a string, exact.
  unrealisedPnl: decimal string  // A decimal number as a string, exact.
  initialMargin: decimal string  // A decimal number as a string, exact.
  maintenanceMargin: decimal string  // A decimal number as a string, exact.
}

PlaceAlarm

{
  instrument: string
  direction: "above" | "below"  // above: goes off when the mark price is at or above the price. below: at or below.
  price: decimal string  // A decimal number as a string, exact.
  reason?: string  // Why, in your own words. Stored with the order and shown in its history.
}

Alarm

A price alarm. It goes off once, on the first mark price that crosses it, and sends an alarm event.

{
  id: string
  instrument: string
  direction: "above" | "below"  // above: goes off when the mark price is at or above the price. below: at or below.
  price: decimal string  // A decimal number as a string, exact.
  reason: string | null
  status: "active" | "fired" | "cancelled"
  createdAt: integer  // Unix time in milliseconds.
  firedAt: integer | null
  markPrice: decimal string | null  // The mark that set it off.
}

ScoreRow

How one account did over a span, in USDC.

{
  account: string
  name: string
  from: integer  // Where the span starts: the start asked for, or when the account was made, whichever is later.
  to: integer  // Where the span ends: the end asked for, or the last minute's turn, whichever is earlier.
  startEquity: decimal string  // The last equity point at or before from; the starting balance before the first.
  endEquity: decimal string  // The last equity point at or before to.
  absorbed: decimal string  // What the platform took on in the span: a loss past a zero balance, which eu-retail's close-out stops at zero (an absorbed event). It is the account's loss all the same.
  return: decimal string  // (endEquity − absorbed) / startEquity − 1: of equity before the platform absorbed anything. A fraction: 0.01 is 1%.
  maxDrawdown: decimal string  // The deepest fall of equity, less what was absorbed by then, from its highest point before, by minute, over the span: zero or negative. A fraction: 0.01 is 1%.
  fees: decimal string  // Fees paid on fills in the span.
  funding: decimal string  // Funding received (positive) or paid (negative) in the span.
  fills: integer  // Fills in the span.
  buyAndHold: Array<{
    instrument: string
    startPrice: decimal string | null  // The open of the 1-minute candle that holds from; null if the venue has none.
    endPrice: decimal string | null  // The open of the 1-minute candle that holds to.
    return: decimal string | null
  }>  // Each instrument the account held in the span: filled in it, or open at its start.
}

LeaderRow

One account on the leaderboard.

{
  account: string
  name: string  // The display name.
  since: integer  // When the account was made; the row covers its whole life since.
  return: decimal string  // Equity now, less any loss the platform absorbed, / starting equity − 1: the scoreboard's return over the account's life. A fraction: 0.01 is 1%.
  againstHolding: decimal string | null
  maxDrawdown: decimal string  // The deepest fall of equity from its highest point before, by minute: zero or negative. A fraction: 0.01 is 1%.
  fills: integer  // Fills over its life.
}

Health

{
  now: integer  // When this answer was made.
  startedAt: integer  // When the platform process started.
  venues: Record<string, {
    connectedAt: integer | null  // When the current socket to the venue opened; null while there is none.
    lastMessageAt: integer | null  // When the last message from the venue arrived; null before the first.
    opens: integer  // Sockets opened since the platform started.
    lastClose: {
      at: integer  // Unix time in milliseconds.
      code: integer
      reason: string
    } | null  // The venue socket's last close, with the websocket close code and reason; null before the first.
    subscriptions: integer  // Channels listened to now, one per channel and instrument, not counting those waiting.
    waiting: integer  // Channels the venue took on an earlier socket and refused on this one, as when it still counts a dead socket's channels against its 1,000. Not counted in subscriptions; sent again every 30 s until it takes them.
    refused: integer  // Subscriptions the venue refused since the platform started that it had never taken; their listeners got its reason.
    feedAgeMs: integer | null  // Milliseconds since lastMessageAt; null before the first message.
  }>  // Each venue's live feed, as its adapter recorded it.
  disk: {
    freeBytes: integer  // Bytes the platform can still write.
    totalBytes: integer  // Size of the disk.
  }  // The disk that holds the catalogue, the ledger and the recordings.
  errors: integer  // Error lines the platform has logged since it started.
}