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. </br> This API returns a limited number of orders, sorted by rate desc.</br> Note: </br> 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)

get

/read-partner/api/v1/orders

Query parameters

chainIdstringrequired

makerAssetstringrequired

takerAssetstringrequired

ratenumber · float

Used to filter orders, only orders having rate greater than or equal are returned

gasUSDnumber

Gas in USD used to calculate rate of orders. If gasUSD is equal to 0 or null, server will calculate gasUSD by itself.

makerAssetPriceUSDnumber

Maker asset's price in USD used to calculate rate of orders. If makerAssetPriceUSD is equal to 0 or null, server will calculate makerAssetPriceUSD by itself.

takerAssetPriceUSDnumber

Taker asset's price in USD used to calculate rate of orders. If takerAssetPriceUSD is equal to 0 or null, server will calculate takerAssetPriceUSD by itself.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://limit-order.kyberswap.com/read-partner/api/v1/orders?chainId=text&makerAsset=text&takerAsset=text'

200

400

500

200

{
  "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
        }
      ]
    }
  }
}

OK

Generate encoded data for fillOrderTo() method

Generate encoded data for fillOrderTo() method

post

/read-partner/api/v1/encode/fill-order-to

Body

orderIdintegerrequired

takingAmountstringrequired

Format: uint256

thresholdAmountstringrequired

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

targetstringrequired

The wallet address who will be received maker asset

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-order-to' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderId": 1,
    "takingAmount": "100000000000000000",
    "thresholdAmount": "0",
    "target": "0x123456"
  }'

200

400

404

500

200

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

OK

Generate encoded data for fillBatchOrdersTo() method

post

/read-partner/api/v1/encode/fill-batch-orders-to

Body

orderIdsinteger[]required

takingAmountstringrequired

Format: uint256

thresholdAmountstringrequired

Format: uint256

targetstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://limit-order.kyberswap.com/read-partner/api/v1/encode/fill-batch-orders-to' \
  --header 'Content-Type: application/json' \
  --data '{
    "orderIds": [
      1,
      2,
      3
    ],
    "takingAmount": "1000000000000000000",
    "thresholdAmount": "0",
    "target": "0x123456"
  }'

200

400

404

409

500

200

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

OK

Get current supported pairs of a specific chain

get

/read-partner/api/v1/orders/pairs

Query parameters

chainIdstringrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://limit-order.kyberswap.com/read-partner/api/v1/orders/pairs?chainId=text'

200

400

500

200

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

OK