Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Fundamentals Endpoints via REST API #13

Open
12 tasks
joaquinbejar opened this issue Nov 23, 2024 · 0 comments
Open
12 tasks

Implement Fundamentals Endpoints via REST API #13

joaquinbejar opened this issue Nov 23, 2024 · 0 comments

Comments

@joaquinbejar
Copy link
Owner

joaquinbejar commented Nov 23, 2024

Implement Fundamentals Endpoints via REST API

Description

Objective:

Implement all Fundamentals endpoints via REST API. These endpoints will provide access to company-related data, corporate actions, financial reports, and other fundamental information.

Dependencies:

This issue depends on the completion of the Market Data REST API implementation (#12). Once the foundational market data endpoints are complete, these fundamentals endpoints can be added.

Endpoints to Implement:

  1. GET Company: Fetch detailed information about a company.
  2. GET Corporate Calendars: Retrieve corporate event calendars (e.g., earnings, IPOs).
  3. GET Dividends: Fetch dividend history for companies.
  4. GET Corporate Actions: Retrieve corporate action events (e.g., splits, mergers).
  5. GET Ratios: Provide financial ratios for companies (e.g., P/E, EPS).
  6. GET Financial Reports: Access detailed financial reports (e.g., balance sheet, income statement).
  7. GET Price Statistics: Retrieve price-related statistics (e.g., averages, volatility).

Tasks

General Tasks:

  • Define data models for the fundamentals endpoints.
  • Set up routing and handlers for these REST API endpoints.
  • Ensure error handling for invalid inputs or missing data.
  • Write unit and integration tests for each endpoint.

Endpoint-Specific Tasks:

  • GET Company: Implement fetching of company details.
  • GET Corporate Calendars: Create a calendar system for corporate events.
  • GET Dividends: Add support for fetching historical dividend data.
  • GET Corporate Actions: Implement retrieval of corporate action events.
  • GET Ratios: Fetch and calculate financial ratios for companies.
  • GET Financial Reports: Provide detailed financial report data.
  • GET Price Statistics: Implement fetching of price-related statistics.

Documentation:

  • Update the API documentation to include examples for these endpoints.

Additional Notes

  • This issue assumes that the foundational Market Data endpoints (#12) are complete.
  • Priority can be adjusted based on the importance of specific endpoints.

Labels

enhancement, REST API, Fundamentals

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant