Get a strategy

GET/v1/earn/strategies/{strategyId}

fundable still reports whether the strategy exists on your project's cluster.

Requires an API key with the earn.read action.

Path parametersCopy Anchor Link

• strategyId · string · required · min length 1 · example earn_strategy_8d1f0c52-6a3e-4b7e-9f21-3c5d7a9e4b10

  The strategy's id from the catalog.

HeadersCopy Anchor Link

• x-project-id · string · min length 1 · example prj_example

  Required for dashboard sessions. API keys use their assigned project.

ResponsesCopy Anchor Link

• 200 The strategy

  • data · object · required

    • strategy · object · required

      One strategy in the catalog.

      • id · string · required · example earn_strategy_3b6a81ce-00b0-4c5a-9761-cb359932e97e

        The strategy's ID. Pass it as strategyId to preview or build a deposit.

      • provider · string · required · example kamino

        Open provider id (e.g. kamino, veda).

      • providerReference · string · required · example 7uib8xGAwkaPz4ZGCA6t8sSEid5Yp9ty13PHUweTypx

        The strategy's onchain address at the provider, such as a vault. It identifies the instrument; never send funds to it.

      • name · string · required · example Allez USDC

      • sourceKind · string · required · one of defi, rwa

        Where the yield comes from: onchain DeFi or real-world assets.

      • underlyingSource · string · example kamino

        Open id of the underlying protocol or fund, when the provider reports one.

      • depositMints · string[] · required

        Mints the strategy accepts directly. The first is the deposit token.

      • shareMint · string · example hXm2xSRF5PLKGMrTvAWqKhR76MuJX5dAabeSChkjqu2

        The share token a deposit mints, when the strategy has one.

      • apyType · string · required · one of variable, fixed

      • currentApy · string · example 0.062

        Latest observed APY as a decimal ratio string ("0.062" = 6.2%), refreshed about every five minutes. Absent when the provider reports none.

      • liquidityTerm · string · required · one of instant, delayed

      • redemptionDelayDays · number · example 2

        For delayed liquidity: the provider's stated redemption delay.

      • riskMetadata · object

        Curator and risk framework metadata, as published by the provider. Curators publish heterogeneous frameworks, so this is an open shape.

        • curator · string · example allez

        • riskTier · string

        • frameworkUrl · string

        • * · any

      • status · string · required · one of active, paused, deprecated

        The strategy's lifecycle. Only active strategies accept new deposits.

      • depositSlippage · object | null · required

        Not null when a deposit build for this strategy, in your environment, requires minSharesOut. Preview the deposit first and derive the floor from sharesOut minus your tolerance. Most production strategies are not null; a strategy priced later, such as a provider order, may be null because no onchain instruction can enforce a floor. Answered per request, like fundable.

        • quoteRequired · boolean · required · always true

          The live quote endpoint must be called before building this direction.

        • defaultToleranceBps · integer · required · example 50

          Suggested tolerance in basis points, to take off a preview's quote when you compute the floor. Your customer may choose another.

      • withdrawalSlippage · object | null · required

        Non-null when this provider's withdrawal builder refuses to run without an explicit minAmountOut: call the withdrawal preview first and derive the floor from assetsOut. Null when this withdrawal cannot enforce a floor; omit minAmountOut.

        • quoteRequired · boolean · required · always true

          The live quote endpoint must be called before building this direction.

        • defaultToleranceBps · integer · required · example 50

          Suggested tolerance in basis points, to take off a preview's quote when you compute the floor. Your customer may choose another.

      • hostCluster · string · required · one of devnet, mainnet-beta

        The cluster the strategy runs on.

      • fundable · boolean · required

        Whether the strategy exists on your project's cluster. false means a deposit can never work from this project. true is necessary but not sufficient: the strategy must also be active, and your organization must be activated for the provider.

      • feeSponsored · boolean · required

        Whether SDP pays network fees for Treasury movements on this strategy from your environment. It never applies to a customer's wallet: to sponsor an Embedded Yield transaction, pass feePayer when you build it. Always false when the strategy is not fundable, and a swap-funded deposit is never sponsored.

      • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

      • updatedAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • meta · object · required

    Response metadata.

    • requestId · string · required · min length 1 · example req_example

      Request identifier for tracing.

    • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

      ISO 8601 timestamp.

• 400 Bad Request

  • error · object · required

    Standard error payload.

    • code · string · required

      Machine-readable error code.

    • message · string · required

      Human-readable error message.

    • details · object

      Optional error details for debugging.

      • * · any

  • meta · object

    • requestId · string · min length 1 · example req_example

      Request identifier for tracing.

• 401 Unauthorized

  Same fields as 400.

• 403 Forbidden. Requires the earn.read action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

  Same fields as 400.

• 404 Not Found

  Same fields as 400.

• 429 Too Many Requests

  Same fields as 400.

• 500 Internal Server Error

  Same fields as 400.

• 503 Service Unavailable

  Same fields as 400.