📗API

For a more comprehensive protocol support and enhanced position and market information, we recommend using the Lending SDK.

GitHub

https://github.com/dinngo/compound-kit-api

API Server

https://compound-kit-api.protocolink.com

Swagger Docs

https://compound-kit-api.protocolink.com/docs

Returns the current version of the API

GEThttps://compound-kit-api.protocolink.com/status

Response

200

OK

Body

application/json

versionstring

Example: "0.1.3"

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version": "0.1.3"
}

List multi-chain markets

GEThttps://compound-kit-api.protocolink.com/v1/markets

Response

200

OK

Body

application/json

marketGroupsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/markets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "marketGroups": [
    {
      "chainId": 137,
      "markets": [
        {
          "id": "USDC",
          "label": "USDC"
        }
      ]
    }
  ]
}

Get market information and position for an optional account

GEThttps://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}

Path parameters

chainId*integer

Example: 137

Example: 137

marketId*string

Example: usdc

Example: "usdc"

Query parameters

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the estimated post-deleverage position

POSThttps://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/deleverage

Path parameters

chainId*integer

Example: 137

Example: 137

marketId*string

Example: usdc

Example: "usdc"

Body

application/json

account*string

Example: "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"

collateralTokenTokenWETH (object)

baseAmountstring

Example: "1000"

slippageinteger

Example: 100

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/deleverage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"
    }),
});
const data = await response.json();

List supported tokens for zaps

GEThttps://compound-kit-api.protocolink.com/v1/{chainId}/zap-tokens

Path parameters

chainId*integer

Example: 137

Example: 137

Response

200

OK

Body

application/json

tokensarray of TokenUSDC (object)

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/{chainId}/zap-tokens', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "tokens": [
    {
      "chainId": 137,
      "address": "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
      "decimals": 6,
      "symbol": "USDC",
      "name": "USD Coin"
    }
  ]
}

Get the estimated post-zap-repay

POSThttps://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/zap-repay

Path parameters

chainId*integer

Example: 137

Example: 137

marketId*string

Example: usdc

Example: "usdc"

Query parameters

Body

application/json

account*string

Example: "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"

srcTokenTokenMATIC (object)

srcAmountstring

Example: "10"

slippageinteger

Example: 100

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/zap-repay', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"
    }),
});
const data = await response.json();

Get the estimated post-zap-borrow

POSThttps://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/zap-borrow

Path parameters

chainId*integer

Example: 137

Example: 137

marketId*string

Example: usdc

Example: "usdc"

Body

application/json

account*string

Example: "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"

srcAmountstring

Example: "100"

destTokenTokenMATIC (object)

slippageinteger

Example: 100

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://compound-kit-api.protocolink.com/v1/markets/{chainId}/{marketId}/zap-borrow', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account": "0x0FBeABcaFCf817d47E10a7bCFC15ba194dbD4EEF"
    }),
});
const data = await response.json();