Finbud Data TypeScript API Library
by glaksmono
This library provides convenient access to the Finbud Data REST API from server-side TypeScript or JavaScript. It is generated with Stainless.
Last updated: N/A
What is Finbud Data TypeScript API Library?
Finbud Data TypeScript API Library is a client library that simplifies interaction with the Finbud Data REST API. It provides TypeScript definitions for request and response types, error handling, retries, timeouts, and advanced features like accessing raw response data and logging.
How to use Finbud Data TypeScript API Library?
Install the library using npm install finbud-data
. Import the library and instantiate a client with your API key. Use the client's methods to interact with the Finbud Data API, handling potential errors using try/catch blocks and checking for FinbudData.APIError
instances.
Key features of Finbud Data TypeScript API Library
TypeScript definitions for request and response types
Automatic retries for certain errors
Configurable timeouts
Access to raw Response data (headers)
Customizable logging
Support for undocumented endpoints and parameters
Use cases of Finbud Data TypeScript API Library
Retrieving financial analyst estimates
Automating data retrieval from Finbud Data
Integrating Finbud Data into TypeScript applications
Building financial analysis tools
FAQ from Finbud Data TypeScript API Library
What is Semantic Versioning?
What is Semantic Versioning?
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions.
What TypeScript version is supported?
What TypeScript version is supported?
TypeScript >= 4.9 is supported.
What runtimes are supported?
What runtimes are supported?
Web browsers, Node.js 18 LTS or later, Deno v1.28.0 or higher, Bun 1.0 or later, Cloudflare Workers, Vercel Edge Runtime, Jest 28 or greater with the "node" environment, and Nitro v2.6 or greater.
How do I configure retries?
How do I configure retries?
Use the maxRetries
option when instantiating the client or on a per-request basis.
How do I configure timeouts?
How do I configure timeouts?
Use the timeout
option when instantiating the client or on a per-request basis.