Maker APIs

KyberSwap Limit Order Maker APIs

Download OpenAPI specification:

51KB

Limit-Order-APIs.yaml

Maker APIs

Create New Order

API to create new order for partners/makers

POSThttps://limit-order.kyberswap.com/write/api/v1/orders

Body

application/json

chainId*string

Support only EVM compatible blockchains.

makerAsset*string

The address of the token you want to sell.

takerAsset*string

The address of the token you want to buy

maker*string

The address of the maker, and signer, of this order.

receiverstring

Address which will receive takerAsset from taker. Default: equal to maker

allowedSendersarray of string

Allowed addresses to call LimitOrder() function. These addresses is the same as taker

makingAmount*string

The amount of makerToken being sold by the maker. Format: uint256

takingAmount*string

The amount of takerToken being sold by the taker Format: uint256

feeRecipientstring

Recipient of maker token or taker token fees (if non-zero)

makerTokenFeePercentstring

Amount of makerToken paid by the taker to the feeRecipient. For example, 20% = 0.2 -> makerTokenFeePercent = 0.2 * 10000 = 2000 Format: uint32

expiredAt*integer

Timestamp in seconds

salt*string

The salt of order - returned from Get signing order message API

signature*string

Signed by maker

Response

200400500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "5",
      "makerAsset": "0x1a30c9ed6436e03d506227a362b2cbf59a303967",
      "takerAsset": "0x4f6519025e6de0edb6e4901827c1956ce18c39d3",
      "maker": "0xef09879057a9ad798438f3ba561bcdd293d72fc7",
      "receiver": "",
      "allowedSenders": [],
      "makingAmount": "3000000000000000000",
      "takingAmount": "6000000000000000000",
      "feeRecipient": "",
      "takerTokenFeeAmount": "",
      "expiredAt": 1672200257,
      "salt": "123456",
      "signature": "d8ebe9440b60ca3414053d4f46e7f13cb9b0326395387bf86ed027b5adec883f6f63b52e31e1137ddfd211e4689932b37e4b2273066539a91cf43b064fc74df31c"
    }),
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "id": 1
    }
  }
}

Get current active making amount

Get total making amount of a maker which is able to be sold to takers

GEThttps://limit-order.kyberswap.com/read-ks/api/v1/orders/active-making-amount

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-ks/api/v1/orders/active-making-amount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "activeMakingAmount": "1000000000000000000"
    }
  }
}

Get list of order for makers

GEThttps://limit-order.kyberswap.com/read-ks/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-ks/api/v1/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "orders": [
        {
          "id": 0,
          "chainId": "string",
          "nonce": 0,
          "makerAsset": "string",
          "takerAsset": "string",
          "makerAssetSymbol": "string",
          "takerAssetSymbol": "string",
          "makerAssetDecimals": 0,
          "takerAssetDeicmals": 0,
          "makerAssetLogoURL": "string",
          "takerAssetLogoURL": "string",
          "makingAmount": "string",
          "takingAmount": "string",
          "filledMakingAmount": "string",
          "filledTakingAmount": "string",
          "status": "string",
          "createdAt": 0,
          "expiredAt": 0,
          "transactions": [
            {
              "id": 0,
              "txHash": "string",
              "txTime": 0,
              "makingAmount": "string",
              "takingAmount": "string"
            }
          ]
        }
      ],
      "pagination": {
        "totalItems": 1
      }
    }
  }
}

Get signing order message

Get signing message to sign to create order. The response of this API will be used when signing order with Sign Typed Data v4 before Creating New Order API

POSThttps://limit-order.kyberswap.com/write/api/v1/orders/sign-message

Body

application/json

chainId*string

makerAsset*string

takerAsset*string

maker*string

receiverstring

Defines who will be received token when the order is filled Default: equal to maker

allowedSendersarray of string

Defines who will be able to fill the order

makingAmount*string

takingAmount*string

feeRecipientstring

makerTokenFeePercentstring

Amount of makerToken paid by the taker to the feeRecipient. For example, 20% = 0.2 -> makerTokenFeePercent = 0.2 * 10000 = 2000 Format: uint32

expiredAt*integer

Timestamp in seconds

Response

200400500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/orders/sign-message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "text",
      "makerAsset": "text",
      "takerAsset": "text",
      "maker": "text",
      "makingAmount": "text",
      "takingAmount": "text"
    }),
});
const data = await response.json();

Response

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "types": {
        "EIP712Domain": [
          {
            "name": "name",
            "type": "string"
          },
          {
            "name": "version",
            "type": "string"
          },
          {
            "name": "chainId",
            "type": "uint256"
          },
          {
            "name": "verifyingContract",
            "type": "address"
          }
        ],
        "Order": [
          {
            "name": "salt",
            "type": "uint256"
          },
          {
            "name": "makerAsset",
            "type": "address"
          },
          {
            "name": "takerAsset",
            "type": "address"
          },
          {
            "name": "maker",
            "type": "address"
          },
          {
            "name": "receiver",
            "type": "address"
          },
          {
            "name": "allowedSender",
            "type": "address"
          },
          {
            "name": "makingAmount",
            "type": "uint256"
          },
          {
            "name": "takingAmount",
            "type": "uint256"
          },
          {
            "name": "feeRecipient",
            "type": "address"
          },
          {
            "name": "makerTokenFeePercent",
            "type": "uint32"
          },
          {
            "name": "makerAssetData",
            "type": "bytes"
          },
          {
            "name": "takerAssetData",
            "type": "bytes"
          },
          {
            "name": "getMakerAmount",
            "type": "bytes"
          },
          {
            "name": "getTakerAmount",
            "type": "bytes"
          },
          {
            "name": "predicate",
            "type": "bytes"
          },
          {
            "name": "permit",
            "type": "bytes"
          },
          {
            "name": "interaction",
            "type": "bytes"
          }
        ]
      },
      "domain": {
        "name": "Kyber Limit Order Protocol",
        "version": "2",
        "chainId": "5",
        "verifyingContract": "0x973B1847407C579a58E610e5f12003996C5a4f16"
      },
      "primaryType": "Order",
      "message": {
        "salt": "40222148808882531",
        "makerAsset": "0x4f6519025e6de0edb6e4901827c1956ce18c39d3",
        "takerAsset": "0x1a30c9ed6436e03d506227a362b2cbf59a303967",
        "maker": "0xef09879057a9ad798438f3ba561bcdd293d72fc7",
        "receiver": "0xef09879057a9ad798438f3ba561bcdd293d72fc7",
        "allowedSender": "0x0000000000000000000000000000000000000000",
        "makingAmount": "500000000000000000000",
        "takingAmount": "300000000000000000000",
        "feeRecipient": "0x0000000000000000000000000000000000000000",
        "makerTokenFeePercent": "0",
        "makerAssetData": "",
        "takerAssetData": "",
        "getMakerAmount": "f4a215c300000000000000000000000000000000000000000000001b1ae4d6e2ef50000000000000000000000000000000000000000000000000001043561a8829300000",
        "getTakerAmount": "296637bf00000000000000000000000000000000000000000000001b1ae4d6e2ef50000000000000000000000000000000000000000000000000001043561a8829300000",
        "predicate": "961d5b1e000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000000020000000000000000000000002892e28b58ab329741f27fd1ea56dca0192a38840000000000000000000000002892e28b58ab329741f27fd1ea56dca0192a38840000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000044cf6fc6e3000000000000000000000000ef09879057a9ad798438f3ba561bcdd293d72fc7000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002463592c2b00000000000000000000000000000000000000000000000000000000636c96e900000000000000000000000000000000000000000000000000000000",
        "permit": "",
        "interaction": ""
      }
    }
  }
}

Generate encoded data for increaseNonce() method

increaseNonce() method can be used to cancel all your orders

POSThttps://limit-order.kyberswap.com/write/api/v1/encode/increase-nonce

Response

200500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/encode/increase-nonce', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

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

Generate encoded data for cancelBatchOrders() method

POSThttps://limit-order.kyberswap.com/write/api/v1/encode/cancel-batch-orders

Body

application/json

orderIds*array of integer

Response

200400404409500

OK

Body

application/json

code*integer

message*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/encode/cancel-batch-orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": {
        "orderIds": [
          1,
          2
        ]
      }
    }),
});
const data = await response.json();

Response

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