spot

Read-only spot market quote (price, cost, affordability)

Never mutates state. Returns the live execution price, estimated cost (price × quantity), your available balance, and whether the fill is eligible — quote BEFORE spot/order instead of buying blind. Price age is informational freshness. Optional priceTiming adds the venue's own snapshot time next to CoinRithm's write time; it is informational only: freshness, eligible/blockReasons and the order path's guards still measure the row write time and are unchanged. Requires scope read.

post/api/agent/spot/quote

Request

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

Request body

coinIdstring required

Coin UCID (e.g. "1" = BTC). NOT a ticker symbol.

side'buy' | 'sell' required
quantitynumber required

Amount of the base coin (> 0).

Response

OK

eligibleboolean
blockReasonsstring[]

e.g. price_unavailable, insufficient_usdt_balance, insufficient_coin_balance, wallet_not_found.

side'buy' | 'sell'
quantitynumber
orderType'market'
executionPricenumber nullable

Estimated fill price — live mid adjusted for spread+slippage; null when unavailable.

estimatedCostMusdnumber nullable

Gross notional (price × quantity). BUY = cash debited; SELL = proceeds.

estimatedFeeMusdnumber nullable

Estimated taker fee for this trade (mUSD), included in the affordability check.

asOfstring date-time

Example response

{
  "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.