From 23cfdef5d8f4995c7ded629af1aaa82b4ff3c6cd Mon Sep 17 00:00:00 2001 From: Luis Fernando Molina Date: Fri, 5 Apr 2019 00:58:13 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 48 ++++++++++-------------------------------------- 1 file changed, 10 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index a555d9b61..a047f83e3 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,22 @@ -# I'm Charly, an e-bot! -AKA an extractor algobot running on the AAPlatform by Advanced Algos Ltd. +# Charly -### My Specialty -I get trades data for all markets --both historic and live-- assuring consistency using recursive processes, and store it in a highly fragmented and usable dataset. +Charly is a Sensor bot that is capable of extracting trades from exchanges. It has 3 main processes which together creates an ongoing dataset of trades guaranteed to be reliable. -### Ideal for -My dataset is fundamental for building candles and calculating volumes, along with many other indicators based on actual trade information. +## Live Trades -### Details +This process extracts the latest 2 minutes of trade records and save 2 files of 1 minute each. The process need to run every 1 minute in noTime mode. The last file written is overwritten at the next run, allowing the process to complete with the trades that happened after the previous execution retrieval of data. -| **Name** | **Type** | **Version** | **Release Date** | **Current dataSet** | -|----------|----------|----------|----------|----------| -| Charly |Extraction | 1.0 | Jan 2018 | dataSet.V1 | +## Hole Fixing -# My Product +When the Live Trades process goes down, the exchange goes down or anything in the middle goes down, data from the exchange can not be retrieved. Once Live Trades is running normally again a whole on the dataset appears between the last files saved and the new files after the restart. -### Current Dataset Scope -* **Exchanges**: Poloniex -* **Markets**: USDT-BTC (only this market available at this point in time; the rest will follow soon) -* **Range**: Market Start Date – Current Time (-0 to 59 secs) +The Hole Fixing process is there to detect those holes and retrieve the missing information, allowing the dataset to be 100% reliable. This process runs every 1 minute under allMonths start mode, where a yearly range must be specified (initial processing year and final processing year) -### Current Dataset -* **Version:** dataSet.V1 -* **Update Frequency**: 1 minute -* **Cloud Output Location:** Charly > dataSet.V1 -* **Folder Structure Tree**: Output > Trades > ExchangeName > Year > Month > Day > Hour > Minute -* **Files Structure**: One .json file per pair (e.g.: BTC_BCH.json, BTC_BCN.json, ... , ETH_BCH, ETH_BCN, etc.) stored at the Minute level of the Folder Tree Structure -* **In-File Record Structure**: - * Trade ID at Exchange, numeric; - * Trade Type, “sell” or “buy”; - * Trade Rate, decimal; - * Trade Amount A, decimal; - * Trade Amount B, decimal; - * Trade Seconds, numeric, 0 to 59 -* **In-File Record Example**: - * [[19057863,"buy",7350.00000000,15.09998700,0.00205442,0],[19057864,"sell",7349.27989360,1.49682783,0.00020367,2], ... ,[19057865,"sell",7346.00000000,146.92000000,0.02000000,2],[19057869,"buy",7342.00000000,73.42000000,0.01000000,4]] +## Historic Trades +This process is designed to grabb historical trades information from an exchange, starting from the latest trades, and going all the way back to the begining of the market, respecting the exchange limits on trades per batch extracted. -### Compatible Plotters -Not applicable. - -### Dependencies -None. - -### Data as a Service (DaaS) Fees -No fees. +This process is currently not being mantained, meaning that there is no guarantee that it can still run. # Disclaimer From 5df368fc72d5f8c0ba476bad8d48dd424456392f Mon Sep 17 00:00:00 2001 From: Luis Fernando Molina Date: Fri, 5 Apr 2019 01:03:26 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a047f83e3..f41011d98 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,15 @@ Charly is a Sensor bot that is capable of extracting trades from exchanges. It h ## Live Trades -This process extracts the latest 2 minutes of trade records and save 2 files of 1 minute each. The process need to run every 1 minute in noTime mode. The last file written is overwritten at the next run, allowing the process to complete with the trades that happened after the previous execution retrieval of data. +This process extracts the latest 2 minutes of trade records and save 2 files of 1 minute each. The last file written is overwritten at the next run, allowing the process to complete with the trades that happened after the previous execution retrieval of data. + +### Start Mode + +The process need to run every 1 minute in noTime mode. + +``` +startMode = noTime +``` ## Hole Fixing From c40b419556ee8ec1f69fec7e9a91b1d91601dceb Mon Sep 17 00:00:00 2001 From: Luis Fernando Molina Date: Fri, 5 Apr 2019 01:05:15 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f41011d98..b2479aeaf 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,32 @@ This process extracts the latest 2 minutes of trade records and save 2 files of The process need to run every 1 minute in noTime mode. ``` -startMode = noTime +"startMode": { + "noTime": { + "run": "false" + } + } ``` ## Hole Fixing When the Live Trades process goes down, the exchange goes down or anything in the middle goes down, data from the exchange can not be retrieved. Once Live Trades is running normally again a whole on the dataset appears between the last files saved and the new files after the restart. -The Hole Fixing process is there to detect those holes and retrieve the missing information, allowing the dataset to be 100% reliable. This process runs every 1 minute under allMonths start mode, where a yearly range must be specified (initial processing year and final processing year) +The Hole Fixing process is there to detect those holes and retrieve the missing information, allowing the dataset to be 100% reliable. + +### Start Mode + +This process runs every 1 minute under allMonths start mode, where a yearly range must be specified (initial processing year and final processing year) + +``` +"startMode": { + "allMonths": { + "run": "true", + "minYear": "2019", + "maxYear": "2021" + } + } +``` ## Historic Trades