Introduction

Welcome to Finbar's developer documentation. This guide will help you fetch your first financial metric within minutes. You'll learn how to authenticate, call the REST API, and use our SDKs in your preferred programming language.

Authentication

Create an API key in Dashboard → API Keys and send it as a Bearer token in the Authorization header.

GET https://api.finbar.com/v1/metrics?ticker=AAPL&metric=revenue
Authorization: Bearer $FINBAR_KEY
Content-Type: application/json

Quickstart

Fetch Apple's revenue time series from 2019 to 2024 using curl:

curl -s https://api.finbar.com/v1/metrics \
  -H "Authorization: Bearer $FINBAR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ticker": "AAPL",
    "metric": "revenue",
    "from": 2019,
    "to": 2024
  }'

Endpoints

All API endpoints are served over HTTPS from our base URL: https://api.finbar.com/v1

Key endpoints include:

• GET /metrics — fetch a metric time series for a specific company
• GET /ratios — retrieve common financial ratios and calculations
• POST /screen — run a screener query across multiple companies
• GET /company — get detailed company information and metadata

Error Handling

Finbar uses conventional HTTP response codes to indicate success or failure of API requests.

{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'ticker' parameter is required",
    "param": "ticker"
  }
}

Rate Limits

API rate limits vary based on your plan. Free tier allows 1,000 requests per month, while paid plans offer higher limits.

Check your current usage in the dashboard or via the X-RateLimit-Limit and X-RateLimit-Remaining headers included in all responses.