News API

Overview

The News API provides access to financial news and economic calendar events. This documentation outlines the available objects and functions to help you integrate market news and events into your trading algorithms and analysis workflows.

Available Objects

Available Functions

Getting Started

To begin working with the News API:

1. Import the GoldenGoose library
2. Use the get() function to retrieve news or calendar data
3. Process the retrieved data based on your application's needs

Example

import goldengoose
 
# Get economic calendar events for the current week
calendar = goldengoose.news.get("calendar")
 
# Access current events
current_epoch = goldengoose.get_current_epoch()
current_events = calendar[current_epoch]
 
# Display upcoming economic events
for event in current_events:
    print(f"Event: {event.title}")
    print(f"Time: {event.datetime}")
    print(f"Impact: {event.impact}")
    print(f"Forecast: {event.forecast}")
    print(f"Previous: {event.previous}")
    print("---")
 
# Get company-specific news for Apple
apple_news = goldengoose.news.get("news", symbol="AAPL")
 
# Display recent news articles
for article in apple_news:
    print(f"Headline: {article.headline}")
    print(f"Source: {article.source}")
    print(f"Published: {article.datetime}")
    print(f"URL: {article.url}")
    print("---")

Usage Notes

• The get() function accepts different parameter configurations:

  • get("calendar") - Retrieves the full economic calendar
  • get("calendar", date="2023-03-15") - Retrieves calendar events for a specific date
  • get("news") - Retrieves general market news
  • get("news", symbol="AAPL") - Retrieves news specific to a ticker symbol
  • get("news", category="earnings") - Retrieves news filtered by category

• Calendar events include important economic data releases such as:

  • Interest rate decisions
  • Employment reports
  • GDP releases
  • Inflation metrics
  • Earnings announcements

• News data is updated in real-time during market hours

• Historical news data is available for research and backtesting purposes

• Each news item includes metadata such as source, publication time, and relevance score

Advanced Features

• Filter news by impact level (high, medium, low)
• Search for specific keywords or phrases in news content
• Set up alerts for significant economic events
• Track sentiment analysis for news related to specific companies or sectors

For more detailed information on specific objects and functions, please refer to the dedicated documentation pages linked in the tables above.