Limit orders

​

The model

​

Price direction

​

Reference price

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Not exist reference price for this pair FOOZZ/BARZZ",
    "details": [
      {
        "message": "Not exist pair for create limit order, you must be select a new pair (Not possible create limit order, you must be select a new pair | > Error => Could not recover data of contract)"
      }
    ]
  },
  "meta": {
    "requestId": "EdkfSjF0IAMEPEg=",
    "version": "v1",
    "accountType": "integrator",
    "apiKeyId": "00000000-0000-4000-8000-000000000000"
  }
}

• Send each token’s real symbol in tokenASymbol (the token you sell) and tokenBSymbol (the token you buy). Olympex doesn’t check them against the token contracts. Read symbol() from each token contract, or take the symbol from GET /tokens by address, trimmed and without a trailing _<number>: the list tells duplicate symbols apart with suffixes such as STRK_1, so send STRK.
• Responses can return a normalized symbol: WETH becomes ETH, WBNB becomes BNB and WPOL becomes POL. The addresses are returned as you sent them.
• Check the symbols in the response. Olympex accepts a real but wrong symbol, such as WBTC on a WETH order, and then prices the order from that token’s market. Cancel an order whose symbols match neither your tokens’ symbols nor their normalized forms.
• The same error can occur when Olympex can’t reach its price data at that moment. If you’re sure of the pair and the symbols, retry later with backoff before you rule the pair out.

​

Lifecycle

​

Expiry

​

Update a pending order

​

Cancel a pending order

​

List your orders

• It ignores any other query parameter, so a misspelt filter returns every order. Send each parameter once: a repeated parameter matches nothing.
• The list returns only orders created with your API key, including cancelled ones. An order ID from another API key returns 404 NOT_FOUND.
• It is unsorted and unpaginated: sort by createdAt yourself.
• accountTo is stored exactly as you sent it, and ?accountTo= matches case-sensitively. Send the EIP-55 checksummed form everywhere.

​

Creating an order is not safe to repeat

​

Funds and fees

• Nothing moves at creation. The tokens stay in the maker’s wallet, and nothing is reserved. The wallet must still hold amount and the allowance when the order executes, or it can’t execute.
• At execution, Olympex pulls amount of inTokenAddress from accountTo through the Olympex order contract, swaps it, and sends all the output to accountTo.
• Gas is reimbursed in the token sold. Olympex pays the execution gas and is reimbursed from accountTo in inTokenAddress, as a second transfer. The maker needs no native token for the execution, only for its own approvals.
• The reimbursement is the real gas cost. It is the execution transaction’s gas used times its actual gas price, converted to inTokenAddress. The order’s gasPrice isn’t a cap: neither the API nor the order contract enforces it.
• So the allowance must cover amount plus the gas cost in inTokenAddress. Estimate that cost with a single-chain POST /quotes and "includeGasInfo": true: dataFeeTransaction.transactionFeeInToken is the estimate, and valueToApprove is amount plus it. Size the allowance from that estimate plus a generous buffer, not from gasPrice: the estimate leaves out the Olympex contracts, and gas prices move before the order executes. See Gas and fees.

​

What can’t be sold

​

What this means for your integration

• Express priceTrigger in units of the token you buy per 1 token you sell, and send amount as a human-readable string.
• Sign the pair once, and keep the allowance at amount plus the gas estimate and a buffer, summed over every open order that sells the token.
• Send the tokens’ real symbols and check the ones the create call returns. Poll GET /limit-order/{id}, and treat unknown statuses as not final.
• Never retry a create call blindly: list your orders and match first.

​

Related