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

get

/aggregator/liquidity/add/asym_asset

Query parameters

assetstringrequired

Token to provide liquidity (e.g. ETH.ETH)

affiliateAddressstringrequired

The affiliate address that would receive the fee. (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

affiliateBasisPointsintegerrequired

Basis point to take from the trade (e.g. 50 for 0.5%), should be within 1-10000 range

assetAmountintegerrequired

Amount of asset to add (e.g 15.5)

thorAddressstringrequired

Thorchain Address (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

assetAddressstringrequired

Asset Address (e.g. 0x991A9B64805260c02702B3bCDF8c269dA98563aB)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/add/asym_asset?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text'

200

400

500

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

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

Add symmetrical liquidity

Endpoint to get transaction memo for adding sym liquidity

get

/aggregator/liquidity/add/sym

Query parameters

assetstringrequired

Token to provide liquidity (e.g. ETH.ETH)

affiliateAddressstringrequired

The affiliate address that would receive the fee. (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

affiliateBasisPointsintegerrequired

Basis point to take from the trade (e.g. 50 for 0.5%), should be within 1-10000 range

assetAmountintegerrequired

Amount of asset to add (e.g 15.5), can be omitted if runeAmount is provided,then assetAmount will be calculated using runeAmount

runeAmountintegerrequired

Amount of asset to add (e.g 1000), can be omitted if assetAmount is provided,then runeAmount will be calculated using assetAmount

thorAddressstringrequired

Thorchain Address (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

assetAddressstringrequired

Asset Address (e.g. 0x991A9B64805260c02702B3bCDF8c269dA98563aB)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/add/sym?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&runeAmount=1&thorAddress=text&assetAddress=text'

200

400

500

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

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

Add symmetrical asset liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

get

/aggregator/liquidity/add/sym_asset

Query parameters

assetstringrequired

Token to provide liquidity (e.g. ETH.ETH)

affiliateAddressstringrequired

The affiliate address that would receive the fee. (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

affiliateBasisPointsintegerrequired

Basis point to take from the trade (e.g. 50 for 0.5%), should be within 1-10000 range

assetAmountintegerrequired

Amount of asset to add (e.g 15.5)

thorAddressstringrequired

Thorchain Address (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

assetAddressstringrequired

Asset Address (e.g. 0x991A9B64805260c02702B3bCDF8c269dA98563aB)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/add/sym_asset?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text'

200

400

500

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

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

Add symmetrical rune liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

get

/aggregator/liquidity/add/sym_rune

Query parameters

assetstringrequired

Token to provide liquidity (e.g. ETH.ETH)

affiliateAddressstringrequired

The affiliate address that would receive the fee. (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

affiliateBasisPointsintegerrequired

Basis point to take from the trade (e.g. 50 for 0.5%), should be within 1-10000 range

runeAmountintegerrequired

Amount of rune to add (e.g 15.5)

thorAddressstringrequired

Thorchain Address (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

assetAddressstringrequired

Asset Address (e.g. 0x991A9B64805260c02702B3bCDF8c269dA98563aB)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/add/sym_rune?asset=text&affiliateAddress=text&affiliateBasisPoints=1&runeAmount=1&thorAddress=text&assetAddress=text'

200

400

500

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

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

Add symmetrical single sided asset liquidity

Endpoint to get transaction memo for adding symmetrical asset liquidity

get

/aggregator/liquidity/add/single_sided

Query parameters

assetstringrequired

Token to provide liquidity (e.g. ETH.ETH)

affiliateAddressstringrequired

The affiliate address that would receive the fee. (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

affiliateBasisPointsintegerrequired

Basis point to take from the trade (e.g. 50 for 0.5%), should be within 1-10000 range

assetAmountintegerrequired

Amount of asset to add (e.g 15.5)

thorAddressstringrequired

Thorchain Address (e.g. thor160yye65pf9rzwrgqmtgav69n6zlsyfpgm9a7xk)

assetAddressstringrequired

Asset Address (e.g. 0x991A9B64805260c02702B3bCDF8c269dA98563aB)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/add/single_sided?asset=text&affiliateAddress=text&affiliateBasisPoints=1&assetAmount=1&thorAddress=text&assetAddress=text'

200

400

500

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

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

Withdraw Liquidity memo

Endpoint to get transaction memo for withdrawing liquidity

get

/aggregator/liquidity/withdraw

Query parameters

assetstringrequired

Token to provide liquidity (e.g. BTC.BTC)

positionTypestring · enumrequired

type of position

Options: sym_rune, sym_asset, sym, asym_asset, single_sided

withdrawTypestring · enumrequired

type of withdraw

Options: asset, rune, sym

percentnumberrequired

Percentage of liquidity to withdraw, Minimum 1, Maximum 100

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.thorswap.net/aggregator/liquidity/withdraw?asset=text&positionType=sym_rune&withdrawType=asset&percent=1'

200

400

500

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

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