API Documentation

Welcome to the Zimbabwe Bank Rates API. This API provides programmatic access to real-time and historical exchange rate data for the Zimbabwe Gold (ZiG) currency.

Base URLhttps://zimbabwegoldexchangerates.icep0ps.dev/api/v1

Authentication

Currently, the API is public and does not require an API key for read-only access to public endpoints. Rate limiting is applied by IP address to ensure fair usage.

Get Latest Rates

Retrieves the most recent exchange rates available.

GET/rates/latest

Query Parameters

targetCurrencyOptionalFilter by currency code (e.g., 'USD').

Example Request

bash

curl -X GET "https://zimbabwegoldexchangerates.icep0ps.dev/api/v1/rates/latest"

Example Response

json

{
  "success": true,
  "data": [
    {
      "id": 123,
      "currency": "USD",
      "bid": "24.4000",
      "ask": "24.6000",
      "mid_rate": "24.5000",
      "bid_rate_zwg": "24.4000",
      "ask_rate_zwg": "24.6000",
      "mid_rate_zwg": "24.5000",
      "created_at": "2026-01-01",
      "previous_rate": 122
    }
  ],
  "is_fallback": false
}

Get Historical Rates

Retrieves exchange rates for a specific past date.

GET/rates/:date

Path Parameters

dateRequiredDate in YYYY-MM-DD format.

Example Request

bash

curl -X GET "https://zimbabwegoldexchangerates.icep0ps.dev/api/v1/rates/2025-12-25"

List Currencies

Returns a list of all supported currencies available in the system.

GET/currencies

Example Response

json

{
  "success": true,
  "data": [
    { "name": "USD" },
    { "name": "ZAR" },
    { "name": "GBP" },
    { "name": "EUR" }
  ]
}