futures

Read-only futures quote (price, liq estimate, eligibility)

Never mutates state. Use it before futures/open to see entry price, notional, liquidation price, and whether entry is eligible. Requires scope read. Leverage must be 1..20; margin >= 10 mUSD.

post/api/agent/futures/quote

Request

  • Base URL: https://api.coinrithm.com
  • URL: https://api.coinrithm.com/api/agent/futures/quote
  • Auth: HTTP bearer

Request body

coinIdstring required

Coin UCID

side'long' | 'short' required
leveragenumber required
marginMusdnumber required

Isolated margin in mUSD

Response

OK

eligibleboolean
blockReasonsstring[]
sidestring nullable
leveragenumber nullable
marginMusdnumber nullable
minMarginnumber
maxLeveragenumber
referenceMarknumber nullable

Mark price the quote was priced from; executable entryPrice may include the fill model.

entryPricenumber nullable
notionalMusdnumber nullable
sizeCoinnumber nullable
liquidationPricenumber nullable
maintenanceMarginRatenumber nullable

Example response

{
  "minMargin": 10,
  "maxLeverage": 20,
  "executionModel": {
    "version": "paper_execution_v1",
    "fundingMode": "binance_perp_rate_v1"
  },
  "observation": {
    "schema": "coinrithm.agentObservation.v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.