> ## Documentation Index > Fetch the complete documentation index at: https://docs.pods.finance/llms.txt > Use this file to discover all available pages before exploring further. # Get fiat ramp limits > Returns both on-ramp and off-ramp limits in one request. Each direction contains the effective remaining amount in the requested currency after applying both the matching local cap and the global USD cap, plus the remaining global cap in USD. The top-level remaining fields are deprecated aliases for the off-ramp values. ## OpenAPI ````yaml /openapi.yaml get /api/v1/limits openapi: 3.0.0 info: version: 2.0.0 title: Pods API description: > # Pods API Documentation Pods API is a comprehensive DeFi aggregation platform that enables cross-chain and same-chain transactions for yield strategies. ## Key Features - **Cross-Chain Swaps**: Swap tokens across different blockchain networks - **Same-Chain Swaps**: Optimal routing for swaps within the same network - **Yield Strategies**: Access to multiple DeFi protocols (Aave, Morpho, Lido, etc.) - **Wallet Tracking**: Monitor positions and yields across protocols - **Transaction Monitoring**: Real-time status updates for cross-chain transactions ## Authentication Most API endpoints require authentication using an API key in the `x-api-key` header: ``` x-api-key: your-api-key-here ``` Obtain your API key from the Pods dashboard. **Exceptions:** - `GET /health` is public and does not require authentication. - Customer dashboard endpoints (e.g. `GET /customers/me`, `/customers/:id/tokens`, `/customers/:id/token-groups`) require a **Bearer** token (Supabase or Magic JWT). API key alone is not sufficient for these routes because they enforce user role checks. ## Base URL Production: `https://api.pods.finance` ## Rate Limits - 100 requests per minute per API key - 1000 requests per hour per API key ## Quote Expiration Quotes expire after 5 minutes. The `deadline` field is a Unix timestamp in seconds and `deadlineDate` is an ISO 8601 string (UTC); request a new quote when the deadline has passed. ## Error Handling All errors follow a consistent format. The HTTP status line is the source of truth — the body does **not** include `httpStatus`: ```json { "error": { "code": "ERROR_CODE", "message": "Human-readable error message", "details": {} } } ``` ## Common Error Codes - **QUOTE_NOT_FOUND** (404): Quote not found or expired - **ACTION_NOT_FOUND** (404): Action not found - **STRATEGY_NOT_FOUND** (404): Strategy not found - **RECURRING_COLLECTION_REQUIRES_FEE** (400): Recurring collection requires a performance or markup fee configured - **RECURRING_MARKUP_RECIPIENT_REQUIRED** (422): Live recurring collection with a markup fee requires a non-zero markup fee recipient - **RECURRING_RECIPIENT_ROTATION_PENDING_DISPATCH** (409): Markup fee recipient cannot be rotated while a recurring collection transaction is unresolved - **RECURRING_REGISTRY_CONTROLLER_NOT_CONFIGURED** (503): Recurring collection controller is not configured for this network - **RECURRING_REGISTRY_MISMATCH** (409): On-chain recurring collection registry is not synchronized - **INVALID_ACTION_TYPE** (400): Action type is not supported for this endpoint - **QUOTE_EXPIRED** (400): Quote has expired - **QUOTE_VALIDATION_ERROR** (400): Quote validation failed - **PIX_THIRD_PARTY_QUOTE_MISMATCH** (400): thirdParty must match the Pix offramp quote - **MISSING_PIX_KEY** (400): pixKey is required to create the BRL Pix payout ticket - **INVALID_PIX_BRCODE_FORMAT** (400): pixKey looks like a Pix BR Code but failed format/checksum validation - **PIX_BRCODE_EXPIRED** (400): This Pix BR Code has expired - **PIX_BRCODE_LOOKUP_FAILED** (502): Failed to look up Pix BR Code details from Avenia - **PIX_BRCODE_REQUOTE_REQUIRED** (400): This Pix BR Code has a fixed amount that was not priced into the existing quote; request a new quote - **PROVIDER_NOT_FOUND** (404): Swap provider not found - **NO_ROUTE_FOUND** (400): No swap route available between specified chains - **INVALID_PREFERRED_PROVIDER** (400): Unknown preferredProvider name - **PREFERRED_PROVIDER_NOT_ELIGIBLE** (400): preferredProvider is not eligible for this swap route - **PREFERRED_PROVIDER_QUOTE_UNAVAILABLE** (400): No quote was returned for the requested preferredProvider - **QUOTE_GENERATION_FAILED** (400): Could not generate quote for specified parameters - **FEE_SPONSORSHIP_NOT_ALLOWED** (403): Fee sponsorship is not allowed for this customer - **CUSTOMER_STRATEGY_NOT_FOUND** (404): Customer strategy not found - **FEE_ACTIVATION_IN_PROGRESS** (409): Profit fee activation is already reconciling - **FEE_ACTIVATION_TASK_NOT_PERSISTED** (500): Fee activation task could not be persisted - **INVALID_TX_HASH** (400): Invalid transaction hash format - **TX_UPDATE_FAILED** (500): Failed to update transaction status - **INVALID_AMOUNT_PARAMS** (400): Cannot specify both amountIn and amountOut simultaneously - **MISSING_AMOUNT_PARAMS** (400): Either amountIn or amountOut is required - **INVALID_SLIPPAGE** (400): slippage must be a number between 0.0001 and 0.5 (fraction of 1, e.g. 0.01 = 1%) - **AMOUNT_IN_TOO_LOW** (400): AmountIn is below the minimum for this route - **AMOUNT_IN_TOO_HIGH** (400): AmountIn exceeds available liquidity for this route. Try a smaller amount. - **AMOUNT_IN_TOO_LOW_OFFRAMP** (400): AmountIn must be greater than 1 USDC - **AMOUNT_IN_TOO_HIGH_OFFRAMP** (400): AmountIn must be less than 5k USDC - **AMOUNT_OUT_TOO_LOW_OFFRAMP** (400): AmountOut is below the route minimum (0.5 BRL on Pix BRLA/BRS, 5 BRLA on USDC Pix) - **AMOUNT_OUT_TOO_HIGH_OFFRAMP** (400): AmountOut must be less than 26k BRLA - **AMOUNT_EXCEEDS_PROVIDER_LIMIT** (409): Requested amount exceeds the remaining provider withdrawal limit - **AMOUNT_IN_TOO_LOW_ONRAMP** (400): AmountIn is below the route minimum (0.5 BRL on Pix BRLA/BRS, 1 BRLA on USDC Pix) - **AMOUNT_IN_TOO_HIGH_ONRAMP** (400): AmountIn must be less than 75k BRLA - **AMOUNT_OUT_TOO_LOW_ONRAMP** (400): AmountOut must be greater than 1 USDC - **AMOUNT_OUT_TOO_HIGH_ONRAMP** (400): AmountOut must be less than 15k USDC - **TRANSFER_VALIDATION_FAILED** (400): Token transfer validation failed - **REFUND_PROCESSING_FAILED** (500): Failed to process refund transaction - **INSUFFICIENT_AMOUNT_FOR_REFUND** (400): Transferred amount insufficient to cover refund fee - **FORBIDDEN** (403): Access denied - **INTERNAL_SERVER_ERROR** (500): An unexpected error occurred - **BYTECODE_GENERATION_FAILED** (500): Failed to generate transaction bytecode - **SWAP_EXECUTION_FAILED** (500): Failed to execute swap transaction - **KAMINO_SERVICE_UNAVAILABLE** (503): Lending service is temporarily unavailable. Please try again later. - **KAMINO_BAD_REQUEST** (400): Invalid request to lending service - **DEPOSIT_NOT_FOUND** (404): Bitcoin deposit not found - **SYMBIOSIS_API_ERROR** (502): Error communicating with Symbiosis API ## Support - Documentation: https://docs.pods.finance - Support: support@pods.finance contact: name: Pods Support email: support@pods.finance url: https://pods.finance license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.pods.finance description: Production server security: [] tags: - name: Health description: Health check endpoints - name: KYC description: >- KYC onboarding and status endpoints: reusable Sumsub import, BigDataCorp capture, and externally captured evidence - name: Swap description: Token swap operations - name: Tracking description: Execution tracking for swaps, transfers, and strategy operations - name: Strategies description: DeFi yield strategy operations - name: Ondo description: Ondo Global Markets stock status and tradability - name: Tokens description: Token catalog and metadata - name: Transfer description: Token transfer transaction generation - name: Wallets description: Wallet position tracking - name: Customers description: Customer account management (Bearer auth) - name: Quotes description: Quote history and management - name: Smart Account description: ERC-4337 Gnosis Safe smart account provisioning paths: /api/v1/limits: get: tags: - KYC summary: Get fiat ramp limits description: >- Returns both on-ramp and off-ramp limits in one request. Each direction contains the effective remaining amount in the requested currency after applying both the matching local cap and the global USD cap, plus the remaining global cap in USD. The top-level remaining fields are deprecated aliases for the off-ramp values. parameters: - schema: type: string pattern: ^[A-Z]{3}$ description: Three-letter ISO currency code used for local limit values example: BRL required: true name: currency in: query - schema: type: string description: Wallet address linked to the approved KYC profile example: '0x0000000000000000000000000000000000000001' required: true name: originAddress in: query responses: '200': description: Directional ramp limits retrieved, or no applicable provider found content: application/json: schema: anyOf: - $ref: '#/components/schemas/RampLimitsResponse' - $ref: '#/components/schemas/NoRampLimitProviderResponse' example: provider: avenia currency: BRL remaining: '5500' remainingGlobalUsd: '1100' onramp: remaining: '6000' remainingGlobalUsd: '1600' offramp: remaining: '5500' remainingGlobalUsd: '1100' blocked: false '401': description: Unauthorized - missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Invalid query content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: schemas: RampLimitsResponse: type: object properties: provider: type: string enum: - avenia currency: type: string description: Requested three-letter ISO currency code example: BRL remaining: type: string description: Backward-compatible alias for `offramp.remaining` deprecated: true example: '5500' remainingGlobalUsd: type: string description: Backward-compatible alias for `offramp.remainingGlobalUsd` deprecated: true example: '1100' onramp: $ref: '#/components/schemas/DirectionalRampLimit' offramp: $ref: '#/components/schemas/DirectionalRampLimit' blocked: type: boolean description: >- Whether Avenia has blocked the account. Both directional remaining values are zero when true. example: false required: - provider - currency - onramp - offramp - blocked NoRampLimitProviderResponse: type: object properties: provider: nullable: true required: - provider Error: type: object properties: error: type: object properties: code: type: string message: type: string details: nullable: true required: - code - message required: - error example: error: code: QUOTE_NOT_FOUND message: Quote not found or expired DirectionalRampLimit: type: object properties: remaining: type: string description: >- Remaining allowance in the requested currency, rounded down to at most two decimal places. Omitted when Avenia does not expose a limit. example: '6000' remainingGlobalUsd: type: string description: >- Remaining global allowance for this direction in USD, rounded down to at most two decimal places. Omitted when Avenia does not expose a global limit. example: '1600' securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API key for authentication. Obtain from your Pods dashboard. ````