diff --git a/README.md b/README.md index 340303f..92933d5 100644 --- a/README.md +++ b/README.md @@ -27,29 +27,36 @@ Please reach out at info@cambioml.com for an API key. ```python import os import sec_agent_sdk -from sec_agent_sdk import FormType, FilingTable +from sec_agent_sdk import ApiClient, DefaultApi, FilingTable, FormType from sec_agent_sdk.rest import ApiException from pprint import pprint configuration = sec_agent_sdk.Configuration() # Configure API key authorization: APIKeyHeader -configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"] +configuration.api_key["APIKeyHeader"] = "YOUR-API-KEY" # Enter a context with an instance of the API client -with sec_agent_sdk.ApiClient(configuration) as api_client: +with ApiClient(configuration) as api_client: # Create an instance of the API class - 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 - table = FilingTable.BALANCE_SHEET # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet' | 'business-segments-and-kpis' - date_filed = '2024-04-17' # optional str (date string in YYYY-mm-dd) or None(the latest filing will be retrieved) + api_instance = DefaultApi(api_client) + form_type = FormType.EIGHT_K # FormType | 10-K | 10-Q | 8-K | 6-K + company = "AAPL" # ticker + table = ( + FilingTable.BALANCE_SHEET + ) # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet' + # date_filed = '2024-04-17' # optional 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, table, date_filed) + api_response = api_instance.search_sec_filing_get(form_type, company, table) print("The response of DefaultApi->search_sec_filing:\n") pprint(api_response) + + # Search sec filing v2 + api_response = api_instance.search_sec_filing_v2_get(form_type, company, table) + print("The response of DefaultApi->search_sec_filing_v2:\n") + pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->search_sec_filing: %s\n" % e) diff --git a/test/aisec_example.py b/test/aisec_example.py index e6158e1..b3035a8 100644 --- a/test/aisec_example.py +++ b/test/aisec_example.py @@ -19,17 +19,22 @@ with ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = DefaultApi(api_client) - form_type = FormType.TEN_Q # FormType | 10-K | 10-Q | 8-K | 6-K - company = "AMZN" # ticker + form_type = FormType.EIGHT_K # FormType | 10-K | 10-Q | 8-K | 6-K + company = "AAPL" # ticker # date_filed = '2024-04-17' # str | date string in YYYY-mm-dd table = ( - FilingTable.BUSINESS_SEGMENTS_AND_KPIS + FilingTable.BALANCE_SHEET ) # FilingTable | 'cash-flow-statement' | 'income-statement' | 'balance-sheet' try: # Search sec filing - api_response = api_instance.search_sec_filing(form_type, company, table) + api_response = api_instance.search_sec_filing_get(form_type, company, table) print("The response of DefaultApi->search_sec_filing:\n") pprint(api_response) + + # Search sec filing v2 + api_response = api_instance.search_sec_filing_v2_get(form_type, company, table) + print("The response of DefaultApi->search_sec_filing_v2:\n") + pprint(api_response) except ApiException as e: print("Exception when calling DefaultApi->search_sec_filing: %s\n" % e)