Schemas

32-byte hex, 0x-prefixed.

32-byte hex, 0x-prefixed.

Scale of the token, and of every amount the transaction endpoints take for it.

high from 90%, critical from 98% by default; a pool leaves a level 3 points below its threshold.

Share of depositor assets that cannot be withdrawn right now, in percent. At 100 an unstake reverts.

Base-token amount that can be withdrawn right now.

When the reading was taken. Readings are hourly.

Stable identifier every other endpoint keys off.

Address of the pool contract itself.

Raw 0-100 score. riskCategory is the bucket it falls in.

Current annual percentage yield.

Mean APY over the last 30 days.

Total value locked, in USD.

False when the pool is listed for data only and cannot be staked into.

The token a stake is denominated in.

The share token an unstake is denominated in.

Exit liquidity. Null for pools that are not monitored or not read yet.

When the stats above were last recomputed, for a partner's own caching.

The amount priced, in amountToken units.

Tier percentage, in percent units.

Gas coverage: the batch’s approximate gas at the live price.

What is left once the fee is taken, in finalAmountToken units. Stake, buy, bridge: amount less the fee — about what a wallet holding amount can send. Unstake, sell: the proceeds less the fee.

Contract the call is made against.

Native value to send, as a hex quantity.

ABI-encoded calldata, hex.

The user's smart account address.

Encoded executeBatch over calls, hex.

Placeholder used for gas estimation. The wallet replaces it with its signature over userOpHash.

Sponsoring paymaster contract from the chain's Gas Manager policy. Set on every built op: gas is always sponsored.

Delegate implementation the EOA points at.

The EOA's own transaction nonce.

The digest the wallet signs.

The EIP-7702 tuple to sign, or null when the EOA already delegates to delegate — then sign only userOpHash and send no authorization.

Handle for the server-side intent. Single-use and short-lived: the user op itself is never accepted back from the client.

The amount the batch moves: base-token units for a stake, share units for an unstake.

Public uuid of the partner user the transaction is built for.

Stake: base-token units; unstake: wrap-token (share) units. Required unless maxAmount is true.

Build for the largest amount the wallet can send right now, fee included; amount is then ignored. The amount used is returned.

Hash of the submitted user operation, to track it on-chain.

Wallet signature over userOpHash, 0x-prefixed hex.

Public uuid of the partner user the transaction is built for.

Signature over bundle.authorization. Required when the bundle carried one; must be omitted when it was null.

Only client_credentials is supported.

Omit when authenticating with an HTTP Basic header.

Omit when authenticating with an HTTP Basic header.

Space-delimited subset of the credential scopes. Defaults to all of them. all:read / all:write may be used as shorthand; the granted scope in the response always lists the individual permissions.

Send as Authorization: Bearer <token>.

Lifetime in seconds.

Space-delimited scopes actually granted — a wildcard grant arrives here already expanded, and anything asked for but not held is dropped.

Human-readable detail. Every authentication failure carries the same wording on purpose: an unknown client_id must not be distinguishable from a wrong secret.

Public uuid — what every other endpoint addresses the user by.

Set once and never replaced.

ISO 3166-1 code of the user's country, null when none is set.

Numeric KYC tier the user has reached, null before any KYC.

Unique across all users. Stored lowercased.

EVM address, unique across all users. Stored lowercased. Optional: an account may be created without one and link it later, once.

BCP 47 tag (en, pt-BR). Defaults to en.

ISO 3166-1 alpha-2. Must be a country the platform knows.

Must stay unique.

Only settable while the user has no wallet — an existing one is never replaced.

Refresh of the balances from the on-chain indexer. current means the last refresh is still inside the freshness window.

Registration of the user's wallet with the transaction indexer, which is what keeps balances and positions moving between refreshes. current means it was already registered.

Null for a chain-native coin, which has no contract.

Scale of the token.

False for a token discovered on-chain that Restake has not vetted. Unverified tokens are excluded from portfolio valuations — treat a balance in one as untrusted.

Stable identifier of this balance row.

Human-readable amount, already scaled by token.decimals.

The wallet these balances belong to, null when none is set.

Stable identifier of this transfer row.

On-chain transaction hash.

Relative to the user's own wallet.

Always positive — direction carries the sign.

When Restake indexed the transfer, not when it was mined.

Newest first.

Total value of the wallet at that moment.

Sum of the unrealized PnL of every open position at that moment. Zero when the user held no positions.

Stable identifier of the position.

Slug of the pool staked into — the handle the staking API takes.

Size of the position in wrap-token (share) units — the same units the unstake endpoint takes.

The share token the position is held in.

Cost basis: what the deposits were worth when they were made, time-weighted across top-ups.

Value at the last valuation — openUsdValue plus the PnL.

Gain or loss against the cost basis.

Projection of a year at the rate realised so far.

The same projection as a percentage. Null before the first valuation of a freshly opened position.

Time-weighted across top-ups, so it moves when a user adds.

When the figures above were last recomputed.

Slug of the stock — the handle the stocks API takes.

Stable identifier of the position.

Null only for a holding whose catalogue row has gone.

Shares held, in stock-token units — the units the sell endpoint takes. Not rounded: it is a token balance, not a USD amount.

Cost basis: what the shares were bought for, in USD. Average-cost — a partial sell reduces it proportionally, so selling half leaves the average entry price exactly where it was.

openUsdValue / amount. Null for an empty position.

Live spot price, falling back to the last one this position was valued at when the price feed could not be reached. Null when neither exists.

amount * currentPriceUsd, null when there is no price.

Gain or loss against the cost basis.

The same figure as a percentage. A simple return, never annualized.

Whether the stock's market is open right now.

When the next session opens, null while open. A PnL that has not moved since Friday is a shut market, not a stale read.

USD-weighted across top-ups, so it moves when a user buys.

Scale of the token.

Whether the stock is inside one of its sessions, and not paused for a corporate action, right now.

When the stock next becomes tradable. Null while it is open.

Market price in USD, as the issuing venue reports it. A trade's fill price differs by the route's spread — see the quote.

Hourly closes over the last 24 hours of open market, oldest first, with the live price appended. Empty when no price is available.

Change over the last 24 hours of open market, as a percentage.

The same change in USD.

Stable identifier every other endpoint keys off.

What the token stands for: a share (equity) or a physical commodity such as gold (commodity). The value ?assetType= filters the list on.

The sector of an equity. Always other for a commodity.

False when Restake has switched buying of this stock off.

False when Restake has switched selling of this stock off.

The venue's sessions this stock trades in, as Ondo lists them. Empty when Ondo lists none for it. Read marketOpen rather than deriving the state from this — the windows carry holiday rules and per-stock pauses.

The share token. A sell is denominated in this one.

The USD stablecoin the stock is traded against. A buy is denominated in this one, and it is what a sell settles in.

Whether the stock is inside one of its sessions, and not paused for a corporate action, right now.

When the stock next becomes tradable. Null while it is open.

Market price in USD, as the issuing venue reports it. A trade's fill price differs by the route's spread — see the quote.

Hourly closes over the last 24 hours of open market, oldest first, with the live price appended. Empty when no price is available.

Change over the last 24 hours of open market, as a percentage.

The same change in USD.

The USD leg the percentage was applied to: the amount going in on a buy, the route's proceeds on a sell.

The tier that notional fell in, as a percentage.

The tiered platform fee.

Flat contribution to the sponsored gas.

The single transfer the batch makes: the two above, summed.

That total in the fee token's base units, after being rounded up to its smallest unit. This is the amount that settles on-chain.

Scale of the fee token.

Address of the token going in.

Address of the token coming out.

Human-readable amount going in — what was asked for.

Human-readable amount the route returns, before slippage.

Payment-token units per share this amount fills at on the route, at 8 decimal places, on both sides of the trade.

The market price the catalogue shows, for comparison against the route: the gap to executionPrice is the route's spread and price impact for this amount. Null when it could not be fetched — which never fails the quote.

The route's own gas estimate. Nullable and indicative.

What this trade would be charged. Null means nothing would be — not that the fee is unknown.

Unix timestamp, seconds.

Handle for the server-side intent. Single-use and short-lived: the user op itself is never accepted back from the client.

The routing this batch was built against.

Public uuid of the partner user the trade is built for.

Human-readable source token amount, for example 100 or 0.5. Required unless maxAmount is true.

Trade the largest amount the wallet can right now, fee included; amount is then ignored. A buy keeps back the fee; a sale sells every share and pays the fee from the proceeds. The amount used is the returned quote.sourceAmount.

Maximum slippage, in percent. Capped at 5: on Ethereum the batch goes through the public mempool and can be sandwiched up to this bound.

Wallet signature over userOpHash, 0x-prefixed hex.

Public uuid of the partner user the trade is built for.

Signature over bundle.authorization. Required when the bundle carried one; must be omitted when it was null.

Smallest amount in, in source-token units.

Largest amount in that fills at the quoted speed, in source-token units.

The bridge contract the deposit calls (Across SpokePool).

The source token: approved, and pays the gas fee.

Receives the gas-fee transfer. Null when none is charged.

The handle quote and construct take.

Live from the provider. Null when it cannot be reached; quote and construct on the route answer 503 until it can.

Every contract a batch on this route calls, on the source chain — the allowlist for verifying a batch before the user signs it.

Deposited, in source-token units.

Delivered to the user, in destination-token units.

What the bridge keeps (in − out), in source-token units.

Gas-sponsorship coverage, charged on top of amountIn in gasFeeToken. The wallet needs amountIn + gasFee.

Expected seconds from signing to delivery.

From GET bridge/routes.

Amount to deposit, in source-token units (1.5 is 1.5 USDC). The gas fee is charged on top of it.

Public uuid of the partner user. Required on a quote because the wallet it is priced for is theirs.

Echo back to transaction/batch/send with the signatures. Single-use; it lapses with the quote.

From GET bridge/routes.

Public uuid of the partner user.

Amount to deposit, in source-token units (1.5 is 1.5 USDC). The gas fee is charged on top of it. Required unless maxAmount is true.

Bridge the largest amount the wallet can right now: the balance less the gas fee, within the route’s live limits; amount is then ignored. The amount used is the returned quote.amountIn.

Wallet signature over userOpHash, 0x-prefixed hex.

Public uuid of the partner user.

Signature over bundle.authorization. Required when the bundle carried one; must be omitted when it was null.

Public uuid of the partner user.

The provider's id for the deposit (Across: depositId).

Pass as cursor for the next page. Null on the last page.

The HTTP reason phrase.

Stable, upper snake case identifier of the failure.

Human-readable description. On VALIDATION_FAILED it joins every failure with ; .

Every failed constraint, only on VALIDATION_FAILED.