Create Single-side Asset Liquidity Session

post https://api.thirdfi.org/api/v1/sessions/single-side-liquidity

This API is used to create DeX liqudity session with single-side asset for liqudity providing transaction.

Body Params

Session body

successURL

string

Defaults to https://thirdfi.org

URL to redirect user after completing a gateway transaction

cancelURL

string

Defaults to https://thirdfi.org

URL to redirect user after cancelling a gateway transaction

userEmail

string

required

A existing customer email needs to be provided when creating a session

amount

number

required

If addLiquidity is set to true, this indicates the amount of the token asset used to provide liquidity to the pool. If addLiquidity is set to false, the amount of LP token used to remove from the pool is indicated.

chain

string

required

Blockchain to which the transaction will be sent. See https://thirdfi.readme.io/reference/dexswap-overview#list-of-chains-we-supported for more information.

isNative

boolean

required

If true, native token will be used. If false, wrapped tokens (WETH) will be used. defaults to false

addLiquidity

boolean

required

Indicate whether to add or remove liquidity.

pair

string

required

Symbol of pair used for manage liquidity. The pair of the pools can be found from Get Supported DeX Pools API (https://thirdfi.readme.io/reference/get-dexswap-pools).

inputTokenSymbol

string

Token symbol from the pair that used to provide the liquidity to the pool. This is only applied when addLiquidity is set to true.

Responses

Language

Credentials

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.thirdfi.org/api/v1/sessions/single-side-liquidity \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "successURL": "https://thirdfi.org",
8
  "cancelURL": "https://thirdfi.org",
9
  "isNative": true,
10
  "addLiquidity": true
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Session is created.

401Unauthorized

403Forbidden Resources