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

# Build a Forwarder deposit transaction list

> Builds a direct same-chain Boost Forwarder deposit transaction list for a supported target. The server infers the accepted input token from the target registry.



## OpenAPI

````yaml https://api-tbi.boost.xyz/v1/openapi.json post /v1/forwarder/deposit
openapi: 3.1.0
info:
  title: Boost Time-Based Incentives SDK API
  version: 1.0.0
  description: >-
    Public /v1 API surface for the Boost TBI SDK. Internal Rabbithole, admin,
    Polymarket, and widget routes are intentionally excluded.
servers:
  - url: https://api-tbi.boost.xyz
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Campaigns
    description: Campaign discovery, detail, and stats endpoints.
  - name: Claims
    description: Claim proof and claim status endpoints.
  - name: Forwarder
    description: Boost Forwarder target discovery and direct deposit transaction builders.
  - name: Referrals
    description: >-
      Referral attribution: signed per-campaign binds, referrer earnings, and
      claim proofs.
  - name: Users
    description: User rewards and balance endpoints.
paths:
  /v1/forwarder/deposit:
    post:
      tags:
        - Forwarder
      summary: Build a Forwarder deposit transaction list
      description: >-
        Builds a direct same-chain Boost Forwarder deposit transaction list for
        a supported target. The server infers the accepted input token from the
        target registry.
      operationId: buildForwarderDeposit
      parameters:
        - name: X-Boost-Ref-Id
          in: header
          required: false
          description: >-
            Optional partner attribution reference ID. Values are manually
            assigned by Boost and must be at most 128 characters.
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForwarderBuildDepositRequest'
      responses:
        '200':
          description: Forwarder deposit transactions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForwarderBuildDepositResponse'
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
components:
  schemas:
    ForwarderBuildDepositRequest:
      type: object
      properties:
        targetChainId:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        targetAddress:
          type: string
        amount:
          type: string
          pattern: ^(0|[1-9]\d*)$
        sender:
          type: string
        receiver:
          type: string
        inputToken:
          type: string
      required:
        - targetChainId
        - targetAddress
        - amount
        - sender
      additionalProperties: false
    ForwarderBuildDepositResponse:
      type: object
      properties:
        action:
          type: string
          const: deposit
        flow:
          type: string
          const: direct
        forwarderAddress: {}
        target:
          type: object
          properties:
            chainId:
              type: integer
              exclusiveMinimum: 0
              maximum: 9007199254740991
            targetAddress: {}
            forwarderAddress: {}
            acceptedToken:
              type: object
              properties:
                address: {}
                decimals:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                symbol:
                  type: string
              required:
                - address
                - decimals
                - symbol
              additionalProperties: false
            acceptedTokens:
              type: array
              items:
                type: object
                properties:
                  address: {}
                  decimals:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  symbol:
                    type: string
                required:
                  - address
                  - decimals
                  - symbol
                additionalProperties: false
            shareToken:
              type: object
              properties:
                symbol:
                  type: string
                decimals:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
                - symbol
                - decimals
              additionalProperties: false
            protocol:
              type: string
            name:
              type: string
            supportedActions:
              type: array
              items:
                type: string
                const: deposit
            depositActionType:
              type: string
              enum:
                - erc4626-deposit
                - compound-v2-mint
                - compound-v3-supply
                - aave-v3-pool-supply
                - aave-staked-token-stake
                - lido-earn-deposit
                - midas-deposit-instant
          required:
            - chainId
            - targetAddress
            - forwarderAddress
            - acceptedToken
            - acceptedTokens
            - shareToken
            - protocol
            - name
            - supportedActions
            - depositActionType
          additionalProperties: false
        transactions:
          minItems: 1
          type: array
          items:
            type: object
            properties:
              chainId:
                type: integer
                exclusiveMinimum: 0
                maximum: 9007199254740991
              to: {}
              data: {}
              value:
                type: string
                pattern: ^(0|[1-9]\d*)$
              gasEstimate:
                type: string
                pattern: ^(0|[1-9]\d*)$
              description:
                type: string
            required:
              - chainId
              - to
              - data
              - value
              - gasEstimate
              - description
            additionalProperties: false
      required:
        - action
        - flow
        - forwarderAddress
        - target
        - transactions
      additionalProperties: false
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          enum:
            - INVALID_PARAMS
            - NOT_FOUND
            - RATE_LIMITED
            - INTERNAL_ERROR
            - INVALID_SIGNATURE
            - SELF_REFERRAL
            - ALREADY_BOUND
            - ALREADY_PARTICIPATING
            - CAMPAIGN_NOT_BINDABLE
            - INVALID_SESSION
            - WALLET_NOT_LINKED
            - REFERRER_NOT_LINKED
            - CYCLIC_REFERRAL
        details:
          anyOf:
            - {}
            - type: 'null'
      required:
        - error
        - code
        - details
      additionalProperties: false

````