# Bank of Israel API
> Live official exchange-rate data from the Bank of Israel (BOI), the central bank of Israel, for the new shekel (ILS) — each rate with the day's percentage change: the BOI official representative rate for every published currency (normalised to one unit), a single currency's shekel-per-unit rate and inverse plus daily change, the currencies ranked by daily change against the shekel (biggest gainers and losers), and currency conversion between any two published currencies (including ILS) cross-computed through the shekel.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/boi-api/..."
```

## Pricing
- **Free** (Free) — 13,000 calls/Mo, 3 req/s
- **Basic** ($7/Mo) — 169,000 calls/Mo, 8 req/s
- **Pro** ($23/Mo) — 1,050,000 calls/Mo, 15 req/s
- **Scale** ($49/Mo) — 5,600,000 calls/Mo, 35 req/s

## Endpoints

### Rates

#### `GET /v1/rate` — One currency shekel-per-unit rate, inverse and daily change

**Parameters:**
- `currency` (query, required, string) — 3-letter ISO currency code Example: `USD`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/boi-api/v1/rate?currency=USD"
```

**Response:**
```json
{
    "data": {
        "base": "ILS",
        "unit": 1,
        "source": "Bank of Israel",
        "currency": "USD",
        "last_update": "2026-06-10",
        "ils_per_unit": 2.973,
        "unit_per_ils": 0.33636058,
        "daily_change_pct": 1.1913
    },
    "meta": {
        "timestamp": "2026-06-10T14:00:08.337Z",
        "request_id": "ffb48b88-22c5-4968-9b21-ee4c51239dc3"
    },
    "status": "ok",
    "message": "Rate retrieved successfully",
    "success": true
}
```

#### `GET /v1/rates` — BOI official rate for every currency vs the shekel

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/boi-api/v1/rates"
```

**Response:**
```json
{
    "data": {
        "base": "ILS",
        "date": "2026-06-10",
        "count": 14,
        "rates": [
            {
                "unit": 1,
                "currency": "AUD",
                "raw_rate": 2.0848,
                "last_update": "2026-06-10",
                "ils_per_unit": 2.0848,
                "daily_change_pct": 0.5498
            },
            {
                "unit": 1,
                "currency": "CAD",
                "raw_rate": 2.1342,
                "last_update": "2026-06-10",
                "ils_per_unit": 2.1342,
                "daily_change_pct": 1.1997
            },
            {
                "unit": 1,
                "currency": "CHF",
                "raw_rate": 3.723,
                "last_update": "2026-06-10",
                "ils_per_unit": 3.723,
                "daily_change_pct": 0.8397
            },
            {
                "unit": 1,
                "currency": "DKK",
                "raw_rate": 0.4595,
                "last_update": "2026-06-10",
                "ils_per_unit": 0.4595,
                "daily_change_pct": 1.0334
            },
            {
                "unit": 1,
                "currency": "EGP",
                "raw_rate": 0.0573,
                "last_update": "2026-06-10",
                "ils_per_unit": 0.0573,
                "daily_change_pct": 0.8803
            },
            {
                "unit": 1,
                "currency": "EUR",
                "raw_rate": 3.4346,
      
…(truncated, see openapi.json for full schema)
```

### Signals

#### `GET /v1/movers` — Currencies ranked by daily change vs the shekel

**Parameters:**
- `limit` (query, optional, string) — Number of gainers and losers each (1-13) Example: `5`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/boi-api/v1/movers?limit=5"
```

**Response:**
```json
{
    "data": {
        "base": "ILS",
        "date": "2026-06-10",
        "note": "daily change of the currency against the shekel, in percent",
        "losers": [
            {
                "currency": "LBP",
                "ils_per_unit": 3.0e-5,
                "daily_change_pct": 0
            },
            {
                "currency": "SEK",
                "ils_per_unit": 0.3132,
                "daily_change_pct": 0.2882
            },
            {
                "currency": "ZAR",
                "ils_per_unit": 0.1795,
                "daily_change_pct": 0.5039
            },
            {
                "currency": "AUD",
                "ils_per_unit": 2.0848,
                "daily_change_pct": 0.5498
            },
            {
                "currency": "NOK",
                "ils_per_unit": 0.3132,
                "daily_change_pct": 0.7722
            }
        ],
        "source": "Bank of Israel",
        "gainers": [
            {
                "currency": "JOD",
                "ils_per_unit": 4.1935,
                "daily_change_pct": 1.2092
            },
            {
                "currency": "CAD",
                "ils_per_unit": 2.1342,
                "daily_change_pct": 1.1997
            },
            {
                "currency": "USD",
                "ils_per_unit": 2.973,
                "daily_change_pct": 1.1913
            },
            {
                "currency": "GBP",
                "ils_per_unit": 3.9814,
      
…(truncated, see openapi.json for full schema)
```

### Convert

#### `GET /v1/convert` — Convert an amount between two currencies at BOI rates

**Parameters:**
- `from` (query, required, string) — Source currency Example: `USD`
- `to` (query, required, string) — Target currency Example: `EUR`
- `amount` (query, optional, string) — Amount to convert Example: `100`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/boi-api/v1/convert?from=USD&to=EUR&amount=100"
```

**Response:**
```json
{
    "data": {
        "to": "EUR",
        "date": "2026-06-10",
        "from": "USD",
        "rate": 0.86560298,
        "amount": 100,
        "result": 86.560298,
        "source": "Bank of Israel",
        "ils_per_to": 3.4346,
        "ils_per_from": 2.973
    },
    "meta": {
        "timestamp": "2026-06-10T14:00:09.934Z",
        "request_id": "b16048b1-d00a-494f-86b7-f5f74c18217e"
    },
    "status": "ok",
    "message": "Conversion completed successfully",
    "success": true
}
```

### Meta

#### `GET /v1/meta` — Service metadata and endpoint catalog

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/boi-api/v1/meta"
```

**Response:**
```json
{
    "data": {
        "source": "Bank of Israel public API (boi.org.il, live)",
        "service": "boi-api",
        "usd_ils": 2.973,
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/rate": "One currency's official rate, shekel-per-unit and inverse, plus daily change (currency=USD).",
            "GET /v1/rates": "The BOI official rate for every currency vs the shekel, with daily change.",
            "GET /v1/movers": "Currencies ranked by daily change vs the shekel — gainers and losers (limit=5).",
            "GET /v1/convert": "Convert an amount between two currencies at BOI rates (from=USD, to=EUR, amount=100)."
        },
        "description": "Live official exchange-rate data from the Bank of Israel (BOI), the central bank of Israel, for the new shekel (ILS), via its public API — each rate with the day's percentage change. The rates endpoint returns the BOI's official representative rate for every published currency against the shekel, normalised to one unit; the rate endpoint returns a single currency's official rate (shekel-per-unit and the inverse) plus the daily change; the movers endpoint ranks currencies by their daily change against the shekel (biggest gainers and losers); the convert endpoint converts an amount between any two published currencies (including ILS) at the BOI's official rates, cross-computed through the shekel. Live, no key, nothing stored. Distinct from the ECB, SNB, NBU, HNB, NBG, NBRB, CBU, CBA
…(truncated, see openapi.json for full schema)
```


---
Marketplace page: https://www.oanor.com/api/boi-api
OpenAPI spec: https://www.oanor.com/api/boi-api/openapi.json
