Overview
This reference documents all available endpoints in the FinBrain REST API. Use this documentation to integrate FinBrain data into your applications, trading systems, and research workflows.
Base URL
Section titled “Base URL”All API requests are made to:
https://api.finbrain.tech/v1/Authentication
Section titled “Authentication”All endpoints require authentication via the token query parameter:
?token=YOUR_API_KEYSee Authentication for details.
Available Endpoints
Section titled “Available Endpoints”Market Discovery
Section titled “Market Discovery”| Endpoint | Method | Description |
|---|---|---|
/v1/available/markets | GET | List all available markets |
/v1/available/tickers/{type} | GET | List all tickers for a prediction type |
Predictions
Section titled “Predictions”| Endpoint | Method | Description |
|---|---|---|
/v1/market/{market}/predictions/{type} | GET | Get predictions for all tickers in a market |
/v1/ticker/{ticker}/predictions/{type} | GET | Get predictions for a specific ticker |
Alternative Data
Section titled “Alternative Data”| Endpoint | Method | Description |
|---|---|---|
/v1/sentiments/{market}/{ticker} | GET | Get sentiment scores |
/v1/insidertransactions/{market}/{ticker} | GET | Get insider trading data |
/v1/housetrades/{market}/{ticker} | GET | Get congressional trades |
/v1/analystratings/{market}/{ticker} | GET | Get analyst ratings |
/v1/putcalldata/{market}/{ticker} | GET | Get options put/call ratios |
/v1/linkedindata/{market}/{ticker} | GET | Get LinkedIn metrics |
/v1/appratings/{market}/{ticker} | Get mobile app ratings |
Request Format
Section titled “Request Format”URL Parameters
Section titled “URL Parameters”| Parameter | Description | Example |
|---|---|---|
{market} | Market identifier | S&P 500, NASDAQ |
{ticker} | Stock symbol | AAPL, TSLA |
{type} | Prediction type | daily, monthly |
Query Parameters
Section titled “Query Parameters”| Parameter | Required | Description |
|---|---|---|
token | Yes | Your API key |
dateFrom | No | Start date (YYYY-MM-DD) |
dateTo | No | End date (YYYY-MM-DD) |
Example Request
Section titled “Example Request”curl "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily?token=YOUR_API_KEY"import requests
url = "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily"params = {"token": "YOUR_API_KEY"}
response = requests.get(url, params=params)data = response.json()const response = await fetch( "https://api.finbrain.tech/v1/ticker/AAPL/predictions/daily?token=YOUR_API_KEY");const data = await response.json();Response Format
Section titled “Response Format”All responses are returned as JSON.
Success Response
Section titled “Success Response”{ "ticker": "AAPL", "market": "S&P 500", "data": [ // ... endpoint-specific data ]}Error Response
Section titled “Error Response”{ "error": "Error Type", "message": "Human-readable error message"}HTTP Status Codes
Section titled “HTTP Status Codes”| Code | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 403 | Forbidden - Access denied |
| 404 | Not Found - Data not found |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |
See Error Codes for detailed error documentation.
Rate Limits
Section titled “Rate Limits”| Tier | Requests/Day | Requests/Minute |
|---|---|---|
| Free | 100 | 10 |
| Basic | 1,000 | 60 |
| Professional | 10,000 | 300 |
| Enterprise | Unlimited | Custom |
SDKs and Libraries
Section titled “SDKs and Libraries”For easier integration, use our official SDK:
- Python SDK -
pip install finbrain-python - MCP Integration -
pip install finbrain-mcp
Next Steps
Section titled “Next Steps”- Authentication - Learn about API authentication
- Available Markets - Discover available markets
- Ticker Predictions - Get AI predictions
- Error Codes - Handle errors properly