Skip to content

Commit

Permalink
feat: allow to skip date_filed query
Browse files Browse the repository at this point in the history
  • Loading branch information
Kai Hu committed May 20, 2024
1 parent 702a627 commit 4dda0c6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Please reach out at [email protected] for an API key.

```python
import sec_agent_sdk
from sec_agent_sdk import FormType, FilingTable
from sec_agent_sdk.rest import ApiException
from pprint import pprint

Expand All @@ -43,12 +44,12 @@ with sec_agent_sdk.ApiClient(configuration) as api_client:
api_instance = sec_agent_sdk.DefaultApi(api_client)
form_type = FormType.EIGHT_K # FormType | 10-K | 10-Q | 8-K | 6-K
company = 'AA' # ticker
date_filed = '2024-04-17' # str | date string in YYYY-mm-dd
table = FilingTable.INCOME_STATEMENT # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet'
table = FilingTable.BALANCE_SHEET # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet'
date_filed = '2024-04-17' # str (date string in YYYY-mm-dd) or None(the latest filing will be retrieved)

try:
# Search sec filing
api_response = api_instance.search_sec_filing(form_type, company, date_filed, table)
api_response = api_instance.search_sec_filing(form_type, company, table, date_filed)
print("The response of DefaultApi->search_sec_filing:\n")
pprint(api_response)
except ApiException as e:
Expand Down
2 changes: 1 addition & 1 deletion sec_agent_sdk/api/default_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,8 @@ def search_sec_filing_without_preload_content(
self,
form_type: FormType,
company: StrictStr,
date_filed: StrictStr,
table: FilingTable,
date_filed: Optional[StrictStr] = None,
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Expand Down

0 comments on commit 4dda0c6

Please sign in to comment.