> ## Documentation Index
> Fetch the complete documentation index at: https://docs.swap.coffee/llms.txt
> Use this file to discover all available pages before exploring further.

# Returns detailed information about requested pool



## OpenAPI

````yaml https://backend.swap.coffee/openapi get /v1/yield/pool/{pool_address}
openapi: 3.0.3
info:
  title: Swap Coffee API
  version: 1.0.0
servers:
  - url: https://backend.swap.coffee/
  - url: http://localhost:8080/
security:
  - {}
  - ApiKey: []
tags:
  - name: Entity
    description: Tokens, pools, DEXes, etc.
  - name: Routing
    description: >-
      Core functionality of the aggregation service. Build routes, get
      transactions, etc.
  - name: Strategies
    description: Limit orders, DCA, VCA, etc.
  - name: Yield
    description: >-
      Yield aggregator functionality. Provides and handles routes to pools with
      the best yield.
  - name: Referral
    description: Everything related to the referral program of swap.coffee.
  - name: Cashback
    description: Cashback programs conducted on swap.coffee.
  - name: Claim
    description: Claiming various rewards available on swap.coffee.
  - name: Contests
    description: Timed contests based on trading volumes for certain token-pairs.
  - name: Staking
    description: Responsible of managing staked funds, corresponding rewards, etc.
  - name: DEX
    description: Core functionality of the Coffee DEX service.
  - name: LiquidityProvisioning
    description: Everything related to liquidity provisioning in DEXes.
  - name: Boosts
    description: >-
      Functionality to support incentives and rewards for liquidity providers
      among all DEXes.
  - name: Profile
    description: Retrieve information about user profiles.
  - name: Partnership
    description: Various functionality for our partners.
  - name: Statistics
    description: Retrieve information about dex aggregation stats.
  - name: Ton
    description: Retrieve information about TON entities.
  - name: Auth
    description: Auth operations. For internal usage only.
paths:
  /v1/yield/pool/{pool_address}:
    get:
      tags:
        - Yield
      summary: Returns detailed information about requested pool
      operationId: getYieldDetails
      parameters:
        - name: pool_address
          in: path
          required: true
          description: Pool address
          schema:
            type: string
      responses:
        '200':
          description: Detailed information about requested pool, with incentives and so on
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiYieldDetails'
        default:
          $ref: '#/components/responses/ApiError'
components:
  schemas:
    ApiYieldDetails:
      type: object
      required:
        - pool_statistics
        - pool
      properties:
        pool_statistics:
          $ref: '#/components/schemas/ApiPoolStatistics'
        pool:
          oneOf:
            - $ref: '#/components/schemas/ApiYieldDetails_Dex'
            - $ref: '#/components/schemas/ApiYieldDetails_DexCLMM'
            - $ref: '#/components/schemas/ApiYieldDetails_DexDLMM'
            - $ref: '#/components/schemas/ApiYieldDetails_LiquidStaking'
            - $ref: '#/components/schemas/ApiYieldDetails_Lending'
            - $ref: '#/components/schemas/ApiYieldDetails_Perpetual'
            - $ref: '#/components/schemas/ApiYieldDetails_FarmixLending'
            - $ref: '#/components/schemas/ApiYieldDetails_DaoLamaLending'
          discriminator:
            propertyName: yieldTypeResolver
            mapping:
              dex_pool:
                $ref: '#/components/schemas/ApiYieldDetails_Dex'
              dex_pool_clmm:
                $ref: '#/components/schemas/ApiYieldDetails_DexCLMM'
              dex_pool_dlmm:
                $ref: '#/components/schemas/ApiYieldDetails_DexDLMM'
              liquid_staking_pool:
                $ref: '#/components/schemas/ApiYieldDetails_LiquidStaking'
              lending_pool:
                $ref: '#/components/schemas/ApiYieldDetails_Lending'
              perpetual_vault_pool:
                $ref: '#/components/schemas/ApiYieldDetails_Perpetual'
              farmix_lending_pool:
                $ref: '#/components/schemas/ApiYieldDetails_FarmixLending'
              daolama_lending_pool:
                $ref: '#/components/schemas/ApiYieldDetails_DaoLamaLending'
    ApiPoolStatistics:
      type: object
      required:
        - address
        - tvl_usd
        - volume_usd
        - fee_usd
        - apr
        - lp_apr
        - boost_apr
      properties:
        address:
          type: string
        tvl_usd:
          type: number
          format: double
        volume_usd:
          type: number
          format: double
        fee_usd:
          type: number
          format: double
        apr:
          type: number
          format: double
        lp_apr:
          type: number
          format: double
        boost_apr:
          type: number
          format: double
        locked_asset_amount:
          type: string
    ApiYieldDetails_Dex:
      type: object
      required:
        - pool
        - boosts
        - total_supply
      properties:
        pool:
          $ref: '#/components/schemas/ApiPool'
        boosts:
          type: array
          items:
            $ref: '#/components/schemas/ApiBoost'
        total_supply:
          type: string
          description: Absolute value of total minted LP for this pool
    ApiYieldDetails_DexCLMM:
      type: object
      required:
        - pool
        - boosts
      properties:
        pool:
          $ref: '#/components/schemas/ApiPoolCLMM'
        boosts:
          type: array
          items:
            $ref: '#/components/schemas/ApiBoost'
    ApiYieldDetails_DexDLMM:
      type: object
      required:
        - pool
        - boosts
      properties:
        pool:
          $ref: '#/components/schemas/ApiPoolDLMM'
        boosts:
          type: array
          items:
            $ref: '#/components/schemas/ApiBoost'
    ApiYieldDetails_LiquidStaking:
      type: object
      properties:
        pool:
          $ref: '#/components/schemas/ApiLiquidStakingPool'
        stats:
          $ref: '#/components/schemas/ApiLiquidStakingPoolStats'
      required:
        - pool
        - stats
    ApiYieldDetails_Lending:
      type: object
      properties:
        pool:
          $ref: '#/components/schemas/ApiLendingPool'
        stats:
          $ref: '#/components/schemas/ApiLendingPoolStats'
      required:
        - pool
        - stats
    ApiYieldDetails_Perpetual:
      type: object
      properties:
        pool:
          $ref: '#/components/schemas/ApiPerpetualVaultPool'
      required:
        - pool
    ApiYieldDetails_FarmixLending:
      type: object
      properties:
        pool:
          $ref: '#/components/schemas/ApiDefiLendingPool'
      required:
        - pool
    ApiYieldDetails_DaoLamaLending:
      type: object
      properties:
        pool:
          $ref: '#/components/schemas/ApiDefiLendingPool'
      required:
        - pool
    ApiPool:
      type: object
      required:
        - dex
        - address
        - type
        - amm_type
        - tokens
        - reserves
        - fees
      properties:
        dex:
          type: string
          example: stonfi
        address:
          type: string
        type:
          $ref: '#/components/schemas/ApiPoolType'
        amm_type:
          $ref: '#/components/schemas/ApiAmmType'
        amm_settings:
          $ref: '#/components/schemas/ApiJson'
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/ApiToken'
        reserves:
          $ref: '#/components/schemas/ApiPoolReserves'
        restrictions:
          type: array
          items:
            $ref: '#/components/schemas/ApiTokenRestrictions'
        fees:
          $ref: '#/components/schemas/ApiPoolFees'
        unavailable_until:
          type: integer
          format: int64
          description: UTC unix timestamp in seconds
    ApiBoost:
      type: object
      required:
        - pool_address
        - reward_token
        - reward_rate_per_second
        - finish_seconds_unix
        - rewards_per_day_usd
        - apr
      properties:
        pool_address:
          type: string
        boost_factory:
          type: string
        boost_id:
          type: integer
          format: int64
        reward_token:
          $ref: '#/components/schemas/ApiToken'
        reward_rate_per_second:
          type: string
        start_seconds_unix:
          type: integer
          format: int64
        finish_seconds_unix:
          type: integer
          format: int64
        rewards_per_day_usd:
          type: number
        apr:
          type: number
          description: Apr in percents
        lock_duration_seconds:
          type: integer
          format: int64
        excluded_addresses:
          type: array
          items:
            type: string
    ApiPoolCLMM:
      type: object
      required:
        - pool
        - sqrtPriceX96
        - liquidity
        - tick
        - ticks
        - jetton0PriceUsd
        - jetton1PriceUsd
      properties:
        pool:
          $ref: '#/components/schemas/ApiPool'
        sqrtPriceX96:
          type: string
          description: Current pool price in sqrtPriceX96 format
        liquidity:
          type: string
          description: Current available liquidity in the pool
        tick:
          type: integer
          format: int64
          description: Current pool tick
        ticks:
          $ref: '#/components/schemas/ApiJson'
        jetton0PriceUsd:
          type: number
          format: double
          description: Price of the first jetton in USD
        jetton1PriceUsd:
          type: number
          format: double
          description: Price of the second jetton in USD
    ApiPoolDLMM:
      type: object
      required:
        - pool
        - current_sqrt_price
        - active_bin
        - bin_step
        - base_bin_step
        - bins
      properties:
        pool:
          $ref: '#/components/schemas/ApiPool'
        current_sqrt_price:
          type: number
          format: double
          description: Current sqrt price
        active_bin:
          type: integer
          description: Active bin index
        bin_step:
          type: integer
          description: Bin step in basis points
        base_bin_step:
          type: integer
          description: Base bin step coefficient (denominator)
        bins:
          type: object
          description: Available bins
          additionalProperties:
            type: object
            properties:
              liquidity:
                type: string
                format: bigint
                description: Raw liquidity amount
              amount_x:
                type: number
                format: double
                description: Amount of token X
              amount_y:
                type: number
                format: double
                description: Amount of token X
              price_lower:
                type: number
                format: double
                description: Lower bound of the price
              price_upper:
                type: number
                format: double
                description: Upper bound of the price
    ApiLiquidStakingPool:
      type: object
      properties:
        protocol:
          type: string
        address:
          type: string
        base_token:
          $ref: '#/components/schemas/ApiToken'
        liquid_token:
          $ref: '#/components/schemas/ApiToken'
        supports_tx_building:
          type: boolean
      required:
        - protocol
        - address
        - base_token
        - liquid_token
        - supports_tx_building
    ApiLiquidStakingPoolStats:
      properties:
        rate:
          type: number
          format: double
        cycle_end:
          type: number
          format: int64
        tvl_usd:
          type: number
          format: double
        apr:
          type: number
          format: double
      required:
        - rate
        - cycle_end
        - tvl_usd
        - apr
    ApiLendingPool:
      type: object
      properties:
        protocol:
          type: string
        address:
          type: string
        token:
          $ref: '#/components/schemas/ApiToken'
        supports_tx_building:
          type: boolean
      required:
        - protocol
        - address
        - token
        - supports_tx_building
    ApiLendingPoolStats:
      properties:
        available_liquidity:
          type: number
          format: double
        liquidation_threshold:
          type: number
          format: double
        liquidation_bonus:
          type: number
          format: double
        collateral_factor:
          type: number
          format: double
      required:
        - available_liquidity
        - liquidation_threshold
        - liquidation_bonus
        - collateral_factor
    ApiPerpetualVaultPool:
      type: object
      properties:
        protocol:
          type: string
        address:
          type: string
        quote_token:
          $ref: '#/components/schemas/ApiToken'
        lp_token:
          $ref: '#/components/schemas/ApiToken'
        exchange_rate:
          type: string
          format: bigint
        normalizer:
          type: string
          format: bigint
      required:
        - protocol
        - address
        - quote_token
        - lp_token
        - exchange_rate
        - normalizer
    ApiDefiLendingPool:
      type: object
      properties:
        address:
          type: string
        token:
          $ref: '#/components/schemas/ApiToken'
        exchange_rate:
          type: string
          format: bigint
        normalizer:
          type: string
          format: bigint
        remaining_liquidity_to_supply:
          type: string
          format: bigint
      required:
        - address
        - token
        - exchange_rate
        - normalizer
    ApiPoolType:
      type: string
      enum:
        - public
        - private
        - slumbering
        - invalid
    ApiAmmType:
      type: string
      enum:
        - constant_product
        - cubic_stable
        - curve_fi_stable
        - concentrated_v3
        - tonstakers
        - weighted_constant_product
        - weighted_stable
        - bidask
        - moon_dlmm
        - bidask_damm
    ApiJson:
      type: object
      additionalProperties: {}
    ApiToken:
      type: object
      required:
        - address
        - metadata
      properties:
        address:
          $ref: '#/components/schemas/ApiTokenAddress'
        metadata:
          $ref: '#/components/schemas/ApiTokenMetadata'
    ApiPoolReserves:
      type: array
      items:
        type: number
        format: double
    ApiTokenRestrictions:
      type: object
      properties:
        min_swap_amount:
          type: number
          format: double
        max_swap_amount:
          type: number
          format: double
    ApiPoolFees:
      type: object
      required:
        - average_gas
      properties:
        average_gas:
          type: number
          format: double
        divider:
          type: integer
          format: int64
        input:
          type: integer
          format: int64
        output:
          type: integer
          format: int64
        first_token:
          type: integer
          format: int64
        second_token:
          type: integer
          format: int64
    ApiTokenAddress:
      type: object
      required:
        - blockchain
        - address
      properties:
        blockchain:
          type: string
          example: ton
        address:
          type: string
          example: native
    ApiTokenMetadata:
      type: object
      required:
        - name
        - symbol
        - decimals
        - listed
        - verification
      properties:
        name:
          type: string
          example: ARBUZ
        symbol:
          type: string
          example: ARBUZ
        decimals:
          type: integer
          format: int32
        image_url:
          type: string
        listed:
          type: boolean
        verification:
          $ref: '#/components/schemas/ApiTokenVerification'
    ApiTokenVerification:
      type: string
      enum:
        - whitelisted
        - blacklisted
        - community
        - unknown
  responses:
    ApiError:
      description: Some error during request processing
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````