binance-api-node icon indicating copy to clipboard operation
binance-api-node copied to clipboard

Docs are not updated/aligned with actual API

Open caiusCitiriga opened this issue 3 years ago • 2 comments

Hi!

It's been several times now, that I had to struggle with the fact that what I read on the Readme documentation of the library does not always reflect as true on the actual library.

For example, the docs states that accountCoins() is a valid method. Which indeed it is, if you don't use typescript. I've discovered that out of curiosity by doing await client['accountCoins'](). Which worked, and gave me a result.

Unfortunately though, this result seemed to be kinda wrong, but I guess that's another story: PR

Is there a documentation update scheduled in the near future maybe? 😊

caiusCitiriga avatar Mar 21 '22 13:03 caiusCitiriga

Hi @caiusCitiriga , I think that accountCoins is same endpoint that capitalConfigs, so you could use client.capitalConfigs.

But if you want, you could update index.d.ts file, because accountCoins exists, but just on http-client.js

JonathanLoscalzo avatar Apr 11 '22 17:04 JonathanLoscalzo

Property 'accountCoins' does not exist on type 'Binance'.

suenot avatar Sep 08 '22 20:09 suenot