# Hkab — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Access real-time Hong Kong HIBOR interest rates and daily exchange rates to stay updated on key financial benchmarks. Get the latest market highlights and rate information directly from the Hong Kong Association of Banks to inform your financial decisions.

**Category:** Finance & Markets | **Website:** [hkab.org.hk/](https://hkab.org.hk/) | **Docs:** [parse.bot/marketplace/446c5e80-e787-40ab-9923-4226cc878030/hkab-org-hk-api](https://parse.bot/marketplace/446c5e80-e787-40ab-9923-4226cc878030/hkab-org-hk-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-hkab-org-hk-api-446c5e80/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_exchange_rates

Fetches HKAB opening indicative counter exchange rates for a specific date. Returns buying and selling rates for all published currency pairs against HKD. When no date is provided, returns the most recent available rates. Rates are expressed in HKD per unit of foreign currency (or per 100 units for some currencies).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `date` | string | No | Date in YYYY-MM-DD format (e.g. '2026-06-09'). Omitting returns the latest available date. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-hkab-org-hk-api-446c5e80/get_exchange_rates \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date":"<string>"}'
```

### get_hibor_rates

Fetches HKAB HKD Interest Settlement Rates (HIBOR) for a specific date. Returns rates for all standard tenors (Overnight through 12 Months). When no date parameters are supplied, returns the most recent available rates, automatically skipping weekends and holidays. Each rate is a percentage value. The publication_time reflects the official HKAB fixing time.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `day` | integer | No | Day (1-31). When omitted along with year and month, returns latest available rates. |
| `month` | integer | No | Month (1-12). When omitted along with year and day, returns latest available rates. |
| `year` | integer | No | Year (e.g. 2026). When omitted along with month and day, returns latest available rates. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-hkab-org-hk-api-446c5e80/get_hibor_rates \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"day":"<integer>","month":"<integer>","year":"<integer>"}'
```

### get_hibor_rates_range

Fetches daily HIBOR rates for every business day (Monday–Friday) within a date range. Returns an array of daily records ordered chronologically. Each record contains the full set of tenor rates. Weekends are automatically skipped. The date range must not exceed 31 days. Holidays within the range are included in the results with is_holiday=true and null rates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `end_date` | string | Yes | End date in YYYY-MM-DD format (e.g. '2026-08-05'). Must not be before start_date and range must not exceed 31 days. |
| `start_date` | string | Yes | Start date in YYYY-MM-DD format (e.g. '2026-08-01'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-hkab-org-hk-api-446c5e80/get_hibor_rates_range \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"end_date":"<string>","start_date":"<string>"}'
```

### get_homepage_highlights

Fetches a combined summary of the latest HIBOR rates and major exchange rates (AUD, EUR, GBP, JPY, CNY, CNH, USD) in a single response. Useful for quick market overviews without making separate calls. No parameters required — always returns the most recent available data.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-hkab-org-hk-api-446c5e80/get_homepage_highlights \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```