> ## 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.

# Resolve a Rabbithole username to its referral payout wallet

> Returns the wallet a Rabbithole username's referral links credit: the account's chosen payout wallet, lowercase as stored. Usernames are 3-20 lowercase letters, digits, or underscores (input is trimmed and lowercased) and never change once claimed, but the payout wallet can be re-pointed by the user, so resolve at bind time rather than caching long-term. Use this to obtain the address a signed ReferralBind message must carry when the link carried a username; session-authenticated binds can pass referrerUsername directly.



## OpenAPI

````yaml https://api-tbi.boost.xyz/v1/openapi.json get /v1/referrals/usernames/{username}
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/referrals/usernames/{username}:
    get:
      tags:
        - Referrals
      summary: Resolve a Rabbithole username to its referral payout wallet
      description: >-
        Returns the wallet a Rabbithole username's referral links credit: the
        account's chosen payout wallet, lowercase as stored. Usernames are 3-20
        lowercase letters, digits, or underscores (input is trimmed and
        lowercased) and never change once claimed, but the payout wallet can be
        re-pointed by the user, so resolve at bind time rather than caching
        long-term. Use this to obtain the address a signed ReferralBind message
        must carry when the link carried a username; session-authenticated binds
        can pass referrerUsername directly.
      operationId: resolveReferralUsername
      parameters:
        - name: username
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9_]{3,20}$
        - 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._:-]*$
      responses:
        '200':
          description: Resolved referral payout wallet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferralUsernameResolution'
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1ErrorResponse'
        '404':
          description: Resource not found
          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:
    ReferralUsernameResolution:
      type: object
      properties:
        username:
          type: string
        referrer: {}
      required:
        - username
        - referrer
      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
            - REFERRER_NOT_FOUND
        details:
          anyOf:
            - {}
            - type: 'null'
      required:
        - error
        - code
        - details
      additionalProperties: false

````