Place a deposit order

post/dex/orders/depositapi_key

Lock a deposit in an order that any miner can fill for executorFee. It fills only if the offer buys at least minShares against the pool when it executes, and waits otherwise. The fill sends the owner the new provision's ownerNFT and whatever the pool did not take.

Request body

LDDepositOrderExecuteRequest · application/json

amountXstringrequired
Most nanoERG the order offers to the reserves, not counting the provision box. Decimal string.
amountYstringrequired
Raw token units the order offers. Decimal string.
minSharesstringrequired
Fewest shares the order accepts, checked against the pool when it fills. Required and must be positive. A floor far under the quote's shares lets a pool moved earlier in the same block take the difference. Decimal string.
executorFeestring
nanoERG paid to whoever fills the order. Omit for the client's default. Decimal string.
maxMinerFeestring
Most nanoERG a fill may pay as a miner fee, out of executorFee. Must be below executorFee. Omit for the client's default. Decimal string.

Responses

200The placement transaction and the order it createdLDOrderPlacementResult▶

outcomestringrequired
Node submission outcome; uncertain retains the known transaction ID and input ownership.
one ofacceptedrejecteduncertain
txIdstringrequired
▶
orderLDOrderrequired
An outstanding LithosDex order owned by this wallet. Which term fields are present depends on type.
- boxIdstringrequired
  Order box id. Pass it to POST /dex/orders/{boxId}/cancel.
- typestringrequired
  one ofSWAPDEPOSITREDEEM
- statusstringrequired
  PENDING: the placement is unconfirmed. OPEN: placed and waiting for a fill. FILLING: an unconfirmed transaction fills it. CANCELLING: an unconfirmed transaction cancels it. Only PENDING and OPEN orders can be cancelled.
  one ofPENDINGOPENFILLINGCANCELLING
- placementTxIdstringrequired
  Transaction that created the order box
- placedHeightinteger · int32
  Height the placement confirmed at. Absent while it is unconfirmed.
- spendingTxIdstring
  The unconfirmed transaction filling or cancelling the order. Present when FILLING or CANCELLING.
- ownerstringrequired
  Address that receives the fill, and the only key that can cancel
- valuestringrequired
  nanoERG held by the order box. Decimal string.
- executorFeestringrequired
  nanoERG the order pays whoever fills it. Decimal string.
- maxMinerFeestringrequired
  Most nanoERG a fill may pay as a miner fee, out of executorFee. Decimal string.
- ergInboolean
  SWAP only. True when selling ERG for the token.
- amountInstring
  SWAP only. nanoERG or raw token units sold into the pool. Decimal string.
- minOutputstring
  SWAP only. Least the owner receives: tokens when selling ERG, or nanoERG after executorFee when selling the token. Decimal string.
- amountXstring
  DEPOSIT only. Most nanoERG offered to the reserves. Decimal string.
- amountYstring
  DEPOSIT only. Raw token units offered. Decimal string.
- minSharesstring
  DEPOSIT only. Fewest shares the order accepts. Decimal string.
- ownerNFTstring
  REDEEM only. Ownership NFT of the provision the order closes.
- provisionBoxIdstring
  REDEEM only. Current box of that provision. Absent when it cannot be found.
- fillableNowbooleanrequired
  Whether the order would fill against the current pool. False when the pool cannot meet the order's minimum or refuses it; the order waits until that changes or it is cancelled. Always true while FILLING and false while CANCELLING.
claimedXstring
REDEEM only. Settled ERG fees the placement claimed. Decimal string.
claimedYstring
REDEEM only. Token side of claimedX. Decimal string.

400Malformed body, a non-positive amount or `minShares`, or a `maxMinerFee` not below `executorFee`. ApiError▶

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

422The pool has no provision tokens left, or the wallet cannot cover the order.ApiError▶

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

503Node or wallet unavailable. 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

← PreviousQuote a deposit order Next →Quote a redeem order

curl -X POST "http://localhost:9000/dex/orders/deposit" \ -H "api_key: $LITHOS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amountX": "5000000000", "amountY": "152000000", "minShares": "1170587", "executorFee": "3000000", "maxMinerFee": "1000000" }'

{ "outcome": "accepted", "txId": "40b7d045a858d537cdbf072e46ffbb86c0c9f6b0e93c369c1ffcba76797636d7", "order": { "boxId": "5035b2e112b4f5b873dd3444c01df1e7e697807fd84fe96790eacb128e46428d", "type": "SWAP", "status": "OPEN", "placementTxId": "40b7d045a858d537cdbf072e46ffbb86c0c9f6b0e93c369c1ffcba76797636d7", "placedHeight": 484719, "spendingTxId": "9f3c1ab7d2e45806c91f7b3ad4e2091856cbf740e3a92d5178cc0b46e21f5d38", "owner": "3WwbzR34YmLRy3Z6WLON5hBBkX8Zm1gUHmC7tEXDNRJfHBqhsZr", "value": "1004000000", "executorFee": "3000000", "maxMinerFee": "1000000", "ergIn": true, "amountIn": "1000000000", "minOutput": "29974258", "amountX": "5000000000", "amountY": "152000000", "minShares": "1170587", "ownerNFT": "a1f4c2e8b7d93052416fbc8e07d21935a8c4f60b2e91d7385c06a4b1f2e83d97", "provisionBoxId": "ce00d6e0f4fd3390c0519bb0d24824e1e6b06978163f4845a7cf2c1c7d8f1b65", "fillableNow": true }, "claimedX": "253000000", "claimedY": "7690000" }