API Reference

Get User Positions

You can use the getUserPositions() function to retrieve a list of open positions that a user has.

Example

import { QueryChain } from "@firefly-exchange/library-sui/dist/src/spot"; import { SuiClient } from "@firefly-exchange/library-sui"; import { mainnet } from './config' const client = new SuiClient({ url: "https://fullnode.mainnet.sui.io:443" }); /// Parameters: /// - userAddress : The Sui address of the target user for retrieving position data ex: 0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269 async function getUserPositions(userAddress: string){ let qc = new QueryChain(client); let resp = await qc.getUserPositions(mainnet.BasePackage ,userAddress); return resp } await getUserPositions("0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269")

Response

[ { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0x17d3d6ff7e9790aaf05ceb7c6300e162b1d8291750158b63c6dd5625cebd4295", "lower_tick":-63400, "upper_tick":-61520, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0x2c8a7309f3b7b38370faaf15956285d913e9de2e1383dd5d96fbd9845c3f1362", "lower_tick":5680, "upper_tick":7520, "liquidity":1511439490, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0x5c2ec62c3d490fc85b9255ba8c866898a0634481741809a1482e89a97704bdbb", "lower_tick":-63200, "upper_tick":-62120, "liquidity":902885748, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0x75857c5d605a7f6c09a84052f04915495906464e8947a9e3a83df7575afd405e", "lower_tick":-63200, "upper_tick":-62120, "liquidity":361154300, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0x904c75da693efe712b7437712d2fd3f8057bb93779f8a356ef8c33b8cb4362c4", "lower_tick":-62760, "upper_tick":-62440, "liquidity":52256555, "fee_growth_coin_a":3.402823669209385e+38, "fee_growth_coin_b":3.402823669209385e+38, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xa7726d9332eb8953a4eb3e97fd31216540d738f45e31ae648477c9bde52b53b2", "lower_tick":-63400, "upper_tick":-61520, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xb2dc318fde4c7ac5b444a38dfe9fd0fbd69b13e6110001cb6420ddd6b76fe550", "lower_tick":-63400, "upper_tick":-61520, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xc8771877bf1e14441fc91f835276eea743a233931d5432313bcdf068fa2c008c", "lower_tick":5920, "upper_tick":6960, "liquidity":2653415594, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xdae3e4b63a59b8515f350732c92c1901af95c281fa9aa5202206987157c79a00", "lower_tick":5680, "upper_tick":7520, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xe2ab9b5bce83acd95dc9d61b5946565b3b1a785ef0bea68f50f4d3b5317137f5", "lower_tick":-21200, "upper_tick":-14680, "liquidity":124548988, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xf22a8edeb9adaceee10de2c8e51a4d8dedc701ada858e551ac4926043d240da4", "lower_tick":-21200, "upper_tick":-14680, "liquidity":124548988, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xf3b01421f515da937afa40be5d2c9dc7b3f4009fc0ad79386ae85dafb1a82017", "lower_tick":-63760, "upper_tick":-61160, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 }, { "owner":"0xa2d6fcd5ed2ae13fe527a96c96100120d519900599f33e38ee112d80e51f9269", "pool_id":"0x3b585786b13af1d8ea067ab37101b6513a05d2f90cfe60e8b1d9e1b46a63c4fa", "position_id":"0xff989128d28b9152f2f6adaee9ae920a5f25930b34c16b2112262b735206a028", "lower_tick":5680, "upper_tick":7520, "liquidity":0, "fee_growth_coin_a":0, "fee_growth_coin_b":0, "fee_rate":2000, "token_a_fee":0, "token_b_fee":0 } ]