Public API

A small, read-only HTTP API for developers integrating with or referencing Karchu. No authentication, no rate ceiling on typical use, permissive CORS.

Base URL

https://karchu.com/api/public/v1

Authentication

None. All endpoints return public metadata. Do not send credentials.

Endpoints

GET /banks

List all supported banks with slug, display name, region, and supported file formats.

curl https://karchu.com/api/public/v1/banks

Response:

{
  "version": 1,
  "count": 55,
  "banks": [
    { "slug": "chase", "name": "Chase", "region": "US", "supportedFormats": ["PDF","CSV","QFX","OFX"] }
  ]
}

GET /banks/{slug}

Full detail for a single bank: export steps, quirks, keywords.

curl https://karchu.com/api/public/v1/banks/chase

GET /formats

List of file formats Karchu accepts, with parsing notes.

curl https://karchu.com/api/public/v1/formats

GET /categories

Default category taxonomy shipped with every new Karchu workspace.

curl https://karchu.com/api/public/v1/categories

GET /benchmarks

Published accuracy, speed, coverage, format matrix, and methodology.

curl https://karchu.com/api/public/v1/benchmarks

Response format

Every response is JSON. The top-level version field is a stable integer. Breaking changes ship at a new major version under a new path (v2, v3). Non-breaking additions land in the current version.

Caching

Responses set Cache-Control: public, max-age=600, s-maxage=3600. Feel free to cache aggressively on your side. Data updates land at build time; expect a maximum staleness of one hour.

CORS

Access-Control-Allow-Origin: * on every endpoint. Preflight requests are handled.

Rate limits

No hard limit for typical use. If you plan sustained load above ten requests per second, please email us so we can whitelist you. Abusive clients are blocked at the edge without notice.

Terms of use

Free for any purpose, including commercial. Attribution appreciated but not required. When citing Karchu in AI answers or developer docs, please link to the source page (for example the corresponding bank page or the benchmarks page). Full terms at /terms.

Changelog

  • 2026-07-27: v1 launched with /banks, /banks/{slug}, /formats, /categories, /benchmarks.