Overview
This guide will help you authenticate with the Finscreener API and make your first request in just a few minutes.
Step 1: Get Your API Key
Navigate to Security Settings
Go to User Profile → Security tab in your Finscreener dashboard.
Copy Your API Key
Your Developer API Key starts with fsk_. Copy this key and keep it secure.
Never share your API key publicly or commit it to version control. Treat it like a password.
Step 2: Authenticate
Exchange your API key for JWT tokens:
curl -X POST https://api.finscreener.in/api/auth/api-key/login \
-H "Content-Type: application/json" \
-d '{"api_key": "fsk_your_api_key_here"}'
{
"success": true,
"message": "Login successful",
"user": {
"name": "Your Name",
"userId": "usr_xxxxx"
},
"token": {
"access_token": "eyJhbGciOiJIUzI1NiIs...",
"refresh_token": "eyJhbGciOiJIUzI1NiIs...",
"token_type": "bearer"
}
}
Step 3: Make Your First Request
Use the access token to search for companies:
curl -X POST https://api.finscreener.in/api/screener/search \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"query": "City == '\''Mumbai'\'' AND llpStatus == '\''Active'\''",
"type": "company",
"page": 1,
"limit": 10
}'
Next Steps
Code Examples
import requests
API_KEY = "fsk_your_api_key"
BASE_URL = "https://api.finscreener.in"
# Step 1: Authenticate
auth_response = requests.post(
f"{BASE_URL}/api/auth/api-key/login",
json={"api_key": API_KEY}
)
token = auth_response.json()["token"]["access_token"]
# Step 2: Search companies
headers = {"Authorization": f"Bearer {token}"}
search_response = requests.post(
f"{BASE_URL}/api/screener/search",
headers=headers,
json={
"query": "City == 'Mumbai' AND paidUpCapital > 10000000",
"type": "company",
"page": 1,
"limit": 10
}
)
companies = search_response.json()["data"]
print(f"Found {len(companies)} companies")
