Clients

TypeScript SDK

@compound/api, zero-dependency fetch client, generated from the same catalog the API serves, typed end to end.

Install

npm i @compound/api

Use

One method per endpoint, camel-cased. async: true narrows the return type to a job handle; waitForJob resolves on success or failure (a failed job is never charged).

app.ts

import { CompoundCore } from "@compound/api";

const compound = new CompoundCore({ apiKey: process.env.COMPOUND_API_KEY! });

// Sync call
const invoice = await compound.invoice({ data: pdfBase64 });

// Async job with polling handled for you
const job = await compound.parse({ data: bigPdfBase64, async: true });
const result = await compound.waitForJob(job.jobId);

Every method's snippet, with a real example body, lives on its collection guide.