Alex

Supported Chains

Available on Stacks Mainnet.

Available Endpoints:

Click on the endpoint to jump to the section with full details

• /getprice GET - Returns the swap quotation for a given token pair on Uniswap V3.

• /getuserliquidity GET - Returns the balance of a particular token pair of accounts.

• /getpoolliquidity GET - Returns the total liquidity for a specified pool.

• /gettokenliquidity GET - Returns the individual token liquidity within the specified liquidity pool.

• /gettokenidpriceGET - Returns the USD price of the liquidity token of a particular pool.

• /swap POST - Initiate a swap transaction on a specified DEX.

DEX IDs

Many endpoints have a parameter where you can provide a DEX ID.

Below is a list of DEX IDs related to Alex. For a complete list and more information, please see the DEX ID page.

DEX Name	Chain	DEX ID
Alex	Stacks	3100

Endpoint Details

/getprice

Returns the swap quotation for a given token pair.

GET https://api.expand.network/dex/getprice

Query Parameter

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
amountIn*	String	Amount of token.
path*	String	Comma separated values of token addresses whose price is to be fetched.

Sample Request

https://api.expand.network/dex/getprice?path=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx,SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-db20&amountIn=100&dexId=3100

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "amountIn": "100",
        "path": [
            "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.token-wstx",
            "SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.brc20-db20"
        ],
        "amountsOut": [
            "100",
            "2603"
        ]
    }
}

/getuserliquidity

Returns the total liquidity (amount of liquidity pool token) that a user holds.

GET https://api.expand.network/dex/getuserliquidity

Query Parameter

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
address*	String	Public address of liquidity provider.
poolId*	String	pool id of pair

Sample Request

https://api.expand.network/dex/getuserliquidity?dexId=3100&poolId=13&address=SP16PBYTMSTXSQY9F0CFNFNYSZ1JD3JGEPM4AZBTD

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "poolId": "13",
        "liquidity": "7031371207288",
        "tokenA": "1047964",
        "tokenB": "21118906"
    }
}

/getpoolliquidity

Returns the total liquidity for a specified pool.

GET https://api.expand.network/dex/getpoolliquidity

Query Parameter

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
poolId*	String	Pool Id whose liquidity is to be fetched.

Sample Request

https://api.expand.network/dex/getpoolliquidity?dexId=3100&poolId=59

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "totalLiquidity": "900000000000000000"
    }
}

/gettokenliquidity

Returns the individual token liquidity within the specified liquidity pool.

GET https://api.expand.network/dex/gettokenliquidity

Query Parameter

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
poolId*	String	Pool Id whose liquidity is to be fetched.

Sample Request

https://api.expand.network/dex/gettokenliquidity?dexId=3100&poolId=117

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "token-wstx-v2": "79571081726",
        "token-wchillguy": "115134358586619695"
    }
}

/gettokenidprice

Returns the USD price of the liquidity token of a particular pool.

GET https://api.expand.network/dex/gettokenidprice

Query Parameter

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
poolId*	String	Pool Id whose USD price of liquidity token is to be fetched.

Sample Request

https://api.expand.network/dex/gettokenidprice?dexId=3100&poolId=14

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "poolId": "14",
        "price": "0.9698074551870216"
    }
}

/swap

Initiate a swap transaction on a specified DEX.

POST https://api.expand.network/dex/swap

Request Body

Name	Type	Description
rpc	String	Remote procedural call URL.
dexId*	String	Refer to the DEX ID page for details.
path*	String	Comma-separated values of token addresses, inside an array, to swap. Note: For assets other than XLM (Native token), the token issuer is required.
amountIn*	String	Amount of token to be swapped.
amountOutMin*	String	Minimum amount accepted as the result of swap.
from*	String	Address of the sender of the token.
slippage	String	Percentage of total swap value. By default, 1. 0 <= slippage value <= 10

Sample Request

{
    "dexId": "3100",
    "path": [
        "SP102V8P0F7JX67ARQ77WEA3D3CFB5XW39REDT0AM.token-wstx-v2",
        "sp102v8p0f7jx67arq77wea3d3cfb5xw39redt0am.token-alex"
    ],
    "amountIn": "1000",
    "from": "SP16PBYTMSTXSQY9F0CFNFNYSZ1JD3JGEPM4AZBTD",
    "amountOutMin": "0",
    "slippage": "10"
}

Sample Response

{
    "status": 200,
    "msg": "success",
    "data": {
        "chainId": "1700",
        "from": "SP16PBYTMSTXSQY9F0CFNFNYSZ1JD3JGEPM4AZBTD",
        "data": "eyJjb250cmFjdE5hbWUiOiJhbW0tcG9vbC12Mi0wMSIsImZ1bmN0aW9uTmFtZSI6InN3YXAtaGVscGVyIiwiZnVuY3Rpb25BcmdzIjpbeyJ0eXBlIjo2LCJhZGRyZXNzIjp7InR5cGUiOjAsInZlcnNpb24iOjIyLCJoYXNoMTYwIjoiNDAyZGEyYzA3OWU1ZDMxZDU4YjljZmM3Mjg2ZDFiMWViMmY3ODM0ZSJ9LCJjb250cmFjdE5hbWUiOnsidHlwZSI6MiwiY29udGVudCI6InRva2VuLXdzdHgtdjIiLCJsZW5ndGhQcmVmaXhCeXRlcyI6MSwibWF4TGVuZ3RoQnl0ZXMiOjEyOH19LHsidHlwZSI6NiwiYWRkcmVzcyI6eyJ0eXBlIjowLCJ2ZXJzaW9uIjoyMiwiaGFzaDE2MCI6IjQwMmRhMmMwNzllNWQzMWQ1OGI5Y2ZjNzI4NmQxYjFlYjJmNzgzNGUifSwiY29udHJhY3ROYW1lIjp7InR5cGUiOjIsImNvbnRlbnQiOiJ0b2tlbi1hbGV4IiwibGVuZ3RoUHJlZml4Qnl0ZXMiOjEsIm1heExlbmd0aEJ5dGVzIjoxMjh9fSx7InR5cGUiOjEsInZhbHVlIjoiMTAwMDAwMDAwIn0seyJ0eXBlIjoxLCJ2YWx1ZSI6IjEwMDAifSx7InR5cGUiOjEwLCJ2YWx1ZSI6eyJ0eXBlIjoxLCJ2YWx1ZSI6IjE4MTAzIn19XSwiY29udHJhY3RBZGRyZXNzIjoiU1AxMDJWOFAwRjdKWDY3QVJRNzdXRUEzRDNDRkI1WFczOVJFRFQwQU0iLCJwb3N0Q29uZGl0aW9ucyI6W3sidHlwZSI6NSwiY29uZGl0aW9uVHlwZSI6MCwicHJpbmNpcGFsIjp7InR5cGUiOjEsInByZWZpeCI6MiwiYWRkcmVzcyI6eyJ0eXBlIjowLCJ2ZXJzaW9uIjoyMiwiaGFzaDE2MCI6IjRkNjVmYjU0Y2ViYjliZjkyZjAzMWY1N2Q3ZDlmODY0ZDFjYTBlYjUifX0sImNvbmRpdGlvbkNvZGUiOjEsImFtb3VudCI6IjEwIn0seyJ0eXBlIjo1LCJjb25kaXRpb25UeXBlIjoxLCJwcmluY2lwYWwiOnsidHlwZSI6MSwicHJlZml4IjozLCJhZGRyZXNzIjp7InR5cGUiOjAsInZlcnNpb24iOjIyLCJoYXNoMTYwIjoiNDAyZGEyYzA3OWU1ZDMxZDU4YjljZmM3Mjg2ZDFiMWViMmY3ODM0ZSJ9LCJjb250cmFjdE5hbWUiOnsidHlwZSI6MiwiY29udGVudCI6ImFtbS12YXVsdC12Mi0wMSIsImxlbmd0aFByZWZpeEJ5dGVzIjoxLCJtYXhMZW5ndGhCeXRlcyI6MTI4fX0sImNvbmRpdGlvbkNvZGUiOjMsImFtb3VudCI6IjE4MTAzIiwiYXNzZXRJbmZvIjp7InR5cGUiOjQsImFkZHJlc3MiOnsidHlwZSI6MCwidmVyc2lvbiI6MjIsImhhc2gxNjAiOiI0MDJkYTJjMDc5ZTVkMzFkNThiOWNmYzcyODZkMWIxZWIyZjc4MzRlIn0sImNvbnRyYWN0TmFtZSI6eyJ0eXBlIjoyLCJjb250ZW50IjoidG9rZW4tYWxleCIsImxlbmd0aFByZWZpeEJ5dGVzIjoxLCJtYXhMZW5ndGhCeXRlcyI6MTI4fSwiYXNzZXROYW1lIjp7InR5cGUiOjIsImNvbnRlbnQiOiJhbGV4IiwibGVuZ3RoUHJlZml4Qnl0ZXMiOjEsIm1heExlbmd0aEJ5dGVzIjoxMjh9fX1dLCJ2YWxpZGF0ZVdpdGhBYmkiOnRydWV9",
        "referenceId": "10b9072658dd43b388b24bf39471400e"
    }
}