Authentication

All FinBrain API requests require authentication using your API key passed as a query parameter.

Authentication Method

Token Query Parameter

Include your API key in every request using the token query parameter:

https://api.finbrain.tech/v1/endpoint?token=YOUR_API_KEY

Example

cURL

curl "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily?token=YOUR_API_KEY"

Python

import requests

response = requests.get(
    "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily",
    params={"token": "YOUR_API_KEY"}
)

JavaScript

const API_KEY = "YOUR_API_KEY";

const response = await fetch(
  `https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily?token=${API_KEY}`
);

Getting an API Key

1. Visit finbrain.tech
2. Create an account or sign in
3. Navigate to your account dashboard
4. Copy your API key

Authentication Errors

401 Unauthorized

Returned when the API key is missing or invalid.

Response:

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}

Common causes:

• Missing token parameter in the request
• Typo in the API key
• Using an expired or revoked API key

403 Forbidden

Returned when the API key is valid but lacks permission for the requested resource.

Response:

{
  "error": "Forbidden",
  "message": "Access denied for this resource"
}

Common causes:

• Endpoint not included in your subscription tier
• Account suspended
• Accessing a restricted resource

429 Too Many Requests

Returned when rate limits are exceeded.

Response:

{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please slow down."
}

Rate Limits

Tier	Requests/Day	Requests/Minute
Free	100	10
Basic	1,000	60
Professional	10,000	300
Enterprise	Unlimited	Custom

Security Best Practices

Environment Variables

Never hardcode your API key. Use environment variables:

Python

import os
from finbrain import FinBrainClient

api_key = os.environ.get("FINBRAIN_API_KEY")
fb = FinBrainClient(api_key=api_key)

JavaScript

const API_KEY = process.env.FINBRAIN_API_KEY;

Bash

export FINBRAIN_API_KEY="your_api_key_here"
curl "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily?token=$FINBRAIN_API_KEY"

.env Files

For local development, use a .env file:

.env

FINBRAIN_API_KEY=your_api_key_here

Add .env to your .gitignore:

.gitignore

.env

Production Secrets

In production, use your platform’s secrets management:

• AWS: Secrets Manager or Parameter Store
• Google Cloud: Secret Manager
• Azure: Key Vault
• Heroku: Config Vars
• Vercel: Environment Variables

Additional Security Tips

1. Never commit API keys to version control
2. Don’t expose keys in client-side code - use a backend proxy
3. Rotate keys periodically - especially after team member changes
4. Use different keys for development and production
5. Monitor usage - check for unexpected API call patterns

Related Documentation

• API Reference Overview
• Error Codes
• Python SDK