> ## 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 list of pools which correspond to the given params



## OpenAPI

````yaml https://backend.swap.coffee/openapi get /v1/yield/pools
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/pools:
    get:
      tags:
        - Yield
      summary: Returns list of pools which correspond to the given params
      operationId: getYieldSearchResponse
      parameters:
        - name: blockchains
          in: query
          required: false
          description: If set, only pools from given blockchains will be returned
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ApiSupportedBlockchain'
        - name: providers
          in: query
          required: false
          description: If set, only pools from given pool providers will be returned
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ApiSupportedYields'
        - name: trusted
          in: query
          required: false
          description: Returns only those pools which are trusted by DEXes or community
          schema:
            type: boolean
            default: true
        - name: with_active_boosts
          in: query
          required: false
          description: Returns only pools which have active boosts
          schema:
            type: boolean
            default: false
        - name: recently_created
          in: query
          required: false
          description: Returns only pools created within last 24 hours
          schema:
            type: boolean
            default: false
        - name: with_liquidity_from
          in: query
          required: false
          description: >-
            If set, returns only pools in which liquidity has been partially
            provisioned by the given address
          schema:
            type: string
        - name: my_tokens_filter_address
          in: query
          required: false
          description: >-
            If set, returns liquidity sources, where this user can supply it's
            tokens
          schema:
            type: string
            description: UQCNTO0Nh0Z7QNyRW1BLWfk08f2dAOw4izrx9sO6OUPg4DoV
        - name: search_text
          in: query
          required: false
          description: >-
            If set, look for given (sub-)text within pool's address, token
            tickers and addresses
          schema:
            type: string
        - name: order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/ApiPoolSortOrder'
        - name: descending_order
          in: query
          required: false
          schema:
            type: boolean
            default: true
        - name: in_groups
          in: query
          required: false
          description: >-
            If set, groups pools by liquidity providers, then handles and
            returns each group separately
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/querySize10'
        - $ref: '#/components/parameters/queryPage'
      responses:
        '200':
          description: List of corresponding pools
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiYieldSearchResponse'
          headers:
            Cache-Control:
              schema:
                type: string
        default:
          $ref: '#/components/responses/ApiError'
components:
  schemas:
    ApiSupportedBlockchain:
      type: string
      enum:
        - ton
    ApiSupportedYields:
      type: string
      enum:
        - stonfi
        - dedust
        - stonfi_v2
        - coffee
        - tonraffles
        - tonco
        - colossus
        - bidask
        - tonstakers
        - bemo
        - bemo_v2
        - hipo
        - torch_finance
        - stakee
        - kton
        - evaa
        - coffin
        - moon
        - storm_trade
        - farmix_lending
        - dao_lama_vault
    ApiPoolSortOrder:
      type: string
      enum:
        - tvl
        - volume
        - apr
    ApiYieldSearchResponse:
      type: object
      required:
        - pools
        - total_count
      properties:
        total_count:
          type: integer
          format: int32
        pools:
          type: array
          items:
            $ref: '#/components/schemas/ApiYieldPool'
    ApiYieldPool:
      type: object
      required:
        - address
        - protocol
        - is_trusted
        - tokens
        - pool_statistics
      properties:
        address:
          type: string
        protocol:
          $ref: '#/components/schemas/ApiSupportedYields'
        is_trusted:
          type: boolean
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/ApiToken'
        pool_statistics:
          $ref: '#/components/schemas/ApiPoolStatistics'
        pool:
          oneOf:
            - $ref: '#/components/schemas/ApiYieldBriefPool_Dex'
          discriminator:
            propertyName: yieldTypeResolver
            mapping:
              dex_pool: '#/components/schemas/ApiYieldBriefPool_Dex'
    ApiToken:
      type: object
      required:
        - address
        - metadata
      properties:
        address:
          $ref: '#/components/schemas/ApiTokenAddress'
        metadata:
          $ref: '#/components/schemas/ApiTokenMetadata'
    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
    ApiYieldBriefPool_Dex:
      type: object
      required:
        - amm_type
      properties:
        amm_type:
          $ref: '#/components/schemas/ApiAmmType'
    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'
    ApiAmmType:
      type: string
      enum:
        - constant_product
        - cubic_stable
        - curve_fi_stable
        - concentrated_v3
        - tonstakers
        - weighted_constant_product
        - weighted_stable
        - bidask
        - moon_dlmm
        - bidask_damm
        - dedust_v2
    ApiTokenVerification:
      type: string
      enum:
        - whitelisted
        - blacklisted
        - community
        - unknown
  parameters:
    querySize10:
      in: query
      name: size
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 10
    queryPage:
      in: query
      name: page
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 1
  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

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.