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

# 紅包 - 列表

> 取得紅包列表



## OpenAPI

````yaml /zh-Hant/api-reference/openapi-data-zh-Hant.yaml GET /v2/redpacket
openapi: 3.1.0
info:
  title: Services API
  description: Services API
  contact:
    name: AI
    email: ai@sx.ai
  license:
    name: MIT
  version: '1.0'
servers:
  - url: https://api.chainstream.io
    description: Production
security:
  - bearer_auth: []
  - api_key_auth: []
tags:
  - name: Blockchain
    description: 區塊鏈相關操作
  - name: Token
    description: 代幣相關操作
  - name: Trade
    description: 交易相關操作
  - name: Wallet
    description: 錢包相關操作
  - name: Dex
    description: DEX 相關操作
  - name: Ranking
    description: 排行榜相關操作
  - name: DexPool
    description: DEX 池子相關操作
  - name: Watchlist
    description: 關注列表相關操作
  - name: KYT
    description: KYT 相關操作
  - name: Webhook
    description: Webhook 相關操作
  - name: RedPacket
    description: 紅包相關操作
  - name: IPFS
    description: IPFS 相關操作
  - name: DexScreener
    description: DexScreener 相關操作
paths:
  /v2/redpacket:
    get:
      tags:
        - RedPacket
      summary: 紅包 - 列表
      description: 取得紅包列表
      operationId: get.redpackets
      parameters:
        - name: cursor
          in: query
          description: 分頁游標
          required: false
          schema:
            type: string
          example: cursor_abc
        - name: limit
          in: query
          description: 每頁結果數量
          required: false
          schema:
            type: integer
            format: int64
          example: 20
        - name: direction
          in: query
          description: 分頁方向
          required: false
          schema:
            oneOf:
              - $ref: '#/components/schemas/PageDirection'
            default: next
          example: next
        - name: creator
          in: query
          description: 建立者錢包地址
          required: false
          schema:
            type: string
          example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
        - name: chain
          in: query
          description: 紅包所在的區塊鏈網路
          required: false
          schema:
            $ref: '#/components/schemas/ChainSymbol'
          example: sol
      responses:
        '200':
          description: 成功回應
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RedPacketsPage'
components:
  schemas:
    PageDirection:
      type: string
      description: Pagination direction
      enum:
        - next
        - prev
    ChainSymbol:
      type: string
      description: Supported blockchain chains
      enum:
        - sol
        - eth
        - bsc
    RedPacketsPage:
      type: object
      description: Paginated red packets response
      required:
        - total
        - hasNextPage
        - records
      properties:
        endCursor:
          type:
            - string
            - 'null'
          description: 目前頁結束游標
        hasNextPage:
          type: boolean
          description: 是否有下一頁
        records:
          type: array
          items:
            $ref: '#/components/schemas/RedPacket'
          description: 紅包列表
        startCursor:
          type:
            - string
            - 'null'
          description: 目前頁起始游標
        total:
          type: integer
          format: int64
          description: 紅包總數
    RedPacket:
      type: object
      description: Red packet detail
      required:
        - id
        - creator
        - mint
        - totalAmount
        - maxClaims
      properties:
        chain:
          type:
            - string
            - 'null'
          description: 紅包所在的區塊鏈網路
          example: sol
        claimAuthority:
          type:
            - string
            - 'null'
          description: 領取授權地址
          example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB
        claimedAmount:
          type:
            - string
            - 'null'
          description: 已領取金額
          example: '500000000'
        claimedCount:
          type:
            - integer
            - 'null'
          format: int32
          description: 已領取次數
          example: 5
        createdAt:
          type:
            - integer
            - 'null'
          format: int64
          description: 紅包建立時間戳
          example: 1717334400000
        creator:
          type: string
          description: 建立者錢包地址
          example: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v
        expiration:
          type:
            - integer
            - 'null'
          format: int64
          description: 過期時間（秒）
          example: 24
        expired:
          type:
            - boolean
            - 'null'
          description: 紅包是否已提取
        expiredAt:
          type:
            - integer
            - 'null'
          format: int64
          description: 過期時間戳
          example: 1717420800000
        id:
          type: string
          description: 紅包標識
          example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB
        maxClaims:
          type: integer
          format: int32
          description: 最大領取次數
          example: 10
        memo:
          type:
            - string
            - 'null'
          description: 紅包留言
          example: Happy Red Packet
        mint:
          type: string
          description: 代幣鑄造地址
          example: Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB
        refundedAmount:
          type:
            - string
            - 'null'
          description: 退款金額
          example: '0'
        shareId:
          type:
            - string
            - 'null'
          description: 分享標識
          example: abc123
        totalAmount:
          type: string
          description: 紅包總金額
          example: '1000000000'
        txHash:
          type:
            - string
            - 'null'
          description: 交易雜湊
          example: 5UfDuX7hXbL3mFfPdq1pymNHM...
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    api_key_auth:
      type: apiKey
      in: header
      name: X-API-KEY

````