FinanceFlow API Documentation

Welcome to the FinanceFlow API documentation. This API provides access to financial data, including commodity prices, bonds, exchange rates, and other market indicators.

Basic Principles

• Access to the API is granted via an API key.
• Base URL: https://financeflowapi.com/api/v1/
• The required endpoint follows, for example, for commodities: commodities.
• The api_key parameter is mandatory and must be included in the request.
• You can find your API key in your account dashboard.

Request Examples

Fetching commodity data:

https://financeflowapi.com/api/v1/commodities?api_key=YOUR_API_KEY

Example with an actual key:

https://financeflowapi.com/api/v1/commodities?api_key=k2d93mn57x;l37c3lxds

Commodity API - Real-Time and Historical Market Data

The Commodity API provides real-time and historical market data for various commodities, including energy resources, metals, and agricultural products. With this API, developers can access up-to-date commodity prices and historical trends, making it an essential tool for financial analysts, traders, and market researchers. The API ensures fast and reliable data delivery, empowering users to integrate live commodity pricing into their applications seamlessly.

Base URL

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

All endpoints follow this base URL.

1. Supported Commodities List

Endpoint: /commodity-catalog

This endpoint provides a complete list of supported commodities available in the API.

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 of a specific commodity in real-time.

Request Parameters:

• name (string) - The name of the commodity (e.g., "Coal").
• api_key (string) - 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

Retrieves historical price data for a specific commodity over a given period.

Request Parameters:

• name (string) - The name of the commodity (e.g., "Gold").
• interval (string) - The data interval: day or month.
• date_from (string, optional) - Start date (format: YYYY-MM-DD).
• date_to (string, optional) - End date (format: YYYY-MM-DD).
• The period betweendate_from and date_to must not exceed 100 days
• api_key (string) - 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
        },
             .............
    ]
}
                        

Government Bonds API - Real-Time and Historical Bond Market Data

The Government Bonds API provides real-time and historical data on government bonds from various countries. This API is an essential tool for investors, analysts, and financial institutions seeking accurate and up-to-date bond yield data. With a seamless integration process, users can easily track bond performance, compare yields, and analyze trends over time.

Base URL

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

All endpoints follow this base URL.

1. Supported Countries List

Endpoint: /bonds-catalog

This endpoint provides a list of supported countries with available government bond data.

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 government bonds from a specific country and maturity type.

Request Parameters:

• region (string, optional) - The region filter (e.g., "europe").
• country (string) - The country name (e.g., "united_states").
• type (string) - The bond maturity type (e.g., "10y", "6m", "52w", "30ytips").
• api_key (string) - 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

Retrieves historical yield data for government bonds over a specified period.

Request Parameters:

• frequency (string) - The data interval: day or month.
• country (string) - The country name (e.g., "Germany").
• type (string) - The bond maturity type (e.g., "10y", "6m", "52w").
• date_from (string, optional) - Start date (format: YYYY-MM-DD).
• date_to (string, optional) - End date (format: YYYY-MM-DD).
• The period betweendate_from and date_to must not exceed 100 days
• api_key (string) - 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
        },
    ]
}