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

# Get an onramp rate

> Retrieve the conversion rate between a source fiat currency and a destination crypto currency.



## OpenAPI

````yaml https://production.hifi.com/api/v3/openapi.json get /v3/onramps/rates
openapi: 3.0.0
info:
  title: Hifi API
  version: 3.0.0
  description: API documentation for HIFI
servers:
  - url: https://production.hifi.com
    description: Production server
  - url: https://sandbox.hifi.com
    description: Sandbox server
security:
  - bearerAuth: []
tags:
  - name: Common
    description: Common endpoints
  - name: User
    description: User endpoints
  - name: Counter Party
    description: Counter party endpoints
  - name: Crypto Transfer
    description: Crypto transfer and batch transfer endpoints
  - name: Wallet
    description: Wallet and wallet offer endpoints
  - name: External Account
    description: External bank account endpoints (under a counter party)
  - name: External Wallet
    description: External wallet endpoints (under a counter party)
  - name: External Card
    description: External card endpoints (under a counter party)
  - name: Token Swap
    description: Token swap endpoints
  - name: Bridge
    description: Bridge endpoints
  - name: Virtual Account
    description: Virtual account endpoints
  - name: Compliance
    description: Compliance and compliance link endpoints
  - name: Webhook Endpoint
    description: Webhook endpoint endpoints
  - name: File
    description: File upload endpoints
  - name: Onramp
    description: Onramp (fiat to crypto) endpoints
  - name: Offramp
    description: Offramp (crypto to fiat) endpoints
  - name: Orchestration Address
    description: Orchestration (liquidation) address endpoints
  - name: KYC Link
    description: Hosted and custom KYC/KYB link endpoints
  - name: Transfer Approval
    description: Transfer approval endpoints
  - name: Corridor
    description: Supported fiat/crypto transfer corridor endpoints
  - name: Migration
    description: v2-to-v3 ID mapping endpoints
paths:
  /v3/onramps/rates:
    get:
      tags:
        - Onramp
      summary: Get an onramp rate
      description: >-
        Retrieve the conversion rate between a source fiat currency and a
        destination crypto currency.
      operationId: v3GetOnrampRate
      parameters:
        - $ref: '#/components/parameters/OnrampRateSourceCurrencyQueryParameter'
        - $ref: '#/components/parameters/OnrampRateDestinationCurrencyQueryParameter'
        - $ref: '#/components/parameters/OnrampRateTransferTypeQueryParameter'
      responses:
        '200':
          $ref: '#/components/responses/GetOnrampRatesResponse'
        '400':
          $ref: '#/components/responses/BadRequestResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
components:
  parameters:
    OnrampRateSourceCurrencyQueryParameter:
      name: sourceCurrency
      in: query
      required: true
      schema:
        type: string
        enum:
          - USD
      description: Source fiat currency.
      example: USD
    OnrampRateDestinationCurrencyQueryParameter:
      name: destinationCurrency
      in: query
      required: true
      schema:
        type: string
        enum:
          - USDC
          - USDT
          - PYUSD0
      description: Destination crypto currency.
      example: USDC
    OnrampRateTransferTypeQueryParameter:
      name: transferType
      in: query
      required: false
      schema:
        type: string
        enum:
          - ACH
          - WIRE
          - RTP
      description: Fiat rail for the rate lookup.
      example: ACH
  responses:
    GetOnrampRatesResponse:
      description: Conversion rate retrieved successfully.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OnrampRateObject'
          example:
            sourceCurrency: USD
            destinationCurrency: USDC
            rate: 1
    BadRequestResponse:
      description: Bad Request — the request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            type: VALIDATION_ERROR
            message: One or more fields are invalid or missing.
            fields:
              - code: invalid_value
                message: Must be a valid email address
                field: email
    UnauthorizedResponse:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
    InternalServerErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'
  schemas:
    OnrampRateObject:
      type: object
      description: >-
        Conversion rate between a source fiat currency and a destination crypto
        currency.
      properties:
        sourceCurrency:
          type: string
          enum:
            - USD
          example: USD
        destinationCurrency:
          type: string
          enum:
            - USDC
            - USDT
            - PYUSD0
          example: USDC
        rate:
          type: number
          description: Conversion rate from source to destination currency.
          example: 1
    ApiError:
      type: object
      description: >-
        Standard v3 error shape, returned by validation failures and
        business-logic errors alike.
      properties:
        type:
          type: string
          description: >-
            Machine-readable error type, e.g. VALIDATION_ERROR,
            ACTION_NOT_ALLOWED, RESOURCE_CONFLICT.
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message.
          example: One or more fields are invalid or missing.
        fields:
          type: array
          description: >-
            Present on field-level validation errors. One entry per problem
            field.
          items:
            type: object
            properties:
              code:
                type: string
                description: Error code related to the field issue.
              message:
                type: string
                description: Error message for the specific issue.
              field:
                type: string
                description: The name of the field that has an issue.
    Unauthorized:
      type: object
      properties:
        type:
          type: string
          description: Unauthorized enum
          example: UNAUTHORIZED
        message:
          type: string
          description: Unauthorized message
          example: Authentication required
    InternalServerError:
      type: object
      properties:
        type:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: Internal server error enum
        message:
          type: string
          example: An internal server error occurred
          description: Internal server error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````