Skip to content

Commit 664c2d2

Browse files
Update Documentation
Updated Fundamentals Documentation
1 parent f5eb019 commit 664c2d2

File tree

1 file changed

+15
-18
lines changed

1 file changed

+15
-18
lines changed

src/docs/FundamentalsApi.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -645,14 +645,12 @@ api_key
645645

646646
### HTTP response details
647647
| Status code | Description | Response headers |
648-
|------------|-------------|------------------|
649-
| **200** | | - |
648+
|-------------|-------------|------------------|
649+
| **200** | | |
650650

651651
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
652652

653-
# **v1_fundamentals_exchange_outstanding_shares_exchange_code_exchange_code_year_get**
654-
> OptionsResponse v1_fundamentals_exchange_outstanding_shares_exchange_code_exchange_code_year_get(exchange_code, year)
655-
653+
## **Fundamentals Outstanding Shares BY Exchange & Year**
656654

657655

658656
Given an exchange_code and a year return all outstanding shares for all companies for that year
@@ -677,14 +675,15 @@ configuration = IntelligentStockMarketAPI.Configuration(
677675
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
678676
# Create an instance of the API class
679677
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
680-
exchange_code = 'exchange_code_example' # str |
681-
year = 'year_example' # str |
678+
exchange_code = 'TO' # str |
679+
year = '2023' # str |
682680

683681
try:
684682
api_response = api_instance.v1_fundamentals_exchange_outstanding_shares_exchange_code_exchange_code_year_get(exchange_code, year)
685683
pprint(api_response)
686684
except ApiException as e:
687-
print("Exception when calling FundamentalsApi->v1_fundamentals_exchange_outstanding_shares_exchange_code_exchange_code_year_get: %s\n" % e)
685+
print("Exception when calling Fundamentals Api {}".format(e))
686+
688687
```
689688

690689
### Parameters
@@ -710,14 +709,11 @@ api_key
710709
### HTTP response details
711710
| Status code | Description | Response headers |
712711
|-------------|-------------|------------------|
713-
| **0** | | - |
712+
| **200** | | - |
714713

715714
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
716715

717-
# **v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get**
718-
> OptionsResponse v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get(stock_code, to, _from, term)
719-
720-
716+
## **Financial Statements Given a Range of Dates**
721717

722718
Return Annual or Quarterly Statements based on Term, Stock Code, and dates _from and _to
723719

@@ -742,15 +738,16 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
742738
# Create an instance of the API class
743739
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
744740
stock_code = 'stock_code_example' # str |
745-
to = 'to_example' # str |
746-
_from = '_from_example' # str |
747-
term = 'term_example' # str |
741+
_to = '2022-12-31' # str |
742+
_from = '2022-01-01' # str |
743+
term = 'quarterly' # str |
748744

749745
try:
750-
api_response = api_instance.v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get(stock_code, to, _from, term)
746+
api_response = api_instance.v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get(stock_code, _to, _from, term)
751747
pprint(api_response)
752748
except ApiException as e:
753-
print("Exception when calling FundamentalsApi->v1_fundamentals_financial_statements_by_term_from_to_stock_code_term_get: %s\n" % e)
749+
print("Exception when calling Fundamentals Api {}".format(e))
750+
754751
```
755752

756753
### Parameters

0 commit comments

Comments
 (0)