Maker APIs

KyberSwap Limit Order Maker APIs

Download OpenAPI specification:

98KB

LimitOrderAPIs_v1.2.yaml

Maker APIs

API statuses and support

KyberSwap APIs uses the following statuses to minimize version miscommunications and ensure an uninterrupted service for the end user:

• Latest: API is functional and supported. This is the recommended version for all integrators (new and existing).

• Legacy: API remains functional with support for bugs only. No new feature updates.

• Deprecated: API is no longer functional and is not supported.

For all developers, it is highly recommended that you refer to the API with the Latest tag to ensure access to the latest features as well as improved service quality and efficiency. APIs which are planned to be sunset will be tagged Legacy during the transition period and thereafter moved to Deprecated.

The KyberSwap Docs will continue to maintain information regarding Legacy and Deprecated APIs.

Latest

Create Order(s)

Developer Guide

Please refer to Create Limit Order for the relevant sequence diagram as well as a TypeScript example.

Get Unsigned Create Order Message

Get EIP712 create order message to be signed. The response of this API will need to be signed with Sign Typed Data v4 before submitting create order request to KyberSwap via /write/api/v1/orders.

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

Body

application/json

chainId*string

The chainId on which the order is being created. Only supports EVM chains.

makerAsset*string

The token address of the asset which the Maker is selling.

takerAsset*string

The token address of the asset which the Maker expects in return.

maker*string

The address of the Maker.

receiverstring

Defines who will receive the takerAsset when the order is filled. Default: maker.

allowedSendersarray of string

Defines the addresses who are allowed to fill the order.

makingAmount*string

The amount of makerAsset in wei. String representation of uint256 value.

takingAmount*string

The amount of takerAsset in wei. String representation of uint256 value.

feeRecipientstring

The address to receive the fees, if any. Fees are configured in makerTokenFeePercent.

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

The unix timestamp upon which the order will automatically lapse (i.e. expire).

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

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": "137",
      "makerAsset": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "takerAsset": "0x1c954e8fe737f99f68fa1ccda3e51ebdb291948c",
      "maker": "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7",
      "allowedSenders": [
        "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7"
      ],
      "makingAmount": "10000",
      "takingAmount": "20000000000000000",
      "expiredAt": 1697690051
    }),
});
const data = await response.json();

Response

200400500

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "types": {
        "DSOrder": [
          {
            "name": "orderHash",
            "type": "bytes32"
          },
          {
            "name": "opExpireTime",
            "type": "uint32"
          }
        ],
        "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": "feeConfig",
            "type": "uint256"
          },
          {
            "name": "makerAssetData",
            "type": "bytes"
          },
          {
            "name": "takerAssetData",
            "type": "bytes"
          },
          {
            "name": "getMakerAmount",
            "type": "bytes"
          },
          {
            "name": "getTakerAmount",
            "type": "bytes"
          },
          {
            "name": "predicate",
            "type": "bytes"
          },
          {
            "name": "interaction",
            "type": "bytes"
          }
        ]
      },
      "domain": {
        "name": "Kyber Limit Order Protocol",
        "version": "2",
        "chainId": "5",
        "verifyingContract": "0x973B1847407C579a58E610e5f12003996C5a4f16"
      },
      "primaryType": "Order",
      "message": {
        "allowedSender": "0x2bfc3a4ef52fe6cd2c5236da08005c59eafb43a7",
        "feeConfig": "73529011378642731556159749336395186902652258478889",
        "getMakerAmount": "0xf4a215c3000000000000000000000000000000000000000000000000000000000000271000000000000000000000000000000000000000000000000000470de4df820000",
        "getTakerAmount": "0x296637bf000000000000000000000000000000000000000000000000000000000000271000000000000000000000000000000000000000000000000000470de4df820000",
        "interaction": "0x",
        "maker": "0x2bfc3a4ef52fe6cd2c5236da08005c59eafb43a7",
        "makerAsset": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
        "makerAssetData": "0x",
        "makingAmount": "10000",
        "predicate": "0x961d5b1e000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000002000000000000000000000000cab2fa2eeab7065b45cbcf6e3936dde2506b4f6c000000000000000000000000cab2fa2eeab7065b45cbcf6e3936dde2506b4f6c0000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000044cf6fc6e30000000000000000000000002bfc3a4ef52fe6cd2c5236da08005c59eafb43a7000000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002463592c2b0000000000000000000000000000000000000000000000000000000065308b6d00000000000000000000000000000000000000000000000000000000",
        "receiver": "0x2bfc3a4ef52fe6cd2c5236da08005c59eafb43a7",
        "salt": "108360087403015833110619993432889154326",
        "takerAsset": "0x1c954e8fe737f99f68fa1ccda3e51ebdb291948c",
        "takerAssetData": "0x",
        "takingAmount": "20000000000000000"
      }
    }
  }
}

Create New Order

API for Makers to create new orders by sending in order params which includes the signed EIP712 message returned in /write/api/v1/orders/sign-message.

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

Body

application/json

chainId*string

The chainId on which the order is being created. Only supports EVM chains.

makerAsset*string

The token address of the asset which the Maker is selling.

takerAsset*string

The token address of the asset which the Maker expects in return.

maker*string

The address of the Maker.

receiverstring

Defines who will receive the takerAsset when the order is filled. Default: maker.

allowedSendersarray of string

Defines the addresses who are allowed to fill the order.

makingAmount*string

The amount of makerAsset in wei. String representation of uint256 value.

takingAmount*string

The amount of takerAsset in wei. String representation of uint256 value.

feeRecipientstring

The address to receive the fees, if any. Fees are configured in makerTokenFeePercent.

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

The unix timestamp upon which the order will automatically lapse (i.e. expire).

salt*string

The randomized data fed as an additional input to the hashing function. Returned in /write/api/v1/orders/sign-message.

signature*string

The signed(signDataTyped) EIP712 creation order returned in /write/api/v1/orders/sign-message.

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/orders', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "137",
      "makerAsset": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
      "takerAsset": "0x1c954e8fe737f99f68fa1ccda3e51ebdb291948c",
      "maker": "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7",
      "allowedSenders": [
        "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7"
      ],
      "makingAmount": "10000",
      "takingAmount": "20000000000000000",
      "expiredAt": 1697683411,
      "salt": "235124343165545613944116882191476069603",
      "signature": "0xff25fe292d922e7a28b4b84919d2709b8b01a4d2cd4d5ee2335b227dbaa13e1f789d861e1cbb1153e251d839651490276bae2324266f3107c1ade2137c6b4c301b"
    }),
});
const data = await response.json();

Response

200400500

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

Query Maker Order(s)

Get List Of Orders By Maker

Get all orders created by a Maker address filtered by the order status.

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

Query parameters

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://limit-order.kyberswap.com/read-ks/api/v1/orders?chainId=text&maker=text&status=active', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "code": 0,
  "message": "Successfully",
  "data": {
    "orders": [
      {
        "id": "22385,",
        "chainId": "137",
        "nonce": "3,",
        "makerAsset": "0x2791bca1f2de4661ed88a30c99a7a9449aa84174",
        "takerAsset": "0x1c954e8fe737f99f68fa1ccda3e51ebdb291948c",
        "contractAddress": "0xcab2fa2eeab7065b45cbcf6e3936dde2506b4f6c",
        "orderHash": "57e2bec735db51269aff31b60f4a02f8bd2ef2e554c1433bbd0aea914c378f3a",
        "makerAssetSymbol": "USDC.e",
        "takerAssetSymbol": "KNC",
        "makerAssetLogoURL": "https://assets.coingecko.com/coins/images/6319/large/USD_Coin_icon.png",
        "takerAssetLogoURL": "https://storage.googleapis.com/ks-setting-1d682dca/9e796f57-482a-426d-904d-007a6adf22fb.png",
        "makerAssetDecimals": 6,
        "takerAssetDecimals": 18,
        "makingAmount": "10000",
        "takingAmount": "20000000000000000",
        "filledMakingAmount": "0",
        "filledTakingAmount": "0",
        "status": "open",
        "createdAt": 1697679812,
        "expiredAt": 1697683411,
        "operatorSignatureExpiredAt": 0,
        "transactions": []
      }
    ],
    "pagination": {
      "totalItems": 1
    }
  }
}

Get Maker Active Making Amount

Get the Maker's total making amount for a specified token.

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

Query parameters

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://limit-order.kyberswap.com/read-ks/api/v1/orders/active-making-amount?chainId=text&makerAsset=text&maker=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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

Gasless Cancel Order(s)

Developer Guide

Please refer to Gasless Cancel for the relevant sequence diagram as well as a TypeScript example.

Get Unsigned Cancel Order(s) Message

Get EIP712 cancel order message to be signed (i.e. 'Gasless Cancel'). The response of this API will need to be signed with Sign Typed Data v4 before submitting create order request to KyberSwap via /write/api/v1/orders/cancel.

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

Body

application/json

chainId*string

The chainId on which the order is being created. Only supports EVM chains.

maker*string

The address of the Maker that created the order.

orderIds*array of integer

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/orders/cancel-sign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "137",
      "maker": "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7",
      "orderIds": [
        22393
      ]
    }),
});
const data = await response.json();

Response

200400500

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "types": {
        "EIP712Domain": [
          {
            "name": "name",
            "type": "string"
          },
          {
            "name": "version",
            "type": "string"
          },
          {
            "name": "chainId",
            "type": "uint256"
          },
          {
            "name": "verifyingContract",
            "type": "address"
          }
        ],
        "CancelOrder": [
          {
            "name": "chainId",
            "type": "string"
          },
          {
            "name": "maker",
            "type": "address"
          },
          {
            "name": "orderIds",
            "type": "uint64[]"
          }
        ]
      },
      "domain": {
        "name": "Kyber Limit Order Protocol",
        "version": "1",
        "chainId": "137"
      },
      "primaryType": "CancelOrder",
      "message": {
        "chainId": "137",
        "maker": "0x2bfc3a4ef52fe6cd2c5236da08005c59eafb43a7",
        "orderIds": [
          22393
        ]
      }
    }
  }
}

Submit Gasless Cancel Order(s)

API for Makers to gaslessly cancel orders by sending in order params which includes the signed EIP712 message returned in /write/api/v1/orders/cancel-sign.

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

Header parameters

Body

application/json

chainId*string

The chainId on which the order is being cancelled. Only supports EVM chains.

maker*string

The address of the Maker that created the order.

orderIds*array of integer

The order IDs to be cancelled gaslessly.

signature*string

The signed(signDataTyped) EIP712 cancellation order returned in /write/api/v1/orders/cancel-sign.

Response

200400500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

const response = await fetch('https://limit-order.kyberswap.com/write/api/v1/orders/cancel', {
    method: 'POST',
    headers: {
      "Origin": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chainId": "137",
      "maker": "0x2bfc3A4Ef52Fe6cD2c5236dA08005C59EaFB43a7",
      "orderIds": [
        22405
      ],
      "signature": "0xc888d70ebd240e95dc2af556c8002bb8ad92c3e34f6c037e496779d06e778ede53b76399fdacdb812fc0bc3eb7a429ae0b1bdfeabf052f212f732daea628beaa1c"
    }),
});
const data = await response.json();

Response

200400500

{
  "value": {
    "code": 0,
    "message": "Successfully",
    "data": {
      "orders": [
        {
          "id": 22404,
          "chainId": "137",
          "operatorSignatureExpiredAt": 0
        }
      ]
    }
  }
}

Hard Cancel Order(s)

Developer Guide

Please refer to Hard Cancel for the relevant sequence diagram as well as a TypeScript example.

Generate Encoded Data For Batch Cancellation

Request for the cancellation encoded data from KyberSwap. This data can then be executed on-chain from the signer's wallet.

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

Body

application/json

orderIds*array of integer

The order IDs to be cancelled on-chain.

Response

200400404409500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

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

Response

200400404409500

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

Generate Encoded Data For Cancel All

Request for the cancel all encoded data from KyberSwap. By increasing the LO contract nonce tied to the Maker, the LO contract is able to nullify all existing orders. This data can then be executed on-chain from the Maker's wallet.

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

Response

200500

OK

Body

application/json

code*integer

The response code.

message*string

Server response message.

data*object

Request

JavaScriptCurlPython

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

Response

200500

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