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

# Claim tokens



## OpenAPI

````yaml https://backend.swap.coffee/openapi post /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}:
    post:
      tags:
        - Claim
      summary: Claim tokens
      operationId: claimTokens
      parameters:
        - $ref: '#/components/parameters/pathWalletAddress'
        - $ref: '#/components/parameters/headerXVerify'
        - $ref: '#/components/parameters/queryClaimingType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ApiTokenClaimRequest'
      responses:
        '200':
          description: User's referral info
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiTransactionResponse'
        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'
  schemas:
    ApiTokenClaimRequest:
      type: object
      required:
        - token_address
        - wallet_address
      properties:
        token_address:
          type: string
        wallet_address:
          type: string
    ApiTransactionResponse:
      type: object
      required:
        - query_id
        - message
      properties:
        query_id:
          type: integer
          format: int64
        message:
          $ref: '#/components/schemas/ApiTransactionBoc'
    ApiClaimingType:
      type: string
      enum:
        - all
        - referral
        - cashback
        - staking
        - rewards_stonfi
        - rewards_dedust
        - coffee_dex
        - boost
    ApiTransactionBoc:
      type: object
      required:
        - payload_cell
        - address
        - value
      properties:
        payload_cell:
          type: string
          description: >-
            Base64-encoded cell. Treated as a payload field in TonConnect
            transaction.
          format: base64
        address:
          type: string
          example: EQCM3B12QK1e4yZSf8GtBRT0aLMNyEsBc_DhVfRRtOEffLez
        value:
          type: string
          format: int128
          description: >-
            Amount of nanotons to be sent. Can be passed to TonConnect
            transaction.
        state_init:
          type: string
          format: base64
          description: >-
            Base64-encoded cell. Treated as a stateInit field in TonConnect
            transaction.
        extra:
          type: array
          items:
            $ref: '#/components/schemas/ApiExtraCurrency'
    ApiExtraCurrency:
      type: object
      required:
        - id
        - amount
      properties:
        id:
          type: integer
          format: int64
        amount:
          type: string
          format: int128
  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

````