### Example workflow: get symbols, contracts, and EOD data Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/us-options-underlyings.md Workflow to get supported symbols, query contracts for a symbol, and retrieve historical EOD data for a specific contract. ```bash curl "https://eodhd.com/api/mp/unicornbay/options/underlying-symbols?api_token=YOUR_TOKEN" ``` ```bash curl "https://eodhd.com/api/mp/unicornbay/options/contracts?filter[underlying_symbol]=AAPL&api_token=YOUR_TOKEN" ``` ```bash curl "https://eodhd.com/api/mp/unicornbay/options/eod?filter[contract]=AAPL270115C00150000&api_token=YOUR_TOKEN" ``` -------------------------------- ### Example requests: curl and Python client Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/rates-policy-rates.md Two example requests for fetching ECB policy rates from a start date: one using curl with URL-encoded filter parameters, and one using the helper Python client with repeatable --filter-param flags. ```bash # ECB policy rates from a start date curl "https://eodhd.com/api/rates/policy-rates?api_token=YOUR_TOKEN&filter%5Bcentral_bank%5D=ECB&filter%5Bfrom%5D=2025-01-01" ``` ```python # Using the helper client python eodhd_client.py --endpoint rates/policy-rates --filter-param central_bank=ECB --filter-param from=2025-01-01 ``` -------------------------------- ### Python Client Fundamentals Commands Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/fundamentals-common-stock.md Command-line examples using the EODHD Python client to fetch fundamentals data. Includes getting all fundamentals, filtering by section, using date filtering for quarterly financials, and extracting multiple sections. ```bash # Get all fundamentals python eodhd_client.py --endpoint fundamentals --symbol AAPL.US # Get specific section python eodhd_client.py --endpoint fundamentals --symbol AAPL.US --filter Highlights # Get latest quarterly financials (NEW - with date filtering) python eodhd_client.py --endpoint fundamentals --symbol AAPL.US --filter Financials::Cash_Flow::quarterly --from-date 2024-09-30 --to-date 2024-09-30 # Get multiple sections python eodhd_client.py --endpoint fundamentals --symbol AAPL.US --filter "General,Highlights,Valuation" ``` -------------------------------- ### Example: Applying Adjustment Factor to Prior Price Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/data-adjustment-guide.md Shows how to apply the adjustment factor to all prior prices. The previous close is multiplied by the factor to get the adjusted close. ```text Previous Date Close: $55 Adjusted Close: $55 × 0.8333 = $45.83 ``` -------------------------------- ### Volatility Example Request Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/technical-indicators.md cURL request to get volatility for AAPL.US with period=30. ```bash curl "https://eodhd.com/api/technical/AAPL.US?function=volatility&period=30&api_token=demo&fmt=json" ``` -------------------------------- ### Development Setup Commands Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/CLAUDE.md Commands to set up the development environment: clone the repository, set the EODHD API token, and test the client with the exchanges-list endpoint. ```bash git clone https://github.com/EodHistoricalData/eodhd-claude-skills.git ``` ```bash export EODHD_API_TOKEN="your_token_here" ``` ```bash python skills/eodhd-api/scripts/eodhd_client.py --endpoint exchanges-list ``` -------------------------------- ### Real Example with Demo Token Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/authentication.md Real example using the demo token to check token status. The response shows a demo account with no Marketplace subscriptions. ```bash $ curl "https://eodhd.com/api/internal-user?api_token=demo" ``` -------------------------------- ### WMA Example Request Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/technical-indicators.md cURL request to get WMA for AAPL.US with period=20. ```bash curl "https://eodhd.com/api/technical/AAPL.US?function=wma&period=20&api_token=demo&fmt=json" ``` -------------------------------- ### Python: Using the provided client Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/authentication.md Python example showing how to set the environment variable and use the provided client, which reads the token from the environment automatically. ```python import os # Set environment variable os.environ['EODHD_API_TOKEN'] = 'your_token_here' # Use the client (it reads from environment) # The client automatically includes the token ``` -------------------------------- ### GET /api/news-word-weights Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/news-word-weights.md Example requests and response for the news word weights endpoint. ```APIDOC ## [GET] /api/news-word-weights ### Description Retrieves word weights for a given ticker symbol over a specified date range, indicating the relative importance of words in news coverage. ### Method GET ### Endpoint https://eodhd.com/api/news-word-weights ### Parameters #### Query Parameters - **s** (string) - Required - Ticker symbol (e.g., AAPL.US, TSLA.US, BTC-USD.CC) - **filter[date_from]** (string) - Required - Start date in YYYY-MM-DD format - **filter[date_to]** (string) - Required - End date in YYYY-MM-DD format - **page[limit]** (integer) - Required - Maximum number of words to return (e.g., 10, 20, 50) - **api_token** (string) - Required - API authentication token - **fmt** (string) - Optional - Response format (e.g., json) ### Request Example ```bash curl "https://eodhd.com/api/news-word-weights?s=AAPL.US&filter[date_from]=2025-04-08&filter[date_to]=2025-04-16&page[limit]=10&api_token=demo&fmt=json" ``` ### Response #### Success Response (200) - **data** (object) - Map of words to their weight values - **meta.news_processed** (integer) - Number of news articles processed - **meta.news_found** (integer) - Total number of news articles found - **links.next** (string|null) - Pagination link for next page, null if no more pages #### Response Example ```json { "data": { "appl": 0.01922, "tariff": 0.01889, "stock": 0.01884, "trump": 0.01115, "companies": 0.00983, "market": 0.00919, "china": 0.0079, "trade": 0.00723, "ai": 0.00605, "price": 0.00577, "iphone": 0.00542, "revenue": 0.00498, "sales": 0.00467, "earnings": 0.00423, "growth": 0.00398 }, "meta": { "news_processed": 300, "news_found": 5748 }, "links": { "next": null } } ``` ``` -------------------------------- ### Complete Connection Example Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/websockets-realtime.md Bash script showing the full WebSocket connection workflow: open connection, subscribe, receive data, and unsubscribe. ```bash # 1. Open connection wss://ws.eodhistoricaldata.com/ws/us?api_token=demo # 2. Send subscribe command {"action": "subscribe", "symbols": "AMZN,TSLA"} # 3. Receive streaming data... # 4. Unsubscribe when done {"action": "unsubscribe", "symbols": "AMZN"} ``` -------------------------------- ### Usage examples for DelistedTickerManager Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/delisted-tickers-guide.md Usage example for the DelistedTickerManager class. It creates a manager with a demo token and runs four examples: getting US delisted tickers, searching by company name, finding ticker versions, and analyzing a specific delisted ticker. The output prints the results for each example. ```python def main(): api_token = "demo" # Replace with your token manager = DelistedTickerManager(api_token) # Example 1: Get all US delisted tickers print("=" * 60) print("Example 1: Get US Delisted Tickers") print("=" * 60) us_delisted = manager.get_delisted_tickers("US") print(f"Total US delisted tickers: {len(us_delisted)}") print(f"\nFirst 5 delisted tickers:") print(us_delisted[['Code', 'Name', 'Type']].head()) # Example 2: Search by company name print("\n" + "=" * 60) print("Example 2: Search by Company Name") print("=" * 60) financial_companies = manager.search_by_name("US", "Financial") print(f"Found {len(financial_companies)} delisted companies with 'Financial' in name") print(financial_companies[['Code', 'Name']].head()) # Example 3: Find ticker versions print("\n" + "=" * 60) print("Example 3: Find Ticker Versions") print("=" * 60) versions = manager.find_ticker_versions("US", "ABC") print(f"Found {len(versions)} versions of ABC ticker:") print(versions[['Code', 'Name']]) # Example 4: Analyze specific delisted ticker print("\n" + "=" * 60) print("Example 4: Analyze Delisted Ticker") print("=" * 60) analysis = manager.analyze_delisted_ticker("AAAB", "US") print(f"Ticker: {analysis['ticker']}") print(f"Found: {analysis['found']}") print(f"Price data available: {analysis['price_data_available']}") print(f"Fundamentals available: {analysis['fundamentals_available']}") if analysis['data_summary']: print(f"Date range: {analysis['data_summary'].get('first_date')} to {analysis['data_summary'].get('last_date')}") print(f"Total records: {analysis['data_summary'].get('total_records')}") if __name__ == "__main__": main() ``` -------------------------------- ### Query Parameter Examples (bash) Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/api-authentication-demo-access.md Three bash examples using the query parameter method: demo key for EOD and fundamentals data, and a production key example. The demo key is used for testing; replace YOUR_API_TOKEN with your actual token. ```bash # Demo key - End-of-Day data https://eodhd.com/api/eod/AAPL.US?api_token=demo&fmt=json # Demo key - Fundamentals data https://eodhd.com/api/fundamentals/MSFT.US?api_token=demo # Production key - End-of-Day data https://eodhd.com/api/eod/IBM.US?api_token=YOUR_API_TOKEN&fmt=json ``` -------------------------------- ### Manual setup with git clone and API token Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/README.md Clones the repository and exports the EODHD API token as an environment variable for manual configuration. ```bash git clone https://github.com/EodHistoricalData/eodhd-claude-skills.git export EODHD_API_TOKEN="your_token_here" ``` -------------------------------- ### Standard Deviation Example Request Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/technical-indicators.md cURL request to get standard deviation for AAPL.US with period=20. ```bash curl "https://eodhd.com/api/technical/AAPL.US?function=stddev&period=20&api_token=demo&fmt=json" ``` -------------------------------- ### Use Date Filtering for Financials (curl) Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/fundamentals-common-stock.md Demonstrates using 'from' and 'to' parameters to limit financial data to a specific quarter. The first example gets all quarters, while the second gets only the latest quarter (2024-09-30). ```bash # Gets all quarters (large response) &filter=Financials::Cash_Flow::quarterly # Gets only latest quarter (small response) &filter=Financials::Cash_Flow::quarterly&from=2024-09-30&to=2024-09-30 ``` -------------------------------- ### Complete Connection Example Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/websockets-realtime.md Shows the full WebSocket connection lifecycle: open connection, subscribe, receive data, and unsubscribe. ```APIDOC ## Complete Connection Example ### Description Shows the full WebSocket connection lifecycle: open connection, subscribe, receive data, and unsubscribe. ### Connection ```bash wss://ws.eodhistoricaldata.com/ws/us?api_token=demo ``` ### Steps 1. Open connection to the WebSocket URL 2. Send subscribe command 3. Receive streaming data 4. Send unsubscribe command when done ### Commands ```json {"action": "subscribe", "symbols": "AMZN,TSLA"} ``` ```json {"action": "unsubscribe", "symbols": "AMZN"} ``` ``` -------------------------------- ### Historical data access example Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/api-authentication-demo-access.md Demonstrates that the demo key provides full historical data access for demo tickers, with no date restrictions. ```bash # ✅ Works - Access historical data from 2000 https://eodhd.com/api/eod/AAPL.US?api_token=demo&from=2000-01-01&to=2023-12-31&fmt=json ``` -------------------------------- ### curl fundamentals API examples Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/fundamentals-api.md Use curl to call the EODHD Fundamentals API. The examples show how to check instrument type, get ETF top holdings, and retrieve stock highlights using the demo token. ```bash # Check instrument type curl "https://eodhd.com/api/fundamentals/AAPL.US?api_token=demo&fmt=json&filter=General" # Get ETF top holdings curl "https://eodhd.com/api/fundamentals/VTI.US?api_token=demo&fmt=json&filter=ETF_Data::Top_10_Holdings" # Get stock highlights curl "https://eodhd.com/api/fundamentals/AAPL.US?api_token=demo&fmt=json&filter=Highlights" ``` -------------------------------- ### Install wscat with npm Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/websockets-realtime.md Installs wscat globally via npm. ```bash npm install -g wscat ``` -------------------------------- ### GET /api/mp/tradinghours/markets/details Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/tradinghours-market-details.md Documentation for the Trading Hours Market Details endpoint, including request parameters, response structure, and examples. ```APIDOC ## [GET] /api/mp/tradinghours/markets/details ### Description Returns detailed information about a specific market or exchange, including its trading schedule, timezone, and holiday data availability. The endpoint requires a `fin_id` parameter to identify the market and an `api_token` for authentication. ### Method GET ### Endpoint https://eodhd.com/api/mp/tradinghours/markets/details ### Parameters #### Query Parameters - **fin_id** (string) - Required - The unique identifier for the trading schedule (e.g., `us.nyse`, `jp.jpx`). - **api_token** (string) - Required - Your API token for authentication. ### Request Example ```bash curl "https://eodhd.com/api/mp/tradinghours/markets/details?fin_id=us.nyse&api_token=demo" ``` ### Response #### Success Response (200) Returns a JSON object with a `data` array containing market detail objects. #### Response Example ```json { "data": [ { "fin_id": "US.NYSE", "country_code": "US", "exchange": "New York Stock Exchange", "market": "Canonical", "products": null, "mic": "XNYS", "mic_extended": "XNYS", "acronym": "NYSE", "asset_type": "Securities", "memo": "Canonical", "permanently_closed": null, "timezone": "America/New_York", "weekend_definition": "Sat-Sun", "holidays_min_date": "2000-01-17", "holidays_max_date": "2033-12-26" } ] } ``` ### Response Fields - **fin_id** (string) - Unique identifier for the trading schedule (e.g., `US.NYSE`). - **country_code** (string) - ISO 3166-1 alpha-2 country code (e.g., `US`, `JP`, `GB`). - **exchange** (string) - Exchange name (e.g., `New York Stock Exchange`). - **market** (string|null) - Market segment name (e.g., `Canonical`, `Cash Market`). - **products** (string|null) - Products traded (e.g., `DAX, TecDAX, MDAX, SDAX listed`). - **mic** (string) - Market Identifier Code (ISO 10383). - **mic_extended** (string) - Extended MIC code. - **acronym** (string) - Exchange acronym (e.g., `NYSE`, `JPX`, `LSE`). - **asset_type** (string|null) - Asset type (e.g., `Securities`, `Equities`). - **memo** (string|null) - Additional notes about the market. - **permanently_closed** (string|null) - Date the market permanently closed, or null if active. - **timezone** (string) - IANA timezone identifier (e.g., `America/New_York`, `Asia/Tokyo`). - **weekend_definition** (string) - Weekend days (e.g., `Sat-Sun`, `Fri-Sat`). - **holidays_min_date** (string) - Earliest holiday data available (YYYY-MM-DD). - **holidays_max_date** (string) - Latest holiday data available (YYYY-MM-DD). ``` -------------------------------- ### ETF Fundamentals Request with filter=General Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/fundamentals-etf.md Example request to get general ETF data for VTI.US. Uses the demo API token. ```http https://eodhd.com/api/fundamentals/VTI.US?api_token=demo&fmt=json&filter=General ``` -------------------------------- ### Install plugin from community marketplace Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/README.md Adds the Anthropic community marketplace and installs the eodhd-api plugin from the community channel. ```bash /plugin marketplace add anthropics/claude-plugins-community /plugin install eodhd-api@claude-community ``` -------------------------------- ### GET /mp/unicornbay/options/eod Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/us-options-eod.md Documentation for the US Options EOD endpoint, including example requests, parameters, response format, and error handling. ```APIDOC ## [GET] /mp/unicornbay/options/eod ### Description Retrieves historical end-of-day (EOD) data for US options contracts. This endpoint returns daily snapshots for specified contracts or underlying symbols, with support for filtering by contract, underlying symbol, option type, and trade date range. ### Method GET ### Endpoint https://eodhd.com/api/mp/unicornbay/options/eod ### Parameters #### Query Parameters - **filter[contract]** (string) - Optional - Filter by specific option contract symbol (e.g., AAPL270115P00450000). - **filter[underlying_symbol]** (string) - Optional - Filter by underlying stock symbol (e.g., AAPL). - **filter[type]** (string) - Optional - Filter by option type (e.g., call). - **filter[tradetime_from]** (string) - Optional - Start date for trade time range (format: YYYY-MM-DD). - **filter[tradetime_to]** (string) - Optional - End date for trade time range (format: YYYY-MM-DD). - **fields[options-eod]** (string) - Optional - Comma-separated list of fields to include in the response (e.g., contract,bid_date,open,high,low,last). - **compact** (integer) - Optional - Set to 1 to reduce response size for high-volume requests. - **page[limit]** (integer) - Optional - Number of results per page (max 1000). - **sort** (string) - Optional - Sort order for results (e.g., -exp_date for descending expiration date). - **api_token** (string) - Required - Your API authentication token. ### Request Example ```bash curl "https://eodhd.com/api/mp/unicornbay/options/eod?filter[contract]=AAPL270115P00450000&page[limit]=5&sort=-exp_date&api_token=demo" ``` ### Response #### Success Response (200) Returns historical EOD data for the requested options. Each record represents one day's EOD data with an ID format of `{contract}-{date}` (e.g., 'AAPL270115P00450000-2026-02-06'). #### Error Response Returns a JSON object with error details: ```json { "error": "Error message description", "code": 403 } ``` ### Notes - **Marketplace Product**: This is a marketplace API. - **Historical Data**: Returns daily snapshots - each record represents one day's EOD data. - **Compact Mode**: Use `compact=1` to reduce response size for high-volume requests. - **Zero Values**: Greeks and volatility may be zero for illiquid contracts. - **Pagination**: Max 10,000 offset, 1,000 results per page. - **API call consumption**: 1 request = 10 API calls. - **Rate limits**: 100,000 calls/24h, 1,000 requests/minute. - **History**: 2-year historical depth available. ### HTTP Status Codes | Status Code | Meaning | Description | |-------------|---------|-------------| | **200** | OK | Request succeeded. Data returned successfully. | | **402** | Payment Required | API limit used up. Upgrade plan or wait for limit reset. | | **403** | Unauthorized | Invalid API key. Check your `api_token` parameter. | | **429** | Too Many Requests | Exceeded rate limit (requests per minute). Slow down requests. | ``` -------------------------------- ### Python Client ETF Fundamentals Commands Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/general/fundamentals-etf.md Command-line examples using the Python client to fetch ETF fundamentals for VTI.US with different filters: General, Top_10_Holdings, Sector_Weights, and Performance. ```python # Get ETF general info python eodhd_client.py --endpoint fundamentals --symbol VTI.US --filter General # Get top holdings python eodhd_client.py --endpoint fundamentals --symbol VTI.US --filter ETF_Data::Top_10_Holdings # Get sector allocation python eodhd_client.py --endpoint fundamentals --symbol VTI.US --filter ETF_Data::Sector_Weights # Get performance metrics python eodhd_client.py --endpoint fundamentals --symbol VTI.US --filter ETF_Data::Performance ``` -------------------------------- ### python: Using the helper client (US events, year-over-year) Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/economic-events.md Uses the helper client to fetch US economic events with year-over-year comparison. ```bash python eodhd_client.py --endpoint economic-events --from-date 2025-01-01 --to-date 2025-01-31 --country US --comparison yoy ``` -------------------------------- ### GET /historical-market-cap/{TICKER_CODE} Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/historical-market-cap.md Documentation for the Historical Market Capitalization API endpoint, including parameters, request example, and response details. ```APIDOC ## [GET] /historical-market-cap/{TICKER_CODE} ### Description Provides weekly market capitalization data for US stocks (NYSE and NASDAQ) from 2019 onward. Useful for historical trend analysis, portfolio management, backtesting, and cross-company valuation comparisons. ### Method GET ### Endpoint `https://eodhd.com/api/historical-market-cap/{TICKER_CODE}` ### Parameters #### Path Parameters - **{TICKER_CODE}** (string) - Required - Ticker with exchange suffix (e.g., `AAPL.US`). For US stocks, suffix can be omitted (`AAPL`). #### Query Parameters - **api_token** (string) - Required - Your API key. - **from** (string) - Optional - Start date (`YYYY-MM-DD`). Default: `2019-01-01`. Earliest available data if omitted. - **to** (string) - Optional - End date (`YYYY-MM-DD`). Default: Latest. Latest available data if omitted. - **fmt** (string) - Optional - Output format: `json` or `csv`. Default: `json`. ### Request Example ``` GET https://eodhd.com/api/historical-market-cap/AAPL.US?api_token=YOUR_API_KEY&from=2019-01-01&to=2023-12-31&fmt=json ``` ### Response #### Success Response (200) Returns weekly market capitalization data in the requested format (`json` or `csv`). Each data point includes the market cap value in raw USD (not millions or billions). Divide by `1e9` to get billions. #### Response Example ```json { "date": "2023-12-29", "market_capitalization": 3000000000000 } ``` ### Notes - **Weekly frequency** — one data point per week (typically Thursday/Friday). - **US stocks only** — NYSE and NASDAQ listed stocks. - **Historical depth** — data available from 2019 onward. - **Values in raw USD** — not millions or billions (divide by `1e9` for billions). - **API call consumption**: 10 API calls per request (regardless of date range). - **Available in**: All-In-One, Fundamentals Data Feed. ``` -------------------------------- ### Install websocat with Homebrew Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/websockets-realtime.md Installs websocat via Homebrew on macOS. ```bash brew install websocat ``` -------------------------------- ### GET /api/us-quote-delayed Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/us-live-extended-quotes.md Documentation for the US Live Extended Quotes endpoint, including request examples, parameters, response format, and error handling. ```APIDOC ## [GET] /api/us-quote-delayed ### Description Retrieves delayed extended quotes for US stocks, including bid/ask prices, trade timestamps, and extended hours data. Supports batch requests with multiple symbols and pagination. ### Method GET ### Endpoint https://eodhd.com/api/us-quote-delayed ### Parameters #### Query Parameters - **s** (string) - Required - Comma-separated list of stock symbols (e.g., AAPL.US,TSLA.US). Max 100 per page. - **api_token** (string) - Required - Your API token for authentication. - **fmt** (string) - Optional - Response format. Default is `json`. Also supports `csv`. - **page[limit]** (integer) - Optional - Number of results per page (max 100). - **page[offset]** (integer) - Optional - Pagination offset. ### Request Example ```bash curl "https://eodhd.com/api/us-quote-delayed?s=AAPL.US&api_token=YOUR_TOKEN&fmt=json" ``` ### Response #### Success Response (200) - **data** (object) - Object keyed by symbol, not an array. - **ethPrice** (number) - Extended hours price, available when pre/post-market data exists. - **ethVolume** (number) - Extended hours volume, available when pre/post-market data exists. - **ethTime** (number) - Extended hours timestamp in Unix milliseconds. - **bidTime** (number) - Bid timestamp in Unix milliseconds. - **askTime** (number) - Ask timestamp in Unix milliseconds. - **lastTradeTime** (number) - Last trade timestamp in Unix milliseconds. - **timestamp** (number) - Timestamp in Unix seconds. #### Response Example ```json { "AAPL.US": { "ethPrice": 150.25, "ethVolume": 1000, "ethTime": 1620000000000, "bidTime": 1620000000000, "askTime": 1620000000000, "lastTradeTime": 1620000000000, "timestamp": 1620000000 } } ``` ### Error Handling #### Error Response Format ```json { "error": "Error message description", "code": 403 } ``` #### HTTP Status Codes | Status Code | Meaning | Description | |-------------|---------|-------------| | **200** | OK | Request succeeded. Data returned successfully. | | **402** | Payment Required | API limit used up. Upgrade plan or wait for limit reset. | | **403** | Unauthorized | Invalid API key. Check your `api_token` parameter. | | **429** | Too Many Requests | Exceeded rate limit (requests per minute). Slow down requests. | ### Notes - API call consumption: 1 API call per ticker in the request. - Quotes are delayed (exchange-compliant), not real-time. - Batch requests supported via comma-separated symbols (max 100 per page). - JSON is the default format; CSV is also supported via `fmt=csv`. - The `data` field is an object keyed by symbol, not an array. - Extended hours fields (`ethPrice`, `ethVolume`, `ethTime`) are available when pre/post-market data exists. - Timestamps: `bidTime`, `askTime`, `lastTradeTime`, `ethTime` are in Unix milliseconds; `timestamp` is in Unix seconds. - **Live v2 vs Live v1**: Live v2 (this endpoint) provides quote-level detail (bid/ask, trade timestamps, fundamentals) for US stocks. Live v1 (`/real-time/{symbol}`) provides minute OHLCV bars across multiple asset classes without bid/ask or trade event timestamps. ``` -------------------------------- ### Python: Using the helper client Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/upcoming-ipos.md Uses the EODHD helper client to fetch IPOs for a specific date range. Requires the client script and passes the endpoint and date parameters. ```bash python eodhd_client.py --endpoint calendar/ipos --from-date 2026-02-10 --to-date 2026-02-17 ``` -------------------------------- ### GET /real-estate/{code}/detailed Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/real-estate-detailed-property-prices.md Documentation for the real-estate detailed property prices endpoint, including parameters, request examples, and response structure. ```APIDOC ## [GET] /real-estate/{code}/detailed ### Description Returns detailed property price data for a given country (ISO 3166-1 alpha-2 code) with optional filters for property type, frequency, area, vintage, and date range. The endpoint supports CSV output via `fmt=csv` and consumes 5 API calls per request. ### Method GET ### Endpoint `https://eodhd.com/api/real-estate/{code}/detailed` ### Parameters #### Path Parameters - **code** (string) - Required - ISO 3166-1 alpha-2 country code, case-insensitive (normalised to uppercase). Unknown codes return 404 (`Symbol not found`). #### Query Parameters - **api_token** (string) - Required - Your API token for authentication. - **filter[property_type]** (integer) - Optional - Property type code (e.g., `1`). Valid codes can be discovered via `/real-estate/{code}/detailed/series`. - **filter[freq]** (string) - Optional - Frequency of the data (e.g., `Q` for quarterly). - **filter[from]** (string) - Optional - Start date for the series (e.g., `2020-Q1`). - **filter[area]** (string) - Optional - Area code. Valid codes can be discovered via `/real-estate/{code}/detailed/series`. - **filter[vintage]** (string) - Optional - Vintage code. Valid codes can be discovered via `/real-estate/{code}/detailed/series`. - **filter[to]** (string) - Optional - End date for the series. - **fmt** (string) - Optional - Set to `csv` to receive the response in CSV format. ### Request Example ```bash curl "https://eodhd.com/api/real-estate/AE/detailed?api_token=YOUR_TOKEN&filter[property_type]=1" ``` ### Response #### Success Response (200) Returns a JSON object with `data`, `meta`, and `links` fields. The `data` array contains rows where all fields are strings except `value`; `*_label` fields are human-readable and `unit_measure_label` may be null. #### Response Example ```json { "data": [ { "value": "123.45", "area_label": "Dubai", "property_type_label": "Apartment", "unit_measure_label": null } ], "meta": { "dataset": "real-estate", "source": "...", "applied_filters": {} }, "links": {} } ``` ### Error Handling - **404** - `Symbol not found` when the country code is unknown. ### Notes - The helper client `eodhd_client.py` unwraps the `data` array by default; pass `--raw` to see the full envelope. - API call consumption: 5 calls per request. ``` -------------------------------- ### python: Using the helper client Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/economic-events.md Uses the helper client to fetch economic events for a date range. ```bash python eodhd_client.py --endpoint economic-events --from-date 2025-01-01 --to-date 2025-01-31 ``` -------------------------------- ### Python requests example Source: https://github.com/eodhistoricaldata/eodhd-claude-skills/blob/main/skills/eodhd-api/references/endpoints/historical-market-cap.md Python example using the requests library to fetch historical market cap data for AAPL.US. It sends a GET request with query parameters, parses the JSON response, and prints each weekly date with the market cap in billions of dollars. ```python import requests url = "https://eodhd.com/api/historical-market-cap/AAPL.US" params = { "api_token": "YOUR_API_TOKEN", "from": "2023-01-01", "to": "2023-12-31", "fmt": "json" } response = requests.get(url, params=params) data = response.json() # Iterate over weekly data points for key, entry in data.items(): value_billions = entry["value"] / 1e9 print(f"{entry['date']}: ${value_billions:.2f}B") ```