Skip to content

Commit 859457e

Browse files
freelancing-solutionsfreelancing-solutions
committed
Update Documentation
Updated Fundamentals Documentation
1 parent 664c2d2 commit 859457e

File tree

1 file changed

+30
-44
lines changed

1 file changed

+30
-44
lines changed

‎src/docs/FundamentalsApi.md

Lines changed: 30 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -775,7 +775,7 @@ api_key
775775
### HTTP response details
776776
| Status code | Description | Response headers |
777777
|-------------|-------------|------------------|
778-
| **0** | | - |
778+
| **200** | | - |
779779

780780
[[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)
781781

@@ -838,14 +838,12 @@ api_key
838838

839839
### HTTP response details
840840
| Status code | Description | Response headers |
841-
|-------------|-------------|------------------|
842-
| **0** | | - |
841+
|------------|-------------|------------------|
842+
| **200** | | - |
843843

844844
[[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)
845845

846-
# **v1_fundamentals_financial_statements_exchange_year_exchange_code_year_get**
847-
> OptionsResponse v1_fundamentals_financial_statements_exchange_year_exchange_code_year_get(exchange_code, year)
848-
846+
## **Fundamental Financial Statements By Year**
849847

850848

851849
Given an exchange_code and a year return a complete list of financial statements for all companies in exchange
@@ -877,7 +875,7 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
877875
api_response = api_instance.v1_fundamentals_financial_statements_exchange_year_exchange_code_year_get(exchange_code, year)
878876
pprint(api_response)
879877
except ApiException as e:
880-
print("Exception when calling FundamentalsApi->v1_fundamentals_financial_statements_exchange_year_exchange_code_year_get: %s\n" % e)
878+
print("Exception when calling Fundamentals Api {}".format(e))
881879
```
882880

883881
### Parameters
@@ -903,13 +901,11 @@ api_key
903901
### HTTP response details
904902
| Status code | Description | Response headers |
905903
|-------------|-------------|------------------|
906-
| **0** | | - |
904+
| **200** | | - |
907905

908906
[[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)
909907

910-
# **v1_fundamentals_financial_statements_filing_date_ticker_filing_date_stock_code_get**
911-
> OptionsResponse v1_fundamentals_financial_statements_filing_date_ticker_filing_date_stock_code_get(stock_code, filing_date)
912-
908+
## **Fundamentals Income Statements By Filing Date & Stock Code**
913909

914910

915911
Returns Income Statements by Filing Date and Company Stock Code
@@ -941,7 +937,8 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
941937
api_response = api_instance.v1_fundamentals_financial_statements_filing_date_ticker_filing_date_stock_code_get(stock_code, filing_date)
942938
pprint(api_response)
943939
except ApiException as e:
944-
print("Exception when calling FundamentalsApi->v1_fundamentals_financial_statements_filing_date_ticker_filing_date_stock_code_get: %s\n" % e)
940+
print("Exception when calling Fundamentals Api {}".format(e))
941+
945942
```
946943

947944
### Parameters
@@ -971,10 +968,7 @@ api_key
971968

972969
[[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)
973970

974-
# **v1_fundamentals_financial_statements_ticker_date_range_from_to_stock_code_get**
975-
> OptionsResponse v1_fundamentals_financial_statements_ticker_date_range_from_to_stock_code_get(stock_code, to, _from)
976-
977-
971+
## **Fundamentals - Company Financial Statements Given Date Range**
978972

979973
Given two dates and a stock date return all financial statements, _from & _to should be date-strings
980974

@@ -999,14 +993,15 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
999993
# Create an instance of the API class
1000994
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
1001995
stock_code = 'stock_code_example' # str |
1002-
to = 'to_example' # str |
1003-
_from = '_from_example' # str |
996+
_to = '2022-12-32' # str | YYYY-MM-DD
997+
_from = '2022-01-01' # str | YYYY-MM-DD
1004998

1005999
try:
10061000
api_response = api_instance.v1_fundamentals_financial_statements_ticker_date_range_from_to_stock_code_get(stock_code, to, _from)
10071001
pprint(api_response)
10081002
except ApiException as e:
1009-
print("Exception when calling FundamentalsApi->v1_fundamentals_financial_statements_ticker_date_range_from_to_stock_code_get: %s\n" % e)
1003+
print("Exception when calling Fundamentals Api {}".format(e))
1004+
10101005
```
10111006

10121007
### Parameters
@@ -1037,10 +1032,7 @@ api_key
10371032

10381033
[[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)
10391034

1040-
# **v1_fundamentals_financials_income_statements_statement_id_get**
1041-
> OptionsResponse v1_fundamentals_financials_income_statements_statement_id_get(statement_id)
1042-
1043-
1035+
## **Fundamentals Company Financial Statements By ID**
10441036

10451037
Will return Company Income Statement By Statement ID
10461038

@@ -1064,13 +1056,13 @@ configuration = IntelligentStockMarketAPI.Configuration(
10641056
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
10651057
# Create an instance of the API class
10661058
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
1067-
statement_id = 'statement_id_example' # str |
1059+
statement_id = 'fwpe98394hi8jfu8043' # str |
10681060

10691061
try:
10701062
api_response = api_instance.v1_fundamentals_financials_income_statements_statement_id_get(statement_id)
10711063
pprint(api_response)
10721064
except ApiException as e:
1073-
print("Exception when calling FundamentalsApi->v1_fundamentals_financials_income_statements_statement_id_get: %s\n" % e)
1065+
print("Exception when calling Fundamentals Api {}".format(e))
10741066
```
10751067

10761068
### Parameters
@@ -1095,14 +1087,11 @@ api_key
10951087
### HTTP response details
10961088
| Status code | Description | Response headers |
10971089
|-------------|-------------|------------------|
1098-
| **0** | | - |
1090+
| **200** | | - |
10991091

11001092
[[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)
11011093

1102-
# **v1_fundamentals_highlights_id_fundamental_id_get**
1103-
> HighlightsResponse v1_fundamentals_highlights_id_fundamental_id_get(fundamental_id)
1104-
1105-
1094+
## **Fundamentals - Highlights By Fundamental ID**
11061095

11071096
get fundamental highlights data from either fundamental_id or stock_codes
11081097

@@ -1126,13 +1115,13 @@ configuration = IntelligentStockMarketAPI.Configuration(
11261115
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
11271116
# Create an instance of the API class
11281117
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
1129-
fundamental_id = 'fundamental_id_example' # str |
1118+
fundamental_id = '34599fg83u94sdfkpsdof' # str |
11301119

11311120
try:
11321121
api_response = api_instance.v1_fundamentals_highlights_id_fundamental_id_get(fundamental_id)
11331122
pprint(api_response)
11341123
except ApiException as e:
1135-
print("Exception when calling FundamentalsApi->v1_fundamentals_highlights_id_fundamental_id_get: %s\n" % e)
1124+
print("Exception when calling Fundamentals Api {}".format(e))
11361125
```
11371126

11381127
### Parameters
@@ -1157,14 +1146,11 @@ api_key
11571146
### HTTP response details
11581147
| Status code | Description | Response headers |
11591148
|-------------|-------------|------------------|
1160-
| **0** | | - |
1149+
| **200** | | - |
11611150

11621151
[[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)
11631152

1164-
# **v1_fundamentals_highlights_stock_stock_code_get**
1165-
> HighlightsResponse v1_fundamentals_highlights_stock_stock_code_get(stock_code)
1166-
1167-
1153+
## **Fundamentals - Highlights By Stock Code / Fundamental ID**
11681154

11691155
get fundamental highlights data from either fundamental_id or stock_codes
11701156

@@ -1188,13 +1174,13 @@ configuration = IntelligentStockMarketAPI.Configuration(
11881174
with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
11891175
# Create an instance of the API class
11901176
api_instance = IntelligentStockMarketAPI.FundamentalsApi(api_client)
1191-
stock_code = 'stock_code_example' # str |
1177+
stock_code = 'MSFT' # str |
11921178

11931179
try:
11941180
api_response = api_instance.v1_fundamentals_highlights_stock_stock_code_get(stock_code)
11951181
pprint(api_response)
11961182
except ApiException as e:
1197-
print("Exception when calling FundamentalsApi->v1_fundamentals_highlights_stock_stock_code_get: %s\n" % e)
1183+
print("Exception when calling Fundamentals Api {}".format(e))
11981184
```
11991185

12001186
### Parameters
@@ -1219,16 +1205,16 @@ api_key
12191205
### HTTP response details
12201206
| Status code | Description | Response headers |
12211207
|-------------|-------------|------------------|
1222-
| **0** | | - |
1208+
| **200** | | - |
12231209

12241210
[[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)
12251211

1226-
# **v1_fundamentals_quarterly_balance_sheet_filing_date_stock_code_get**
1212+
## **Fundamentals - Quarterly Balance Sheets By Stock & Filing Date**
12271213
> QuarterlyBalanceResponse v1_fundamentals_quarterly_balance_sheet_filing_date_stock_code_get(stock_code, filing_date)
12281214
12291215

12301216

1231-
given filing_date and balance_sheet_id return Quarterly Balance Sheet
1217+
Given the filing date and stock code return Quarterly Balance Sheets
12321218

12331219
### Example
12341220

@@ -1257,7 +1243,7 @@ with IntelligentStockMarketAPI.ApiClient(configuration) as api_client:
12571243
api_response = api_instance.v1_fundamentals_quarterly_balance_sheet_filing_date_stock_code_get(stock_code, filing_date)
12581244
pprint(api_response)
12591245
except ApiException as e:
1260-
print("Exception when calling FundamentalsApi->v1_fundamentals_quarterly_balance_sheet_filing_date_stock_code_get: %s\n" % e)
1246+
print("Exception when calling Fundamentals Api {}".format(e))
12611247
```
12621248

12631249
### Parameters
@@ -1283,7 +1269,7 @@ api_key
12831269
### HTTP response details
12841270
| Status code | Description | Response headers |
12851271
|-------------|-------------|------------------|
1286-
| **0** | | - |
1272+
| **200** | | - |
12871273

12881274
[[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)
12891275

0 commit comments

Comments
 (0)