{"info":{"title":"Technical analysis API","version":"0.0.6","description":"# Introduction\nThis is a RESTful Technical analysis API to fetch cryptocurrency data from various exchanges and use\nthe data to create recommendations using different technical analysis techniques.\nThe results are fetched from various exchanges and there is also sentiment analysis which checks\n[Reddit](http://reddit.com/) and [Twitter](http://twitter.com/) for activity. This API is build by\n[Tim van de Vathorst](http://timvandevathorst.nl). If you have any questions or thought of some awesome improvements.\nFeel free to send me a message.\n\n# Disclaimer\nUse the results form the API at your own responsibility. Technical Analysis is always more of a\nguess to the results can be different than expected. All results from this API are NOT trading advice.\n\n# API Key\nYou can provide the API key (which you can find after logging in) at the end of each query like this '?apiKey=xxx' to authenticate your request. The full URL would look something like this.\n[https://technical-analysis-api.com/api/v1/analysis/BTC?apiKey=xxx](https://technical-analysis-api.com/api/v1/analysis/BTC?apiKey=xxx)\n"},"host":"https://technical-analysis-api.com","basePath":"/","schemes":["https"],"contact":{"email":"info@timvandevathorst.nl","url":"https://technical-analysis-api.com"},"swagger":"2.0","paths":{"/api/v1/analysis/:coin_symbol":{"get":{"tags":["Recommendations"],"summary":"All of the data combined","description":"This is the most interesting endpoint of the API. It combines all of the other endpoints to analyse a specific coin. What eventually results a summary wether the prediction looks good or bad.\n","parameters":[{"name":"apiKey","description":"User's API key","required":true}],"produces":["application/json"],"responses":{"200":{"description":"Returns the sentiment for the coin based on the latest messages from Reddit and Twitter","schema":{"$ref":"#/definitions/recommendation"}}}}},"/api/v1/strategy/:strategy/:coin_symbol":{"get":{"tags":["Strategy"],"summary":"Detailed information about the strategy.","description":"This response contains detailed information about the strategy you selected","produces":["application/json"],"parameters":[{"name":"apiKey","description":"User's API key","required":true}],"responses":{"200":{"description":"The strategy result. Which includes an array with all the details","schema":{"$ref":"#/definitions/strategy"}}}}},"/api/v1/sentiment/:coin_symbol":{"get":{"tags":["Sentiment"],"summary":"Sentiment analysis","description":"Returns the sentiment for a coin. You can see this value as a percentage which means that if the score is 100 everyone is positive and at 0 people are negative","parameters":[{"name":"apiKey","description":"User's API key","required":true}],"produces":["application/json"],"responses":{"200":{"description":"An average sentiment for this coin and an array with the sentiment per article","schema":{"$ref":"#/definitions/sentiment"}}}}},"/api/v1/detail/overview":{"get":{"tags":["overview","coin information"],"title":"Returns a list of coins","description":"Returns a list of coins with information about the Reddit topic and Twitter hashtag. This are also all supported coins in the system. If you have any suggestion to add more coins please send me a email.","produces":["application/json"],"responses":{"200":{"description":"A list of all available coins","schema":{"$ref":"#/definitions/coins"}}}}},"/api/v1/detail/:coin_symbol":{"get":{"tags":["overview","coin information"],"description":"Returns the information for a specific coin","produces":["application/json"],"responses":{"200":{"description":"Returns the information for a specific coin","schema":{"$ref":"#/definitions/coins"}}}}}},"definitions":{"recommendation":{"properties":{"success":{"type":"boolean"},"symbol":{"type":"string"},"exchange":{"type":"string"},"name":{"type":"string"},"date":{"type":"date"},"price_btc":{"type":"number"},"recommendation":{"type":"string"},"description":{"type":"string"},"confidence":{"type":"number"},"sentiment":{"type":"number"},"strategies":{"type":"object","properties":{"sma":{"type":"object"},"rsa":{"type":"object"},"vwap":{"type":"object"}}},"patterns":{"type":"object","properties":{"indicators":{"type":"object","properties":{"bullish":{"type":"array"},"bearish":{"type":"array"}}}}}}},"strategy":{"properties":{"strategy":{"type":"string"},"result":{"type":"string"},"details":{"type":"array"}}},"sentiment":{"properties":{"sentiment":{"type":"number"},"articles":{"type":"array"}}},"patternDescription":{"properties":{"name":{"type":"string"},"description":{"type":"string"}}},"coins":{"properties":{"symbol":{"type":"string"},"name":{"type":"string"},"reddit_topic":{"type":"string"},"google_trends":{"type":"string"}}}},"responses":{},"parameters":{},"securityDefinitions":{},"tags":[]}