blinktrade / bitex

BlinkTrade - Open Source Bitcoin Exchange
GNU General Public License v3.0
428 stars 233 forks source link

Need API documentation #7

Closed amingilani closed 8 years ago

amingilani commented 10 years ago

Need an API for automated exchange bots. This increases trading and helps make the market more efficient.

pinhopro commented 10 years ago

Our API is 100% based on Websockets. It is jut not documented, but you can take a look at this file https://github.com/blinktrade/bitex/blob/master/jsdev/bitex/api/bitex.js

It is our JavaScript API.

We will be working on the documentation very soon

Thanks, Rodrigo

amingilani commented 10 years ago

Ohhh, thanks! In that case, i'll change the title to reflect the status quo.

amingilani commented 9 years ago

@pinhopro it's been near a year that you said you'd be working on your documentation "very soon". I've emailed, lobbied, and asked multiple times.

I've read the obscure Gist detailing the Restful API, i even know know where the typos are. No, i don't want to read your client and try to understand how the websockets function, I need documentation.

Are you going to publish the documentation anytime soon, or will this issue be ignored for another year or two?

pinhopro commented 9 years ago

@amingilani Our resources are very limited to put focus on writing documentation to developers that don't want to read our client implementation.

If you are interested in contributing with the project, please add me on skype, so I can give you a overview.

Thanks, Rodrigo

amingilani commented 9 years ago

@pinhopro, oh i've read the code implementation, multiple times. I've had other devs take a look too, but my forte is documented code.

I've emailed you, already messaged you on Skype, and even had bitex-powered exchange try to reach you. It's beyond me how you still don't remember me reaching out through all these channels and would like me to repeat my actions.

I've managed projects myself. Priority issues open for a year are not because you're unable, but because you're incompetent. Please, either write a documentation and publish it on the website (not a far away obscure Gist that details half the api, and is full of typos and errors in the sample implementation)

or man up and tell your community that you don't care about them

amingilani commented 9 years ago

If you choose the latter course of action, feel free to close this issue and just refer it to other people that ask for documentation.

pinhopro commented 9 years ago

Yes, I am incompetent in documenting code.

Any help with documentation is well appreciated.

Thanks, Rodrigo

pinhopro commented 9 years ago

The "obscure gist" ( https://gist.github.com/pinhopro/60b1fd213b36d576505e ) is not on our website because it is still not a final documentation. But the final documentation will be very similar to it.

I really don't have too much time to invest in documentation.

bilthon commented 9 years ago

Hey @amingilani who do you think you are by coming here and DEMAND work to be done for you? this is an open source project where people were kind enough to make code available to you (and everybody) in the first place. Now that doesn't give you the right to demand stuff that is not present or call people names because they don't comply. If your "forte is documented code" then the incompetent must be you.

amingilani commented 9 years ago

@bilthon, I would read the thread out for you, but I simply don't have the time to spell it out for you.

To anyone reading this in the future, @pinhopro's explained the API to me, i'll write the docs myself in the future.

amingilani commented 8 years ago

Docs now available at: https://blinktrade.com/docs/

Thanks @pinhopro!