API Documentation

Introduction

Welcome to Bytemine.io's API Hub. You can use our API to access API endpoints and our own signals, which can get information on Fundamentals of a Ticker, Historical Data, Pre-Processed Signals and more from our database.
Currently, we have language bindings in only Shell. However, you can easily translate this to whichever platform/language you are using as these are just simple API calls. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
We offer compelling data services for a highly competitive price, if you decide to switch to one of our premium plans. On top of that you get access to the Trader's platform as well.
If you have any questions or want to raise a concern/query, please drop in a mail at [email protected]. We'll try our best to answer your queries within 24 working hours.

Authentication

No tricky authorization mechanisms. Authorization of the API key is essential for requesting data.
1
# With shell, you can just pass the correct API key with each request
2
curl https://app.bytemine.io/api/checkForCandlestick/{api_key}/...
3
Copied!
1
$.ajax({
2
url: "https://app.bytemine.io/api/checkForCandlestick/{api_key}/...",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
Make sure to replace {api_key} with your API key.
To use the API you have to have an API key. You can get an API key from our developer portal.
The API key should be included in all API requests to the server

Signals

Candlestick Patterns

1
curl https://app.bytemine.io/api/checkForCandlestick/{api_key}/TSLA/5m
2
Copied!
1
$.ajax({
2
url: "https://app.bytemine.io/api/checkForCandlestick/{api_key}/TSLA/5m",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"success": true,
3
"data": [
4
{
5
"time": "2020-12-08 09:30",
6
"pattern": "Bearish Engulfing",
7
"close": 604.48,
8
"high": 654.32,
9
"open": 653.69,
10
"low": 588
11
}
12
]
13
}
Copied!
You can get Candlestick Patterns from our API endpoints. This can be achieved using Long Polling. However, make sure to not call our Endpoints without adding atleast a 1 Min Delay.

HTTP Request

GET https://app.bytemine.io/api/checkForCandlestick/{api_key}/{ticker}/{timeframe}

Query Parameters

Parameter
Default
Description
api_key
true
API Key is required for authentication.
ticker
true
A ticker/symbol is needed for the appropriate candlestick pattern to be returned.
timeframe
true
Only one Timeframe out of these - 1m/2m/5m/15m/30m/60m/90m/1d/5d/1wk/1mo

Example HTTP Request

GET https://app.bytemine.io/api/checkForCandlestick/5fe69c95ed70a9869d9f9af7d8400a6673bb9ces/AAPL/5m
1
curl https://app.bytemine.io/api/getTickerTrend/{api_key}/AMD/30m
Copied!
1
$.ajax({
2
url: "https://app.bytemine.io/api/getTickerTrend/{api_key}/AMD/30m",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"success": true,
3
"trend": "Bearish"
4
}
Copied!
Trends can be classified into three categories - Bullish, Bearish, Neutral. This can be achieved using Long Polling. However, make sure to not call our Endpoints without adding atleast a 1 Min Delay.

HTTP Request

GET https://app.bytemine.io/api/getTickerTrend/{api_key}/{ticker}/{timeframe}

Query Parameters

Parameter
Default
Description
api_key
true
API Key is required for authentication.
ticker
true
A ticker/symbol is needed for the appropriate candlestick pattern to be returned.
timeframe
true
Only one Timeframe out of these - 1m/2m/5m/15m/30m/60m/90m/1d/5d/1wk/1mo

Stock Market Data

Country Abbreviations

In some cases you might need country abbreviations to query the data. For example - if you want to find the list of stocks that a country has then you'd have to use country abbreviations. You can check the list of supported countries and their abbreviations from over here - https://airtable.com/shrffQ8hRyl0LKAQH/tbl9lvQLZq9nryClu.

Get List of all tickers of a Country

1
curl https://server1.bytemine.workers.dev/stocks/{api_key}/{country_abbreviation}/{offset}
2
Copied!
1
$.ajax({
2
url: "https://server1.bytemine.workers.dev/stocks/{api_key}/cz/0",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"start": 0,
3
"totalCount": 36,
4
"tickersReturned": 36,
5
"data": {
6
"0": {
7
"tickerSymbol": "RDSA.PR",
8
"open": 437.85,
9
"low": 434.6,
10
"high": 437.85,
11
"ltp": 434.6,
12
"volume": 251,
13
"dayChange": 6.600006,
14
"dayChangePercent": 1.5420575,
15
"fiftyTwoWeekLow": 275,
16
"fiftyTwoWeekHigh": 509,
17
"marketCap": 3278153187328
18
},
19
"1": {
20
"tickerSymbol": "VOLVB.PR",
21
"open": 535,
22
"low": 535,
23
"high": 535,
24
"ltp": 535,
25
"volume": 50,
26
"dayChange": 0,
27
"dayChangePercent": 0,
28
"fiftyTwoWeekLow": 290,
29
"fiftyTwoWeekHigh": 608,
30
"marketCap": 1089062043648
31
},
32
"2": {
33
"tickerSymbol": "EOAN.PR",
34
"open": 255.5,
35
"low": 255.5,
36
"high": 255.5,
37
"ltp": 255.5,
38
"volume": 223,
39
"dayChange": 0,
40
"dayChangePercent": 0,
41
"fiftyTwoWeekLow": 220,
42
"fiftyTwoWeekHigh": 275.05,
43
"marketCap": 671160205312
44
},
45
"3": {
46
"tickerSymbol": "VER.PR",
47
"open": 1600,
48
"low": 1600,
49
"high": 1600,
50
"ltp": 1600,
51
"volume": 15,
52
"dayChange": 0,
53
"dayChangePercent": 0,
54
"fiftyTwoWeekLow": 923,
55
"fiftyTwoWeekHigh": 1832.5,
56
"marketCap": 556734414848
57
},
58
"4": {
59
"tickerSymbol": "NOKIA.PR",
60
"open": 94.99,
61
"low": 92,
62
"high": 94.99,
63
"ltp": 92,
64
"volume": 520,
65
"dayChange": 1,
66
"dayChangePercent": 1.0989012,
67
"fiftyTwoWeekLow": 76.82,
68
"fiftyTwoWeekHigh": 126.88,
69
"marketCap": 511416041472
70
},
71
"5": {
72
"tickerSymbol": "ERBAG.PR",
73
"open": 766.8,
74
"low": 756,
75
"high": 766.8,
76
"ltp": 756,
77
"volume": 44238,
78
"dayChange": 2,
79
"dayChangePercent": 0.265252,
80
"fiftyTwoWeekLow": 440,
81
"fiftyTwoWeekHigh": 773.6,
82
"marketCap": 306056757248
83
},
84
"6": {
85
"tickerSymbol": "CEZ.PR",
86
"open": 567,
87
"low": 566,
88
"high": 573,
89
"ltp": 571.5,
90
"volume": 163983,
91
"dayChange": 6.5,
92
"dayChangePercent": 1.1504425,
93
"fiftyTwoWeekLow": 433.5,
94
"fiftyTwoWeekHigh": 573,
95
"marketCap": 306023366656
96
},
97
"7": {
98
"tickerSymbol": "OTP.PR",
99
"open": 978,
100
"low": 978,
101
"high": 978,
102
"ltp": 978,
103
"volume": 1,
104
"dayChange": -25,
105
"dayChangePercent": -2.4925225,
106
"fiftyTwoWeekLow": 651,
107
"fiftyTwoWeekHigh": 1003,
108
"marketCap": 264351432704
109
},
110
"8": {
111
"tickerSymbol": "PKO.PR",
112
"open": 186.5,
113
"low": 186.5,
114
"high": 186.5,
115
"ltp": 186.5,
116
"volume": 1,
117
"dayChange": 0,
118
"dayChangePercent": 0,
119
"fiftyTwoWeekLow": 110,
120
"fiftyTwoWeekHigh": 186.5,
121
"marketCap": 226819424256
122
},
123
"9": {
124
"tickerSymbol": "PKN.PR",
125
"open": 368,
126
"low": 368,
127
"high": 368,
128
"ltp": 368,
129
"volume": 10,
130
"dayChange": 2,
131
"dayChangePercent": 0.54644805,
132
"fiftyTwoWeekLow": 225.9,
133
"fiftyTwoWeekHigh": 434.6,
134
"marketCap": 155653701632
135
},
136
"10": {
137
"tickerSymbol": "RBI.PR",
138
"open": 474.4,
139
"low": 474.4,
140
"high": 474.4,
141
"ltp": 474.4,
142
"volume": 230,
143
"dayChange": 0,
144
"dayChangePercent": 0,
145
"fiftyTwoWeekLow": 332,
146
"fiftyTwoWeekHigh": 494.6,
147
"marketCap": 157174415360
148
},
149
"11": {
150
"tickerSymbol": "AVST.PR",
151
"open": 143.15,
152
"low": 140.9,
153
"high": 143.15,
154
"ltp": 143,
155
"volume": 198961,
156
"dayChange": 0.3500061,
157
"dayChangePercent": 0.24536005,
158
"fiftyTwoWeekLow": 119.6,
159
"fiftyTwoWeekHigh": 177,
160
"marketCap": 145669816320
161
},
162
"12": {
163
"tickerSymbol": "KOMB.PR",
164
"open": 684,
165
"low": 678,
166
"high": 686,
167
"ltp": 678,
168
"volume": 94533,
169
"dayChange": -2,
170
"dayChangePercent": -0.29411766,
171
"fiftyTwoWeekLow": 460,
172
"fiftyTwoWeekHigh": 725,
173
"marketCap": 128044367872
174
},
175
"13": {
176
"tickerSymbol": "MOL.PR",
177
"open": 156.2,
178
"low": 156.2,
179
"high": 156.2,
180
"ltp": 156.2,
181
"volume": 200,
182
"dayChange": -1.5,
183
"dayChangePercent": -0.9511732,
184
"fiftyTwoWeekLow": 115,
185
"fiftyTwoWeekHigh": 176,
186
"marketCap": 117469896704
187
},
188
"14": {
189
"tickerSymbol": "TELEC.PR",
190
"open": 261,
191
"low": 260,
192
"high": 264,
193
"ltp": 260,
194
"volume": 40454,
195
"dayChange": -1,
196
"dayChangePercent": -0.38314176,
197
"fiftyTwoWeekLow": 209,
198
"fiftyTwoWeekHigh": 264,
199
"marketCap": 78229315584
200
},
201
"15": {
202
"tickerSymbol": "VIG.PR",
203
"open": 590.5,
204
"low": 586,
205
"high": 595,
206
"ltp": 595,
207
"volume": 3429,
208
"dayChange": 11,
209
"dayChangePercent": 1.8835617,
210
"fiftyTwoWeekLow": 469,
211
"fiftyTwoWeekHigh": 619,
212
"marketCap": 76236161024
213
},
214
"16": {
215
"tickerSymbol": "TABAK.PR",
216
"open": 14600,
217
"low": 14500,
218
"high": 14620,
219
"ltp": 14600,
220
"volume": 1286,
221
"dayChange": 100,
222
"dayChangePercent": 0.6896552,
223
"fiftyTwoWeekLow": 13000,
224
"fiftyTwoWeekHigh": 15780,
225
"marketCap": 40082694144
226
},
227
"17": {
228
"tickerSymbol": "MONET.PR",
229
"open": 78,
230
"low": 77.55,
231
"high": 78.15,
232
"ltp": 77.65,
233
"volume": 1665687,
234
"dayChange": -0.5499954,
235
"dayChangePercent": -0.70331895,
236
"fiftyTwoWeekLow": 48.25,
237
"fiftyTwoWeekHigh": 84.3,
238
"marketCap": 39679152128
239
},
240
"18": {
241
"tickerSymbol": "JUVE.PR",
242
"open": 20.92,
243
"low": 20.67,
244
"high": 20.92,
245
"ltp": 20.67,
246
"volume": 174,
247
"dayChange": -0.8600006,
248
"dayChangePercent": -3.994429,
249
"fiftyTwoWeekLow": 19.82,
250
"fiftyTwoWeekHigh": 29,
251
"marketCap": 26427215872
252
},
253
"19": {
254
"tickerSymbol": "STOCK.PR",
255
"open": 85.5,
256
"low": 85,
257
"high": 86,
258
"ltp": 85,
259
"volume": 3715,
260
"dayChange": -0.19999695,
261
"dayChangePercent": -0.2347382,
262
"fiftyTwoWeekLow": 50.4,
263
"fiftyTwoWeekHigh": 87.5,
264
"marketCap": 17314670592
265
},
266
"20": {
267
"tickerSymbol": "BVB.PR",
268
"open": 136,
269
"low": 135,
270
"high": 136,
271
"ltp": 135,
272
"volume": 223,
273
"dayChange": 0,
274
"dayChangePercent": 0,
275
"fiftyTwoWeekLow": 119.4,
276
"fiftyTwoWeekHigh": 172.9,
277
"marketCap": 12491508736
278
},
279
"21": {
280
"tickerSymbol": "FACC.PR",
281
"open": 247,
282
"low": 247,
283
"high": 247,
284
"ltp": 247,
285
"volume": 100,
286
"dayChange": 0,
287
"dayChangePercent": 0,
288
"fiftyTwoWeekLow": 126.1,
289
"fiftyTwoWeekHigh": 276.4,
290
"marketCap": 11015656448
291
},
292
"22": {
293
"tickerSymbol": "CZG.PR",
294
"open": 374,
295
"low": 370,
296
"high": 374,
297
"ltp": 373,
298
"volume": 895,
299
"dayChange": 2,
300
"dayChangePercent": 0.53908354,
301
"fiftyTwoWeekLow": 280,
302
"fiftyTwoWeekHigh": 410,
303
"marketCap": 11129574400
304
},
305
"23": {
306
"tickerSymbol": "KOFOL.PR",
307
"open": 273,
308
"low": 272,
309
"high": 274,
310
"ltp": 273,
311
"volume": 8947,
312
"dayChange": 1,
313
"dayChangePercent": 0.36764705,
314
"fiftyTwoWeekLow": 212,
315
"fiftyTwoWeekHigh": 26900,
316
"marketCap": 6085688832
317
},
318
"24": {
319
"tickerSymbol": "PEN.PR",
320
"open": 80,
321
"low": 79,
322
"high": 80,
323
"ltp": 79,
324
"volume": 370,
325
"dayChange": -1,
326
"dayChangePercent": -1.25,
327
"fiftyTwoWeekLow": 30,
328
"fiftyTwoWeekHigh": 115,
329
"marketCap": 3911606016
330
},
331
"25": {
332
"tickerSymbol": "PINK.PR",
333
"open": 1100,
334
"low": 1100,
335
"high": 1100,
336
"ltp": 1100,
337
"volume": 3460,
338
"dayChange": -100,
339
"dayChangePercent": -8.333334,
340
"fiftyTwoWeekLow": 500,
341
"fiftyTwoWeekHigh": 1500,
342
"marketCap": 2750000128
343
},
344
"26": {
345
"tickerSymbol": "SABFG.PR",
346
"open": 10600,
347
"low": 10600,
348
"high": 10600,
349
"ltp": 10600,
350
"volume": 310,
351
"dayChange": 0,
352
"dayChangePercent": 0,
353
"fiftyTwoWeekLow": 10500,
354
"fiftyTwoWeekHigh": 10600,
355
"marketCap": 2731959296
356
},
357
"27": {
358
"tickerSymbol": "TOMA.PR",
359
"open": 1290,
360
"low": 1290,
361
"high": 1290,
362
"ltp": 1290,
363
"volume": 650,
364
"dayChange": 0,
365
"dayChangePercent": 0,
366
"fiftyTwoWeekLow": 1200,
367
"fiftyTwoWeekHigh": 1380,
368
"marketCap": 1718628352
369
},
370
"28": {
371
"tickerSymbol": "PRIUA.PR",
372
"open": 352,
373
"low": 352,
374
"high": 352,
375
"ltp": 352,
376
"volume": 600,
377
"dayChange": -4,
378
"dayChangePercent": -1.1235955,
379
"fiftyTwoWeekLow": 240,
380
"fiftyTwoWeekHigh": 358,
381
"marketCap": 1537930240
382
},
383
"29": {
384
"tickerSymbol": "PVT.PR",
385
"open": 1.99,
386
"low": 1.25,
387
"high": 1.99,
388
"ltp": 1.25,
389
"volume": 5511,
390
"dayChange": -0.09000003,
391
"dayChangePercent": -6.7164207,
392
"fiftyTwoWeekLow": 0.5,
393
"fiftyTwoWeekHigh": 1.99,
394
"marketCap": 1331337472
395
},
396
"30": {
397
"tickerSymbol": "PRAB.PR",
398
"open": 392,
399
"low": 392,
400
"high": 392,
401
"ltp": 392,
402
"volume": 500,
403
"dayChange": 0,
404
"dayChangePercent": 0,
405
"fiftyTwoWeekLow": 354,
406
"fiftyTwoWeekHigh": 402,
407
"marketCap": 392000000
408
},
409
"31": {
410
"tickerSymbol": "EFORU.PR",
411
"open": 103,
412
"low": 103,
413
"high": 103,
414
"ltp": 103,
415
"volume": 4,
416
"dayChange": 0,
417
"dayChangePercent": 0,
418
"fiftyTwoWeekLow": 92,
419
"fiftyTwoWeekHigh": 103,
420
"marketCap": 246338912
421
},
422
"35": {
423
"tickerSymbol": "DBK.PR",
424
"open": 273.1,
425
"low": 273.1,
426
"high": 273.1,
427
"ltp": 273.1,
428
"volume": 5,
429
"dayChange": 0,
430
"dayChangePercent": 0,
431
"fiftyTwoWeekLow": 153.4,
432
"fiftyTwoWeekHigh": 293.6,
433
"marketCap": 552189100032
434
}
435
}
436
}
Copied!
The API endpoint requires 3 parameters -> API key, country abbreviation and finally an offset. You can get the country abbreviation from the above step. For offset the default value that you should enter is 0. Since the data is picked up from our SQL database hence we require an offset param to determine which next set of data should we output. You can read about offset from here.
If you still have questions about this then please contact us at [email protected]

Get Country's Most Active stocks

1
curl https://server1.bytemine.workers.dev/activestocks/{api_key}/{country_abbreviation}/{offset}
2
Copied!
1
$.ajax({
2
url: "https://server1.bytemine.workers.dev/activestocks/{api_key}/cz/0",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"start": 0,
3
"totalCount": 38,
4
"tickersReturned": 38,
5
"data": {
6
"0": {
7
"tickerSymbol": "MONET.PR",
8
"open": 77.95,
9
"low": 77.6,
10
"high": 78.1,
11
"ltp": 78,
12
"volume": 1098092,
13
"dayChange": 0.34999847,
14
"dayChangePercent": 0.45073852,
15
"fiftyTwoWeekLow": 48.25,
16
"fiftyTwoWeekHigh": 84.3,
17
"marketCap": 39857999872
18
},
19
"2": {
20
"tickerSymbol": "CEZ.PR",
21
"open": 572,
22
"low": 571.5,
23
"high": 581,
24
"ltp": 581,
25
"volume": 280469,
26
"dayChange": 9.5,
27
"dayChangePercent": 1.6622921,
28
"fiftyTwoWeekLow": 433.5,
29
"fiftyTwoWeekHigh": 581,
30
"marketCap": 311110369280
31
},
32
"3": {
33
"tickerSymbol": "KOMB.PR",
34
"open": 680,
35
"low": 673.5,
36
"high": 683.5,
37
"ltp": 673.5,
38
"volume": 162851,
39
"dayChange": -4.5,
40
"dayChangePercent": -0.6637168,
41
"fiftyTwoWeekLow": 460,
42
"fiftyTwoWeekHigh": 725,
43
"marketCap": 127194513408
44
},
45
"4": {
46
"tickerSymbol": "AVST.PR",
47
"open": 143,
48
"low": 140.85,
49
"high": 143.15,
50
"ltp": 141.3,
51
"volume": 119147,
52
"dayChange": -1.699997,
53
"dayChangePercent": -1.188809,
54
"fiftyTwoWeekLow": 119.6,
55
"fiftyTwoWeekHigh": 177,
56
"marketCap": 141875101696
57
},
58
"5": {
59
"tickerSymbol": "ERBAG.PR",
60
"open": 756,
61
"low": 753,
62
"high": 764,
63
"ltp": 762.8,
64
"volume": 48484,
65
"dayChange": 6.799988,
66
"dayChangePercent": 0.8994693,
67
"fiftyTwoWeekLow": 440,
68
"fiftyTwoWeekHigh": 773.6,
69
"marketCap": 308809662464
70
},
71
"6": {
72
"tickerSymbol": "TELEC.PR",
73
"open": 261,
74
"low": 261,
75
"high": 264,
76
"ltp": 263.5,
77
"volume": 20722,
78
"dayChange": 3.5,
79
"dayChangePercent": 1.3461539,
80
"fiftyTwoWeekLow": 209,
81
"fiftyTwoWeekHigh": 264,
82
"marketCap": 79282405376
83
},
84
"7": {
85
"tickerSymbol": "STOCK.PR",
86
"open": 85,
87
"low": 85,
88
"high": 86.9,
89
"ltp": 85.7,
90
"volume": 8837,
91
"dayChange": 0.69999695,
92
"dayChangePercent": 0.8235258,
93
"fiftyTwoWeekLow": 50.4,
94
"fiftyTwoWeekHigh": 87.5,
95
"marketCap": 17163910144
96
},
97
"8": {
98
"tickerSymbol": "KOFOL.PR",
99
"open": 275,
100
"low": 273,
101
"high": 276,
102
"ltp": 274,
103
"volume": 8071,
104
"dayChange": 1,
105
"dayChangePercent": 0.36630037,
106
"fiftyTwoWeekLow": 212,
107
"fiftyTwoWeekHigh": 26900,
108
"marketCap": 6107980800
109
},
110
"9": {
111
"tickerSymbol": "PVT.PR",
112
"open": 1.99,
113
"low": 1.25,
114
"high": 1.99,
115
"ltp": 1.25,
116
"volume": 5511,
117
"dayChange": 0,
118
"dayChangePercent": 0,
119
"fiftyTwoWeekLow": 0.5,
120
"fiftyTwoWeekHigh": 1.99,
121
"marketCap": 1331337472
122
},
123
"10": {
124
"tickerSymbol": "PINK.PR",
125
"open": 1100,
126
"low": 1100,
127
"high": 1100,
128
"ltp": 1100,
129
"volume": 8230,
130
"dayChange": 0,
131
"dayChangePercent": 0,
132
"fiftyTwoWeekLow": 500,
133
"fiftyTwoWeekHigh": 1500,
134
"marketCap": 2750000128
135
},
136
"11": {
137
"tickerSymbol": "UQA.PR",
138
"open": 172.6,
139
"low": 172.6,
140
"high": 173.2,
141
"ltp": 173.2,
142
"volume": 2215,
143
"dayChange": 3.5,
144
"dayChangePercent": 2.0624633,
145
"fiftyTwoWeekLow": 130.8,
146
"fiftyTwoWeekHigh": 199.7,
147
"marketCap": 54379429888
148
},
149
"12": {
150
"tickerSymbol": "VIG.PR",
151
"open": 595,
152
"low": 595,
153
"high": 599.5,
154
"ltp": 599.5,
155
"volume": 1260,
156
"dayChange": 4.5,
157
"dayChangePercent": 0.75630254,
158
"fiftyTwoWeekLow": 469,
159
"fiftyTwoWeekHigh": 619,
160
"marketCap": 76730605568
161
},
162
"14": {
163
"tickerSymbol": "RDSA.PR",
164
"open": 436,
165
"low": 430,
166
"high": 439.2,
167
"ltp": 431,
168
"volume": 762,
169
"dayChange": -3.600006,
170
"dayChangePercent": -0.8283493,
171
"fiftyTwoWeekLow": 275,
172
"fiftyTwoWeekHigh": 509,
173
"marketCap": 3155898400768
174
},
175
"15": {
176
"tickerSymbol": "TABAK.PR",
177
"open": 14680,
178
"low": 14640,
179
"high": 14940,
180
"ltp": 14940,
181
"volume": 1377,
182
"dayChange": 340,
183
"dayChangePercent": 2.328767,
184
"fiftyTwoWeekLow": 13000,
185
"fiftyTwoWeekHigh": 15780,
186
"marketCap": 41016127488
187
},
188
"16": {
189
"tickerSymbol": "PRIUA.PR",
190
"open": 350,
191
"low": 350,
192
"high": 350,
193
"ltp": 350,
194
"volume": 100,
195
"dayChange": -2,
196
"dayChangePercent": -0.5681818,
197
"fiftyTwoWeekLow": 240,
198
"fiftyTwoWeekHigh": 358,
199
"marketCap": 1520648448
200
},
201
"17": {
202
"tickerSymbol": "NOKIA.PR",
203
"open": 92,
204
"low": 92,
205
"high": 92,
206
"ltp": 92,
207
"volume": 100,
208
"dayChange": 0,
209
"dayChangePercent": 0,
210
"fiftyTwoWeekLow": 76.82,
211
"fiftyTwoWeekHigh": 126.88,
212
"marketCap": 511416041472
213
},
214
"18": {
215
"tickerSymbol": "TOMA.PR",
216
"open": 1290,
217
"low": 1290,
218
"high": 1290,
219
"ltp": 1290,
220
"volume": 650,
221
"dayChange": 0,
222
"dayChangePercent": 0,
223
"fiftyTwoWeekLow": 1200,
224
"fiftyTwoWeekHigh": 1380,
225
"marketCap": 1718628352
226
},
227
"19": {
228
"tickerSymbol": "CZG.PR",
229
"open": 374,
230
"low": 371,
231
"high": 374,
232
"ltp": 374,
233
"volume": 6540,
234
"dayChange": 1,
235
"dayChangePercent": 0.26809654,
236
"fiftyTwoWeekLow": 280,
237
"fiftyTwoWeekHigh": 410,
238
"marketCap": 11159411712
239
},
240
"20": {
241
"tickerSymbol": "SABFG.PR",
242
"open": 10600,
243
"low": 10600,
244
"high": 10600,
245
"ltp": 10600,
246
"volume": 650,
247
"dayChange": 0,
248
"dayChangePercent": 0,
249
"fiftyTwoWeekLow": 10500,
250
"fiftyTwoWeekHigh": 10600,
251
"marketCap": 2731959296
252
},
253
"21": {
254
"tickerSymbol": "PEN.PR",
255
"open": 80,
256
"low": 78,
257
"high": 80,
258
"ltp": 78,
259
"volume": 400,
260
"dayChange": -1,
261
"dayChangePercent": -1.2658228,
262
"fiftyTwoWeekLow": 30,
263
"fiftyTwoWeekHigh": 115,
264
"marketCap": 3931433984
265
},
266
"22": {
267
"tickerSymbol": "PRAB.PR",
268
"open": 392,
269
"low": 392,
270
"high": 392,
271
"ltp": 392,
272
"volume": 500,
273
"dayChange": 0,
274
"dayChangePercent": 0,
275
"fiftyTwoWeekLow": 354,
276
"fiftyTwoWeekHigh": 402,
277
"marketCap": 392000000
278
},
279
"24": {
280
"tickerSymbol": "MOL.PR",
281
"open": 156.2,
282
"low": 156.2,
283
"high": 156.2,
284
"ltp": 156.2,
285
"volume": 200,
286
"dayChange": 0,
287
"dayChangePercent": 0,
288
"fiftyTwoWeekLow": 115,
289
"fiftyTwoWeekHigh": 176,
290
"marketCap": 117469896704
291
},
292
"25": {
293
"tickerSymbol": "JUVE.PR",
294
"open": 20.92,
295
"low": 20.67,
296
"high": 20.92,
297
"ltp": 20.67,
298
"volume": 174,
299
"dayChange": 0,
300
"dayChangePercent": 0,
301
"fiftyTwoWeekLow": 19.82,
302
"fiftyTwoWeekHigh": 29,
303
"marketCap": 26427215872
304
},
305
"26": {
306
"tickerSymbol": "DBK.PR",
307
"open": 273.1,
308
"low": 273.1,
309
"high": 273.1,
310
"ltp": 273.1,
311
"volume": 5,
312
"dayChange": 0,
313
"dayChangePercent": 0,
314
"fiftyTwoWeekLow": 153.4,
315
"fiftyTwoWeekHigh": 293.6,
316
"marketCap": 552189100032
317
},
318
"27": {
319
"tickerSymbol": "VER.PR",
320
"open": 1600,
321
"low": 1600,
322
"high": 1600,
323
"ltp": 1600,
324
"volume": 15,
325
"dayChange": 0,
326
"dayChangePercent": 0,
327
"fiftyTwoWeekLow": 923,
328
"fiftyTwoWeekHigh": 1832.5,
329
"marketCap": 556734414848
330
},
331
"28": {
332
"tickerSymbol": "BVB.PR",
333
"open": 130,
334
"low": 130,
335
"high": 130,
336
"ltp": 130,
337
"volume": 61,
338
"dayChange": -5,
339
"dayChangePercent": -3.7037036,
340
"fiftyTwoWeekLow": 119.4,
341
"fiftyTwoWeekHigh": 172.9,
342
"marketCap": 12028860416
343
},
344
"30": {
345
"tickerSymbol": "FACC.PR",
346
"open": 247,
347
"low": 247,
348
"high": 247,
349
"ltp": 247,
350
"volume": 30,
351
"dayChange": 0,
352
"dayChangePercent": 0,
353
"fiftyTwoWeekLow": 126.1,
354
"fiftyTwoWeekHigh": 276.4,
355
"marketCap": 11015656448
356
},
357
"31": {
358
"tickerSymbol": "EOAN.PR",
359
"open": 257.15,
360
"low": 257.15,
361
"high": 257.15,
362
"ltp": 257.15,
363
"volume": 300,
364
"dayChange": 1.6499939,
365
"dayChangePercent": 0.64579016,
366
"fiftyTwoWeekLow": 220,
367
"fiftyTwoWeekHigh": 275.05,
368
"marketCap": 675494494208
369
},
370
"32": {
371
"tickerSymbol": "VOLVB.PR",
372
"open": 535,
373
"low": 535,
374
"high": 535,
375
"ltp": 535,
376
"volume": 50,
377
"dayChange": 0,
378
"dayChangePercent": 0,
379
"fiftyTwoWeekLow": 290,
380
"fiftyTwoWeekHigh": 608,
381
"marketCap": 1089062043648
382
},
383
"33": {
384
"tickerSymbol": "PKO.PR",
385
"open": 186.5,
386
"low": 186.5,
387
"high": 186.5,
388
"ltp": 186.5,
389
"volume": 1,
390
"dayChange": 0,
391
"dayChangePercent": 0,
392
"fiftyTwoWeekLow": 110,
393
"fiftyTwoWeekHigh": 186.5,
394
"marketCap": 226819424256
395
},
396
"34": {
397
"tickerSymbol": "RBI.PR",
398
"open": 474.4,
399
"low": 474.4,
400
"high": 474.4,
401
"ltp": 474.4,
402
"volume": 230,
403
"dayChange": 0,
404
"dayChangePercent": 0,
405
"fiftyTwoWeekLow": 332,
406
"fiftyTwoWeekHigh": 494.6,
407
"marketCap": 157005529088
408
},
409
"35": {
410
"tickerSymbol": "PKN.PR",
411
"open": 368,
412
"low": 368,
413
"high": 368,
414
"ltp": 368,
415
"volume": 10,
416
"dayChange": 0,
417
"dayChangePercent": 0,
418
"fiftyTwoWeekLow": 225.9,
419
"fiftyTwoWeekHigh": 434.6,
420
"marketCap": 155653701632
421
},
422
"36": {
423
"tickerSymbol": "EFORU.PR",
424
"open": 103,
425
"low": 103,
426
"high": 103,
427
"ltp": 103,
428
"volume": 10,
429
"dayChange": 0,
430
"dayChangePercent": 0,
431
"fiftyTwoWeekLow": 92,
432
"fiftyTwoWeekHigh": 103,
433
"marketCap": 246338912
434
},
435
"37": {
436
"tickerSymbol": "OTP.PR",
437
"open": 978,
438
"low": 978,
439
"high": 978,
440
"ltp": 978,
441
"volume": 1,
442
"dayChange": 0,
443
"dayChangePercent": 0,
444
"fiftyTwoWeekLow": 651,
445
"fiftyTwoWeekHigh": 1003,
446
"marketCap": 264351432704
447
}
448
}
449
}
Copied!
The API endpoint requires 3 parameters -> API key, country abbreviation and finally an offset. You can get the country abbreviation from the Step 2 (under Stock Market Data). For offset the default value that you should enter is 0. Since the data is picked up from our SQL database hence we require an offset param to determine which next set of data should we output. You can read about offset from here.
At a time, the API returns a maximum of 200 tickers (if tickers in a country are greater 200). If you still have questions about this then please contact us at [email protected]

Get OLHCV Data of Tickers via single API Call

1
curl https://server1.bytemine.workers.dev/tickerList/{api_key}/{list_of_tickers}
2
Copied!
1
$.ajax({
2
url: "https://server1.bytemine.workers.dev/tickerList/{api_key}/ULVR.L%2CGSK.L%2CRB.L%2CBATS.L%2CAZN.L",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"0": {
3
"exchangeName": "LSE",
4
"percentChange": "0.11%",
5
"low": 4101.5,
6
"open": 4124.5,
7
"high": 4140,
8
"ltp": 4135.5,
9
"volume": 1682548,
10
"name": "Unilever PLC",
11
"symbol": "ULVR.L",
12
"type": "EQUITY"
13
},
14
"1": {
15
"exchangeName": "LSE",
16
"percentChange": "-1.67%",
17
"low": 1292.4,
18
"open": 1315,
19
"high": 1316.2,
20
"ltp": 1297.6,
21
"volume": 7105777,
22
"name": "GlaxoSmithKline plc",
23
"symbol": "GSK.L",
24
"type": "EQUITY"
25
},
26
"2": {
27
"exchangeName": "LSE",
28
"percentChange": "0.09%",
29
"low": 6464.855,
30
"open": 6506,
31
"high": 6556,
32
"ltp": 6498,
33
"volume": 1091046,
34
"name": "Reckitt Benckiser Group plc",
35
"symbol": "RB.L",
36
"type": "EQUITY"
37
},
38
"3": {
39
"exchangeName": "LSE",
40
"percentChange": "0.09%",
41
"low": 2764,
42
"open": 2780,
43
"high": 2805.5,
44
"ltp": 2788.5,
45
"volume": 2911611,
46
"name": "British American Tobacco p.l.c.",
47
"symbol": "BATS.L",
48
"type": "EQUITY"
49
},
50
"4": {
51
"exchangeName": "LSE",
52
"percentChange": "-0.85%",
53
"low": 7194,
54
"open": 7260,
55
"high": 7320,
56
"ltp": 7225,
57
"volume": 1359034,
58
"name": "AstraZeneca PLC",
59
"symbol": "AZN.L",
60
"type": "EQUITY"
61
}
62
}
Copied!
The API endpoint requires 2 parameters -> API key, and list of ticker separated by a 'comma'. Since you'd be passing this list in a URL you'd have to convert this comma separated string into ascii codes. What this means is convert all commas into %2C. Please refer here for more details.
Please check out the example by switching over to the Javascript tab to know more about how to format this request. If you still have questions about this then please contact us at [email protected]

Company Details

1
curl https://valhalla.bytemine.workers.dev/companyDetails/{api_key}/ITC.NS
2
Copied!
1
$.ajax({
2
url: "https://valhalla.bytemine.workers.dev/companyDetails/{api_key}/ITC.NS",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"address": [
3
"Virginia House",
4
"37 Jawaharlal Nehru Road"
5
],
6
"businessSummary": "ITC Limited engages in the fast moving consumer goods, hotels, paperboards, paper and packaging, agri, and information technology (IT) businesses in India and internationally. The company primarily offers cigarettes and cigars; staples, spices, biscuits, confectionery and gums, snacks, noodles and pasta, beverages, dairy, ready to eat meals, chocolate, coffee, and frozen foods; personal care products; education and stationery products; safety matches; and incense sticks under various brands. It also retails formals and casual wear products, and other lifestyle products under the WLS brand. In addition, the company offers paper boards and specialty paper products; and packaging products, such as carton board, flexible, tobacco, and green packaging products, as well as operates approximately 100 hotels under the ITC Hotel, WelcomHotel, Fortune, and WelcomHeritage brands. Further, it exports feed ingredients, food grains, marine products, processed fruits, coffee products, leaf tobacco products, and spices; and offers IT services and solutions. Additionally, the company offers technology services and solutions for the banking, financial services, consumer packaged goods, manufacturing, travel, hospitality, and healthcare industries. The company also provides property infrastructure and real estate maintenance, business consulting, real estate development, and agro-forestry and other related services; manages and operates golf courses; fabricates and assembles machinery for tube filling, cartoning, wrapping, conveyor solutions, and engineering services; and produces and commercializes seed potato technology products. ITC Limited was incorporated in 1910 and is headquartered in Kolkata, India.",
7
"sector": "Consumer Defensive",
8
"website": "http://www.itcportal.com",
9
"phone": "91 33 2288 9371",
10
"country": "India",
11
"zip": "700071",
12
"city": "Kolkata",
13
"industry": "Tobacco",
14
"employeesCount": 28115,
15
"officers": [
16
{
17
"name": "Mr. Sanjiv Puri",
18
"age": 57,
19
"title": "Chairman & MD"
20
},
21
{
22
"name": "Mr. Rajendra Kumar Singhi",
23
"age": 55,
24
"title": "Exec. VP, Company Sec. & Compliance Officer"
25
},
26
{
27
"name": "Mr. Rajiv Tandon",
28
"age": 66,
29
"title": "Exec. Director"
30
},
31
{
32
"name": "Mr. Sumant Bhargavan",
33
"age": 56,
34
"title": "Exec. Director & Pres of FMCG Bus.es"
35
},
36
{
37
"name": "Mr. Nakul Anand",
38
"age": 64,
39
"title": "Exec. Director"
40
},
41
{
42
"name": "Mr. Supratim Dutta",
43
"age": 53,
44
"title": "CFO & Exec. VP of Corp. Fin."
45
},
46
{
47
"name": "Mr. Saradindu Dutta",
48
"age": 60,
49
"title": "Head of Corp. Accounts"
50
},
51
{
52
"name": "Mr. Samrat Banerjee",
53
"title": "VP & Divisional CIO"
54
},
55
{
56
"name": "Mr. Angamuthu Shanmuga Sundaram",
57
"age": 53,
58
"title": "Gen. Counsel"
59
},
60
{
61
"name": "Mr. Arif Nazeeb",
62
"age": 58,
63
"title": "Head of Corp. Communications & Exec. VP"
64
}
65
]
66
}
Copied!
You can get company details of any stock from our API endpoints. This can be achieved using Long Polling. However, make sure to not call our Endpoints without adding atleast a 1 Min Delay.

HTTP Request

GET https://valhalla.bytemine.workers.dev/companyDetails/{api_key}/{ticker}

Query Parameters

Parameter
Default
Description
api_key
true
API Key is required for authentication.
ticker
true
A ticker/symbol is needed for the appropriate candlestick pattern to be returned.

Example HTTP Request

GET https://valhalla.bytemine.workers.dev/companyDetails/afdhesdf/TSLA

Open High Low Close Volume

1
curl https://valhalla.bytemine.workers.dev/olhc/{api_key}/GOOG/15m/1d
2
Copied!
1
$.ajax({
2
url: "https://valhalla.bytemine.workers.dev/olhc/{api_key}/GOOG/15m/1d",
3
type: 'GET',
4
success: function(data) {
5
console.log(data);
6
}
7
});
Copied!
The above command returns JSON structured like this:
1
{
2
"currency": "USD",
3
"exchangeTimeZone": "America/New_York",
4
"regularMarketPrice": 2285.88,
5
"timezone": "EDT",
6
"symbol": "GOOG",
7
"olhc": {
8
"timestamp": [
9
1617975000,
10
1617975900,
11
1617976800,
12
1617977700,
13
1617978600,
14
1617979500,
15
1617980400,
16
1617981300,
17
1617982200,
18
1617983100,
19
1617984000,
20
1617984900,
21
1617985800,
22
1617986700,
23
1617987600,
24
1617988500,
25
1617989400,
26
1617990300,
27
1617991200,
28
1617992100,
29
1617993000,
30
1617993900,
31
1617994800,
32
1617995700,
33
1617996600,
34
1617997500
35
],
36
"open": [
37
2256.699951171875,
38
2262.77001953125,
39
2266.89990234375,
40
2269.590087890625,
41
2261.139892578125,
42
2261,
43
2262.050048828125,
44
2266,
45
2265.60009765625,
46
2268.929931640625,
47
2271.199951171875,
48
2271.60009765625,
49
2271.405029296875,
50
2272.699951171875,
51
2276.449951171875,
52
2274.510009765625,
53
2276.5205078125,
54
2279,
55
2274.429931640625,
56
2277.429931640625,
57
2275.22998046875,
58
2275,
59
2273.409912109375,
60
2271.93994140625,
61
2277.830078125,
62
2279.3798828125
63
],
64
"high": [
65
2263.06005859375,
66
2269.949951171875,
67
2272.929931640625,
68
2270.8701171875,
69
2266.139892578125,
70
2264.340087890625,
71
2266,
72
2267.080078125,
73
2270.090087890625,
74
2271.72998046875,
75
2275.550048828125,
76
2273.06005859375,
77
2272.8701171875,
78
2276.56005859375,
79
2276.639892578125,
80
2275.22998046875,
81
2280,
82
2279,
83
2277.169921875,
84
2279.349853515625,
85
2277,
86
2275.669921875,
87
2274.43994140625,
88
2277.8349609375,
89
2283.455078125,
90
2289.0400390625
91
],
92
"low": [
93
2253.7138671875,
94
2258.5400390625,
95
2266.659912109375,
96
2260.27001953125,
97
2259.2099609375,
98
2260.985107421875,
99
2261.570068359375,
100
2263.080078125,
101
2264.89501953125,
102
2268.85009765625,
103
2270.5400390625,
104
2269.837890625,
105
2270.385009765625,
106
2272.195068359375,
107
2273.965087890625,
108
2272.830078125,
109
2276.280029296875,
110
2273.135009765625,
111
2274.22509765625,
112
2276.22998046875,
113
2275.22998046875,
114
2272,
115
2271.280029296875,
116
2271.6953125,
117
2277.780029296875,
118
2279.3798828125
119
],
120
"close": [
121
2260.71875,
122
2266.150146484375,
123
2269.639892578125,
124
2262.3798828125,
125
2261.969970703125,
126
2262.580078125,
127
2266,
128
2266.155029296875,
129
2270.070068359375,
130
2270.8798828125,
131
2270.5400390625,
132
2270.81494140625,
133
2272.699951171875,
134
2276.56005859375,
135
2274.397705078125,
136
2275.219970703125,
137
2279,
138
2274.409912109375,
139
2276.010009765625,
140
2277.47998046875,
141
2275.85009765625,
142
2272.8701171875,
143
2271.844970703125,
144
2277.8349609375,
145
2279.554931640625,
146
2284.610107421875
147
],
148
"volume": [
149
102072,
150
57972,
151
38485,
152
34142,
153
30494,
154
27754,
155
22196,
156
32638,
157
16987,
158
22611,
159
25798,
160
19028,