Taker APIs

KyberSwap Limit Order Taker APIs

Download OpenAPI specification:

51KB

Limit-Order-APIs.yaml

Taker APIs

Get orders for taker

This API is used by partners / takers to get orders to fill. This API returns a limited number of orders, sorted by rate desc. Note: rate = ((making_amount - filled_making_amount) * (1 - maker_token_fee_percent) * maker_asset_price_usd - gas_usd) / ((taking_amount - filled_taking_amount) * taker_asset_price_usd)

GEThttps://limit-order.kyberswap.com/read-partner/api/v1/orders

Query parameters

Response

200400500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/read-partner/api/v1/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "orders": [
        {
          "id": 0,
          "chainId": "string",
          "salt": "string",
          "signature": "string",
          "makerAsset": "string",
          "takerAsset": "string",
          "maker": "string",
          "receiver": "string",
          "allowedSenders": "string",
          "makingAmount": "string",
          "takingAmount": "string",
          "filledMakingAmount": "string",
          "filledTakingAmount": "string",
          "feeRecipient": "string",
          "makerTokenFeePercent": "string",
          "makerAssetData": "string",
          "takerAssetData": "string",
          "getMakerAmount": "string",
          "getTakerAmount": "string",
          "predicate": "string",
          "permit": "string",
          "interaction": "string",
          "expiredAt": 0
        }
      ]
    }
  }
}

Generate encoded data for fillOrderTo() method

Generate encoded data for fillOrderTo() method

POSThttps://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-order-to

Body

application/json

orderId*integer

takingAmount*string

Format: uint256

thresholdAmount*string

If thresholdAmount != 0, the order will be filled if and only if (actualTakingAmount / actualMakingAmount) <= (thresholdAmount / requestedMakingAmount)

target*string

The wallet address who will be received maker asset

Response

200400404500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-order-to', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderId": 1,
      "takingAmount": "100000000000000000",
      "thresholdAmount": "0",
      "target": "0x123456"
    }),
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "encodedData": "string"
    }
  }
}

Generate encoded data for fillBatchOrdersTo() method

POSThttps://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-batch-orders-to

Body

application/json

orderIds*array of integer

takingAmount*string

Format: uint256

thresholdAmount*string

Format: uint256

target*string

Response

200400404409500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-batch-orders-to', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "orderIds": [
        1,
        2,
        3
      ],
      "takingAmount": "1000000000000000000",
      "thresholdAmount": "0",
      "target": "0x123456"
    }),
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "encodedData": "string"
    }
  }
}

Get current supported pairs of a specific chain

GEThttps://limit-order.kyberswap.com/read-partner/api/v1/orders/pairs

Query parameters

Response

200400500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/read-partner/api/v1/orders/pairs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "pairs": [
        {
          "makerAsset": "string",
          "takerAsset": "string"
        }
      ]
    }
  }
}