Liquidity API

Build transactions that interact with THORChain's liquidity

PreviousLending API NextQuote API

Last updated 1 year ago

Was this helpful?

Add asymmetric asset liquidity

Endpoint to get transaction memo for adding asym asset liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/add/asym_asset

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

assetTxDataobject

Transaction data for asset.

estimatedSharestring

Estimated share of the pool user will have after transaction

slippageobject

Slippage information for transaction

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/add/asym_asset?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "assetTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "router": "text",
    "estimatedTime": "text"
  },
  "estimatedShare": "text",
  "slippage": {
    "assetAmount": "text",
    "baseAmount": "text",
    "decimal": 1
  }
}

Add symmetrical liquidity

Endpoint to get transaction memo for adding sym liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/add/sym

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

assetTxDataobject

Transaction data for asset.

runeTxDataobject

transaction data for Rune. (one of the response object for add liquidity memo)

estimatedSharestring

Estimated share of the pool user will have after transaction

slippageobject

Slippage information for transaction

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/add/sym?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&runeAmount=1&thorAddress=text&assetAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "assetTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "router": "text",
    "estimatedTime": "text"
  },
  "runeTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "estimatedTime": "text"
  },
  "estimatedShare": "text",
  "slippage": {
    "assetAmount": "text",
    "baseAmount": "text",
    "decimal": 1
  }
}

Add symmetrical asset liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/add/sym_asset

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

assetTxDataobject

Transaction data for asset.

estimatedSharestring

Estimated share of the pool user will have after transaction

slippageobject

Slippage information for transaction

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/add/sym_asset?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "assetTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "router": "text",
    "estimatedTime": "text"
  },
  "estimatedShare": "text",
  "slippage": {
    "assetAmount": "text",
    "baseAmount": "text",
    "decimal": 1
  }
}

Add symmetrical rune liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/add/sym_rune

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

runeTxDataobject

transaction data for Rune. (one of the response object for add liquidity memo)

estimatedSharestring

Estimated share of the pool user will have after transaction

slippageobject

Slippage information for transaction

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/add/sym_rune?asset=text&affiliateAddress=text&affiliateBasisPoints=1&runeAmount=1&thorAddress=text&assetAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "runeTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "estimatedTime": "text"
  },
  "estimatedShare": "text",
  "slippage": {
    "assetAmount": "text",
    "baseAmount": "text",
    "decimal": 1
  }
}

Add symmetrical single sided asset liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/add/single_sided

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

runeTxDataobject

Transaction data for asset.

estimatedSharestring

Estimated share of the pool user will have after transaction

slippageobject

Slippage information for transaction

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/add/single_sided?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "runeTxData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "router": "text",
    "estimatedTime": "text"
  },
  "estimatedShare": "text",
  "slippage": {
    "assetAmount": "text",
    "baseAmount": "text",
    "decimal": 1
  }
}

Withdraw Liquidity memo

Endpoint to get transaction memo for withdrawing liquidity

GEThttps://dev-api.thorswap.net/aggregator/liquidity/withdraw

Query parameters

Response

A complete response required to build asset and/or rune transactions.

Body

txDataobject

Transaction data for asset.

Request

const response = await fetch('https://dev-api.thorswap.net/aggregator/liquidity/withdraw?asset=text&positionType=sym_rune&withdrawType=asset&percent=1', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "txData": {
    "assetAmount": 1,
    "recipient": "text",
    "memo": "text",
    "feeRate": 1,
    "router": "text",
    "estimatedTime": "text"
  }
}