> ## 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. # Borrow against collateral > Borrow an asset from Aave using a Credit Account. Bundles an optional swap, collateral supply, and borrow into a single atomic Safe transaction. - If `token_in` equals `collateral_token`, the tokens are supplied directly as collateral. - If `token_in` differs from `collateral_token`, a swap is performed first via 1inch. The Credit Account must already be created via `/v2/credit/create_account` and funded with `token_in`. ## OpenAPI ````yaml /v2/combined_spec.json post /v2/credit/borrow 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: /v2/credit/borrow: post: tags: - Credit summary: Borrow against collateral description: >- Borrow an asset from Aave using a Credit Account. Bundles an optional swap, collateral supply, and borrow into a single atomic Safe transaction. - If `token_in` equals `collateral_token`, the tokens are supplied directly as collateral. - If `token_in` differs from `collateral_token`, a swap is performed first via 1inch. The Credit Account must already be created via `/v2/credit/create_account` and funded with `token_in`. operationId: v2_credit_borrow requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditBorrowRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreditBorrowResponse' '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="", ) as compass_api: res = compass_api.credit.credit_borrow(owner="0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425", chain=models.Chain.BASE, borrow_token="WETH", borrow_amount=0.01, sub_account_id=0, token_in="USDC", amount_in=100, collateral_token="USDC", interest_rate_mode=models.InterestRateMode.VARIABLE, slippage=0.5, gas_sponsorship=False, fee=None) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { CompassApiSDK } from "@compass-labs/api-sdk"; const compassApiSDK = new CompassApiSDK({ apiKeyAuth: "", }); async function run() { const result = await compassApiSDK.credit.creditBorrow({ owner: "0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425", chain: "base", tokenIn: "USDC", amountIn: 100, collateralToken: "USDC", borrowToken: "WETH", borrowAmount: 0.01, interestRateMode: "variable", slippage: 0.5, gasSponsorship: false, }); console.log(result); } run(); components: schemas: CreditBorrowRequest: properties: owner: type: string title: Owner description: The address that owns the Credit Account. default: '0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425' examples: - '0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425' chain: $ref: '#/components/schemas/Chain' description: Blockchain network. default: base examples: - base protocol: $ref: '#/components/schemas/CreditProtocol' description: Lending protocol to use. Defaults to Aave. default: AAVE collateral_vault: anyOf: - type: string - type: 'null' title: Collateral Vault description: >- Euler only: the EVK collateral vault to supply into. Required when protocol=EULER and supplying collateral. borrow_vault: anyOf: - type: string - type: 'null' title: Borrow Vault description: >- Euler only: the EVK vault to borrow from. Required when protocol=EULER. market_id: anyOf: - type: string - type: 'null' title: Market Id description: >- Morpho only: the bytes32 market id (from /v2/credit/morpho_markets). Required when protocol=MORPHO. sub_account_id: type: integer maximum: 255 minimum: 0 title: Sub Account Id description: >- Euler only: EVC sub-account (0–255) to isolate this position. Each sub-account is an independent Euler position with its own collateral, borrow controller, and health, letting one Credit Account hold multiple isolated Euler positions. Defaults to 0. Ignored for Aave/Morpho. default: 0 token_in: anyOf: - type: string title: Token description: >- A token identifier - either a supported symbol (e.g., USDC, WETH) or a valid Ethereum address (0x...) examples: - USDC - WETH - '0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8' - type: 'null' title: Token In description: >- Token currently held in the Credit Account to use as input. If the same as collateral_token, no swap is performed. Omit together with amount_in and collateral_token to borrow against existing collateral. examples: - USDC - '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' default: USDC amount_in: anyOf: - type: number exclusiveMinimum: 0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Amount In description: >- Amount of token_in to use (in token units, not wei). Omit together with token_in and collateral_token for borrow-only mode. examples: - 100 - 1.5 default: 100 collateral_token: anyOf: - type: string title: Token description: >- A token identifier - either a supported symbol (e.g., USDC, WETH) or a valid Ethereum address (0x...) examples: - USDC - WETH - '0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8' - type: 'null' title: Collateral Token description: >- Aave reserve token to supply as collateral. Omit together with token_in and amount_in for borrow-only mode. examples: - WETH - '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2' default: USDC borrow_token: type: string title: Token description: Asset to borrow from Aave. examples: - DAI - '0x6b175474e89094c44da98b954eedeac495271d0f' default: WETH borrow_amount: anyOf: - type: number exclusiveMinimum: 0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Borrow Amount description: Amount to borrow (in token units, not wei). examples: - 50 - 0.5 default: 0.01 interest_rate_mode: $ref: '#/components/schemas/InterestRateMode' description: The interest rate mode for the borrow position. default: variable examples: - variable slippage: anyOf: - type: number maximum: 100 minimum: 0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Slippage description: >- Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed. default: '0.5' examples: - 0.5 gas_sponsorship: type: boolean title: Gas Sponsorship description: >- If true, returns EIP-712 signature data instead of an unsigned transaction. default: false examples: - false fee: anyOf: - $ref: '#/components/schemas/CreditFee' - type: 'null' description: >- Optional fee configuration. If provided, a fee will be deducted from the borrowed amount and sent to the specified recipient address. permit2_signature: anyOf: - type: string - type: 'null' title: Permit2 Signature description: >- The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data. permit2_nonce: anyOf: - type: integer minimum: 0 - type: 'null' title: Permit2 Nonce description: >- The nonce used in the Permit2 signature (from the signed typed data). permit2_deadline: anyOf: - type: integer minimum: 0 - type: 'null' title: Permit2 Deadline description: >- The deadline timestamp used in the Permit2 signature (from the signed typed data). type: object required: - owner - chain - borrow_token - borrow_amount title: CreditBorrowRequest default: owner: '0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425' chain: base token_in: USDC amount_in: 100 collateral_token: USDC borrow_token: WETH borrow_amount: 0.01 interest_rate_mode: variable slippage: 0.5 gas_sponsorship: false CreditBorrowResponse: properties: transaction: anyOf: - $ref: '#/components/schemas/UnsignedTransaction' - type: 'null' description: >- Unsigned transaction to execute the borrow bundle. Present when gas_sponsorship is false. example: chainId: '0x2105' data: 0x6a761202000000000000000000000000... from: '0xc98949522db2eE403d6c75E91DDEe875a824bB10' gas: '0xb71b0' maxFeePerGas: '0x3b9aca00' maxPriorityFeePerGas: '0x5f5e100' nonce: '0x2b' to: '0xaB5801a7D398351b8bE11C439e05C5B3259aeC9B' value: '0x0' eip_712: anyOf: - $ref: '#/components/schemas/BatchedSafeOperationsResponse-Output' - type: 'null' description: >- EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship is true. estimated_collateral_amount: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Estimated Collateral Amount description: >- Estimated amount of collateral token received from swap. Only present when token_in differs from collateral_token. example: '99.8500000000' fee_amount: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Fee Amount description: >- The fee amount charged on the borrow, in borrow token units. Present when a fee was applied. example: '0.1500000000' type: object title: CreditBorrowResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Chain: type: string enum: - base - ethereum - arbitrum - hyperevm - tempo - bsc title: Chain description: The chain to use. CreditProtocol: type: string enum: - AAVE - EULER - MORPHO title: CreditProtocol description: >- Which lending protocol a credit action targets. ``AAVE`` is the default so existing callers (which never send a ``protocol`` field) keep hitting the unchanged Aave code path. ``EULER`` opts in to the Euler V2 path, where the market is identified by EVK vault address(es). ``MORPHO`` identifies Morpho Blue lending markets (bytes32 market id) and is currently read-only: positions and market discovery only — transaction builders land with the looping work (COM-7106/7107/7108), so transact endpoints reject it with a 422. InterestRateMode: type: string enum: - stable - variable title: InterestRateMode description: |- On AAVE there are 2 different interest modes. A stable (but typically higher rate), or a variable rate. CreditFee: properties: recipient: type: string title: Recipient description: The wallet address that will receive the fee. examples: - '0xb8340945eBc917D2Aa0368a5e4E79C849c461511' amount: anyOf: - type: number exclusiveMinimum: 0 - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Amount description: >- The fee amount. If `denomination` is 'PERCENTAGE', this is a percentage of the transaction amount (e.g., 1.5 for 1.5%). If `denomination` is 'FIXED', this is a fixed amount in token units (e.g., 0.1 for 0.1 tokens). If `denomination` is 'PERFORMANCE', this is a percentage of realized profit calculated using FIFO cost basis (e.g., 10 for 10% of profit). examples: - 1.5 - 0.1 - 10 denomination: type: string enum: - PERCENTAGE - FIXED title: Denomination description: >- The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the borrow amount), or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens). default: PERCENTAGE examples: - PERCENTAGE - FIXED additionalProperties: false type: object required: - recipient - amount title: CreditFee description: >- Fee configuration for credit-product actions. Same shape as `Fee`, but narrows `denomination` to the values supported by credit borrows. PERFORMANCE is not supported because realized-profit fees are not meaningful for debt positions. 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' BatchedSafeOperationsResponse-Output: properties: domain: $ref: >- #/components/schemas/compass__api_backend__v2__models__safe__transact__response__batched_safe_operations__EIP712Domain description: EIP-712 domain separator types: $ref: >- #/components/schemas/compass__api_backend__v2__models__safe__transact__response__batched_safe_operations__EIP712Types description: EIP-712 type definitions primaryType: type: string const: SafeTx title: Primarytype description: Primary type for the structured data message: $ref: '#/components/schemas/SafeTxMessage' description: Safe transaction message data type: object required: - domain - types - primaryType - message title: BatchedSafeOperationsResponse description: Response containing EIP-712 typed data for Safe transaction signing. example: domain: chainId: 8453 verifyingContract: '0x6B90E8B4E3E971E74C1A47a3a20976377E2dB4b1' message: baseGas: '0' data: >- 0x8d80ff0a0000000000000000000000000000000000000000000000000000000000000020 gasPrice: '0' gasToken: '0x0000000000000000000000000000000000000000' nonce: '7' operation: 1 refundReceiver: '0x0000000000000000000000000000000000000000' safeTxGas: '0' to: '0x93C23AAE4793C14D6DF35D2A2A2234204e1559dA' value: '0' primaryType: SafeTx types: EIP712Domain: - name: chainId type: uint256 - name: verifyingContract type: address SafeTx: - name: to type: address - name: value type: uint256 - name: data type: bytes - name: operation type: uint8 - name: safeTxGas type: uint256 - name: baseGas type: uint256 - name: gasPrice type: uint256 - name: gasToken type: address - name: refundReceiver type: address - name: nonce type: uint256 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 compass__api_backend__v2__models__safe__transact__response__batched_safe_operations__EIP712Domain: properties: chainId: type: integer title: Chainid description: Chain ID verifyingContract: type: string title: Verifyingcontract description: Address of the Product Account type: object required: - chainId - verifyingContract title: EIP712Domain description: The EIP-712 domain separator. compass__api_backend__v2__models__safe__transact__response__batched_safe_operations__EIP712Types: properties: EIP712Domain: items: $ref: '#/components/schemas/EIP712DomainField' type: array title: Eip712Domain description: EIP712Domain type definition SafeTx: items: $ref: '#/components/schemas/SafeTxField' type: array title: Safetx description: SafeTx type definition type: object required: - EIP712Domain - SafeTx title: EIP712Types description: The type definitions for EIP-712 structured data. SafeTxMessage: properties: to: type: string title: To description: Destination address value: type: string title: Value description: Value in wei as a string data: type: string title: Data description: Transaction data as hex string operation: $ref: '#/components/schemas/OperationType' description: Operation type (0=Call, 1=DelegateCall) safeTxGas: type: string title: Safetxgas description: Gas for the transaction baseGas: type: string title: Basegas description: Base gas costs gasPrice: type: string title: Gasprice description: Gas price gasToken: type: string title: Gastoken description: Token address for gas payment refundReceiver: type: string title: Refundreceiver description: Address to receive gas refund nonce: type: string title: Nonce description: Transaction nonce type: object required: - to - value - data - operation - safeTxGas - baseGas - gasPrice - gasToken - refundReceiver - nonce title: SafeTxMessage description: The message data for the transaction. EIP712DomainField: properties: name: type: string title: Name type: type: string title: Type type: object required: - name - type title: EIP712DomainField description: A field in the EIP712Domain type definition. SafeTxField: properties: name: type: string title: Name type: type: string title: Type type: object required: - name - type title: SafeTxField description: A field in the SafeTx type definition. OperationType: type: integer enum: - 0 - 1 title: OperationType description: Safe operation types. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Your Compass API Key. Get your key [here](https://www.compasslabs.ai/dashboard). ````