FMP Node Wrapper Documentation

Welcome to the comprehensive documentation for the FMP Node Wrapper - a powerful Node.js library for interacting with the Financial Modeling Prep API.

What is FMP Node Wrapper?

The FMP Node Wrapper is a TypeScript-first Node.js library that provides a clean, intuitive interface for accessing financial data from the Financial Modeling Prep API. It offers:

Type Safety: Full TypeScript support with comprehensive type definitions
Easy Integration: Simple setup and straightforward API calls
Comprehensive Coverage: Support for all major FMP API endpoints
Error Handling: Consistent error handling across all endpoints
Performance: Optimized for high-performance applications

Quick Start

Get started with the FMP Node Wrapper in just a few steps:

1npm install fmp-node-api

1import { FMP } from 'fmp-node-api';
2
3// Initialize the client (uses FMP_API_KEY environment variable)
4const fmp = new FMP();
5
6// Get a stock quote
7const quote = await fmp.quote.getQuote({ symbol: 'AAPL' });

Key Features

🚀 Easy Setup

Simple initialization with your API key and optional configuration.

📊 Stock Data

Access real-time and historical stock data, quotes, and market information.

💰 Financial Statements

Retrieve income statements, balance sheets, and cash flow statements.

📈 Historical Data

Get historical price data with flexible date ranges and intervals.

🏢 Company Information

Access company profiles, ratios, and fundamental data.

Getting Started

Ready to dive in? Start with our Getting Started Guide to learn how to set up and use the library.

Configuration

Learn about different configuration options including environment variables, security best practices, and troubleshooting in our Configuration Guide.

API Reference

Explore the complete API Reference to see all available endpoints and their usage.

Examples

Check out our Examples section for practical code samples and use cases.

Support

If you need help or have questions:

Check the API Reference for detailed endpoint documentation
Review the Examples for common use cases
Open an issue on our GitHub repository

Ready to get started? Install the package and begin building with financial data today!