Licence
MIT
Version
0.2.0
Deps
1
Size
1.6 MB
Vulns
0
Weekly
320
@stockfit/api
Official TypeScript / Node.js SDK for the StockFit API: SEC EDGAR financials, filings, fund and ETF data, ownership, insider transactions, and earnings.
Fully typed, generated from the StockFit OpenAPI spec.
Install
npm install @stockfit/apiRequires Node.js 18+ (uses the built-in fetch).
Authentication
Get an API token from your StockFit account. Configure the client once, then call any endpoint function:
import {createClient, incomeStatement, companyDetails} from '@stockfit/api';
createClient({token: process.env.STOCKFIT_TOKEN!});
const income = await incomeStatement({query: {symbol: 'AAPL'}});
console.log(income.data);
const profile = await companyDetails({query: {symbol: 'AAPL'}});
console.log(profile.data);Tree-shakeable: import only the endpoints you use.
Configuration
createClient({
token: 'fl_...',
baseUrl: 'https://api.stockfit.io/v1', // optional override
});Examples
Runnable example apps live in examples/:
company-exploreris a Next.js app with a search bar that shows company details. It calls the SDK server-side via a Next route handler, so the API token stays on the server and never reaches the browser (the recommended pattern for web apps).
License
MIT, Copyright Second Dot LLC. Use of the StockFit API itself is governed by the StockFit terms of service and your subscription.