FinanceFlow API Documentation

Welcome to the FinanceFlow API, your ultimate financial data API for accessing real-time and historical market data. Explore commodities, government bonds, economic events, stock indices, and over 511,000+ stock tickers like AAPL, TSLA, and GOOGL. Our open-source documentation is now available on GitHub, making it easier to integrate and contribute.

Sign up for a free API key (200 requests/month) or upgrade to Standard ($10.99/month) or Premium ($20.99/month) plans. Star our GitHub repo to stay updated!

Basic Principles

  • Access to the API is granted via an API key, available in your account dashboard.
  • Base URL: https://financeflowapi.com/api/v1/
  • Endpoints (e.g., commodity-spot, ticker-spot) follow the base URL.
  • The api_key parameter is mandatory for all requests.
  • Explore detailed docs for each endpoint on GitHub.

Request Examples

Fetching stock ticker data (e.g., AAPL):

GET https://financeflowapi.com/api/v1/ticker-spot?api_key=YOUR_API_KEY&ticker=AAPL

Example with an actual key:

GET https://financeflowapi.com/api/v1/ticker-spot?api_key=k2d93mn57x;l37c3lxds&ticker=AAPL

Important: Requests require a valid API key. Get yours now and start building!

Commodity API - Real-Time and Historical Market Data

The Commodity API delivers real-time and historical data for commodities like gold, oil, and coal. Ideal for financial analysts and traders, it provides reliable pricing and trends. Explore the full documentation on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

1. Supported Commodities List

Endpoint: /commodity-catalog

Lists all supported commodities (e.g., aluminum, barley).

Request Parameters:

  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/commodity-catalog?api_key=YOUR_API_KEY

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740778358,
        "request_id": "67c22b7644819"
    },
    "data": [
        {"name": "aluminum"},
        {"name": "barley"},
        ...
    ]
}
                        

2. Real-Time Commodity Price

Endpoint: /commodity-spot

Retrieves the latest price for a specific commodity.

Request Parameters:

  • name (string, required) - The commodity name (e.g., "coal").
  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/commodity-spot?api_key=YOUR_API_KEY&name=Coal

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740775729,
        "request_id": "67c221313880a"
    },
    "data": {
        "commodity_name": "coal",
        "current_price": 100.1,
        "daily_change": "2.30",
        "daily_change_percent": "-2.25%",
        "weekly_change_percent": "-3.29%",
        "monthly_change_percent": "-12.99%",
        "ytd_change_percent": "-20.08%",
        "yearly_change_percent": "-23.59%",
        "last_updated": "2024-09-20"
    }
}
                        

3. Historical Commodity Data

Endpoint: /commodity-history

Provides historical price data for a commodity over a period (max 100 days).

Request Parameters:

  • name (string, required) - The commodity name (e.g., "gold").
  • interval (string, required) - Data interval: day or month.
  • date_from (string, optional) - Start date (YYYY-MM-DD).
  • date_to (string, optional) - End date (YYYY-MM-DD).
  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/commodity-history?api_key=YOUR_API_KEY&name=Gold&interval=day&date_from=2025-01-01&date_to=2025-01-31

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740776956,
        "request_id": "67c225fc0cf7a"
    },
    "data": [
        {"date": "2025-01-31", "price": 2797.16},
        {"date": "2025-01-30", "price": 2796.18},
        ...
    ]
}
                        

Conclusion: The Commodity API is your go-to for real-time and historical commodity data. Integrate it today and explore detailed docs on GitHub. Start now!

Government Bonds API - Real-Time and Historical Bond Yields

The Government Bonds API provides real-time and historical yield data for bonds from countries like the US and Germany. Essential for investors and analysts, it’s now fully documented on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

1. Supported Countries List

Endpoint: /bonds-catalog

Lists countries with available bond data (e.g., Australia, Austria).

Request Parameters:

  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/bonds-catalog?api_key=YOUR_API_KEY

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740777157,
        "request_id": "67c226c5a42f6"
    },
    "data": [
        {"bond_country": "australia"},
        {"bond_country": "austria"},
        ...
    ]
}
                        

2. Real-Time Government Bond Yields

Endpoint: /bonds-spot

Retrieves real-time yield data for bonds by country and maturity type.

Request Parameters:

  • region (string, optional) - Region filter (e.g., "europe").
  • country (string, required) - Country name (e.g., "united_states").
  • type (string, required) - Bond maturity type (e.g., "10y", "6m").
  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/bonds-spot?api_key=YOUR_API_KEY&country=united_states&type=10y

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740777735,
        "request_id": "67c2290775514"
    },
    "data": [
        {
            "bond_country": "united_states",
            "bond_yield": 4.215,
            "bond_type": "10Y",
            "daily_bond_change": "0.0500",
            "weekly_bond_change_percent": "-0.22%",
            "monthly_bond_change_percent": "-0.33%",
            "ytd_bond_value_change": "-0.36%",
            "yearly_bond_change_percent": "-0.04%",
            "last_updated": "2024-09-11 21:22:12"
        }
    ]
}
                        

3. Historical Government Bond Yields

Endpoint: /bonds-history

Provides historical yield data for bonds over a period (max 100 days).

Request Parameters:

  • frequency (string, required) - Data interval: day or month.
  • country (string, required) - Country name (e.g., "germany").
  • type (string, required) - Bond maturity type (e.g., "10y").
  • date_from (string, optional) - Start date (YYYY-MM-DD).
  • date_to (string, optional) - End date (YYYY-MM-DD).
  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/bonds-history?api_key=YOUR_API_KEY&country=united_states&type=10y&frequency=day&date_from=2025-01-01&date_to=2025-01-31

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740777901,
        "request_id": "67c229ad838c9"
    },
    "data": [
        {"date": "2025-01-31", "bond_type": "10y", "price": 4.541},
        {"date": "2025-01-30", "bond_type": "10y", "price": 4.519},
        ...
    ]
}
                        

Conclusion: The Government Bonds API empowers you with precise bond yield data. Check the full docs on GitHub and start integrating!

Financial Calendar API - Key Economic Events

The Financial Calendar API delivers schedules of economic events like PMI and GDP reports for countries worldwide. Crucial for traders and analysts, it’s fully documented on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

1. Supported Countries List

Endpoint: /calendar-catalog

Lists countries with available financial calendar data.

Request Parameters:

  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/calendar-catalog?api_key=YOUR_API_KEY

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740778132,
        "request_id": "67c22a948bc91"
    },
    "data": [
        {"country": "Afghanistan"},
        {"country": "Albania"},
        ...
    ]
}
                        

2. Financial Calendar

Endpoint: /financial-calendar

Retrieves upcoming economic events for a country or globally (max 60 days).

Request Parameters:

  • country (string, optional) - Country name (e.g., "United States").
  • date_from (string, optional) - Start date (YYYY-MM-DD).
  • date_to (string, optional) - End date (YYYY-MM-DD).
  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/financial-calendar?api_key=YOUR_API_KEY&country=United States&date_from=2025-03-01&date_to=2025-03-07

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1740778240,
        "request_id": "67c22b003df2b"
    },
    "data": [
        {
            "country": "United States",
            "report_name": "S&P Global Manufacturing PMI Final",
            "actual": "",
            "previous": "51.2",
            "consensus": "51.6",
            "economicImpact": "Moderate",
            "report_date": "02",
            "datetime": "2025-03-03 14:45:00"
        },
        ...
    ]
}
                        

Conclusion: Stay ahead with the Financial Calendar API. View detailed docs on GitHub and get started!

World Economic Indicators API - Real-Time Economic Data

The World Economic Indicators API provides real-time and historical data on indicators like consumer credit and PMI. Perfect for economists and investors, it’s documented on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

Endpoint

Endpoint: /world-indicators

Retrieves economic indicator data for a specific country.

Request Parameters:

  • api_key (string, required) - Your unique API key.
  • country (string, required) - Country name (e.g., "germany").
  • indicator_name (string, required) - Indicator name (e.g., "Consumer Credit").

Request Example:

GET https://financeflowapi.com/api/v1/world-indicators?api_key=YOUR_API_KEY&country=germany&indicator_name=Consumer%20Credit

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1741363821,
        "request_id": "67cb1a6d8f942"
    },
    "data": [
        {
            "country": "Germany",
            "indicator_name": "Consumer Credit",
            "last": "235944000000.0",
            "previous": "235183000000.0",
            "units": "EUR",
            "report_date": "2024-12"
        }
    ]
}
                        

Conclusion: Track global trends with the World Economic Indicators API. See full docs on GitHub and start now!

Stock Index Spot API - Real-Time Index Data

The Stock Index Spot API delivers real-time data for global indices like DE40 and S&P 500. Essential for market monitoring, it’s detailed on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

1. Supported Benchmark List

Endpoint: /index-catalog

Lists available stock indices (e.g., ASX200, DE40).

Request Parameters:

  • api_key (string, required) - Your unique API key.

Request Example:

GET https://financeflowapi.com/api/v1/index-catalog?api_key=YOUR_API_KEY

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1743339544,
        "request_id": "67e9401854175"
    },
    "data": [
        {"benchmark": "adx general"},
        {"benchmark": "ase"},
        {"benchmark": "aspi"},
        {"benchmark": "ASX200"}
    ]
}
                        

2. Stock Index Spot Data

Endpoint: /index-spot

Retrieves real-time data for a specific index by country or benchmark.

Request Parameters:

  • api_key (string, required) - Your unique API key.
  • country (string, optional) - Country name (e.g., "germany").
  • benchmark (string, optional) - Benchmark name (e.g., "de40"). Use either country or benchmark.

Request Examples:

By Country:

GET https://financeflowapi.com/api/v1/index-spot?api_key=YOUR_API_KEY&country=germany

By Benchmark:

GET https://financeflowapi.com/api/v1/index-spot?api_key=YOUR_API_KEY&benchmark=de40

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1743340626,
        "request_id": "67e94452c1b30"
    },
    "data": {
        "benchmark": "de40",
        "country": "germany",
        "region": "europe",
        "price": 22462,
        "daily_change": "217",
        "daily_change_percent": "-0.96%",
        "monthly_change_percent": "-2.96%",
        "yearly_change_percent": "22.85%",
        "last_updated": "2025-03-28"
    }
}
                        

Conclusion: Monitor global indices with the Stock Index Spot API. Full docs on GitHub. Get started!

Stock Tickers API - Real-Time Data for 511,000+ Tickers

The Stock Tickers API provides real-time data and metadata for over 511,000+ stock tickers, including AAPL, TSLA, GOOGL, MSFT, and AMZN. Perfect for traders and developers, it’s your go-to financial data API. Full details on GitHub.

Base URL

https://financeflowapi.com/api/v1/

All endpoints follow this base URL.

1. Tickers Catalog

Endpoint: /tickers-catalog

Lists up to 300 tickers per page, with filters for exchange or ticker.

Request Parameters:

  • api_key (string, required) - Your unique API key.
  • exchange (string, optional) - Exchange filter (e.g., "NYSE").
  • ticker (string, optional) - Specific ticker (e.g., "GOOGL").
  • page (integer, optional) - Page number (default: 1).

Request Examples:

All tickers (first page):

GET https://financeflowapi.com/api/v1/tickers-catalog?api_key=YOUR_API_KEY

Filter by exchange (NYSE):

GET https://financeflowapi.com/api/v1/tickers-catalog?api_key=YOUR_API_KEY&exchange=NYSE

Filter by ticker (GOOGL):

GET https://financeflowapi.com/api/v1/tickers-catalog?api_key=YOUR_API_KEY&ticker=GOOGL

Second page:

GET https://financeflowapi.com/api/v1/tickers-catalog?api_key=YOUR_API_KEY&page=2

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "page": 1,
        "total_pages": 2,
        "total_items": 425,
        "tickers_per_page": 300,
        "timestamp": 1745423861,
        "request_id": "68090df504b96"
    },
    "data": [
        {
            "ticker": "TOPS",
            "company_name": "Top Ships Inc.",
            "exchange": "ASE",
            "full_exchange_name": "NYSE American",
            "currency": "USD",
            "market": "us_market",
            "first_trade_date": "2004-08-02 13:30:00",
            "timezone": "America/New_York"
        },
        ...
    ]
}
                        

2. Real-Time Stock Ticker Data

Endpoint: /ticker-spot

Provides real-time price data for a specific ticker.

Request Parameters:

  • api_key (string, required) - Your unique API key.
  • ticker (string, required) - Stock ticker symbol (e.g., "AAPL").

Request Example:

GET https://financeflowapi.com/api/v1/ticker-spot?api_key=YOUR_API_KEY&ticker=AAPL

Response Example:

{
    "success": true,
    "code": 200,
    "message": "OK",
    "meta": {
        "timestamp": 1745427151,
        "request_id": "68091acfb967b"
    },
    "data": {
        "ticker": "AAPL",
        "price": "203.890000",
        "change": "4.149994",
        "changePercent": "2.077698",
        "dayHigh": "208.000000",
        "dayLow": "202.799000",
        "volume": 29540691,
        "prevClose": "199.740000",
        "marketState": "REGULAR",
        "lastUpdated": "2025-04-23T16:51:33"
    }
}
                        

Conclusion: Power your apps with the Stock Tickers API, covering 511,000+ tickers. Explore docs on GitHub and start building!