feat: add ASX corporate actions endpoint#75
Open
alexpipipi wants to merge 1 commit into
Open
Conversation
Add ASXCorporateActionsAPI wrapping GET /api/asx-corporate-actions
(JSON:API { data, meta, links } envelope, bare query params
type/symbol/date_from/date_to + page[offset]/page[limit] pagination).
Registered in eodhd/APIs/__init__.py and exposed via
APIClient.get_asx_corporate_actions(). Adds tests/test_asx_corporate_actions.py.
Contributor
Author
Bridge AI pre-merge review (Codex GPT-5.4 + Gemini Pro)No genuine blockers. One flag on |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an SDK wrapper for the ASX Corporate Actions endpoint
GET /api/asx-corporate-actions.Mirrors the paginated-endpoint pattern used for the Sanctions / Credit & Sovereign Risk / Interest Rates endpoints (bare query params,
page[offset]/page[limit]pagination, JSON:API{ data, meta, links }envelope).Endpoint
GET /api/asx-corporate-actions— 1 API call per request.Query params (bare, not
filter[...]):type— enum:dividends,splits,bonus-issues,rights-issues,buybacks,capital-returns,spp,othersymbol— ASX ticker with.AUsuffix, e.g.PMV.AUdate_from/date_to—YYYY-MM-DDpage[offset](default 0),page[limit](1-1000, default 100)Changes
eodhd/APIs/ASXCorporateActionsAPI.py— newASXCorporateActionsAPIwithget_corporate_actions(); type-enum + pagination-bounds validation, URL-encoded bare params, blank/None params omitted.eodhd/APIs/__init__.py— register the new API class.eodhd/apiclient.py—APIClient.get_asx_corporate_actions()facade delegating to the API class.tests/test_asx_corporate_actions.py— 10 tests (URL/token/fmt, bare-params + nofilter[], envelope keys, type lowercasing, hyphenated enum, invalid type, symbol URL-encoding, blank omission, pagination bounds, facade delegation).Testing
python3 -m pytest tests/— 80 passed (10 new). Envelope shape and endpoint live-verified.Usage