Skip to content

Commit c98e1e4

Browse files
freelancing-solutionsfreelancing-solutions
committedApr 1, 2023
Update Documentation
EOD and Fundamental Data
·
v0.0.6
1 parent d01a73c commit c98e1e4

File tree

3 files changed

+58
-24
lines changed

3 files changed

+58
-24
lines changed
 

‎src/docs/EODStockResponse.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# EODStockResponse
22

3+
The EODStockResponse model represents the response data that is returned by the EODStock API endpoint. This model contains three optional properties that provide information about the status of the API call and the data that was returned.
4+
5+
The "message" property is a string that indicates whether the API call was successful or if an error occurred. If the call was successful, the "message" property will contain the string "Success". If an error occurred, the "message" property will contain a description of the error.
6+
7+
The "payload" property is an instance of the "EODStock" object, which contains data about the requested stock. This object includes properties such as the stock symbol, the date range of the stock data, and an array of daily stock data points.
8+
9+
The "status" property is a Boolean value that indicates whether the data returned by the API is valid. If the data is valid, the "status" property will be set to "True". If the data is invalid, the "status" property will be set to "False".
310
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**EODStock**](EODStock.md) | | [optional]
8-
**status** | **bool** | True if data is found and valid | [optional]
11+
| Name | Type | Description | Notes |
12+
|-------------|-----------------------------|---------------------------------|------------|
13+
| **message** | **str** | success or error message | [optional] |
14+
| **payload** | [**EODStock**](EODStock.md) | | [optional] |
15+
| **status** | **bool** | True if data is found and valid | [optional] |
916

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1118

1219

‎src/docs/Exchange.md

+25-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
# Exchange
22

3+
The Exchange model represents a financial exchange, which is a platform where financial instruments are traded.
4+
This model contains several properties that provide information about the exchange.
5+
6+
The "code" property is a string that represents the exchange code, which is a unique identifier for the exchange.
7+
8+
The "country" property is a string that indicates the country in which the exchange operates.
9+
10+
The "currency_symbol" property is a string that represents the currency symbol used in the country where the exchange operates.
11+
12+
The "exchange_id" property is a string that represents the unique identifier for the exchange.
13+
14+
The "name" property is a string that represents the name of the exchange.
15+
16+
The "operating_mic" property is a string that represents the operating MIC (Market Identifier Code) for the exchange.
17+
318
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**code** | **str** | exchange_code code | [optional]
7-
**country** | **str** | the country the exchange_code operates in | [optional]
8-
**currency_symbol** | **str** | the currency symbol of the country the exchange_code operates in | [optional]
9-
**exchange_id** | **str** | exchange_code unique id | [optional]
10-
**name** | **str** | name of exchange_code | [optional]
11-
**operating_mic** | **str** | exchange_code operating mic | [optional]
12-
13-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
19+
| Name | Type | Description | Notes |
20+
|---------------------|---------|------------------------------------------------------------------|------------|
21+
| **code** | **str** | exchange_code code | [optional] |
22+
| **country** | **str** | the country the exchange_code operates in | [optional] |
23+
| **currency_symbol** | **str** | the currency symbol of the country the exchange_code operates in | [optional] |
24+
| **exchange_id** | **str** | exchange_code unique id | [optional] |
25+
| **name** | **str** | name of exchange_code | [optional] |
26+
| **operating_mic** | **str** | exchange_code operating mic | [optional] |
27+
28+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1429

1530

‎src/docs/ExchangeListedCompaniesResponse.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1-
# ExchangeListedCompaniesResponse
1+
## General Fundamental Data For Exchange Listed Companies
22

3-
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**message** | **str** | success or error message | [optional]
7-
**payload** | [**General**](General.md) | | [optional]
8-
**status** | **bool** | True if data is found and valid | [optional]
3+
The General Fundamental Data For Exchange Listed Companies model provides general information about companies listed on
4+
an exchange. This model contains several properties that provide valuable information for investors and analysts.
95

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
6+
The "message" property is a string that indicates whether the data was successfully retrieved or if there was an error.
7+
If the data was retrieved successfully, the message will indicate success, otherwise it will provide an error message.
8+
9+
The "payload" property is an instance of the General model, which contains the general fundamental data for
10+
the exchange listed companies.
11+
12+
The "status" property is a boolean that indicates whether the data is found and valid. If the data is found and valid,
13+
the status will be True, otherwise it will be False.
14+
15+
### Properties
16+
| Name | Type | Description | Notes |
17+
|-------------|---------------------------|---------------------------------|------------|
18+
| **message** | **str** | success or error message | [optional] |
19+
| **payload** | [**General**](General.md) | | [optional] |
20+
| **status** | **bool** | True if data is found and valid | [optional] |
21+
22+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1123

1224

0 commit comments

Comments
 (0)
Please sign in to comment.