One LithosDex pool and its vault

get/dex/pools/{poolNft}

One pool as the index last read it, with its fee vault read from the node now.

Path parameters

poolNftstringrequired
The pool's NFT id, 64 hex characters

Responses

200The pool and its vaultLDPoolDetail▶

▶
poolLDPoolSummaryrequired
One LithosDex pool as the index last read it. Amounts are decimal strings in base units.
- poolNFTstringrequired
- kindstringrequired
  n2t is ERG against a token, t2t token against token
  one ofn2tt2t
- utxoIdstringrequired
  The pool box the index read
- inclusionHeightinteger · int32required
- ▶
  tokenXLDPoolTokenrequired
  One side of a pool. A verified token's name, ticker and decimals come from the client's verified list; any other token's from the node's token index, where whoever minted the token chose them.
  tokenIdstringrequired
  Token id, or ERG for the X side of an ERG/token pool
  namestring
  tickerstring
  Short symbol. Verified tokens and ERG only.
  decimalsinteger · int32
  verifiedbooleanrequired
- ▶
  tokenYLDPoolTokenrequired
  One side of a pool. A verified token's name, ticker and decimals come from the client's verified list; any other token's from the node's token index, where whoever minted the token chose them.
  tokenIdstringrequired
  Token id, or ERG for the X side of an ERG/token pool
  namestring
  tickerstring
  Short symbol. Verified tokens and ERG only.
  decimalsinteger · int32
  verifiedbooleanrequired
- reservesXstringrequired
- reservesYstringrequired
- pendingXstringrequired
  Fees awaiting a flush to the vault
- pendingYstringrequired
- supplystringrequired
  Shares issued
- ▶
  feeParamsLDFeeParamsrequired
  Fee numerators over feeDenom. dexFeeNum stays in the pool; ergFeeNum / tokenFeeNum are set aside for liquidity providers.
  dexFeeNuminteger · int64required
  ergFeeNuminteger · int64required
  tokenFeeNuminteger · int64required
  feeDenominteger · int64required
  Denominator of every numerator above
- provTokensLeftstringrequired
  Deposits the pool can still take, one provision token each
- pricenumber · double
  Units of Y per unit of X at display decimals. Absent when either side's decimals are unknown.
- verifiedbooleanrequired
  Whether the client's verified list names this pool
- genesisCheckedbooleanrequired
  Whether this pool's genesis was checked. False for verified pools, which are checked by hand, and while the node could not be read.
- problemsstring[]required
  Genesis facts this pool breaks. Any one can let the pool be drained.
- warningsstring[]required
  Risks short of that, such as too little ERG to survive storage rent.
▶
vaultLDPoolVaultrequired
A pool's fee vault. Amounts are decimal strings in base units.
- vaultNFTstringrequired
- utxoIdstringrequired
- accXstringrequired
  Fee per share of X, scaled by 1e27, as of the last flush
- accYstringrequired
- balanceXstringrequired
  Fees held for provisions to claim
- balanceYstringrequired

404No LithosDex pool with that NFT.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

503The index is still building, or the vault could not be read. Retry.ApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousEvery LithosDex pool Next →List your outstanding orders on any pool

{ "pool": { "poolNFT": "string", "kind": "n2t", "utxoId": "string", "inclusionHeight": 0, "tokenX": { "tokenId": "c1980d829988229516430a47a5eca376060b6ce859616db0936e78ab25cb6de7", "name": "LIT", "ticker": "LIT", "decimals": 9, "verified": true }, "tokenY": { "tokenId": "c1980d829988229516430a47a5eca376060b6ce859616db0936e78ab25cb6de7", "name": "LIT", "ticker": "LIT", "decimals": 9, "verified": true }, "reservesX": "string", "reservesY": "string", "pendingX": "string", "pendingY": "string", "supply": "string", "feeParams": { "dexFeeNum": 9985, "ergFeeNum": 15, "tokenFeeNum": 15, "feeDenom": 10000 }, "provTokensLeft": "string", "price": 0.1, "verified": true, "genesisChecked": true, "problems": [ "string" ], "warnings": [ "string" ] }, "vault": { "vaultNFT": "string", "utxoId": "string", "accX": "string", "accY": "string", "balanceX": "string", "balanceY": "string" } }