• Reading the docs…
Start trading

API reference

Pool and Crossings

What the chain sees, as the API serves it: the vaults’ holdings, every committed Crossing with its Residual swaps and Commit, the crossed share, and the token panel’s fees, buybacks and burns.

Routes#

GET /v1/home#

Network totals for Home’s live strip: Crossings committed, the crossed share of notional and the vaults’ USD value, with the next cutoff as Countdown gives it. While state is empty the strip reads “The first Crossing opens with the first deposit or order” alone.

Returns Home.

Errors

  • INDEXER_UNAVAILABLE: the indexer has not verified the latest Commit yet, or its root disagrees with the chain; retryable.
  • PROGRAM_UNAVAILABLE: the Pool is not indexed yet; retryable.
  • UPSTREAM_UNAVAILABLE: the price of an asset the vaults hold is unavailable from its oracle or Jupiter; retryable.
TypeScript
const home = await api.home()
const crossed = home.crossedShare.value === null ? null : Number(home.crossedShare.value)
Response
{
  "state": "live",
  "crossingsCommitted": "16",
  "crossedShare": {
    "value": "0.146382366996720325",
    "unavailableReason": null
  },
  "assetsUsd": "2637.236231",
  "countdown": {
    "currentSlot": "470885217",
    "lastCommitSlot": "470884581",
    "deltaSlots": 4,
    "nextCutoffSlot": "470885218",
    "slotTimeMs": 200,
    "observedAt": "2026-11-17T09:42:29.429Z"
  }
}

GET /v1/pool#

Everything the Pool page shows, in one read: each asset in the vaults, the latest Crossings, the crossed share and its history per Crossing, the token panel, the notional routed in full for tokens with no price feed, and the anonymity set per day.

Returns Pool. It raises the same errors as GET /v1/home.

crossings is the first page of GET /v1/crossings; read further pages there. Every history is newest first and bounded: crossedShareHistory covers the latest 100 Crossings, token.fees the fee payments of the latest 100 Crossings that paid fees, and token.buybacks the latest 100 completed buybacks.

token is the fee flow as the chain records it. fees holds the same rows each Crossing’s fees holds. buybacks holds buys of $PRV through Jupiter, each with the burn of exactly what it delivered, and supplyBurned totals every burn to date, the listed buybacks’ and all earlier ones. state is active and mint the $PRV mint. The token itself is told on Pool and, for builders, in Fees and $PRV.

noFeedRouting covers the tokens with no Pyth feed, whose whole flow routes as the Residual (Residual). routedUsd is their routed notional since launch and totalUsd all crossed and routed notional, so their share is routedUsd / totalUsd. venues groups those tokens by the AMM of each token’s deepest pool on GeckoTerminal, largest notional first.

anonymitySet holds one row for each UTC day with a verified Crossing, the latest 14, newest first. depositors counts the distinct wallets whose deposits were credited that day, read from the chain. activeAccounts, exits and exitDelaySlots are the enclave’s totals over every account for the slots of that day, signed by the active enclave key; the API checks the signature against the key the Registry admitted and returns null for the three while no signed totals are available.

TypeScript
const { assets, crossedShare, token } = await api.pool()
const burned = BigInt(token.supplyBurned)
const paid = token.fees.reduce((sum, fee) => sum + BigInt(fee.amount), 0n)

The capture keeps the first item of assets, crossings.items, token.fees and token.buybacks, and two of the 77 in crossedShareHistory: the newest, with nothing published, and Crossing 5, which crossed and routed JUP against SOL. Its supplyBurned, 593,972,957, is the sum of the three buybacks’ burnedAmount.

Response
{
  "assets": [
    {
      "asset": {
        "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "symbol": "USDC",
        "name": "USD Coin",
        "decimals": 6,
        "icon": null,
        "tokenProgram": "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA",
        "admitted": true,
        "registryIndex": 1,
        "denominationUnit": "10000"
      },
      "amount": "1507247119",
      "valueUsd": "1507.247119"
    }
  ],
  "assetsUsd": "2237.294426",
  "crossings": {
    "items": [
      {
        "index": "77",
        "slot": "470893136",
        "time": "2026-11-17T12:55:17.000Z",
        "pairs": [],
        "crossedNotionalUsd": {
          "value": "0",
          "unavailableReason": null
        },
        "routedNotionalUsd": "0",
        "residuals": [],
        "fees": [],
        "commitTransaction": "47RSU4PG8WRER2hU7dDo8RHE1y9bn2deuvAqXG81yHJysD52K7p3Z7MGFHHc8xpi9UtBJJApm7zLrGvsBTYNCnDM",
        "root": "/JfK9NzLsvxuFXToLjUywlqcJSQFsspHlYSwqNvDmDU=",
        "diffHash": "HssE8B1LPfFbJrPtJ98sCpX5UPEHVfRCB9HQoHBORc4="
      }
    ],
    "page": {
      "nextCursor": "before:54",
      "hasMore": true
    },
    "asOf": "2026-11-17T12:58:49.802Z"
  },
  "crossedShare": {
    "value": "0.5",
    "unavailableReason": null
  },
  "crossedShareHistory": [
    {
      "crossing": "77",
      "share": {
        "value": null,
        "unavailableReason": "not_published"
      }
    },
    {
      "crossing": "5",
      "share": {
        "value": "0.5",
        "unavailableReason": null
      }
    }
  ],
  "token": {
    "state": "active",
    "mint": "9FSjffoh8Yk8jdpr9EEEuxTD6mphYayfboxZMKWVPRV",
    "feeRecipient": "2oxQFJKkXUegJg5JbYtxbTTdByAsNuVsDTbdGyRcnAe9",
    "supplyBurned": "593972957",
    "fees": [
      {
        "mint": "So11111111111111111111111111111111111111112",
        "amount": "10466",
        "recipient": "2oxQFJKkXUegJg5JbYtxbTTdByAsNuVsDTbdGyRcnAe9",
        "transaction": "8CEasCD7yjJps9oioMiKYGKZGU48NJb3LN5EWhtuBRFF3SB1FVxhTavmMkiyPZesPbkzXrqdLditgkJ7NGC5utu"
      }
    ],
    "buybacks": [
      {
        "id": "477ikatJeK7C8Paw5GgAHcTZTqdT7RVy6XdCtq5TwMrZ7X7opbBAq8fcdnztjktVcVUEH8TcwxwR5W9CpkPzcpB",
        "time": "2026-11-17T12:09:02.000Z",
        "inputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
        "inputAmount": "1805",
        "boughtAmount": "49024539",
        "burnedAmount": "49024539",
        "buyTransaction": "477ikatJeK7C8Paw5GgAHcTZTqdT7RVy6XdCtq5TwMrZ7X7opbBAq8fcdnztjktVcVUEH8TcwxwR5W9CpkPzcpB",
        "burnTransaction": "4z7vbdgrUmR3ZrLpbFP9XmtjnQKAsSQtJ6yV4Z5uf9NMpa3LeSCjkkXZoDZWxBEKU8yBG2sAmvxHph2yzGQHuCSN"
      }
    ]
  },
  "noFeedRouting": {
    "routedUsd": "0.000000",
    "totalUsd": "15.043532",
    "venues": []
  },
  "anonymitySet": [
    {
      "day": "2026-11-17",
      "depositors": 7,
      "activeAccounts": null,
      "exits": null,
      "exitDelaySlots": null
    }
  ]
}

GET /v1/crossings#

The committed Crossings, newest first, a page at a time: the feed on Pool. activity keeps only the Crossings that did something an observer can see: fills those that crossed notional or routed a Residual swap, deposits those that credited a deposit, exits those whose exits root lists an Exit piece, and active any of the three. Each page ends with a nextCursor of the form before:<index>, so the next page continues below the last Crossing read whatever commits meanwhile (Pages).

Parameter Type In Meaning
cursor string (optional) query Where the page starts: the previous page's page.nextCursor, before: with the index of the last Crossing read. Omit it for the newest Crossings.
limit integer (optional) query, default 24 Crossings per page, 1 to 100.
activity string (optional) query, default all Which Crossings to list: all, the default; fills, those that crossed notional or routed a Residual swap; deposits, those that credited a deposit; exits, those whose exits root lists an Exit piece; active, any of the three.

Returns Crossings, a page of Crossing.

Errors

  • VALIDATION_ERROR: cursor is neither before: with an index of up to 20 digits nor a decimal integer of up to 12 digits, limit is outside 1 to 100, activity is not one of all, active, fills, deposits and exits, or the query carries another key.
  • INDEXER_UNAVAILABLE: the indexer has not verified the latest Commit yet, or its root disagrees with the chain; retryable.
  • PROGRAM_UNAVAILABLE: the Pool is not indexed yet; retryable.
TypeScript
const fills = await api.crossings({ activity: 'fills', limit: 2 })
if (fills.page.nextCursor) await api.crossings({ activity: 'fills', limit: 2, cursor: fills.page.nextCursor })

The capture’s two Crossings each crossed part of a market and routed the rest, JUP against SOL in Crossing 14 and SOL against USDC in Crossing 8, each with its Residual swap and its fee. Each Crossing’s routedNotionalUsd equals its swap’s.

Response
{
  "items": [
    {
      "index": "14",
      "slot": "470448430",
      "time": "2026-11-17T07:27:31.000Z",
      "pairs": [
        "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN_So11111111111111111111111111111111111111112"
      ],
      "crossedNotionalUsd": {
        "value": "0.242172",
        "unavailableReason": null
      },
      "routedNotionalUsd": "0.242172",
      "residuals": [
        {
          "pair": "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN_So11111111111111111111111111111111111111112",
          "inputMint": "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN",
          "outputMint": "So11111111111111111111111111111111111111112",
          "inputAmount": "1000000",
          "outputAmount": "3378512",
          "transaction": "4SLpjkG1aVd7qQ6SQPuEKS1TjxyrYxEaeVoGJpHPuNxdnBgW7Rhc1oTjbPtiYzykmvzNHVPZKXnY8Ceqm9KDPTuk",
          "direction": "sell",
          "routedNotionalUsd": "0.242172"
        }
      ],
      "fees": [
        {
          "mint": "So11111111111111111111111111111111111111112",
          "amount": "10150",
          "recipient": "2oxQFJKkXUegJg5JbYtxbTTdByAsNuVsDTbdGyRcnAe9",
          "transaction": "Zo8U9uFSRuPqv2RhKyacVXNchQSCxFBD6cw1AFu3gY96JXRxLz8arCCJXdBXo3ax2vqhVJJjwZGvvkk5yRSYvd8"
        }
      ],
      "commitTransaction": "Zo8U9uFSRuPqv2RhKyacVXNchQSCxFBD6cw1AFu3gY96JXRxLz8arCCJXdBXo3ax2vqhVJJjwZGvvkk5yRSYvd8",
      "root": "Jk27Uw3/D3fmCcqAmsv641H46pMqG2FGpeOSnsNYfBQ=",
      "diffHash": "KJYqSOs5qDeLVjOQ8R+zhibckhSNRP5iovZ0U48vjYU="
    },
    {
      "index": "8",
      "slot": "470448317",
      "time": "2026-11-17T07:27:08.000Z",
      "pairs": [
        "So11111111111111111111111111111111111111112_EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
      ],
      "crossedNotionalUsd": {
        "value": "7.15185",
        "unavailableReason": null
      },
      "routedNotionalUsd": "7.15185",
      "residuals": [
        {
          "pair": "So11111111111111111111111111111111111111112_EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "inputMint": "So11111111111111111111111111111111111111112",
          "outputMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "inputAmount": "100000000",
          "outputAmount": "7142038",
          "transaction": "5WHeWMU6S3DMrZerQssaCVFwSZ4XtqRonuqFPt8mZduZghn9gNXgdhLicB7tL15Qmv49jZmtWVFTicdYk8qpuBnZ",
          "direction": "sell",
          "routedNotionalUsd": "7.151850"
        }
      ],
      "fees": [
        {
          "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "amount": "21444",
          "recipient": "2oxQFJKkXUegJg5JbYtxbTTdByAsNuVsDTbdGyRcnAe9",
          "transaction": "TKE7ZW1dAVFLi9bqDA3KQprKn8W22ihAcdvHnAxa2ZwCRiA4auJBWqvZgNFXcDGLs4A8odX4HDGbyTwvL6JaW6w"
        }
      ],
      "commitTransaction": "TKE7ZW1dAVFLi9bqDA3KQprKn8W22ihAcdvHnAxa2ZwCRiA4auJBWqvZgNFXcDGLs4A8odX4HDGbyTwvL6JaW6w",
      "root": "2E30F2AQ6ORAFn6kDvyAuflXXs5/fgI1V454n2mOiS8=",
      "diffHash": "HZWvzOYpUXUa5n7OLSKOnsKlvDRDWNmXcQei20Dkuec="
    }
  ],
  "page": {
    "hasMore": false,
    "nextCursor": null
  },
  "asOf": "2026-11-17T07:29:42.651Z"
}

GET /v1/crossings/{index}#

One committed Crossing by its index, the number a fill names.

Parameter Type In Meaning
index U64 path The Crossing's index.

Returns Crossing.

Errors

  • VALIDATION_ERROR: index is not an unsigned integer.
  • NOT_FOUND: no committed Crossing has this index.
  • INDEXER_UNAVAILABLE: the indexer has not verified the latest Commit yet, or its root disagrees with the chain; retryable.
  • PROGRAM_UNAVAILABLE: the Pool is not indexed yet; retryable.
TypeScript
const crossing = await api.crossing('14')
const swaps = crossing.residuals.map((swap) => `${swap.direction} ${swap.pair}: ${swap.transaction}`)
Response
{
  "index": "14",
  "slot": "470448430",
  "time": "2026-11-17T07:27:31.000Z",
  "pairs": [
    "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN_So11111111111111111111111111111111111111112"
  ],
  "crossedNotionalUsd": {
    "value": "0.242172",
    "unavailableReason": null
  },
  "routedNotionalUsd": "0.242172",
  "residuals": [
    {
      "pair": "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN_So11111111111111111111111111111111111111112",
      "inputMint": "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN",
      "outputMint": "So11111111111111111111111111111111111111112",
      "inputAmount": "1000000",
      "outputAmount": "3378512",
      "transaction": "4SLpjkG1aVd7qQ6SQPuEKS1TjxyrYxEaeVoGJpHPuNxdnBgW7Rhc1oTjbPtiYzykmvzNHVPZKXnY8Ceqm9KDPTuk",
      "direction": "sell",
      "routedNotionalUsd": "0.242172"
    }
  ],
  "fees": [
    {
      "mint": "So11111111111111111111111111111111111111112",
      "amount": "10150",
      "recipient": "2oxQFJKkXUegJg5JbYtxbTTdByAsNuVsDTbdGyRcnAe9",
      "transaction": "Zo8U9uFSRuPqv2RhKyacVXNchQSCxFBD6cw1AFu3gY96JXRxLz8arCCJXdBXo3ax2vqhVJJjwZGvvkk5yRSYvd8"
    }
  ],
  "commitTransaction": "Zo8U9uFSRuPqv2RhKyacVXNchQSCxFBD6cw1AFu3gY96JXRxLz8arCCJXdBXo3ax2vqhVJJjwZGvvkk5yRSYvd8",
  "root": "Jk27Uw3/D3fmCcqAmsv641H46pMqG2FGpeOSnsNYfBQ=",
  "diffHash": "KJYqSOs5qDeLVjOQ8R+zhibckhSNRP5iovZ0U48vjYU="
}

Types#

Home#

Field Type Meaning
state "empty", "live", "escape" live while Commits land, escape while the Escape is active, empty before the first Crossing.
crossingsCommitted U64 Crossings committed to date.
crossedShare AggregateMetric Crossed notional as a fraction of crossed plus routed notional, to date.
assetsUsd UnsignedDecimal USD value of every asset in the vaults.
countdown Countdown The earliest cutoff an Intent sent now can make.

Pool#

Field Type Meaning
assets VaultAsset[] Each asset in the vaults.
assetsUsd UnsignedDecimal USD value of every asset in the vaults.
crossings Crossings The first page of the Crossing list, newest first.
crossedShare AggregateMetric Crossed notional as a fraction of crossed plus routed notional, to date.
crossedShareHistory object[] The crossed share of each of the latest 100 Crossings, newest first.
crossedShareHistory[].crossing U64 The Crossing's index.
crossedShareHistory[].share AggregateMetric Its crossed notional as a fraction of its crossed plus routed notional.
token TokenPanel The fees paid to the fee recipient, and $PRV's buybacks and burns.
noFeedRouting NoFeedRouting The notional routed in full because its token has no Pyth feed, against all notional, since launch.
anonymitySet AnonymityDay[] Totals per UTC day, the latest 14 days with a verified Crossing, newest first.

Crossings#

Field Type Meaning
items Crossing[] The page's Crossings, newest first.
page object Where the next page starts.
page.nextCursor string or null before: and the index of the page's last Crossing: the cursor of the next page; null on the last.
page.hasMore boolean Whether another page follows.
asOf Timestamp When the server read the list.

Crossing#

A Crossing’s crossed and routed notional are the only aggregates its diff publishes: the diff carries both in USD microunits, and the Commit’s accumulator covers them. The routed figure values each Residual swap’s input at the same price as that swap’s routedNotionalUsd, rounded down once per swap, so it equals the sum of its swaps’ figures when every swap carries one; compare them as decimals, since a swap’s figure is written to six places. No per-pair crossed size, order count or owner is published (What an observer sees).

Field Type Meaning
index U64 The Crossing's index k.
slot U64 The slot of its Commit.
time Timestamp When its Commit landed.
pairs PairId[] The markets of its Residual swaps, each as its pair; empty when nothing was routed.
crossedNotionalUsd AggregateMetric USD notional crossed inside the Pool, a matched cross counted once.
routedNotionalUsd UnsignedDecimal USD notional routed through its Residual swaps, priced and rounded as each swap's routedNotionalUsd, so it equals their sum when every swap carries one.
residuals ResidualSwap[] Its Residual swaps, one per pair with a net remainder.
fees Fee[] The fees its Commit paid to the fee recipient, per quote asset.
commitTransaction Signature The Commit transaction's signature.
root Hash The Ledger root the Commit stored.
diffHash Hash The accumulator δk over the diff's log_diff chunks, which the Commit sealed.

ResidualSwap#

A Residual swap names its market by the market’s own pair, base first, and its side by direction, so a buy and a sell of one market share one pair.

Field Type Meaning
pair PairId The market the swap was routed for, as its pair.
inputMint Address The mint the Pool paid in, from vault shard 0.
outputMint Address The mint the Pool received, into vault shard 0.
inputAmount U64 Base units the Pool paid.
outputAmount U64 Base units the Pool received.
transaction Signature The swap transaction's signature.
direction "buy", "sell" (optional) sell when the Pool paid the market's base asset for its quote asset, buy when it paid the quote asset for the base.
routedNotionalUsd UnsignedDecimal or null The swap's USD notional: its input amount at the Crossing's verified Pyth mid for the input asset, rounded down and written to six decimals; null when that asset had none.

Fee#

Field Type Meaning
mint Address The quote asset the fee was paid in: SOL or USDC.
amount U64 Base units paid.
recipient Address The fee recipient, the token's launch wallet.
transaction Signature The Commit transaction that paid it, from vault shard 0.

VaultAsset#

Field Type Meaning
asset Asset The asset.
amount U64 Base units held across its vault shards.
valueUsd UnsignedDecimal Their USD value.

AggregateMetric#

Field Type Meaning
value UnsignedDecimal or null The figure as a decimal; null when there is none.
unavailableReason "not_published" or null not_published when there is no figure: the Crossing's public summary carries none, or nothing has crossed or routed yet; otherwise null.

TokenPanel#

Field Type Meaning
state "mint-pending", "active" active on an API configured with the $PRV mint; mint-pending on one without it.
mint Address or null The $PRV mint; null while mint-pending.
feeRecipient Address or null The fee recipient each Commit pays, the token's launch wallet; null until configured.
supplyBurned BaseUnits $PRV burned to date, in base units: every burn of every buyback, listed or older.
fees Fee[] The fee payments of the latest 100 Crossings that paid fees, newest first.
buybacks Buyback[] The latest 100 completed buybacks, newest first, each with the burn of what it bought; empty while mint-pending.

Buyback#

Field Type Meaning
id string The buyback's id, its buy transaction's signature.
time Timestamp When the buy landed.
inputMint Address The fee asset spent: SOL or USDC.
inputAmount U64 Base units of it spent.
boughtAmount U64 $PRV the swap delivered, in base units.
burnedAmount U64 $PRV burned, in base units: exactly boughtAmount.
buyTransaction Signature The swap through Jupiter, by transaction signature.
burnTransaction Signature The burn, by transaction signature.

NoFeedRouting#

Field Type Meaning
routedUsd UnsignedDecimal USD notional routed for tokens with no Pyth feed, over every verified Crossing.
totalUsd UnsignedDecimal USD notional crossed plus routed, over every verified Crossing.
venues NoFeedVenue[] Those tokens grouped by the AMM of each one's deepest pool, largest notional first.

NoFeedVenue#

Field Type Meaning
dex string GeckoTerminal's id for the AMM; unknown when no pool was found.
program Address or null The AMM's program id; null for an AMM outside the six the API maps.
notionalUsd UnsignedDecimal USD notional routed for this venue's tokens.
tokens object[] Each token routed here, largest notional first.
tokens[].mint Address The token's mint.
tokens[].symbol string The token's symbol.
tokens[].notionalUsd UnsignedDecimal USD notional routed for this token.
tokens[].pool Address or null The token's deepest pool by reserve on GeckoTerminal; null when none was found.
tokens[].quoteMint Address or null The other mint of that pool; null when none was found.

AnonymityDay#

Field Type Meaning
day string The UTC date, YYYY-MM-DD; the day runs from its first Crossing's slot to the next day's first.
depositors integer Distinct wallets whose deposits were credited in that day's Crossings.
activeAccounts integer or null Accounts with a deposit, a settling Intent, a fill or an Exit in the day's slots, from the enclave's signed totals; null while none are available.
exits integer or null Exits committed in the day's slots from accounts with a deposit on record, from the same totals; null while none are available.
exitDelaySlots object or null For those Exits, the slots from the account's latest deposit to the Exit, at the 10th, 50th and 90th percentile; null with no Exit or no totals.
exitDelaySlots.p10 U64 10th percentile, in slots.
exitDelaySlots.p50 U64 Median, in slots.
exitDelaySlots.p90 U64 90th percentile, in slots.