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

# Get Exchange Rates

> Retrieves real-time exchange rates.

Retrieves real-time exchange rates. Use the optional `fromSymbols` and `toSymbols` query parameters to filter results to specific currency pairs.


## OpenAPI

````yaml GET /api/v1/org/rates
openapi: 3.1.0
info:
  title: Afriex Business API
  version: 1.0.8
  description: >-
    Welcome to the Afriex Business API. This API allows you to manage customers,
    process payments, handle payouts, and receive real-time notifications via
    webhooks.


    For detailed guidance on authentication, pagination, error handling, and
    webhooks, please refer to the [dedicated guides](https://docs.afriex.com) in
    the top bar. The guide provides a step-by-step instructions to help you
    integrate seamlessly.
  termsOfService: https://www.afriex.com/terms-and-condition
  contact:
    name: Afriex API Support
    email: eng@afriex.co
    url: https://docs.afriex.com
  license:
    name: Proprietary
    url: https://www.afriex.com/terms-and-condition
servers:
  - url: https://sandbox.api.afriex.com
    description: Staging Base URL
  - url: https://api.afriex.com
    description: Production Base URL
security:
  - ApiKey: []
tags:
  - name: Customers
    description: Create and manage your customers.
  - name: Payment Methods
    description: Register and resolve customer payout and collection methods.
  - name: Transactions
    description: Create and track deposits, withdrawals, and swaps.
  - name: Balance
    description: View and top up your business wallet balances.
  - name: Rates
    description: Fetch real-time exchange rates.
  - name: Checkout Sessions
    description: Create hosted checkout sessions.
  - name: Webhooks
    description: Webhook event payloads and sandbox webhook testing.
  - name: Media
    description: Generate presigned URLs for secure file uploads.
paths:
  /api/v1/org/rates:
    parameters:
      - $ref: '#/components/parameters/x-api-version'
    get:
      tags:
        - Rates
      summary: Get exchange rates
      description: Retrieves real-time exchange rates.
      operationId: getRates
      parameters:
        - name: fromSymbols
          in: query
          description: >-
            Comma-separated list of base currency symbols to filter rates by
            (e.g., USD,NGN,EUR). If omitted, defaults to USD only.
          required: false
          schema:
            type: string
            examples:
              - USD,NGN,EUR
        - name: toSymbols
          in: query
          description: >-
            Comma-separated list of target currency symbols to filter rates by
            (e.g., NGN,EUR,GBP). If omitted, all target currencies are returned.
          required: false
          schema:
            type: string
            examples:
              - NGN,EUR,GBP
      responses:
        '200':
          description: Successful retrieval of rates
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      rates:
                        type: object
                        description: Map of base currencies to their exchange rates
                        additionalProperties:
                          type: object
                          additionalProperties:
                            type: string
                            examples:
                              - '1.30272'
                        examples:
                          - USD:
                              USD: '1'
                              GBP: '0.69255'
                              EUR: '0.80832'
                              CAD: '1.30272'
                              NGN: '1410.1041'
                              KES: '125.0912'
                      updatedAt:
                        type: integer
                        format: int64
                        description: Unix timestamp of the last update
                        examples:
                          - 1773245407620
              examples:
                allRates:
                  summary: All USD rates
                  value:
                    data:
                      rates:
                        USD:
                          USD: '1'
                          EUR: '0.80832'
                          GBP: '0.69255'
                          CAD: '1.30272'
                          NGN: '1410.1041'
                          KES: '125.0912'
                          GHS: '10.96338'
                          UGX: '3485.0742'
                      updatedAt: 1775632339823
                filteredRates:
                  summary: Filtered, USD to NGN and GBP
                  value:
                    data:
                      rates:
                        USD:
                          NGN: '1410.1041'
                          GBP: '0.69255'
                      updatedAt: 1775632523393
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingApiKey:
                  summary: Missing API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Authorization header is missing
                    details: {}
                invalidApiKey:
                  summary: Invalid API key
                  value:
                    code: AUTHENTICATION_ERROR
                    error: Invalid authorization header
                    details: {}
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                serverError:
                  summary: Unexpected server error
                  value:
                    code: INTERNAL_SERVER_ERROR
                    error: It's not you, it's us, please reach out to support
                    details: {}
      x-codeSamples:
        - lang: TypeScript
          label: Afriex SDK
          source: |
            const response = await afriex.rates.getRates({
              fromSymbols: "USD,NGN",
              toSymbols: "NGN,USD,GBP,KES",
            });

            console.log(response.rates);
            console.log(response.updatedAt); // Unix timestamp
components:
  parameters:
    x-api-version:
      name: x-api-version
      in: header
      required: false
      description: >-
        API version in ISO 8601 format (e.g. 2025-12-28). Defaults to latest
        stable.
      schema:
        type: string
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code.
        error:
          type: string
          description: Human-readable error message.
        details:
          $ref: '#/components/schemas/ErrorDetails'
    ErrorDetails:
      type: object
      properties:
        errorMessage:
          type: string
          description: Detailed/technical error message.
        friendlyMessage:
          type: string
          description: User-facing error message safe to display.
        data:
          type: object
          description: >-
            Optional caller-safe context for the error. On a customer-create
            uniqueness conflict (EMAIL_ALREADY_EXISTS /
            PHONE_NUMBER_ALREADY_EXISTS) this carries the existing customer's
            id, so you can adopt it without a follow-up lookup.
          properties:
            customerId:
              type: string
              description: Id of the existing customer (on a create conflict).
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Static business API key issued from the dashboard. A business can
        provision **multiple API keys**, each scoped to a configurable set of
        **permissions** (e.g. read transactions, create deposits, etc).
        Permissions are chosen per key at creation time in the dashboard and may
        be revoked by deleting the key. Requests made with a key that does not
        include the permission required by the target endpoint will be rejected
        with a `403 Forbidden` response; an unrecognised, malformed or revoked
        key returns `401 Unauthorized`. Manage your keys and their permissions
        under **Developer → API keys** in the dashboard.

````