Finbud Data TypeScript API Library

What is Finbud Data TypeScript API Library?

It is a TypeScript/JavaScript library that provides convenient access to the Finbud Data REST API. It is generated with Stainless and offers full type safety for requests and responses. Designed for server-side developers using TypeScript or JavaScript.

How to use Finbud Data TypeScript API Library?

Install via npm install finbud-data. Import the client, pass an API key (defaults to FINBUD_DATA_API_KEY environment variable), and call methods such as client.analysts.retrieveEstimates. The full API is detailed in api.md.

Key features of Finbud Data TypeScript API Library

• TypeScript definitions for all request params and response fields.
• Automatic retries on certain errors (default 2 times).
• Configurable timeouts (default 1 minute).
• Customizable logging with multiple log levels.
• Access to raw Response data via .asResponse().
• Supports Node.js, Deno, Bun, browsers, Cloudflare Workers, and more.

Use cases of Finbud Data TypeScript API Library

• Retrieve analyst estimates from the Finbud Data API.
• Build server-side applications that query financial data.
• Integrate Finbud Data into TypeScript or JavaScript projects with full type safety.

FAQ from Finbud Data TypeScript API Library

What are the runtime and language requirements?

TypeScript >= 4.9 is required. Supported runtimes include Node.js 18+, Deno v1.28+, Bun 1.0+, and modern web browsers.

How does error handling work?

Errors are subclasses of APIError, with specific types for 4xx/5xx responses. Certain errors (connection issues, 408, 409, 429, >=500) are automatically retried twice by default.

Can I customize the fetch client or logging?

Yes. You can supply a custom fetch function or fetchOptions. Logging can be configured via the FINBUD_DATA_LOG environment variable or the logLevel client option, and a custom logger (e.g., pino) can be passed.

Is this library semantically versioned?

It follows SemVer, but minor versions may include backwards-incompatible changes that affect only static types or internal, undocumented behavior.

Where can I find the full API documentation?

The full API is documented in api.md and via docstrings that appear on hover in most modern editors.