getPools

This interface retrieves data directly from the chain, which may slow the response time if numerous

Retrieve all turbos pools.

Signature

getPool(withLocked?: boolean): Promise<Pool.Pool[]>

Params

withLocked: Retrieve all turbos pools including locked ones. Defaults false

Example

// unlocked
const pools = await sdk.pool.getPools();

// ulocked + locked
const pools = await sdk.pool.getPools(true);

Response

[
  {
    coin_a: '7933797',
    coin_b: '97630837',
    deploy_time_ms: '1727128400342',
    fee: 3000,
    fee_growth_global_a: '3360020434863282893',
    fee_growth_global_b: '32358835950111033230',
    fee_protocol: 300000,
    id: {
      id: '0x8e7be736d448d1eb4bf15521fddf2072402c3fabe539d29e8550b1463fe122cd'
    },
    liquidity: '0',
    max_liquidity_per_tick: '23012265295255187899058267899625901',
    protocol_fees_a: '7933507',
    protocol_fees_b: '97630562',
    reward_infos: [],
    reward_last_updated_time_ms: '1737838546481',
    sqrt_price: '19641326088305147793',
    tick_current_index: {
      type: '0x91bfbc386a41afcfd9b2533058d7e915a1d3829089cc268ff4333d54d6339ca1::i32::I32',
      fields: [Object]
    },
    tick_map: {
      type: '0x2::table::Table<0x91bfbc386a41afcfd9b2533058d7e915a1d3829089cc268ff4333d54d6339ca1::i32::I32, u256>',
      fields: [Object]
    },
    tick_spacing: 60,
    unlocked: true,
    objectId: '0x8e7be736d448d1eb4bf15521fddf2072402c3fabe539d29e8550b1463fe122cd',
    type: '0x91bfbc386a41afcfd9b2533058d7e915a1d3829089cc268ff4333d54d6339ca1::pool::Pool<0x6cc3c2b9f33461479ec785c5f6ea759e0f118a96bde35cc15325c7b853e7fe66::sity::SITY, 0x2::sui::SUI, 0x91bfbc386a41afcfd9b2533058d7e915a1d3829089cc268ff4333d54d6339ca1::fee3000bps::FEE3000BPS>',
    types: [
      '0x6cc3c2b9f33461479ec785c5f6ea759e0f118a96bde35cc15325c7b853e7fe66::sity::SITY',
      '0x2::sui::SUI',
      '0x91bfbc386a41afcfd9b2533058d7e915a1d3829089cc268ff4333d54d6339ca1::fee3000bps::FEE3000BPS'
    ]
  },
  ... more items
]