-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDocumentation
166 lines (114 loc) · 7.06 KB
/
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
#### Documentation
Welcome to our *Stock Market & Financial News API* documentation.
**Stock Marketing & Financial News API**,
provides end-of-day stock information for multiple exchanges around the world.
With this API, you can retrieve data for a specific stock at a given date, or for a range of dates. and also get access
to companies fundamental data, financial statements, social media trending stocks by sentiment, and also the ability to create a summary of the Financial
News Related to a certain stock or company and its sentiment.
**Endpoints**
#### Obtain EOD Data for all Stocks in One Exchange at a Given Date
Endpoint:
/api/v1/eod/{_date}/{exchange_code}
Method: GET
Description:
This endpoint will return end of day (EOD) data for all stocks in an exchange at a given date.
The end of day data provides information about the performance of a stock at the close of a trading day.
Path Parameters:
_exchange_code (string, required):_ This parameter represents the exchange code of the stock for which you want to retrieve the end of day data.
__date (string, required):_ This parameter represents the date for which you want to retrieve the end of day data.
Responses:
200 (default): On success,
the response will include a JSON object that conforms to the "EODStockResponse" schema.
Example Request:
GET /api/v1/eod/2022-12-31/AAPL
----------------------------------------------------------------------------------------------------------------------------------------
##### Obtain EOD Data for a Specific Stock on a certain Date
Endpoint:
/api/v1/eod/{_date}/{exchange_code}.{stock_code}
Method: GET
Description:
This endpoint will return end of day (EOD) data for a certain stock at a given date. The end of day data provides information about the performance of a stock at the close of a trading day.
Path Parameters:
exchange_code (string, required): This parameter represents the exchange code of the stock for which you want to retrieve the end of day data.
_date (string, required): This parameter represents the date for which you want to retrieve the end of day data.
stock_code (string, required): This parameter represents the code for the specific stock for which you want to retrieve the end of day data.
Responses:
200 (default): On success, the response will include a JSON object that conforms to the "EODStockResponse" schema.
Example Request:
GET /api/v1/eod/2022-12-31/AAPL.MSFT
----------------------------------------------------------------------------------------------------------------------------------------
#### Obtain EOD Data for a certain date range from one exchange
Endpoint:
/api/v1/eod/{_from}.{_to}/{exchange_code}
_Method: GET_
Description:
This endpoint returns a list of end of day (EOD) historical data for a specific stock on a specific exchange code between two dates. The end of day data provides information about the performance of a stock at the close of a trading day.
Path Parameters:
exchange_code (string, required): This parameter represents the exchange code of the stock for which you want to retrieve the end of day data.
_from (string, required): This parameter represents the start date for which you want to retrieve the end of day data.
_to (string, required): This parameter represents the end date for which you want to retrieve the end of day data.
Responses:
200 (default): On success, the response will include a JSON object that conforms to the "EODStockListResponse" schema.
Example Request:
/api/v1/eod/2022-01-01.2022-12-31/US
----------------------------------------------------------------------------------------------------------------------------------------
#### Obtain EOD Data for a Stock between Two Dates
Endpoint:
/api/v1/eod/{_from}.{_to}/{stock_code}
HTTP Method: GET
Description:
This endpoint returns end of day data for a certain stock between two dates.
Path Parameters:
stock_code: A required string that specifies the code of the stock to retrieve data for.
_to: A required string that specifies the end date in the format "YYYY-MM-DD" of the date range to retrieve data for.
_from: A required string that specifies the start date in the format "YYYY-MM-DD" of the date range to retrieve data for.
Responses:
_Default (200 OK)_
The API returns a JSON object containing the end of day data for the specified stock between the two dates.
The data will be returned in the format described by the EODStockResponse definition in the API schema.
Example Request:
/api/v1/eod/2022-01-01.2022-12-31/AAPL
----------------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------------------------------------------
#### Given Exchange Code Obtain Exchange Data
Endpoint
/api/v1/exchange/code/{exchange_code}
HTTP Method: GET
Description:
This endpoint returns exchange data, given an exchange_code.
The exchange_code is passed as a path parameter in the URL.
Parameters
exchange_code (string, required): The exchange_code parameter is a required string that specifies the exchange code
for which you want to retrieve data.
Responses
This endpoint returns a JSON object containing the details of the exchange
Example Request:
/api/v1/exchange/code/us
----------------------------------------------------------------------------------------------------------------------------------------
#### Given an Exchange ID Obtain Exchange Data
Endpoint
/api/v1/exchange/id/{exchange_id}
HTTP Method: GET
Description:
This endpoint returns exchange data, given an exchange_code.
The exchange_code is passed as a path parameter in the URL.
Parameters
exchange_code (string, required): The exchange_code parameter is a required string that specifies the exchange code
for which you want to retrieve data.
Responses
This endpoint returns a JSON object containing the details of the exchange
Example Request:
/api/v1/exchange/id/RP5zfbmYel63f0Wc
ExchangeResponse Structure:
{
"message": "Exchange successfully fetched",
"payload": {
"code": "BA",
"country": "Argentina",
"currency_symbol": "ARS",
"exchange_id": "RP5zfbmYel63f0Wc",
"name": "Buenos Aires Exchange",
"operating_mic": "XBUE"
},
"status": true
}