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 hello@bytemine.io. 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.
# With shell, you can just pass the correct API key with each request
curl https://app.bytemine.io/api/checkForCandlestick/{api_key}/...
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
Example HTTP Request
GET https://app.bytemine.io/api/checkForCandlestick/5fe69c95ed70a9869d9f9af7d8400a6673bb9ces/AAPL/5m
The above command returns JSON structured like this:
{
"success": true,
"trend": "Bearish"
}
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
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.
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 contact@bytemine.io.
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 contact@bytemine.io.
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 contact@bytemine.io.
The above command returns JSON structured like this:
{
"address": [
"Virginia House",
"37 Jawaharlal Nehru Road"
],
"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.",
"sector": "Consumer Defensive",
"website": "http://www.itcportal.com",
"phone": "91 33 2288 9371",
"country": "India",
"zip": "700071",
"city": "Kolkata",
"industry": "Tobacco",
"employeesCount": 28115,
"officers": [
{
"name": "Mr. Sanjiv Puri",
"age": 57,
"title": "Chairman & MD"
},
{
"name": "Mr. Rajendra Kumar Singhi",
"age": 55,
"title": "Exec. VP, Company Sec. & Compliance Officer"
},
{
"name": "Mr. Rajiv Tandon",
"age": 66,
"title": "Exec. Director"
},
{
"name": "Mr. Sumant Bhargavan",
"age": 56,
"title": "Exec. Director & Pres of FMCG Bus.es"
},
{
"name": "Mr. Nakul Anand",
"age": 64,
"title": "Exec. Director"
},
{
"name": "Mr. Supratim Dutta",
"age": 53,
"title": "CFO & Exec. VP of Corp. Fin."
},
{
"name": "Mr. Saradindu Dutta",
"age": 60,
"title": "Head of Corp. Accounts"
},
{
"name": "Mr. Samrat Banerjee",
"title": "VP & Divisional CIO"
},
{
"name": "Mr. Angamuthu Shanmuga Sundaram",
"age": 53,
"title": "Gen. Counsel"
},
{
"name": "Mr. Arif Nazeeb",
"age": 58,
"title": "Head of Corp. Communications & Exec. VP"
}
]
}
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
Example HTTP Request
GET https://valhalla.bytemine.workers.dev/companyDetails/afdhesdf/TSLA
You can get OLHC data 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/olhc/{api_key}/{ticker}/{timeframe}/{range}
Query Parameters
Example HTTP Request
GET https://valhalla.bytemine.workers.dev/olhc/afdhesdf/TSLA/5m/5d
You can get similar stocks 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/similar/{api_key}/{ticker}
Query Parameters
Example HTTP Request
GET https://valhalla.bytemine.workers.dev/similar/afdhesdf/TSLA
You can get company summary 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/summary/{api_key}/{ticker}
Query Parameters
Example HTTP Request
GET https://valhalla.bytemine.workers.dev/summary/afdhesdf/LSE.L
