This API retrieves information about all of the actions that occurred for a specific liquidity pool on the protocol within a certain timespan.
Time Range Limit
The maximum time range (difference between endDate and startDate) is 60 days.
Not specifying startDate and endDate
If the startDate and endDate query parameters are not provided, the API will return data from the current date - 30 days.
So if the date-time today is 2022-12-20T00:00:00, then the first object in payload.data would start from at least 2022-11-20T00:00:00.
Understanding Actions in Sushiswap
There are many different types of actions in Sushiswap, as you'll see in the action property for each item of the payload.data
array. The guide below will help you understand the possible actions.
Sushiswap Actions |
---|
Swap |
AddLiquidity |
RemoveLiquidity |
Swap
Within the liquidity pool denoted by poolAddress, the protocol is executing a trade that swaps amount0In of the token at token0Address for amount1Out of the token at token1Address.
Normalized amounts are computed using the decimal count for the respective tokens. In this example, token0Address is USDC with 6 decimals. Hence amount0OutNormalized is amount0Out shifted 6 decimals from the right. token1Address is WETH with 18 decimals. Hence amount1InNormalized is amount1In shifted 18 decimals from the right.
In other words, the address to received 422.699 USDC after swapping 0.17 WETH in Sushiswap.
{
"blockNumber": 12538820,
"transactionHash": "0x380fdf99833926a73d7d44fd32cfac02b205bcaa708a80fc460aa4569dc42f38",
"logIndex": 377,
"timestamp": "2021-05-31 00:05:52 000",
"factoryAddress": "0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac",
"poolAddress": "0x397ff1542f962076d0bfe58ea045ffa2d347aca0",
"event": "Swap(index_topic_1 address sender, uint256 amount0In, uint256 amount1In, uint256 amount0Out, uint256 amount1Out, index_topic_2 address to)",
"action": "Swap",
"walletAddress": "0x737aad349312f36b43041737d648051a39f146e8",
"to": "0x737aad349312f36b43041737d648051a39f146e8",
"sender": "0xd9e1ce17f2641f24ae83637ab66a2cca9c378b9f",
"amount0In": "0",
"amount1In": "177026673285634919",
"amount0Out": "422699929",
"amount1Out": "0",
"amount0InNormalized": "0",
"amount1InNormalized": "0.1770266732856349190",
"amount0OutNormalized": "422.6999290",
"amount1OutNormalized": "0",
"token0Address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"token1Address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
}
property | type |
---|---|
blockNumber | integer |
transactionHash | string |
logIndex | number |
timestamp | string | number |
factoryAddress | string |
poolAddress | string |
event | string |
action | string |
walletAddress | string |
to | string |
sender | string |
amount0In | string |
amount1In | string |
amount0Out | string |
amount1Out | string |
amount0InNormalized | string |
amount1InNormalized | string |
amount0OutNormalized | string |
amount1OutNormalized | string |
token0Address | string |
token1Address | string |
AddLiquidity
Adds amount0 and amount1 of the tokens at token0Address and token1Address to increase liquidity provided by the pool at poolAddress.
{
"blockNumber": 12538820,
"transactionHash": "0x380fdf99833926a73d7d44fd32cfac02b205bcaa708a80fc460aa4569dc42f38",
"logIndex": 386,
"timestamp": "2021-05-31 00:05:52 000",
"factoryAddress": "0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac",
"poolAddress": "0x397ff1542f962076d0bfe58ea045ffa2d347aca0",
"event": "Mint(index_topic_1 address sender, uint256 amount0, uint256 amount1)",
"action": "AddLiquidity",
"walletAddress": "0x737aad349312f36b43041737d648051a39f146e8",
"sender": "0xd9e1ce17f2641f24ae83637ab66a2cca9c378b9f",
"amount0": "422699929",
"amount1": "176495980232589668",
"amount0Normalized": "422.6999290",
"amount1Normalized": "0.1764959802325896680",
"token0Address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"token1Address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
}
property | type |
---|---|
blockNumber | integer |
transactionHash | string |
logIndex | number |
timestamp | string | number |
factoryAddress | string |
poolAddress | string |
event | string |
action | string |
walletAddress | string |
sender | string |
amount0 | string |
amount1 | string |
amount0Normalized | string |
amount1Normalized | string |
token0Address | string |
token1Address | string |
RemoveLiquidity
Remove amount0 and amount1 of the tokens at token0Address and token1Address to decrease liquidity provided by the pool at poolAddress.
{
"blockNumber": 12538820,
"transactionHash": "0x502b562faa9ce541d883f670884a6a2f5570aa575daead03e73fb9971d24fc1d",
"logIndex": 98,
"timestamp": "2021-05-31 00:05:52 000",
"factoryAddress": "0xc0aee478e3658e2610c5f7a4a2e1777ce9e4f2ac",
"poolAddress": "0x397ff1542f962076d0bfe58ea045ffa2d347aca0",
"event": "Burn(index_topic_1 address sender, uint256 amount0, uint256 amount1, index_topic_2 address to)",
"action": "RemoveLiquidity",
"walletAddress": "0xe11fc0b43ab98eb91e9836129d1ee7c3bc95df50",
"to": "0xe11fc0b43ab98eb91e9836129d1ee7c3bc95df50",
"sender": "0xe11fc0b43ab98eb91e9836129d1ee7c3bc95df50",
"amount0": "3943381729",
"amount1": "1646596749596814264",
"amount0Normalized": "3943.3817290",
"amount1Normalized": "1.6465967495968142640",
"token0Address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"token1Address": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"
}
property | type |
---|---|
blockNumber | integer |
transactionHash | string |
logIndex | number |
timestamp | string | number |
factoryAddress | string |
poolAddress | string |
event | string |
action | string |
walletAddress | string |
to | string |
sender | string |
amount0 | string |
amount1 | string |
amount0Normalized | string |
amount1Normalized | string |
token0Address | string |
token1Address | string |