frankfurter-api-status-client

A lightweight, type-safe JavaScript/TypeScript client for the Frankfurter API Status Page, designed for developers who want a minimal way to check service health and inspect public status information. This package wraps the Frankfurter status endpoints with a small promise-based API and predictable success/failure responses.

📦 Installation

npm install frankfurter-api-status-client

💡 Note: This package reads from the public Frankfurter API status page. No API Keys are required. The current package version supports the public Frankfurter Status API endpoints exposed via Instatus.

📘 Features

1. TypeScript-first with exported type definitions
2. Lightweight wrapper around Frankfurter public status endpoints
3. Simple promise-based API for summary and component health checks
4. Zero runtime configuration required
5. Works in both Node.js environments with fetch support and modern browsers

🔤 Example Usage

1. 📁 Get API Status Summary

import { getAPISummary } from 'frankfurter-api-status-client';

async function myFunc() {
  const response = await getAPISummary();
  console.log(response);
}
/* fetch */
await myFunc();

/*
{
  code: "api-ok",
  message: "No Errors. Check Summary.",
  summary: {
    page: { ... },
    components: [ ... ],
    incidents: [ ... ],
    scheduled_maintenances: [ ... ]
  }
}
*/

2. 📁 Get API Status Components

import { getAPIComponents } from 'frankfurter-api-status-client';

async function myFunc() {
  const response = await getAPIComponents();
  console.log(response);
}
/* fetch */
await myFunc();

/*
{
  code: "api-ok",
  message: "No Errors. Check Components Info.",
  components: [
    {
      id: "...",
      name: "...",
      status: "OPERATIONAL"
    }
    ...
  ]
}
*/

📗 Test Coverage

PASS src/get-summary/tests/get-summary.test.ts
  Get API Summary
    ✓ returns 200-OK response w. summary (49 ms)
    ✓ returns 500-ISE response no summary (9 ms)

PASS src/get-components/tests/get-components.test.ts
  Get API Components
    ✓ returns 200-OK response w. components (32 ms)
    ✓ returns 500-ISE response no components (7 ms)

Test Suites: 2 passed, 2 total
Tests:       4 passed, 4 total
Snapshots:   0 total

----------------------------|---------|----------|---------|---------|-------------------
File                        | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------------------------|---------|----------|---------|---------|-------------------
All files                   |   95.16 |     90.9 |     100 |   95.16 |
 get-components             |      90 |     87.5 |     100 |      90 |
  index.ts                  |      90 |     87.5 |     100 |      90 | 24-26
 get-components/tests       |     100 |      100 |     100 |     100 |
  msw-handlers.ts           |     100 |      100 |     100 |     100 |
 get-summary                |   89.65 |    88.88 |     100 |   89.65 |
  index.ts                  |   89.65 |    88.88 |     100 |   89.65 | 23-25
 get-summary/tests          |     100 |      100 |     100 |     100 |
  msw-handlers.ts           |     100 |      100 |     100 |     100 |
 shared                     |     100 |      100 |     100 |     100 |
  create-msw-mock-server.ts |     100 |      100 |     100 |     100 |
  index.ts                  |     100 |      100 |     100 |     100 |
----------------------------|---------|----------|---------|---------|-------------------

🗂 Related NPM Packages

1. Frankfurter API Client: V1: https://www.npmjs.com/package/frankfurter-api-client
2. Frankfurter API Client: V2: https://www.npmjs.com/package/frankfurter-api-client-v2
3. Frankfurter API Status Client: https://www.npmjs.com/package/frankfurter-api-status-client

📘 Contributing

Contributions, suggestions, and improvements are welcome. Feel free to open issues or pull requests.

❤️ Support

Like this project? Support it with a github star, it would mean a lot to me! Cheers and Happy Coding.