Get Started

The Fincrux API allows you to access a wide range of financial data, including company financials, stock market data, and personalized financial insights. This guide will help you get started with authentication, making your first API request, and understanding how to use the API effectively.

Authentication Methods

Fincrux API provides two methods for authentication:

• Access Token Authentication - Requires login via email and password to obtain a token.
• API Key Authentication - Uses a unique API key for authorization.

You can choose either method based on your application's requirements.

Official clients

Install an official SDK for Python or Node.js, or call the REST API directly with cURL / any HTTP client.

Python

Copy
pip install fincrux

Copy
import fincrux

fc = fincrux.Fincrux(api_key="YOUR_API_KEY")
print(fc.get_company_financials("RELIANCE"))

Node.js / TypeScript

Copy
npm install fincrux

Copy
import { Fincrux } from "fincrux";

const fc = new Fincrux({ api_key: "YOUR_API_KEY" });
console.log(await fc.getCompanyFinancials("RELIANCE"));

Packages: PyPI fincrux · npm fincrux

Source: Python on GitHub · Node.js on GitHub

Authentication Types

To authenticate, you can either use an Access Token or an API Key.

• Using an Access Token - Refer to the Access Token Concept Guide to learn how to obtain and use an access token for API authentication.
• Using an API Key - Refer to the API Key Concept Guide to learn how to obtain and use API Keys.

Explore API Endpoints

Now that you're authenticated, explore the available endpoints to fetch various financial data: