Spec

Code snippets

curl "https://api.oanor.com/modularscale-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/modularscale-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/modularscale-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/modularscale-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "name": "Modular Scale API",
        "notes": "Each value is base × ratio^step, with step 0 = the base. Ideal for type scales, spacing systems and design tokens. This produces a numeric scale — to convert or build colour scales use the colour and gradient APIs. Nothing is stored.",
        "version": "v1",
        "endpoints": [
            {
                "path": "/v1/scale",
                "params": {
                    "up": "steps above the base (default 6)",
                    "base": "the base size (default 16)",
                    "down": "steps below the base (default 2)",
                    "unit": "optional suffix like px or rem",
                    "ratio": "named ratio, number, or a:b interval (default golden)",
                    "round": "decimal places (default 4)"
                },
                "returns": "the scale as an array of {step, value, formatted}"
            },
            {
                "path": "/v1/ratios",
                "params": [],
                "returns": "all named ratios with their decimal values"
            },
            {
                "path": "/v1/meta",
                "params": [],
                "returns": "this document"
            }
        ],
        "description": "Generate a modular (geometric) scale for typography and spacing. Pick a base value and a ratio — a named musical interval (minor-third, major-third, perfect-fourth, perfect-fifth, golden, octave…), a plain number like 1.25, or an interval like 3:2 — and get a harmonious scale of sizes stepping up and down from the base, each value being base × ratio^step. Choose how many steps above and below, the rounding, and an optional unit suffix (px, rem, em). The ratios endpoint lists every named ratio with its decimal value. Pure local maths, no key."
    },
    "meta": {
        "timestamp": "2026-06-03T09:25:05.398Z",
        "request_id": "753db686-143a-4ec4-858c-dc659ac6c703"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}