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

# List maple pools

> List the Maple syrup pools (syrupUSDC, syrupUSDT) available through the
`MAPLE` venue, with exchange rate, TVL, 7-day APY and withdrawal-queue state.

Deposit with the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)
using `{"type": "MAPLE", "pool_address": ...}`: shares are minted directly from
Maple at the pool exchange rate, and the Earn Account is authorized with Maple
automatically on its first deposit. Withdrawals are asynchronous (Maple's
withdrawal queue, typically minutes, at most 30 days); to exit immediately at
market price, use the [swap endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).

Maple pools are on Ethereum; other chains return an empty list.



## OpenAPI

````yaml /v2/combined_spec.json get /v2/earn/maple_pools
openapi: 3.1.0
info:
  title: Compass API
  description: Compass Labs DeFi API
  version: 0.0.1
servers:
  - url: https://api.compasslabs.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v2/earn/maple_pools:
    get:
      tags:
        - Earn
      summary: List maple pools
      description: >-
        List the Maple syrup pools (syrupUSDC, syrupUSDT) available through the

        `MAPLE` venue, with exchange rate, TVL, 7-day APY and withdrawal-queue
        state.


        Deposit with the [manage
        endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position)

        using `{"type": "MAPLE", "pool_address": ...}`: shares are minted
        directly from

        Maple at the pool exchange rate, and the Earn Account is authorized with
        Maple

        automatically on its first deposit. Withdrawals are asynchronous
        (Maple's

        withdrawal queue, typically minutes, at most 30 days); to exit
        immediately at

        market price, use the [swap
        endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/swap-tokens).


        Maple pools are on Ethereum; other chains return an empty list.
      operationId: v2_earn_maple_pools
      parameters:
        - name: chain
          in: query
          required: true
          schema:
            type: string
            enum:
              - arbitrum
              - base
              - bsc
              - ethereum
              - hyperevm
              - tempo
            title: Chain
            default: ethereum
          description: >-
            Blockchain network. Maple syrup pools are on Ethereum; other chains
            return an empty list.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaplePoolsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from compass_api_sdk import CompassAPI, models


            with CompassAPI(
                api_key_auth="<YOUR_API_KEY_HERE>",
            ) as compass_api:

                res = compass_api.earn.earn_maple_pools(chain=models.V2EarnMaplePoolsChain.ETHEREUM)

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { CompassApiSDK } from "@compass-labs/api-sdk";

            const compassApiSDK = new CompassApiSDK({
              apiKeyAuth: "<YOUR_API_KEY_HERE>",
            });

            async function run() {
              const result = await compassApiSDK.earn.earnMaplePools({
                chain: "ethereum",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    MaplePoolsResponse:
      properties:
        pools:
          items:
            $ref: '#/components/schemas/MaplePoolInfo'
          type: array
          title: Pools
          description: Maple syrup pools on the requested chain.
          default: []
      type: object
      title: MaplePoolsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MaplePoolInfo:
      properties:
        pool_address:
          type: string
          title: Pool Address
          description: >-
            The pool, which is also the syrup token address. Pass it as
            `pool_address` in the `MAPLE` venue.
          examples:
            - '0x80ac24aA929eaF5013f6436cdA2a7ba190f5Cc0b'
        symbol:
          type: string
          title: Symbol
          description: Syrup token symbol, e.g. syrupUSDC.
        chain:
          type: string
          title: Chain
          description: Blockchain name.
        asset:
          type: string
          title: Asset
          description: Underlying asset deposited and paid out.
        asset_symbol:
          type: string
          title: Asset Symbol
          description: Underlying asset symbol.
        asset_decimals:
          type: integer
          title: Asset Decimals
          description: Underlying asset decimals.
        exchange_rate:
          anyOf:
            - type: string
            - type: 'null'
          title: Exchange Rate
          description: >-
            Underlying asset paid per pool share on redemption at the current
            exit rate.
        tvl_usd:
          anyOf:
            - type: string
            - type: 'null'
          title: Tvl Usd
          description: Total assets in the pool in USD (null if price unavailable).
        apy_7d:
          anyOf:
            - type: string
            - type: 'null'
          title: Apy 7D
          description: >-
            7-day annualized APY from the pool's exchange-rate growth
            (percentage). Null when not yet measured.
        settlement:
          type: string
          const: async
          title: Settlement
          description: >-
            Withdrawals are asynchronous: they request a redemption from Maple's
            queue and the asset is paid out when Maple processes it.
          default: async
        withdrawal_note:
          type: string
          title: Withdrawal Note
          description: Human-readable withdrawal timing.
          default: >-
            Withdrawals settle when Maple processes its queue, typically within
            minutes and at most 30 days. Sell via /v2/earn/swap to exit
            immediately at market price.
        withdrawal_queue:
          $ref: '#/components/schemas/MapleWithdrawalQueue'
          description: Current state of the pool's withdrawal queue.
      additionalProperties: false
      type: object
      required:
        - pool_address
        - symbol
        - chain
        - asset
        - asset_symbol
        - asset_decimals
        - exchange_rate
        - withdrawal_queue
      title: MaplePoolInfo
      description: A Maple syrup pool available through the Earn `MAPLE` venue.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    MapleWithdrawalQueue:
      properties:
        pending_requests:
          type: integer
          title: Pending Requests
          description: Withdrawal requests waiting to be processed by Maple.
        pending_shares:
          type: string
          title: Pending Shares
          description: Pool shares held in the queue across all pending requests.
      type: object
      required:
        - pending_requests
        - pending_shares
      title: MapleWithdrawalQueue
      description: Current state of a pool's withdrawal queue.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Compass API Key. Get your key
        [here](https://www.compasslabs.ai/dashboard).

````

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