{"components":{"responses":{"Error":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}},"description":"Error"}}},"info":{"description":"Cardano DEX market data, served from confirmed-chain materializations. Amounts are base-unit integer strings with decimals adjacent; prices are numerator/denominator rationals plus a base-unit-scale value string. See /llms.txt for the vocabulary rules.","title":"Float API","version":"1.0.0-draft"},"openapi":"3.1.0","paths":{"/llms.txt":{"get":{"description":"Includes the vocabulary rules verbatim from API.md and the base-unit amount rule, prominently.","operationId":"llms_txt","parameters":[],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The point-an-AI-at-it entry point","tags":["meta"]}},"/v1":{"get":{"description":"The root case of the HATEOAS rule: agents explore by following links, never by constructing URLs.","operationId":"directory","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Directory: every resource, its href, and the API policies","tags":["meta"]}},"/v1/addresses/{address}/balances":{"get":{"description":"An interval fold over confirmed UTxOs: +amount at creation, -amount at spend, cumulative per asset. Amounts are base-unit integer strings; a zero balance is a real point, never an omission. meta.as_of is the fold's own watermark (it trails the stream tip by a few blocks by design). With from or to, only the window is read: the balance it opens on and the records inside it, so a row lists the assets held when the window opened and those that moved inside it (an asset emptied before the window is absent rather than \"0\"). 422 for a credential with more than 50,000 balance rows of either kind in what the request reads: the window, or the whole history without one.","operationId":"address_balances","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Restrict to one asset: `ada.lovelace` or `<policyHex>.<assetNameHex>` (the separator-less concatenated form is accepted).","in":"query","name":"asset","required":false,"schema":{"type":"string"}},{"description":"Series resolution in the shared period grammar (1h is materialized today; the default), or `raw` for every point. Raw responses stop at 5000 rows and set meta.truncated: true.","in":"query","name":"period","required":false,"schema":{"enum":["1h","raw"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Balance series per asset from the UTxO interval fold","tags":["addresses"]}},"/v1/addresses/{address}/custody/balances":{"get":{"description":"/balances's series shape, built from custody claims: value a venue's script holds for this address per a datum-declared owner (LP frozen in a yield farm), from each UTxO's creation to its spend. Claims match either of the address's credentials whatever the scope, as in /portfolio. Exclusive with /balances: a UTxO the balance fold already attributes to the address is left out, so the two series add up without counting anything twice. Claims several parties can withdraw alone, claims created before the archive window, and a second venue's claim on an already counted UTxO are left out. Over the requested venues only, `claims` counts each case as shared, before_archive, already_in_balances and duplicate, checked in that order. The address's own history is not read: whether the fold attributes a claimed UTxO to the address is in that UTxO's own record.","operationId":"address_custody_balances","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Series resolution in the shared period grammar (1h is materialized today; the default), or `raw` for every point. Raw responses stop at 5000 rows and set meta.truncated: true.","in":"query","name":"period","required":false,"schema":{"enum":["1h","raw"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Balance series per asset of what venues hold for an address","tags":["addresses"]}},"/v1/addresses/{address}/farm-rewards":{"get":{"description":"Every reward Sundae's yield service has for the address, one row per program and UTC day, oldest first: farm rewards (program type yield) and incentives (type incentive, e.g. SundaeSwap's revenue share to frozen SUNDAE), with the service's status (Claimable, Claimed, Expired, ...) and, for a farm, each pool's part. Sundae computes them off-chain and the chain shows only a claim, so they are provenance venue-reported. A base address matches the rewards owned by its payment key and by its stake key. Every amount carries value: its units at the price board now in meta.quote units, null when the asset is unpriced. totals sums the rows per program type and status; a total's value is null when any of its assets is unpriced. Rows the service returned that cannot be read are listed under unreadable and left out of the totals. 400 for an address the service cannot match, 503 when it does not answer.","operationId":"address_farm_rewards","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Only the rewards of programs of this type: yield (rewards for LP frozen in a farm) or incentive (e.g. SundaeSwap's revenue share to frozen SUNDAE). Absent: both.","in":"query","name":"type","required":false,"schema":{"enum":["yield","incentive"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"An address's rewards from Sundae's yield farming: farm rewards and incentives, day by day","tags":["addresses"]}},"/v1/addresses/{address}/lp-statement":{"get":{"description":"Per period and position (an LP asset held in the wallet or in a venue's custody, mapped to its pool through the redemption graph): units and value at open and close, flows with tx hashes, and the value change split into price_effect, fees (from the LP index) and divergence, which sum to it exactly; fees_itemized from the pool's trades and fee_gap between the two; incentives from the farm rewards source, not_measured when it fails; the share of the pool's liquidity at close and the time-weighted share of its volume. `inputs` lists every series, chunk and watermark read. Unknown is null, never 0. Requires an entitled bearer token when gating is enforced (401 without one, 403 when the tier does not include it). 422 for a credential with more than 50,000 balance rows, which the request reads whole.","operationId":"address_lp_statement","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Window start, unix seconds (inclusive).","in":"query","name":"from","required":true,"schema":{"type":"integer"}},{"description":"Window end, unix seconds (exclusive); clipped to the last closed hour.","in":"query","name":"to","required":true,"schema":{"type":"integer"}},{"description":"month (default): one period per UTC calendar month, clipped to the window; range: the whole window as one period.","in":"query","name":"period","required":false,"schema":{"enum":["month","range"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"json (default) or csv: one row per period, market, line item and asset, values in quote base units.","in":"query","name":"format","required":false,"schema":{"enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"An address's liquidity positions as reconciled return line items (Pro)","tags":["addresses"]}},"/v1/addresses/{address}/orders":{"get":{"description":"Orders at every exchange Float decodes (one list, each order's `venue` names its orders adapter) whose owner names one of the address's credentials, newest placed first. status is the first of: filled (a batch or taker filled it), cancelled, spent (consumed by a transaction Float has no fill or cancel for), else open. Each order carries a label of what the trade does; a filled order uses what actually moved. `held` is what the order UTxO holds, venue state tokens left out: what a cancel returns (null when its contents are unknown). Only the newest 1000 claims below the cursor are examined (meta.scanned of meta.scan_limit); meta.next_before_slot, when present, is the before_slot that resumes. order_count is the orders matching `status` before the limit; the per-status counts cover the examined window.","operationId":"address_orders","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"Narrow to one order status. Omitted returns every status.","in":"query","name":"status","required":false,"schema":{"enum":["open","filled","cancelled","spent"],"type":"string"}},{"description":"Orders returned, newest placed first; at most 500 (default 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Only orders placed in a slot below this one; pass a response's meta.next_before_slot to read the next page.","in":"query","name":"before_slot","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"An address's orders at every exchange: open, filled, cancelled, spent","tags":["addresses"]}},"/v1/addresses/{address}/portfolio":{"get":{"description":"Every held asset gets exactly one row and exactly one kind: ada (the numeraire, exact 1/1 — it never appears in /v1/assets, so a naive balances×prices join would silently drop it), token (priced in the screener universe), redeemable (no direct price, but a base in the redemption graph — LP/qTokens; value: null with links.decomposition, never a fabricated price), nft (quantity 1, unpriced), unpriced (everything else), or custody (held for this address at a venue's script address, per a datum-declared owner — the row carries venue, underlying_kind and the claim's shape). Attribution is exclusive: a UTxO is counted through the address's own credential or through a custody claim, never both. A custody claim whose owner expression lets several parties withdraw alone (any_of, at_least) states its balance, carries shared_with_count, and stays out of the total. total_value_ada sums only the non-null values; unvalued_count says how many rows are excluded. Each holding carries value_ada and `value` in meta.quote units, both observed now; total_value sits beside total_value_ada. 422 for a credential with more than 50,000 balance rows, which the request reads whole.","operationId":"address_portfolio","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Current balances × prices × metadata, joined server-side","tags":["addresses"]}},"/v1/addresses/{address}/portfolio/history":{"get":{"description":"Everything a wallet's value chart needs in one request, sampled at one interval. Every value stamped t is the value at the close of the bucket holding t. balances.rows: the first row is stamped `from` and holds every nonzero balance at that bucket's close; each later row is a bucket in (from, to] in which a balance changed, stamped with its start, listing only the assets that changed, each at its balance at the bucket's end (\"0\" when emptied); readers forward-fill. custody: the same rows per requested venue filter, over the claims /custody/balances counts. decompositions: every asset held in the window that redeems into others, in /v1/assets/{asset}/decomposition's shape, its rows sampled the same way. prices: the published price /v1/assets/{asset}/prices serves (lovelace per base unit), at each bucket in [from, to] with a voter, led by the newest price before `from` when none falls at it, for every held asset on the price board and every terminal of the decompositions. ada_usd: USD per ADA, the closes of /v1/assets/ada.lovelace/candles?quote=usd, led the same way. 400 for an unknown interval, more than 1,000 buckets or from after to; 422 for a credential with more than 50,000 balance rows of one kind inside the window.","operationId":"address_portfolio_history","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"Bucket width: 1h, 4h, 12h, 1d or 7d, or auto, which takes the window's length: 1h up to 14 days, 4h up to 60, 12h up to 180, 1d up to 365 and 7d past that (wider when max_points asks for fewer buckets). Buckets are aligned to multiples of the interval since the Unix epoch (UTC). At most 1,000 buckets.","in":"query","name":"interval","required":true,"schema":{"enum":["1h","4h","12h","1d","7d","auto"],"type":"string"}},{"description":"With interval=auto only: the most buckets auto may choose (at most 1,000). Auto widens the bucket its ladder gives until the window fits.","in":"query","name":"max_points","required":false,"schema":{"type":"integer"}},{"description":"Inclusive window start (unix seconds). Default: a year before `to`, or the wallet's first balance bucket (its first change floored to the interval) when that is later.","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive window end (unix seconds). Default: now.","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Comma-separated venue filters, each matched by family as /custody/balances' venue is (sundae matches sundae-v3, sundae-yf, …): one custody series per filter. Default: none.","in":"query","name":"custody","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"A wallet's balances, custody, decompositions and prices over a window, at chart resolution","tags":["addresses"]}},"/v1/addresses/{address}/transitions":{"get":{"description":"What each transaction changed about the address's holdings, netted per asset from the interval fold's provenance edges: a UTxO consumed and partly returned as change reports the real movement, not the gross legs. Signed base-unit integer strings. This is what separates unwrapping one layer of a composed position from leaving it — both lower a token's balance, but only the unwrap shows the redeemed asset arriving in the same transaction. Each swap carries `price` (a decimal string) and `value` in meta.quote units, both converted at the hour the trade executed and null when no rate covers it. 422 for a credential with more than 50,000 balance rows, which the request reads whole.","operationId":"address_transitions","parameters":[{"description":"Bech32 Shelley address (addr1…). The payment credential keys scope=payment; the stake credential keys scope=wallet.","in":"path","name":"address","required":true,"schema":{"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Per-transaction net asset movements for an address","tags":["addresses"]}},"/v1/assets":{"get":{"description":"Served from the prices materialization. Amounts are base-unit strings; decimals ride along per asset (null until the registry knows them). price, liquidity, liquidity_anchor and fdv are observed now and denominated at the newest rate; volume.24h and change.{1h,24h,7d} come from the rollup's trend cells, where every hour was converted at its own rate, and are null when it has not measured them. include=usd adds the same money fields at the USD rate beside them, or usd: null when no rate is usable. venue lists only the tokens with a pool on those venues, ranked by their liquidity there, and narrows what depends on where a token trades to those pools: liquidity, liquidity_anchor and pool_count are the venues' part of the token's own figures, and volume.24h and trade_count.24h the 24h turnover of those pools as /v1/markets serves each one. price, change, fdv, holder_count and confidence stay the token's across every venue.","operationId":"assets_list","parameters":[{"description":"Ranking key; descending. price_change.24h and holder_count are documented but not available yet.","in":"query","name":"sort","required":false,"schema":{"enum":["liquidity","volume","trade_count","pool_count"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 5000 (default 100). The whole ranked list fits in one page: ask for it rather than walking links.next, which costs a round trip per page.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Comma-separated opt-in blocks; a block the route does not serve is a 400. On the asset routes: `display` adds parallel *_display strings (server-side decimal shift by the asset's decimals; no floats), and `usd` adds a `usd` object per row holding the same money fields at the USD rate, or null when no rate is usable. On a market's candles the only block is `liquidity`: each bucket's reserves and their value. The asset candles take none.","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Ranked asset list (the screener feed)","tags":["assets"]}},"/v1/assets/rowstats":{"get":{"description":"The screener's per-row 24h % / sparkline / 7d % for the whole ranked list, so a scrolled table makes one request instead of one per row. Each token's series is its all-venue hourly candles (the `venues=all` candle series), ADA per token; a token with none is omitted. `closes` is the last 24 hourly closes; changes are fractions. `usd` holds the same cells with every hour priced at its own ADA/USD rate, or null when no rate covers the series. `fee_yield_30d` is the 30-day annualized fee yield (a decimal fraction string) of `fee_yield_pool`, the token's deepest pool, as /v1/markets serves it at request time (same document, freshness and filter); null when unknown or out of date, and the pool is null when the token has no deepest pool.","operationId":"assets_rowstats","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Screener row trend cells for every ranked token in one read","tags":["assets"]}},"/v1/assets/{asset}":{"get":{"description":"Blocks are provenance-tagged; the metadata block is registry facts (missing facts are null, never invented). Money fields and change are the same cells /v1/assets serves, so a row and the page it opens agree. profile/related/ratings blocks are not served yet.","operationId":"asset_detail","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Comma-separated opt-in blocks; a block the route does not serve is a 400. On the asset routes: `display` adds parallel *_display strings (server-side decimal shift by the asset's decimals; no floats), and `usd` adds a `usd` object per row holding the same money fields at the USD rate, or null when no rate is usable. On a market's candles the only block is `liquidity`: each bucket's reserves and their value. The asset candles take none.","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One asset: market data, registry metadata, and its markets","tags":["assets"]}},"/v1/assets/{asset}/activity":{"get":{"description":"One contiguous series from the asset's first mint to now, zero-filled. `minted`, `burned` and `supply` are read per request from the fold's mint rows (raw base units, decimal strings) and are null, with `supply_complete: false`, when those rows do not cover the asset's whole history. `holders`, `senders`, `senders_7d`, `senders_30d`, `transfers` and `transfer_volume` come from the asset-activity scan's document and are null for every bucket it does not reach; `transfers_as_of` dates that document. A transfer is a transaction that moved the asset between credentials, netted per credential, so change outputs and pure mints or burns are not transfers. 404 when the fold has no mint rows for the asset.","operationId":"asset_activity","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Bucket width: `day` (the default) or `week`. Buckets are UTC — a day starts at midnight, a week on Monday. Weekly unique senders are measured over the week itself, never summed from daily counts.","in":"query","name":"period","required":false,"schema":{"enum":["day","week"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Supply flow and transfer activity per UTC day or week","tags":["assets"]}},"/v1/assets/{asset}/candles":{"get":{"description":"Prices are value strings at base-unit scale; the response names the market the series came from, and each bucket converts at its own bucket's rate. ada.lovelace has no market series: it is served under quote=usd only, as the ADA/USD series itself (base ada.lovelace, quote usd, market null), and 404s under quote=ada.","operationId":"asset_candles","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Candle interval in the shared period grammar. 1m and 1h are materialized today; defaults to 1h. Series are sparse — a bucket exists only for a period that had a trade.","in":"query","name":"interval","required":false,"schema":{"enum":["1m","1h"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"venues=all merges every ADA-paired pool of the asset into one series (the token-wide price); omitted serves the single deepest pool.","in":"query","name":"venues","required":false,"schema":{"enum":["all"],"type":"string"}},{"description":"Comma-separated venue:market ids of the asset's pools to merge into one series (the price across just those venues). Each pool's contribution to the token's all-venue series is merged, so naming every pool gives venues=all exactly and a subset never disagrees with it: the same per-minute conversion and the same reference check, over fewer pools. Without from/to the window served is the one venues=all serves. An id that is not a pool of the asset is a 400. Takes precedence over venues.","in":"query","name":"markets","required":false,"schema":{"type":"string"}},{"description":"The spec's one wire-format switch. Absent = verbose row objects (the default stays for existing clients). `compact` = one array per field under `columns`, same order and values — ~3x smaller decoded, for chart clients on slow connections.","in":"query","name":"encoding","required":false,"schema":{"enum":["compact"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Token-level OHLCV (deepest pool's series for now)","tags":["assets"]}},"/v1/assets/{asset}/card.png":{"get":{"description":"Logo, price, 24h change and an hourly sparkline — what a shared token link unfurls into.","operationId":"asset_card","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Social card (PNG, 1200x630)","tags":["assets"]}},"/v1/assets/{asset}/chart.png":{"get":{"description":"The social card's hourly 24h line, without its logo, price or header.","operationId":"asset_chart","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/png":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"24h chart (PNG, 800x320)","tags":["assets"]}},"/v1/assets/{asset}/decomposition":{"get":{"description":"Served verbatim from the rates materialization; rates, virtual prices, and redeemable values are exact numerator/denominator rationals in base units. Interpretation (APR and friends) is a client concern.","operationId":"asset_decomposition","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Redemption decomposition: hops, paths, per-hour rate series","tags":["rates"]}},"/v1/assets/{asset}/holders":{"get":{"description":"From the holders index (wallet-level: stake credential when present, else payment). Supply is the sum of every holder's balance — mint minus burn. 404 until the index has a row for the asset. Distribution (top-N, concentration) is planned.","operationId":"asset_holders","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Holder count, total supply, and FDV","tags":["assets"]}},"/v1/assets/{asset}/logo":{"get":{"description":"Cached from the Cardano token registry. `size` serves a downscaled PNG thumbnail for icon-sized display.","operationId":"asset_logo","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Downscale so the longest side is at most this many px (32, 64 or 128; any other value is a 400), as PNG, aspect kept. A logo already that small, or one that does not decode as a raster (SVG), is served as stored. Absent = the stored original.","in":"query","name":"size","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"image/png":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Registry logo (PNG)","tags":["assets"]}},"/v1/assets/{asset}/prices":{"get":{"description":"The price `/v1/assets/{id}` publishes, as a time series: for each bucket the pools live at its close (newest reserves state within 7 days before the bucket's end, carried forward between events) vote by the same rule as the live price (depth-weighted mean of the pools within 5% of their depth-weighted median, pools under 100 ADA of two-sided depth excluded), and `price` is that figure in the same units as the asset's `price.value`: lovelace per base unit, a decimal string. A token no ADA pool prices in a bucket is priced one hop through a partner token's price at the same bucket. A bucket with no voter is omitted. Curve-priced venues (concentrated and stable pools) vote at their own quote as stored at the bucket's close; a bucket with no stored quote (before the column existed) leaves the pool out. Window: from/to are inclusive bucket times (at most 1,000 buckets); with neither, the newest 14 days of 1h or 365 days of 1d.","operationId":"asset_prices","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Bucket width: 1h (default) or 1d. Unlike candles, a price history is computed from the pools' own chunks, so the interval costs nothing to add; 1m is not served.","in":"query","name":"interval","required":false,"schema":{"enum":["1h","1d"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The token's published price at each bucket's close","tags":["assets"]}},"/v1/assets/{asset}/trades":{"get":{"description":"Cursor-paged, newest first, merged across every venue's rollup. `direction` is the taker's side of the base asset; on a market where this asset is the quote side, the direction still describes the base. `price` and `value` convert at the hour the trade executed and are null when no rate covers it.","operationId":"asset_trades","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The newest trade a polling client already holds, in the cursor grammar (the `cursor` of any trade row, <slot>.<tx_index>.<event_index>.<tx_hash>). Only strictly newer rows return, so a quiet poll gets an empty page instead of the full tape.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 250 (default 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One asset's tape: every swap touching it, across venues","tags":["assets"]}},"/v1/card.png":{"get":{"description":"ADA price with its 24h line, plus network TVL, volume and activity.","operationId":"site_card","parameters":[],"responses":{"200":{"content":{"image/png":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Site social card (PNG, 1200x630)","tags":["meta"]}},"/v1/farms":{"get":{"description":"One row per (program, pool, emitted asset) for every Sundae yield-farming program with a published day, from Sundae's own off-chain calculator (source sundaeswap-yield-api), and every active Minswap, WingRiders, MuesliSwap and VyFinance farm, from the venues' own farm APIs (sources minswap-farm-api, wingriders-api, muesliswap-farm-api, vyfi-api); farm rewards are not on chain until claimed. daily_emission is the pool's base-unit emission of emitted_asset for a day: Sundae's for the day in as_of (emission_basis calculation_day), Minswap's, MuesliSwap's and VyFinance's current daily rate (current_rate), WingRiders' current-epoch rewards over its five days (current_epoch). emission_share is a Sundae pool's share of the day's distributed total (not of the program's nominal emission), null for the other venues. daily_value and liquidity (the whole pool's) are valued at the current price board, like /v1/markets. locked_share is the farm's locked LP over the pool's LP supply now (locked_share_basis lp_supply_now), or over the day's own total LP (calculation_day, Sundae) or the venue's LP issued (venue_lp_supply) when the pool has no supply on record, null above 1. Sundae's locked LP is the LP-days the farm paid on the as_of day (each lock's LP times the part of the day it was locked, from the calculator's own inputs; locked_figure lp_days); Minswap's, WingRiders' and MuesliSwap's is the farm validator's balance of the LP asset now from Float's balances fold (farm_balance), split in the venue's proportions where two farms share an LP asset, or the venue's own figure without one (venue_locked); VyFinance's farming is stakeless, every holder of the LP is paid, so its locked LP is the whole supply (whole_supply, locked_share 1). locked_provenance is chain-verified when Float's own record (the farm's UTxOs, or for whole_supply the pool's LP supply now) agrees with the venue's figure, chain-mismatch when it does not, venue-reported when it could not be read. farmed_liquidity = liquidity x locked LP / that LP supply: the liquidity the emission is paid to. farm_apr = daily_value x 365 / farmed_liquidity as a fraction, simple, null when either is unknown or nothing is locked: computed by Float from the venue-reported emission and the locked LP at Float's prices (farm_apr_provenance float-computed), the average the locked LP earns, not a new locker's marginal rate, and assuming rewards are claimed before they expire. Program type exclusive (a Minswap Launch Bowl farm) and boost (WingRiders' boosting rewards, paid only to farmers who also lock WRT) pay only some LP. venue_apr is the venue's own rate for the pool and asset (provenance venue-reported), null when it states none that is that asset's reward rate alone (MuesliSwap's includes the pool's fee yield, so it is served only where that is 0). A Sundae program is skipped from the day after its last reward day. Programs with no current day and farms listed unreadably are in meta.programs_skipped; meta.sources lists the sources served and meta.sources_unavailable those that could not be read (503 only when none can).","operationId":"farms","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Yield farms (Sundae, Minswap, WingRiders, MuesliSwap, VyFinance) — daily emission per pool and farm APR","tags":["markets"]}},"/v1/flows":{"get":{"description":"For each wallet class (by ADA held now: retail, 1k, 10k, 100k, 1m) and each trailing window (24h, 7d, 30d), the tokens that class bought (net > 0) or sold (net < 0) on the DEXes: its orders' executed fills, not plain transfers. Each row has gross inflow and gross outflow (both non-negative), net, and the wallets that moved the token. ADA classifies wallets and is never itself a flow token. Values are base-unit integer strings, valued at read time through the price board. Windows end at as_of, the newest settled hour; `windows` lists only those complete. class= and window= narrow the document; limit caps each ranked list.","operationId":"flows","parameters":[{"description":"Narrow to one wallet class by ADA held now: retail (<1k), 1k, 10k, 100k, 1m. Omitted returns every class.","in":"query","name":"class","required":false,"schema":{"enum":["retail","1k","10k","100k","1m"],"type":"string"}},{"description":"Narrow to one trailing window: 24h, 7d, or 30d. Omitted returns every window.","in":"query","name":"window","required":false,"schema":{"enum":["24h","7d","30d"],"type":"string"}},{"description":"Rows per (class, window) ranked list, at most 500 (default 50). Rows are sorted by absolute net flow.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Token inflow/outflow per wallet class over trailing windows","tags":["meta"]}},"/v1/health":{"get":{"description":"The advertisable numbers. `chain.ingest_lag_seconds` is how far Float's confirmed data trails the chain — a block is queryable once the fold reaches its slot. Request latency and throughput stats follow (CloudWatch-sourced), with `api.requests_timed_out`: requests stopped at the API's time limit in the last hour, by route. `balances.checkpoints_due` counts the credentials still waiting for a seeded checkpoint, whose balance reads fold their whole history until they get one; it should fall to 0.","operationId":"health","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Service statistics: chain-ingestion latency (and, next, request latency + throughput)","tags":["meta"]}},"/v1/lending/assets":{"get":{"description":"One entry per asset some listed lending market lends, its markets summed in the asset's own base units, so an asset with no price still has totals and rates (only tvl and borrowed_value are null). supplied is NET: supply one listed market holds as another's share token counts once; protocol_owned markets are listed in market_count but in no sum, and a market whose supply cannot be stated is counted in unmeasured_markets instead. supply_apr is money-weighted, Σ yearly supplier interest / Σ supplied, over the markets whose rate is known; staking_apr (ADA) is weighted by what each market's own suppliers hold; debt_apr is what the open debt pays, Σ yearly interest / Σ borrowed (Surf and Fluid from their loan books). coverage gives the share of supply (debt_apr: of debt) behind each rate; a market that cannot state a rate abstains rather than counting as 0. withdrawable_share is the share of supply the pools could pay out now; series_basis gives supply_apr and debt_apr over the venues the history measures, now and averaged over the last 7 days (supply_apr_7d, debt_apr_7d), so a spike shows against its own week; bad_debt sums the markets' open loans at or past liquidation and those whose collateral is worth less than their debt (shortfall_value: by how much), null without the positions document. amount adds `best`: the best single pooled markets for that size (Danogo and Liqwid priced by their own rate models, basis `model`) and supply_route / borrow_route, the amount split over the pools to earn the most or pay the least, with its blended apr, each leg and any part no pool can lend (unfilled). include=sizing adds sizing (scale, quote_per_unit and the joinable pools with their rate models) to each entry: the inputs best is computed from, so a client running float-lending-kernel (the UI's wasm build) sizes any amount without another request; absent otherwise. sort ranks by tvl (default), supply_apr, debt_apr or utilization, largest first, null last (any other key is a 400); venue narrows the markets folded.","operationId":"lending_assets","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"A positive notional in the response's quote (dollars for quote=usd, ADA for quote=ada), converted to each asset's units at its price now. Each asset gains `best`: the pooled market (liqwid, danogo-lending, surf) whose supply APR is highest once a deposit of that size has joined it (basis `model`: the pool's own rate model at the diluted utilization, Liqwid's and Danogo's; `book`: Surf's fixed-rate loans' interest over the larger supply; `upper_bound`: the same where no model is indexed and the borrow rate would also fall), the one whose borrow APR is lowest once a loan of that size is out, among those whose idle cash covers it and that would grant it (basis `model`: the rate model at the utilization the loan leaves, under Danogo's cap; `offer`: Surf's rate now, which the loan keeps; `lower_bound`: the rate now where no model is indexed and it would also rise), and the amount split over the pools (supply_route, borrow_route). Without amount, best is null; for an unpriced asset its figures are null. `include=sizing` adds `sizing` to each asset: the pools, scale and price `best` is computed from (float-lending-kernel's Sizing).","in":"query","name":"amount","required":false,"schema":{"type":"string"}},{"description":"Comma-separated opt-in blocks. `sizing` adds each asset's `sizing`: the joinable pools (with their rate models), scale and quote price that `best` is computed from (float-lending-kernel's Sizing), so a client running the same kernel can size any amount without asking again. Absent without it.","in":"query","name":"include","required":false,"schema":{"enum":["sizing"],"type":"string"}},{"description":"Ranking key: tvl (default), supply_apr, debt_apr, utilization.","in":"query","name":"sort","required":false,"schema":{"enum":["tvl","supply_apr","debt_apr","utilization"],"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Lending by asset — every market of one asset folded, as the price board folds pools","tags":["meta"]}},"/v1/lending/assets/{asset}":{"get":{"description":"The asset's entry (see /v1/lending/assets) plus its markets exactly as /v1/lending/markets serves them, tvl first. The series leaves series_basis.excludes (surf: its rates need the live loan book) out of its rates at every point, so a chart's last point compares with series_basis. 404 when no listed market lends the asset. It takes no venue.","operationId":"lending_asset","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"A positive notional in the response's quote (dollars for quote=usd, ADA for quote=ada), converted to each asset's units at its price now. Each asset gains `best`: the pooled market (liqwid, danogo-lending, surf) whose supply APR is highest once a deposit of that size has joined it (basis `model`: the pool's own rate model at the diluted utilization, Liqwid's and Danogo's; `book`: Surf's fixed-rate loans' interest over the larger supply; `upper_bound`: the same where no model is indexed and the borrow rate would also fall), the one whose borrow APR is lowest once a loan of that size is out, among those whose idle cash covers it and that would grant it (basis `model`: the rate model at the utilization the loan leaves, under Danogo's cap; `offer`: Surf's rate now, which the loan keeps; `lower_bound`: the rate now where no model is indexed and it would also rise), and the amount split over the pools (supply_route, borrow_route). Without amount, best is null; for an unpriced asset its figures are null. `include=sizing` adds `sizing` to each asset: the pools, scale and price `best` is computed from (float-lending-kernel's Sizing).","in":"query","name":"amount","required":false,"schema":{"type":"string"}},{"description":"Comma-separated opt-in blocks. `sizing` adds each asset's `sizing`: the joinable pools (with their rate models), scale and quote price that `best` is computed from (float-lending-kernel's Sizing), so a client running the same kernel can size any amount without asking again. Absent without it.","in":"query","name":"include","required":false,"schema":{"enum":["sizing"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One asset's lending markets folded, with the markets themselves","tags":["meta"]}},"/v1/lending/assets/{asset}/series":{"get":{"description":"Hourly (default) or daily points from the materialized state tape, each the same fold as the live entry over every counted market's latest state at or before the bucket (carried forward; the first point may predate the window). In the asset's own base units, with no value column: the tape carries no historical prices. supply_apr and debt_apr leave the `excludes` venues out at every point. from and to are unix seconds, inclusive, and bound each point's own time. 404 when no listed market lends the asset; 503 without the series document. market_count is the asset's markets with a state at or before the point, counted or not. It takes no venue.","operationId":"lending_asset_series","parameters":[{"description":"Asset id: `ada.lovelace` or `<policyHex>.<assetNameHex>`. The separator-less concatenated form is accepted on input; responses always use `.`.","in":"path","name":"asset","required":true,"schema":{"type":"string"}},{"description":"Series resolution: 1h (default, the rollup's own bucket width) or 1d, which keeps the last point of each UTC day. Narrower than the shared period grammar on purpose — the lending tape materializes exactly one bucket width, so `raw` would mean something different here.","in":"query","name":"period","required":false,"schema":{"enum":["1h","1d"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One asset's lending supply, debt and rates over time","tags":["meta"]}},"/v1/lending/collateral":{"get":{"description":"Per collateral asset, summed over the open positions of the selected markets (narrow with venue and market): `deposited` in raw units, `deposited_value` in the quote, and `debt_backed_value` — each position's debt split over its collateral lines by value share, so a 60/40 basket backs 60% of the debt with its first asset. `markets` lists the same three figures per market. Valued by the same price rule and position computation as /v1/lending/positions; a figure is null, never 0, where a line or a debt could not be priced. A share token (a Liqwid qToken) held against a table entry for its underlying is counted in the underlying; a share line that redeems to zero units is not a deposit and is not counted. `liquidity_anchor` (in the quote) is the ADA in the asset's ADA-paired pools (`liquidity_anchor_id`: a receipt is judged by what it redeems into) and `haircut` the fraction of spot value lost raising, at once, every selected market's backed debt in ADA from that depth (debt / depth; 1 when it cannot clear; debt in markets that never sell the asset, a threshold above 1, left out); each market's own haircut, with its second hop and liquidation bonus, is on its /v1/lending/markets row. 503 until the rollup has written out/lending/positions.json.","operationId":"lending_collateral","parameters":[{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Restrict to one market key (the venue-scoped key, without the `<venue>:` prefix).","in":"query","name":"market","required":false,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"What open lending positions hold of each collateral asset","tags":["meta"]}},"/v1/lending/markets":{"get":{"description":"One row per lending market across the indexed lending venues (danogo-lending, liqwid, fluid, surf). Each carries the underlying asset, total supplied and borrowed (base-unit strings plus display amounts), utilization, supply and borrow APR (fractions), and TVL valued in the quote asset. APR is derived from each protocol's on-chain rate state. sort ranks by tvl (default), supply_apr, borrow_apr or utilization, largest first; a row whose figure is null (unmeasured) sorts after every measured row, a true 0% included. venue filters by venue. include=sparkline attaches a per-row supply_apr history over window (24h/7d/30d, default 7d) from /v1/lending/markets/{market}/series; a row with no series history simply has no sparkline field. include=collateral attaches each row's accepted collateral as the detail endpoint serves it. Next to each rate: withdrawable (what the market can pay out now: supplied less borrowed less what the markets it holds shares of have lent of them) and withdrawable_share; supply_apr_7d and borrow_apr_7d, the rates averaged hour by hour over the last 7 days (null until the history covers the whole week); app_url, the protocol's own page for the market (null where none is verified); receipt, the token a supplier holds for the market (a Liqwid qToken, a Danogo or Surf share; null without one), the id a collateral entry names when it accepts that supply.","operationId":"lending_markets","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Ranking key: tvl (default), supply_apr, borrow_apr, utilization.","in":"query","name":"sort","required":false,"schema":{"enum":["tvl","supply_apr","borrow_apr","utilization"],"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Comma-separated opt-in blocks. `sparkline` adds a per-row supply_apr history over `window`, downsampled to ~56 points; a row with no series history omits the field entirely rather than drawing a flat line. `collateral` adds each row's accepted-collateral table as the detail endpoint serves it (LTV, anchored liquidity, cover).","in":"query","name":"include","required":false,"schema":{"enum":["sparkline","collateral"],"type":"string"}},{"description":"Sparkline lookback, only meaningful with include=sparkline: 24h, 7d (default) or 30d.","in":"query","name":"window","required":false,"schema":{"enum":["24h","7d","30d"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Lending markets — supply/borrow rates, sizes, utilization","tags":["meta"]}},"/v1/lending/markets/{market}":{"get":{"description":"The market's row (see /v1/lending/markets) plus its accepted collateral, the protocol product, and the raw on-chain state for transparency. Each collateral entry carries its dotted asset id, loan-to-value (ltv, from ltv_bps), liquidity_anchor (the ADA in that asset's ADA-paired pools, in the quote — the /v1/assets figure), liquidity_anchor_id (the asset whose depth that is: a receipt token — a Liqwid qToken, a Danogo or Surf share — is judged by what it redeems into) and haircut: the fraction of the collateral's spot value a full liquidation of the debt it backs would lose selling into constant-product pools (debt / depth, both hops when the debt is a token: haircut_basis ada_debt, both_hops, or collateral_hop when the borrowed asset has no depth and the figure is a lower bound; 1 when no price clears it). liquidation_bonus is what the venue pays a liquidator per unit repaid, haircut_limit = bonus / (1 + bonus) the haircut it still pays for; liquidatable is false for a threshold above 1 (never sold). cover_basis `positions`: the debt is debt_backed_value, the debt of the open positions that this collateral backs (each position's debt split over its collateral lines by value share), and deposited and deposited_value are what those positions hold of it. cover_basis `upper_bound`: no positions document covers the market, so the debt is everything the market has borrowed, an upper bound on any one collateral's share, and deposited, deposited_value and debt_backed_value are null. Each is null where unmeasurable — ADA as collateral, an asset with no anchor, nothing borrowed or backed, a position that could not be priced — never 0. The market id is `venue:market`.","operationId":"lending_market","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One lending market, with collateral and raw state","tags":["meta"]}},"/v1/lending/markets/{market}/params":{"get":{"description":"Reserve factor, Liqwid's accrual cadence, the rate model (when indexed), and collateral LTVs, each tagged indexed (read from chain state), calibrated (validated against the protocol's own UI — the note names which market) or default (a flat assumption pending indexing). Exists so DESIGN-LENDING.md's open questions never silently become facts on a client.","operationId":"lending_market_params","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Every constant the market's rate maths assumes, with its source","tags":["meta"]}},"/v1/lending/markets/{market}/series":{"get":{"description":"Hourly (default) or daily rate points from the materialized state tape: supply/borrow APR, utilization, and supplied/borrowed sizes, computed by the same lending_rates function the row and /v1/lending/markets share, so a rate can never disagree with its own history. Sparse — a bucket exists only when the market's state changed in it, never interpolated. A point's bucket is its unix time floored to the period (`ts` is the bucket start; `slot` is the point kept). A bucket keeps its LAST point, the highest slot, whatever order the stored document lists them in; period=1d keeps the last point of each UTC day. from and to are unix seconds, inclusive, and bound each point's own time, not its bucket start: a bucket whose start falls before from is still returned when a point inside it does not. No quote/value columns: this document carries no historical prices, so valuing an old point at today's rate would misstate it (see /v1/lending/stats for a value series priced bucket-by-own-bucket). A known market with no bucketed history yet returns 200 with an empty points array.","operationId":"lending_market_series","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}},{"description":"Series resolution: 1h (default, the rollup's own bucket width) or 1d, which keeps the last point of each UTC day. Narrower than the shared period grammar on purpose — the lending tape materializes exactly one bucket width, so `raw` would mean something different here.","in":"query","name":"period","required":false,"schema":{"enum":["1h","1d"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One lending market's rate and size history","tags":["meta"]}},"/v1/lending/positions":{"get":{"description":"Open loans owned by `owner` — a bech32 address, stake address, 56-hex key/stake hash, or `nft:<policy>.<name>` — optionally narrowed by venue and market; a loan whose owner key paid from a wallet with the queried stake credential (`owner_stake`) matches too. Debt is accrued to the market's current index: interest + principal x index_now / index_snapshot (debt.basis `indexed`; `last_touch`, principal plus recorded interest, where the loan or market carries no index); debt.breakdown splits what a full repayment pays into principal, interest and a venue's minimum-interest top-up. Collateral is valued through the same price rule as /v1/lending/markets (DEX price when liquid, else the venue oracle, else null; price_source says which), with Liqwid qTokens and Danogo pool shares first converted to their underlying at the market's current rate. health is the sum of collateral value x the market's liquidation threshold (its ltv_bps when the market has no threshold; health_basis says which) over debt (below 1 is liquidatable), at the venue's own oracle prices when it publishes one for every asset of the loan (price_basis `venue`: what its validator liquidates at), else at Float's (`dex`); risk.market_health is the same at Float's prices. risk.band is `liquidatable` (health at or below 1, or a Fluid installment deadline passed), `locked` (debt above the collateral's borrowing limit: no more borrowing or withdrawal) or `ok`; a loan no price can liquidate (risk.claim_only: Fluid full_claim) has no health and is `ok` until its deadline; each collateral line carries the price at which it alone makes the loan liquidatable, risk.collateral_drop the fall all collateral can take together. carry is the interest per day against what the collateral earns; drift the health interest alone leaves in 30 days and the days until it reaches 1. history lists every recorded change of the loan (open, borrow, repay, collateral moves, liquidations with the liquidator, seizure and penalty) and ledger its totals; `closed` lists the owner's ended loans with their ledgers (`include=history` adds their rows; null until the rollup has written loans.json). Each figure is null where a price or threshold is unknown, never 0. `supplies` lists what the owner has lent: receipt tokens held (Liqwid qTokens, Danogo and Surf pool shares, valued through the market's rate), Fluid lender pools, and Fluid LenderBonds held (principal plus accrued interest), with totals.supply_value. `lent` lists the Fluid loans the owner's lender pools funded (repaid, liquidated or active, with principal, interest the borrower paid and the struck rate) and their totals; null when unknown (no loans.json, or one from before lender attribution). Positions owned by an NFT (Danogo) match an address, stake address or hash when that credential holds the NFT now, per the balances index (owner.nfts_held lists them); with the explicit `nft:` form no holder lookup runs. include=opportunities adds `opportunities`: loans another pool of the same asset would carry for less (it must take the loan's collateral with enough borrowing power), receipt supplies another pool would pay more on, and held assets no pool earns on (idle ADA net of the staking yield it earns in the wallet), each priced for its own size and given as yearly_value in the quote, largest first, before the fees of switching; priced as one plan (each lands in its target pool before the next is priced), so they add up; balances_known is false when the holdings are unknown. 503 until the rollup has written out/lending/positions.json.","operationId":"lending_positions","parameters":[{"description":"Whose positions: a bech32 payment address (addr1…, matches positions owned by its payment key hash or its stake credential), a stake address (stake1…), a 56-hex hash (matched as a payment key hash or a stake credential), or `nft:<policy>.<name>` for a position owned by that NFT. A loan whose owner key paid from a wallet with that stake credential (`owner_stake`) matches the stake too. For an address, stake address or hash, positions owned by an NFT (Danogo) match when one of the queried credentials holds that NFT now, per the balances index.","in":"query","name":"owner","required":true,"schema":{"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Restrict to one market key (the venue-scoped key, without the `<venue>:` prefix).","in":"query","name":"market","required":false,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Comma-separated opt-in blocks. `history`: every closed loan's rows too (its ledger totals are always served; open positions always carry theirs). `opportunities`: what the wallet leaves on the table: open loans another pool of the same asset would carry for less (it must accept the loan's collateral with enough borrowing power), receipt supplies another pool would pay more on, and held assets no pool is earning on (ADA net of the staking yield it earns in the wallet); each priced for its own size, per year at today's rates, before the fees of switching, and all as one plan (each lands in its target pool before the next is priced).","in":"query","name":"include","required":false,"schema":{"enum":["history","opportunities"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One owner's lending positions: debt, health at the venue's own prices, liquidation prices and every loan's history","tags":["meta"]}},"/v1/lending/stats":{"get":{"description":"totals and venues are valued NOW through the same price index and quote /v1/lending/markets uses, so the figures agree with the table: supplied, borrowed, available, and a supply-weighted utilization, both platform-wide and per venue. series is a historical total valued at EACH bucket's own price from the pool candle history — never today's rate applied to old data, the same discipline usd_rate_series documents for ADA/USD — so a market with no price for a bucket is excluded from it rather than zeroed, and priced_markets reports how many of market_count contributed. venue (comma-separated, family slugs match) scopes totals, venues and series to those venues' markets; a venue matching no listed lending market is a 400. include=by_venue splits every series bucket by venue, the parts adding up to the bucket's supplied and borrowed exactly.","operationId":"lending_stats","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Series resolution: 1h (default, the rollup's own bucket width) or 1d, which keeps the last point of each UTC day. Narrower than the shared period grammar on purpose — the lending tape materializes exactly one bucket width, so `raw` would mean something different here.","in":"query","name":"period","required":false,"schema":{"enum":["1h","1d"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Comma-separated opt-in blocks. `by_venue`: every series bucket split by venue ({<venue>: {supplied, borrowed, priced_markets}}), the parts adding up to the bucket's supplied and borrowed exactly; a venue with no priced market in a bucket is absent.","in":"query","name":"include","required":false,"schema":{"enum":["by_venue"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Lending totals, per-venue breakdown, and a historical value series","tags":["meta"]}},"/v1/lending/supply-ledger":{"get":{"description":"What `owner` (a bech32 address, stake address or 56-hex hash; read as its wallet credential, the stake credential when the address has one; not `nft:`) has lent through receipt tokens: Liqwid qTokens, Danogo and Surf pool shares (Fluid lending is the `lent` block of /v1/lending/positions). Flows are the wallet's own share-token movements from the balances fold: shares arriving are a deposit, shares leaving a withdrawal (a transfer or collateral posting included). A flow's underlying is the transaction's own opposite leg of the underlying when it states it alone (never ADA, whose leg carries the fee), else shares x the market's share rate then, read from the market's state tape (at most months + 1 reads per market; between reads the rate is interpolated). Per market, earned = current + withdrawn - deposited (raw underlying); per month, the underlying held at the month's end - at its start - the month's net flows. *_value figures are converted at current prices into the quote. A figure is null, never 0, where a rate or price is unknown; markets whose earnings are unknown are listed in coverage.unmeasured_markets and left out of the totals. 422 for a credential with more than 50,000 balance rows; 503 until the balances fold and the lending markets document exist.","operationId":"lending_supply_ledger","parameters":[{"description":"Whose positions: a bech32 payment address (addr1…, matches positions owned by its payment key hash or its stake credential), a stake address (stake1…), a 56-hex hash (matched as a payment key hash or a stake credential), or `nft:<policy>.<name>` for a position owned by that NFT. A loan whose owner key paid from a wallet with that stake credential (`owner_stake`) matches the stake too. For an address, stake address or hash, positions owned by an NFT (Danogo) match when one of the queried credentials holds that NFT now, per the balances index.","in":"query","name":"owner","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"How many UTC months the monthly figures and `events` cover, the current month last: an integer from 1 to 36 (default 12).","in":"query","name":"months","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One wallet's lending deposits, withdrawals and interest earned by month, per receipt-token market (Pro)","tags":["meta"]}},"/v1/lending/tape":{"get":{"description":"One event per `lend-pos#<venue>` row the rollup holds, across every lending venue (or those `venue` names), newest first. kind `borrow` is a loan output created (action: the transition's open, borrow, repay, collateral_add, collateral_remove, liquidation, claim, migration, recast, touch or unknown); kind `close` a loan input consumed for good (action: repaid, liquidated or unknown). amount is the raw units of the borrowed asset the step borrowed or repaid (null when the tx cannot state it, never 0 for unknown); value is that amount at today's lending price (rule D4) in the quote. tx_hash is null for a close row written before the rollup recorded it. lender is the Fluid pool's lender where the adapter names it. Page with the opaque `cursor` from links.next, present only when another page exists.","operationId":"lending_tape","parameters":[{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 200 (default 50).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The loan tape: every loan opened, borrowed against, repaid or liquidated, newest first","tags":["meta"]}},"/v1/markets":{"get":{"description":"Liquidity is reserves now, valued at the current price board. Volume is the rollup's turnover document, where each trade was valued at the hour it happened, so it is served as published rather than re-valued here; a window the rollup could not value is null, and a market with an unpriced side is counted in meta.unranked_markets rather than ranked as zero. `window` moves the turnover window off the 24h default and keys volume/trade_count by it; every window here trails the tip by that many seconds, so 7d and 30d are NOT the whole-UTC-day volume_7d_complete/volume_30d_complete on /v1/stats; `q` searches the whole list by ticker, name, asset id or market id before it is paged; `priced=true|false` keeps only the markets whose liquidity could or could not be valued, and meta.unpriced_markets always counts the unvalued ones in scope. With `venue=` naming an order-book venue (Genius Yield, SaturnSwap, Axo, Chadswap) the list also carries that venue's markets as `kind: orderbook` rows, ids `<venue>:<assetA>~<assetB>`: reserves, liquidity and fee_yield null, volume and trade_count from their fills; a list of only those ranks by volume unless `sort` is given. Without a venue filter the list is pools only. fee_yield.30d is the growth of the pool's LP index (invariant per LP unit) over the 30 complete days to today's midnight (UTC), annualized, as a decimal fraction: gross of divergence, not an APR, negative when the index fell, and null when the pool publishes no index, has under 30 days of state, is near-empty, or had flagged reserves in the window.","operationId":"markets_list","parameters":[{"description":"Ranking key: liquidity (default), volume, trade_count, fee_yield_30d. Both liquidity and volume are valued in the quote asset before ranking. fee_yield_30d ranks by each row's fee_yield.30d, highest first; a market without one is counted in meta.unranked_markets and listed after the ranked ones.","in":"query","name":"sort","required":false,"schema":{"enum":["liquidity","volume","trade_count","fee_yield_30d"],"type":"string"}},{"description":"Which turnover window orders the list when sort is volume or trade_count: 1h, 24h (default), 7d, 30d, repeated as meta.window. Each is that many seconds back from the tip, not whole UTC days — /v1/stats serves the day-aligned figures as volume_*_complete. Every row carries EVERY window regardless — volume and trade_count are objects keyed by window name, all measured against one tip — so this narrows the ranking, never the response. Liquidity is a point-in-time reserve figure and is unaffected.","in":"query","name":"window","required":false,"schema":{"enum":["1h","24h","7d","30d"],"type":"string"}},{"description":"Substring filter over either side's ticker, registry name, on-chain name and asset id, plus the market id (venue included). Case-insensitive. Applied across the whole ranked list before paging, so meta.market_count reports the matches, not the catalogue.","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"true keeps only the markets whose liquidity could be valued; false keeps only those whose liquidity could not (liquidity null). Omitted serves both. Applied after venue and q and before ranking and paging, so meta.market_count reports the matches. meta.unpriced_markets always counts the unvalued markets in scope before this filter, so with priced=true it is the number left out.","in":"query","name":"priced","required":false,"schema":{"enum":["true","false"],"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 5000 (default 100). Every priced market fits in one page: ask for it rather than walking links.next, which costs a round trip per page.","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Ranked market list: reserves, valued liquidity and volume","tags":["markets"]}},"/v1/markets/{market}":{"get":{"description":"Reserves are base-unit strings of each side's own asset. volume.24h names a quantity per quote asset in that asset's own base units; turnover.24h is the same window in meta.quote base units, from the rollup's per-hour valuation, and is null when it could not value one of them. `kind` is `pool`, or `orderbook` for an order-book venue's pair market (`<venue>:<assetA>~<assetB>`): the same 24h activity from its fills, `book` (open orders) when the rollup has filed its resting orders, and reserves, fees, trade_sizes, lp and constant_product null with pool_unavailable_reason saying why.","operationId":"market_detail","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One pool/book: side assets, reserves, 24h activity","tags":["markets"]}},"/v1/markets/{market}/candles":{"get":{"description":"Served directly from the rollup materialization. An order-book market's candles are its fills'; a pair with no recorded fill is a 404 that says so. `include=liquidity` adds the pool's state per bucket (reserves, their value at that bucket's prices, LP supply and LP index), the buckets where only that state moved, the `assets` the lists follow, and the state before the first row. With it, `impact=<amount>` adds each bucket's cost of swapping that notional in each direction.","operationId":"market_candles","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}},{"description":"Candle interval in the shared period grammar. 1m and 1h are materialized today; defaults to 1h. Series are sparse — a bucket exists only for a period that had a trade.","in":"query","name":"interval","required":false,"schema":{"enum":["1m","1h"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"The spec's one wire-format switch. Absent = verbose row objects (the default stays for existing clients). `compact` = one array per field under `columns`, same order and values — ~3x smaller decoded, for chart clients on slow connections.","in":"query","name":"encoding","required":false,"schema":{"enum":["compact"],"type":"string"}},{"description":"Comma-separated opt-in blocks; a block the route does not serve is a 400. On the asset routes: `display` adds parallel *_display strings (server-side decimal shift by the asset's decimals; no floats), and `usd` adds a `usd` object per row holding the same money fields at the USD rate, or null when no rate is usable. On a market's candles the only block is `liquidity`: each bucket's reserves and their value. The asset candles take none.","in":"query","name":"include","required":false,"schema":{"type":"string"}},{"description":"With include=liquidity: a decimal notional of at least 0.000001 in the response's quote (dollars for quote=usd, ADA for quote=ada), echoed in canonical form. Each row gains `impact`, the cost of swapping that notional against the pool's closing state in each direction (`selling_base`, `buying_base`): `cost_bps` with the pool's fees, `price_impact_bps` without, both against the curve's marginal price. The notional converts at that bucket's prices; null when any input is unknown, the venue's curve is not computed, or the pool cannot fill the trade.","in":"query","name":"impact","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Pool-level OHLCV","tags":["markets"]}},"/v1/markets/{market}/series":{"get":{"description":"Serves the venue adapter's detail facts; values are decimal strings passed through verbatim, keyed by field name in each row's values object. At most 5,000 rows per response, oldest first, at either period; meta.truncated is true when the window held more, and the next page starts after the last bucket_start (from).","operationId":"market_series","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}},{"description":"Comma-separated detail field names (e.g. sum_invariant,circulating_lp).","in":"query","name":"fields","required":true,"schema":{"type":"string"}},{"description":"Series resolution in the shared period grammar (1h is materialized today; the default), or `raw` for every point. Raw responses stop at 5000 rows and set meta.truncated: true.","in":"query","name":"period","required":false,"schema":{"enum":["1h","raw"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Detail-field series for one market (interest, invariants, supply)","tags":["markets"]}},"/v1/markets/{market}/trades":{"get":{"description":"Cursor-paged from the rollup's swap facts. `direction` is the taker's side of the base asset, read from the pool's signed net change. `price` and `value` convert at the hour the trade executed and are null when no rate covers it; the base and quote `amount`s are that asset's own base units and are never converted.","operationId":"market_trades","parameters":[{"description":"Market id: `<venue>:<marketKey>`.","in":"path","name":"market","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The newest trade a polling client already holds, in the cursor grammar (the `cursor` of any trade row, <slot>.<tx_index>.<event_index>.<tx_hash>). Only strictly newer rows return, so a quiet poll gets an empty page instead of the full tape.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 250 (default 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One pool's tape: executed swaps, newest first","tags":["markets"]}},"/v1/openapi.json":{"get":{"description":"Derived from the same definitions the handlers register; never hand-maintained.","operationId":"openapi","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"This API, as OpenAPI 3.1 — generated from the route table","tags":["meta"]}},"/v1/perps/{venue}":{"get":{"description":"The venue's custody vault as read from the chain: its holdings (each valued where the price board has a price, null where it has none), their total (tvl), and the last 7 days of deposits and withdrawals valued the same way with the number of vault transactions that added (tx_in) or removed (tx_out) value. vault is null until a vault state is indexed. reported is what the venue's own public API says (markets, open interest, volume, liquidations), carrying provenance venue-reported: Float cannot verify it on chain, and it is never summed with the vault figures nor counted in /v1/stats' tvl. quote behaves as on /v1/stats. 404 for a venue that is not a perps venue or has no document yet.","operationId":"perps_venue","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"A perps venue: custody vault holdings and flows, plus its reported figures","tags":["venues"]}},"/v1/portfolio":{"get":{"description":"Combines over UTxOs, not over totals. Two listed addresses sharing a stake credential reach the same rows, so each UTxO is attributed to the first address that names it and the per-address subtotals stay disjoint. Exclusivity holds across the whole set. total_value (and by_address[].total_value) is total_value_ada in meta.quote units, at the rate now. 422 when a listed address's credential has more than 50,000 balance rows.","operationId":"combined_portfolio","parameters":[{"description":"Comma-separated bech32 addresses, at most 25.","in":"query","name":"addresses","required":true,"schema":{"type":"string"}},{"description":"Credential grouping: wallet (default when the address has a stake credential) groups every address sharing it; payment is the one payment credential, and the default for enterprise addresses, which declare no grouping.","in":"query","name":"scope","required":false,"schema":{"enum":["payment","wallet"],"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One portfolio over many addresses: combined total plus per-address","tags":["addresses"]}},"/v1/quotes":{"get":{"description":"Rates are exact numerator/denominator rationals in base units. period=1h keeps the last point per hour bucket; period=raw serves every point (capped at 5000 rows, meta.truncated: true when capped).","operationId":"quotes","parameters":[{"description":"Base asset of the pair: `ada.lovelace` or `<policyHex>.<assetNameHex>` (the separator-less concatenated form is accepted).","in":"query","name":"base","required":true,"schema":{"type":"string"}},{"description":"Quote asset of the pair (same forms as base).","in":"query","name":"quote","required":true,"schema":{"type":"string"}},{"description":"Quote kind; defaults to redemption.","in":"query","name":"kind","required":false,"schema":{"enum":["redemption","mid","oracle"],"type":"string"}},{"description":"Comma-separated venue slugs, case-insensitive. A slug matches itself and its family: `sundae` matches `sundae-yf` and `sundae-v3`. Omitted means every venue; a value naming no slug, or a non-slug token, is a 400.","in":"query","name":"venue","required":false,"schema":{"type":"string"}},{"description":"Restrict to one market key (the venue-scoped key, without the `<venue>:` prefix).","in":"query","name":"market","required":false,"schema":{"type":"string"}},{"description":"Series resolution in the shared period grammar (1h is materialized today; the default), or `raw` for every point. Raw responses stop at 5000 rows and set meta.truncated: true.","in":"query","name":"period","required":false,"schema":{"enum":["1h","raw"],"type":"string"}},{"description":"Inclusive lower bound on bucket time (unix seconds).","in":"query","name":"from","required":false,"schema":{"type":"integer"}},{"description":"Inclusive upper bound on bucket time (unix seconds).","in":"query","name":"to","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Quote series for one asset pair, from the rates facts","tags":["rates"]}},"/v1/rates/graph":{"get":{"description":"One edge per (base, quote, venue, market) redemption quote. The list is paged (limit/cursor) because it grows with the pool set; `base=` filters to the assets you care about, and `edge_count` reports the whole matching set rather than the page.","operationId":"rates_graph","parameters":[{"description":"Set to `stables` to return only the registered USD stablecoin ids and the edge count, omitting the edge list itself.","in":"query","name":"fields","required":false,"schema":{"enum":["stables"],"type":"string"}},{"description":"Comma-separated asset ids; returns only edges whose base is one of them. A consumer that needs the edges for the assets it holds should filter rather than page the whole graph.","in":"query","name":"base","required":false,"schema":{"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 250 (default 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The redemption graph: which assets redeem into which","tags":["rates"]}},"/v1/search":{"get":{"description":"Matches registry ticker/name, the on-chain name, and id prefixes; asset results rank by liquidity.","operationId":"search","parameters":[{"description":"Search text: ticker, name, on-chain name, policy, or id prefix.","in":"query","name":"q","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Assets and markets, ranked","tags":["meta"]}},"/v1/signals":{"get":{"description":"Whale trades, stablecoin depegs and other abnormal market events, newest first, each with a kind, a score and the time it happened. The same feed the Pulse tab renders and the sundae Discord posts.","operationId":"signals","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The Pulse curated feed of unusual market events","tags":["meta"]}},"/v1/staking":{"get":{"description":"One row per liquid-staking receipt Float measures (Danogo's staking-vault receipt, Optim sOADA, RealFi sUSDr; kind liquid) and one for native ADA delegation (kind native, venue cardano). A liquid row's apr is the growth of the receipt's redemption rate (underlying per receipt) over the trailing 30 days, (rate_end / rate_start - 1) x 365.25 / window days, simple; a fall is a negative apr. The window is the 30 days to the newest move of the rate, its start rate read on the line between the moves around it (basis receipt_rate, from the redemption series, timed to the hour), or, for Danogo, the vault datum's own epoch clock (basis vault_epoch_clock, the window lending staking_apr uses). The native row's apr is the ledger's rewards over the active stake they were earned on across the newest 6 rewarded epochs, x 73.05 (basis epoch_rewards, Koios epoch_info): BEFORE pool fees, so a delegator nets less. apr is null unless status is measured: stale (a receipt's rate has not moved for over 10 days, or the newest rewarded epoch trails the current epoch by more than 4), short_history (under 30 days), unavailable (the source has not been read, or holds no usable rate). A source whose read fails keeps serving its last reading, judged stale by the same rules as it ages. tvl is the backing (liquid: the newest quote's numerator) or the active stake (native) at the current price board, null when unpriced. Ranked by apr, null last.","operationId":"staking","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Staking yield — liquid-staking receipts and native ADA delegation","tags":["markets"]}},"/v1/stats":{"get":{"description":"Every volume figure is the rollup's own per-day valuation, converted at the rate in force on that day and only then summed: a window is null as soon as one of its days is unknown, rather than a total missing a day. Trades whose quote asset had no price that day are counted in unpriced_trades_24h and excluded from the volume. totals.tvl is chain TVL, DEX plus lending less the overlap (tvl_lending_dex_overlap: the idle part of lending markets whose underlying is a DEX LP share, already inside pool depth) plus tvl_perps (what perps custody vaults hold, valued now; venue-reported figures are never in it), observed now at the newest rate. totals.tvl_dex and each venue row's tvl are DEX pool depth only, so the venue rows sum to tvl_dex, not to totals.tvl; a venue's tvl_lending is what its lending contracts hold (idle supply plus loan collateral) and lending_supplied its gross supply; a perps venue's row carries tvl_perps. The tvl and volume series convert per day and carry the DEX component only. pool_liquid_floor_lovelace is a threshold in lovelace and is never converted. volume_1d/7d/30d_complete cover whole UTC days ending at volume_series.last_complete_day, and each _complete_prev twin is the window of equal length before it, so the two sides of a change are the same shape; a _complete_prev the series cannot cover is null. The _complete suffix marks a whole-UTC-day window throughout the API: the 7d and 30d on /v1/markets are trailing seconds from the tip and are NOT these figures. volume_24h and trades_24h are the older rolling fields, measured from the day boundary below the tip rather than from the tip: prefer the day windows for anything compared over time. Each volume_series point carries that day's total trade count as well as its volume, so any window either figure is read over can be summed from the series itself. Both series split every point by venue (by_venue); fields=totals serves the same document without those splits, a fraction of its size.","operationId":"stats","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Set to `totals` to serve each volume_series and tvl_series point without its `by_venue` split, every other field unchanged. The splits are most of the document's weight; a caller charting totals alone should ask for this. Any other value is a 400.","in":"query","name":"fields","required":false,"schema":{"enum":["totals"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Per-venue and total volume, TVL, and a daily volume and trade series","tags":["meta"]}},"/v1/trades":{"get":{"description":"Cursor-paged, newest first, k-way merged across every venue's tape. The same swap facts the per-asset and per-market tapes serve, unfiltered, each valued at the hour it executed.","operationId":"recent_trades","parameters":[{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}},{"description":"Opaque page cursor from links.next.","in":"query","name":"cursor","required":false,"schema":{"type":"string"}},{"description":"The newest trade a polling client already holds, in the cursor grammar (the `cursor` of any trade row, <slot>.<tx_index>.<event_index>.<tx_hash>). Only strictly newer rows return, so a quiet poll gets an empty page instead of the full tape.","in":"query","name":"after","required":false,"schema":{"type":"string"}},{"description":"Page size, at most 250 (default 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"The global tape: recent swaps across every venue and token","tags":["markets"]}},"/v1/txs/{tx_hash}":{"get":{"description":"`swaps` and `fills` treat the hash as an execution: what the batch traded, and which order UTxOs that decomposes into. `placed` treats it as an order transaction: where each order it created executed — across venues, when an aggregator split the trade. A swap's `price` and `value` convert at the hour it executed. `cancels` lists cancels the transaction performed. 404 when Float recorded nothing for the hash.","operationId":"tx_detail","parameters":[{"description":"Transaction hash, 64 hex characters.","in":"path","name":"tx_hash","required":true,"schema":{"type":"string"}},{"description":"Denomination for prices and ADA-denominated amounts. Every figure converts at the rate in force when it was observed: a figure observed now (price, liquidity, reserves, fdv, holdings) at the newest rate, a candle per bucket, a trade at the trade's hour, a daily stat at that day. A figure with no rate at its own moment is null, never carried at another moment's rate. Quantities in an asset's own base units are never converted. usd is the volume-weighted index of the exchanges' ADA/USD markets (meta.quote_source: cex-index), falling back per bucket to the rate implied by the fiat-backed stablecoins' pools (stable-implied); it answers 503 when the ADA/USD series is empty or has stopped.","in":"query","name":"quote","required":false,"schema":{"enum":["ada","usd"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"One transaction's trades, in both of its roles","tags":["markets"]}},"/v1/venues":{"get":{"description":"The transparency page. All running adapters decode on-chain data (trust: chain-verified). kind filters to dex, lending or perps venues (DESIGN-LENDING.md's venue taxonomy) so the sections can share one list; any other kind is a 400. Every lending venue with a market in the lending markets document is listed, pools or not, and every perps venue whose document exists.","operationId":"venues","parameters":[{"description":"Filter to one venue kind: dex, lending or perps.","in":"query","name":"kind","required":false,"schema":{"enum":["dex","lending","perps"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OK"},"400":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}},"summary":"Coverage registry: adapters, trust badges, per-venue tips","tags":["venues"]}}},"servers":[{"url":"https://api.float.sundae.fi"}]}