blinktrade / BlinkTradeJS

BlinkTrade JavaScript SDK and CLI
GNU General Public License v3.0
122 stars 46 forks source link

Make REST API Stable #4

Open amingilani opened 7 years ago

amingilani commented 7 years ago

I totally understand this isn't a priority for you guys so I'm only creating this to be notified when the API becomes stable.

Since there's only a stable nodejs client for the websockets API, I'm using it to create an HTTP API service for my internal use and would love to know when the stable API is out so that I can switch to it.

Please close this issue whenever the REST endpoints become stable 👍

cesardeazevedo commented 7 years ago

Which endpoint you refer?

We have actually two rest endpoints, the public endpoint and the trade endpoint.

The Public endpoint is the most basic for those who just need last prices and volumes, a lot people use it, but you can get just the ticker, trades and the orderbook.

The Trade endpoint is actually a bridge to our WebSocket API, so the trade endpoint is both available on rest and websocket, and switch between them through this client is easy, you just need to instantiate the right transport, e.g.: require('blinktrade').BlinkTradeWS and require('blinktrade').BlinkTradeRest and the client API is the same, because all trade functions are shared, you just need to authenticate on rest with the APIKey and the APISecret on the BlinkTradeRest constructor.

Does the instability is related to the this client? and which kind of instability have you experienced?

amingilani commented 7 years ago

The trade endpoint, this warning put me off from it:

screen shot 2016-11-18 at 11 13 19 pm

I've actually created something similar to your implementation tied to my account. It parses HTTP requests and then broadcasts them using require('blinktrade').BlinkTradeWS, so I'm good for now.

The primary reason I did this though was because my app is written in Ruby, and the SDK is in javascript, but it took me a while to get the heartbeat done right and I'll switch over to HTTP when you've decided on the final REST endpoints.