User:Glorat/BoglebotTableGuide

From Bogleheads
< User:Glorat
Revision as of 02:43, 13 January 2021 by Glorat (talk | contribs) (Update docs)

Usage instructions (DRAFT PROPOSAL)

To embed Boglebot search results into the wiki as a table, follow these steps

  1. Visit https://www.boglebot.com/assetdb, enter search criteria and columns to display and press the Search button to see results and generate a URL
  2. Copy the URL from the resulting search page E.g.
    https://www.boglebot.com/assetdb?args=%7B%22query%22%3A%5B%7B%22where%22%3A%5B%22asset.type%22,%22%3D%3D%22,%22ETF%22%5D%7D,%7B%22where%22%3A%5B%22asset.domicile%22,%22%3D%3D%22,%22Ireland%22%5D%7D,%7B%22where%22%3A%5B%22asset.geography%22,%22%3D%3D%22,%22Global%22%5D%7D,%7B%22where%22%3A%5B%22asset.assetClass%22,%22%3D%3D%22,%22Equity%22%5D%7D%5D,%22fields%22%3A%5B%22ticker%22,%22name%22,%22ccy%22,%22asset.incomeTreatment%22,%22asset.ter%22%5D%7D]
  3. Paste the link into the Bogleheads wiki, giving a friendly display label E.g.
    [https://www.boglebot.com/assetdb?args=%7B%22query%22%3A%5B%7B%22where%22%3A%5B%22asset.type%22,%22%3D%3D%22,%22ETF%22%5D%7D,%7B%22where%22%3A%5B%22asset.domicile%22,%22%3D%3D%22,%22Ireland%22%5D%7D,%7B%22where%22%3A%5B%22asset.geography%22,%22%3D%3D%22,%22Global%22%5D%7D,%7B%22where%22%3A%5B%22asset.assetClass%22,%22%3D%3D%22,%22Equity%22%5D%7D%5D,%22fields%22%3A%5B%22ticker%22,%22name%22,%22ccy%22,%22asset.incomeTreatment%22,%22asset.ter%22%5D%7D Global Equity ETFs for non-US]
  4. Add the following snippet somewhere in your wiki page to enable the magic
    {{ User:Glorat/BoglebotTable }}

When you page loads, the link will magically have a results table rendered with it

FAQS

How is the Boglebot database populated?

It is manually populated by volunteer contributions

What happens on browsers (like IE11) that don't support this feature?

No table will be displayed but the original web link to the boglebot search page will still be available

Are there any copyright concerns with any webscraping?

The boglebot database is populated by manually reviewed contributions, not web scraping. As for scraping the boglebot database, open APIs are in the pipeline

Oustanding Items Before Real Use

  • Lock down ability to edit this page to admins and Glorat (since it uses the html tag) - DONE
  • Migrate page from User:Glorat/BoglebotTable to just BoglebotTable

and most importantly of all - get blessing from the wiki admin owners to use this! See https://www.bogleheads.org/forum/viewtopic.php?f=5&t=334061&p=5727991#p5727991