Actual API doc availability

Custom indicators, trading strategies, data export and recording and more...
alchemy
Posts: 7
Joined: Mon Jul 13, 2020 6:25 pm

Actual API doc availability

Post by alchemy » Mon Jul 13, 2020 6:45 pm

Would it be possible to post the API document or related file that shows the actual interface and data available.  I.e. each method, property, all of their parameters, etc.  This would be very helpful in giving us an idea of the capabilities.

Svyatoslav
Site Admin
Posts: 104
Joined: Mon Jun 11, 2018 11:44 am
Has thanked: 2 times
Been thanked: 9 times

Re: Actual API doc availability

Post by Svyatoslav » Tue Jul 14, 2020 8:39 am

Hi. We have repositories under https://github.com/BookmapAPI/ with examples, plus we have Javadoc that's available with the maven artifacts for the api (and also located in "C:\Program Files\Bookmap\lib\bm-l1api-javadoc.jar" after bookmap is installed).

Could you please clarify what else you are missing? (I mean, I get that javadoc could look nicer and be more detailed than what we currently have, but not sure if that's what you are trying to say)

alchemy
Posts: 7
Joined: Mon Jul 13, 2020 6:25 pm

Re: Actual API doc availability

Post by alchemy » Wed Jul 15, 2020 5:26 am

Every API I've ever worked with comes with an API document, which clearly shows each interface exposed by the API, and perhaps a few words as to what each one does.  Typically these documents are in a standard and easily acessible file format such as pdf, word doc, or a web page.  I would really appreciate your help in finding this document.  

Svyatoslav
Site Admin
Posts: 104
Joined: Mon Jun 11, 2018 11:44 am
Has thanked: 2 times
Been thanked: 9 times

Re: Actual API doc availability

Post by Svyatoslav » Wed Jul 15, 2020 7:35 am

https://github.com/BookmapAPI/Layer0ApiDemo - Follow the readme to start with connecting your datasource. This one, in my opinion, is relatively straightforward.
https://github.com/BookmapAPI/DemoStrategies - Follow the readme to start writing your indicators. This one is somewhat confusing and we'll be adding more documentation at some point.

On top of that you might want to read https://www.bookmap.com/knowledgebase/docs/API - that's where we'll (hopefully) eventually provide more details.

About a document with every method - javadoc is such format. Wouldn't say our level of documentation is good (there is a lot to improve), but javadoc is there and even explains things a bit. The catch is that yeah, we never published it on web like many companies do (we will at some point, but no promises on when). You can still unzip the file I specified in my previous post and it will contain HTML pages that you can browse.

Unfortunately there is no nice full walkthrough at this point.

alchemy
Posts: 7
Joined: Mon Jul 13, 2020 6:25 pm

Re: Actual API doc availability

Post by alchemy » Wed Jul 15, 2020 3:43 pm

Thanks, what would be the simplest way to read the Javadoc file?

Svyatoslav
Site Admin
Posts: 104
Joined: Mon Jun 11, 2018 11:44 am
Has thanked: 2 times
Been thanked: 9 times

Re: Actual API doc availability

Post by Svyatoslav » Wed Jul 15, 2020 6:27 pm

Just unzip C:\Program Files\Bookmap\lib\bm-l1api-javadoc.jar with anything that supports zip (you might have to rename it to zip, if your archive program does not recognize it). Then open index.html in your browser and you'll see the list of classes/packages with descriptions (wherever those are present)

Post Reply