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

# Set Allowance

> This endpoint allows users to modify the token allowance on any ERC-20 token for
a specific protocol.

In decentralized finance (DeFi), setting an allowance is a necessary step to
authorize a protocol to spend a specified amount of tokens on behalf of the user.
This operation is crucial for ensuring that the protocol can manage the user's
tokens securely and efficiently, enabling seamless transactions and operations
within the DeFi ecosystem.



## OpenAPI

````yaml /v1/combined_spec.json post /v1/generic/allowance/set
openapi: 3.1.0
info:
  title: Compass API
  description: Compass Labs DeFi API
  version: 0.0.1
servers:
  - url: https://api.compasslabs.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v1/generic/allowance/set:
    post:
      tags:
        - Universal
      summary: Set Allowance
      description: >-
        This endpoint allows users to modify the token allowance on any ERC-20
        token for

        a specific protocol.


        In decentralized finance (DeFi), setting an allowance is a necessary
        step to

        authorize a protocol to spend a specified amount of tokens on behalf of
        the user.

        This operation is crucial for ensuring that the protocol can manage the
        user's

        tokens securely and efficiently, enabling seamless transactions and
        operations

        within the DeFi ecosystem.
      operationId: v1_generic_allowance_set
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetAllowanceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from compass_api_sdk import CompassAPI, models


            with CompassAPI(
                api_key_auth="<YOUR_API_KEY_HERE>",
            ) as compass_api:

                res = compass_api.universal.generic_allowance_set(token="USDC", contract=models.SetAllowanceRequestContractEnum.AAVE_V3_POOL, amount="0.1", chain=models.SetAllowanceRequestChain.BASE, sender="0xa16d82c668317bF20091fA9D6D2CAE09Ee05d7c8", estimate_gas=True)

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { CompassApiSDK } from "@compass-labs/api-sdk";

            const compassApiSDK = new CompassApiSDK({
              apiKeyAuth: "<YOUR_API_KEY_HERE>",
            });

            async function run() {
              const result = await compassApiSDK.universal.genericAllowanceSet({
                token: "USDC",
                contract: "AaveV3Pool",
                amount: "0.1",
                chain: "base",
                sender: "0xa16d82c668317bF20091fA9D6D2CAE09Ee05d7c8",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    SetAllowanceRequest:
      properties:
        action_type:
          type: string
          const: SET_ALLOWANCE
          title: Action Type
          default: SET_ALLOWANCE
        token:
          type: string
          title: Token
          description: The symbol or address of the token for which the allowance is set..
          examples:
            - USDC
            - '0xaf88d065e77c8cC2239327C5EDb3A432268e5831'
          default: USDC
        contract:
          anyOf:
            - type: string
              enum:
                - AaveV3Pool
                - AerodromeBasicRouter
                - AerodromeSlipstreamRouter
                - AerodromeSlipstreamNonfungiblePositionManager
                - UniswapV3Router
                - UniswapV3NFTPositionManager
                - MorphoMarket
                - SkyDaiUsdsConverter
                - SkyUsdcUsdsConverter
                - SkyUsdsVault
                - PendleRouter
                - OdosRouter
                - EthenaVault
            - type: string
          title: Contract
          description: The name or address of the contract to set spending allowance for.
          examples:
            - AaveV3Pool
          default: AaveV3Pool
        amount:
          anyOf:
            - type: number
              exclusiveMinimum: 0
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Amount
          description: The amount to set the allowance to.
          examples:
            - 1.5
          default: '0.1'
        chain:
          type: string
          enum:
            - arbitrum
            - base
            - ethereum
          title: Chain
          default: base
          examples:
            - base
        sender:
          type: string
          title: Sender
          description: The address of the transaction sender.
          examples:
            - '0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B'
          default: '0xa16d82c668317bF20091fA9D6D2CAE09Ee05d7c8'
        estimate_gas:
          type: boolean
          title: Estimate Gas
          description: >-
            Determines whether to estimate gas costs for transactions, also
            verifying that the transaction can be successfully executed.
          default: true
      type: object
      required:
        - token
        - contract
        - amount
        - chain
        - sender
      title: SetAllowanceRequest
      description: Request model for increasing token allowance for a contract.
      default:
        chain: base
        sender: '0xa16d82c668317bF20091fA9D6D2CAE09Ee05d7c8'
        token: USDC
        contract: AaveV3Pool
        amount: '0.1'
      required_allowances: []
    TransactionResponse:
      properties:
        transaction:
          anyOf:
            - $ref: '#/components/schemas/UnsignedTransaction'
            - $ref: '#/components/schemas/UserOperationResponse'
          title: Transaction
          description: >-
            The unsigned transaction data. User must sign and broadcast to
            network.
      type: object
      required:
        - transaction
      title: TransactionResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UnsignedTransaction:
      properties:
        chainId:
          type: string
          title: Chainid
          description: The chain id of the transaction
        data:
          type: string
          title: Data
          description: The data of the transaction
        from:
          type: string
          title: From
          description: The sender of the transaction
        gas:
          anyOf:
            - type: string
            - type: 'null'
          title: Gas
          description: The gas of the transaction
        to:
          type: string
          title: To
          description: The recipient of the transaction
        value:
          type: string
          title: Value
          description: The value of the transaction
        nonce:
          type: string
          title: Nonce
          description: The nonce of the address
        maxFeePerGas:
          type: string
          title: Maxfeepergas
          description: The max fee per gas of the transaction
        maxPriorityFeePerGas:
          type: string
          title: Maxpriorityfeepergas
          description: The max priority fee per gas of the transaction
      type: object
      required:
        - chainId
        - data
        - from
        - gas
        - to
        - value
        - nonce
        - maxFeePerGas
        - maxPriorityFeePerGas
      title: UnsignedTransaction
      example:
        chainId: '0x2105'
        data: >-
          0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d
        from: '0x4A83b4413CF41C3244027e1590E35a0F48403F0c'
        gas: '0x7a120'
        maxFeePerGas: '0x59682f00'
        maxPriorityFeePerGas: '0x3b9aca00'
        nonce: '0x5'
        to: '0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67'
        value: '0x0'
    UserOperationResponse:
      properties:
        to:
          type: string
          title: To
          description: The target contract address for the operation
        data:
          type: string
          title: Data
          description: The calldata for the operation
        value:
          type: string
          title: Value
          description: The ETH value to send with the operation
      type: object
      required:
        - to
        - data
        - value
      title: UserOperationResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Compass API Key. Get your key
        [here](https://www.compasslabs.ai/dashboard).

````