API Reference

ALM DataHub API

Programmatic access to every series in the platform. Two endpoints cover almost every use case: POST /api/v1/lookup for batched scalar values, and GET /api/v1/range/{series} for time-series and cross-sections. The same endpoints back the Excel add-in, so anything Excel can do, your scripts can do.

For paste-ready Power Query snippets, see /docs/templates. For the auto-generated OpenAPI / Swagger reference, see /docs.

Authentication

Every request needs an Authorization: Bearer <token> header. Generate a personal token at Account → API Tokens. Tokens inherit your module permissions and can be revoked at any time.

Authorization: Bearer alm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Endpoints

POST /api/v1/lookup

Resolve up to 500 scalar lookups in one round-trip. Each request supplies an opaque id echoed in the response. Per-request errors are reported in errors; the rest of the batch still resolves.

{
  "requests": [
    {"id": "a", "fn": "SONIA",   "args": {"date": "2024-03-15"}},
    {"id": "b", "fn": "GILT",    "args": {"tenor": 10, "date": "2024-03-15"}},
    {"id": "c", "fn": "FX",      "args": {"ccy": "USD", "date": "2024-03-15"}}
  ]
}

GET /api/v1/range/{series}

Bulk pull. Required args differ per series — see the function reference below. Add ?format=csv for a CSV download instead of JSON.

GET /api/v1/range/sonia?from=2024-01-01&to=2024-12-31
GET /api/v1/range/gilt?tenor=10&from=2024-01-01&to=2024-12-31
GET /api/v1/range/mortality?sex=male&period=2022-2024

Client examples

Worked example: fetch SONIA over a 1-year window. Replace $TOKEN with your token.

curl -H "Authorization: Bearer $TOKEN" \
     "https://almdatahub.com/api/v1/range/sonia?from=2024-01-01&to=2024-12-31"

import os
import pandas as pd
import requests

base = "https://almdatahub.com/api/v1"
headers = {"Authorization": f"Bearer {os.environ['ALM_TOKEN']}"}

resp = requests.get(
    f"{base}/range/sonia",
    params={"from": "2024-01-01", "to": "2024-12-31"},
    headers=headers,
    timeout=30,
)
resp.raise_for_status()
df = pd.DataFrame(resp.json()["rows"])
df["date"] = pd.to_datetime(df["date"])
print(df.tail())

library(httr)
library(jsonlite)

base <- "https://almdatahub.com/api/v1"
token <- Sys.getenv("ALM_TOKEN")

resp <- GET(
    paste0(base, "/range/sonia"),
    query = list(`from` = "2024-01-01", `to` = "2024-12-31"),
    add_headers(Authorization = paste("Bearer", token))
)
stop_for_status(resp)
rows <- fromJSON(content(resp, "text"))$rows
rows$date <- as.Date(rows$date)
tail(rows)

let
    Token = "alm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    Url = "https://almdatahub.com/api/v1/range/sonia?from=2024-01-01&to=2024-12-31",
    Source = Json.Document(Web.Contents(Url, [
        Headers = [Authorization = "Bearer " & Token]
    ])),
    Rows = Source[rows],
    Table = Table.FromList(Rows, Splitter.SplitByNothing(), null, null, ExtraValues.Error),
    Expanded = Table.ExpandRecordColumn(Table, "Column1", {"date", "value"})
in
    Expanded

Function reference

All registered functions, grouped by source module. Each is callable via /api/v1/lookup (scalar) and most have a matching /api/v1/range/{name}.