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

# Get account's claiming stats



## OpenAPI

````yaml https://backend.swap.coffee/openapi get /v1/claim/{address}
openapi: 3.0.3
info:
  title: Swap Coffee API
  version: 1.0.0
servers:
  - url: https://backend.swap.coffee/
  - url: http://localhost:8080/
security:
  - {}
  - ApiKey: []
tags:
  - name: Entity
    description: Tokens, pools, DEXes, etc.
  - name: Routing
    description: >-
      Core functionality of the aggregation service. Build routes, get
      transactions, etc.
  - name: Strategies
    description: Limit orders, DCA, VCA, etc.
  - name: Yield
    description: >-
      Yield aggregator functionality. Provides and handles routes to pools with
      the best yield.
  - name: Referral
    description: Everything related to the referral program of swap.coffee.
  - name: Cashback
    description: Cashback programs conducted on swap.coffee.
  - name: Claim
    description: Claiming various rewards available on swap.coffee.
  - name: Contests
    description: Timed contests based on trading volumes for certain token-pairs.
  - name: Staking
    description: Responsible of managing staked funds, corresponding rewards, etc.
  - name: DEX
    description: Core functionality of the Coffee DEX service.
  - name: LiquidityProvisioning
    description: Everything related to liquidity provisioning in DEXes.
  - name: Boosts
    description: >-
      Functionality to support incentives and rewards for liquidity providers
      among all DEXes.
  - name: Profile
    description: Retrieve information about user profiles.
  - name: Partnership
    description: Various functionality for our partners.
  - name: Statistics
    description: Retrieve information about dex aggregation stats.
  - name: Ton
    description: Retrieve information about TON entities.
  - name: Auth
    description: Auth operations. For internal usage only.
paths:
  /v1/claim/{address}:
    get:
      tags:
        - Claim
      summary: Get account's claiming stats
      operationId: getClaimingStats
      parameters:
        - $ref: '#/components/parameters/pathWalletAddress'
        - $ref: '#/components/parameters/headerXVerify'
        - $ref: '#/components/parameters/queryClaimingType'
        - $ref: '#/components/parameters/querySize100'
        - $ref: '#/components/parameters/queryPage'
      responses:
        '200':
          description: Account's claiming stats
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiClaimingStats'
        default:
          $ref: '#/components/responses/ApiError'
components:
  parameters:
    pathWalletAddress:
      in: path
      name: address
      required: true
      schema:
        type: string
        example: UQCNTO0Nh0Z7QNyRW1BLWfk08f2dAOw4izrx9sO6OUPg4DoV
    headerXVerify:
      in: header
      name: x-verify
      required: true
      description: TON proof for the given address
      schema:
        type: string
    queryClaimingType:
      in: query
      name: type
      required: true
      schema:
        $ref: '#/components/schemas/ApiClaimingType'
    querySize100:
      in: query
      name: size
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        default: 100
    queryPage:
      in: query
      name: page
      schema:
        type: integer
        format: int32
        minimum: 1
        default: 1
  schemas:
    ApiClaimingStats:
      type: object
      required:
        - aggregated
        - detailed
      properties:
        aggregated:
          type: array
          items:
            $ref: '#/components/schemas/ApiClaimingTypeStats'
        detailed:
          type: array
          items:
            $ref: '#/components/schemas/ApiClaimingTokenStats'
    ApiClaimingType:
      type: string
      enum:
        - all
        - referral
        - cashback
        - staking
        - rewards_stonfi
        - rewards_dedust
        - coffee_dex
        - boost
    ApiClaimingTypeStats:
      type: object
      required:
        - type
        - available_usd
      properties:
        type:
          $ref: '#/components/schemas/ApiClaimingType'
        available_usd:
          type: number
          format: double
    ApiClaimingTokenStats:
      type: object
      required:
        - token
        - wallet
        - type
        - claimed
        - locked
        - available
        - available_usd
      properties:
        token:
          $ref: '#/components/schemas/ApiToken'
        wallet:
          type: string
          description: Wallet's address where token resides
        type:
          $ref: '#/components/schemas/ApiClaimingType'
        claimed:
          type: string
          format: int128
        locked:
          type: string
          format: int128
        available:
          type: string
          format: int128
        available_usd:
          type: number
          format: double
    ApiToken:
      type: object
      required:
        - address
        - metadata
      properties:
        address:
          $ref: '#/components/schemas/ApiTokenAddress'
        metadata:
          $ref: '#/components/schemas/ApiTokenMetadata'
    ApiTokenAddress:
      type: object
      required:
        - blockchain
        - address
      properties:
        blockchain:
          type: string
          example: ton
        address:
          type: string
          example: native
    ApiTokenMetadata:
      type: object
      required:
        - name
        - symbol
        - decimals
        - listed
        - verification
      properties:
        name:
          type: string
          example: ARBUZ
        symbol:
          type: string
          example: ARBUZ
        decimals:
          type: integer
          format: int32
        image_url:
          type: string
        listed:
          type: boolean
        verification:
          $ref: '#/components/schemas/ApiTokenVerification'
    ApiTokenVerification:
      type: string
      enum:
        - whitelisted
        - blacklisted
        - community
        - unknown
  responses:
    ApiError:
      description: Some error during request processing
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-Api-Key
      in: header

````