Eodhd API

EODHD API Skill

This skill provides a comprehensive toolkit for interacting with the EOD Historical Data (EODHD) API, a powerful source for a wide range of financial data.

Core Principles

1. API Token First: Before using any function, ensure the user has provided an EODHD API token. The config.json file must be updated with a valid token. If the token is missing or invalid, ask the user to provide one.
2. Use the Client: All API interactions MUST go through the provided Python client: scripts/eodhd_client.py. This client handles authentication, request formation, and basic error handling.
3. Be Specific: When fetching data, use the most specific function available in the client. For example, use get_dividends() for dividend data instead of a generic fundamental data call.
4. Handle Errors: The client returns an {"error": "..."} dictionary on failure. Always check for this and report errors clearly to the user.

Setup: API Token Configuration

Before the first use, you must configure the API token. The user needs to provide their personal EODHD API key.

1. Ask the user for their EODHD API token.

2. Write the token to the configuration file using the file tool:

   default_api.file(
       action="write",
       path="/home/ubuntu/skills/eodhd-api/config.json",
       text=f"{{\"api_token\": \"{user_provided_token}\"}}"
   )
   

Workflow: Fetching Financial Data

Follow this general workflow to retrieve and use financial data from the EODHD API.

Step 1: Understand the User's Request

Identify the specific type of data the user needs. Is it historical prices, company fundamentals, news, or something else? Map their request to one of the available functions in the eodhd_client.py script.

Step 2: Instantiate the Client and Call the Method

Create a Python script to import and use the EODHDClient.

Example: Fetching Historical EOD Prices

# File: /home/ubuntu/fetch_eod.py

from skills.eodhd-api.scripts.eodhd_client import EODHDClient
import json

client = EODHDClient()
data = client.get_eod_historical_data(
    'AAPL.US', 
    from_date='2023-01-01', 
    to_date='2023-01-10'
)

if 'error' in data:
    print(f"An error occurred: {data['error']}")
else:
    print(json.dumps(data, indent=2))

Step 3: Execute the Script

Run the script using the shell tool.

python3.11 /home/ubuntu/fetch_eod.py

Step 4: Process and Present the Data

Analyze the JSON output from the script. Present the information to the user in a clear and readable format, often using Markdown tables or summaries.

Available Client Functions

The eodhd_client.py script provides a high-level interface for the most common EODHD API endpoints. Refer to the script's docstrings for detailed usage of each function.

For detailed parameters and options for each function, consult the official EODHD API Documentation.