Home Forums The XBRL API Getting started with the XBRL Filed Data Add-in for Excel

Viewing 6 reply threads
  • Author
    Posts
    • #189109
      David Tauriello
      Keymaster

      Installation:

      Install the XBRL Filed Data Add-on for Excel || Get these instructions in PDF

        Watch a quick setup demo outlining how to install and get started with the XBRL Filed Add-in for Excel.
      1. Open an Excel file from M365 or Office365, choose the Insert menu, click the Get Add-ins button, search for ‘XBRL’ and install XBRL Filed Data.
         
      2. Click the XBRL Filed Data menu option, then Get a Free Account and follow the instructions on that page. Everyone, regardless of XBRL US Membership status, is welcome to request provisioning to use the XBRL API.

        All XBRL US Member accounts should be able to login and generate client ID and secret pairs. If you’re not able to do this, follow the prompt and request provisioning for this in email.

      3. After the Add-in installs, click the XBRL Filed Data menu option to show the ribbon.
         
      4. Click the login link in the ribbon to show the Query Wizard task pane.

        If you don’t have an XBRL US Web account provisioned to generate client ID and secret pairs, click the Get Account and Credentials button in the ribbon and follow the instructions on the web page.

      5. Click the login button on the task pane and enter your XBRL US Web account email, password, client ID and secret, then click the login button at the bottom of the popup window. NOTE: If you use our ‘Sign in with Google’ option, you cannot use your Google account (gmail and password) to authenticate. You must use your Gmail email and XBRL US password.
         
      6. Choose one of the functions in the task pane from the dropdown, at least one filter criteria, and the fields that should populate from the ‘Data to Return’ section of the Query Wizard task pane, then click the Search button.

      Troubleshooting:

      If you’re having trouble getting data to appear, try the following in the listed order, and stop when your issue is resolved:

      1. If your account has recently been provisioned and you’re unable to generate client ID and secret pair to use in the Add-in, try using a private/incognito browser window or a different browser to login to the XBRL US web site where these pairs are created (or clear your browser’s cache)
         
      2. If you’re using the ‘Sign on with Google’ option to login on the XBRL US Web site, make sure you have created an XBRL US Web account with a password (you can use the same email as your ‘Sign on with Google’ email, but it is recommended that you not re-use your Google account password as your XBRL US Account password) and use the XBRL US Web account email and password as the login for the Add-in.
         
      3. If you login on the Add-in and the Query Wizard doesn’t show ‘Data to Return’ options, right-click the task pane and choose reload, then click the logout button. After this, click the login button. Still not working? Uninstall the Add-in, close, re-open and re-install the Add-in.
         
      4. If you return to Excel and the Add-in task panel shows ‘Unable to open’ the Add-in, click close on the panel, then choose ‘Login / Query Wizard’ to re-initialize the Add-in.
         
      5. Clear the cache in your browser (DESKTOP Users – clear the Microsoft Edge browser cache), then close and re-open Excel and the Add-in.

      Tried everything and it still won’t work? Post a reply here.

    • #189457
      Laura Rusu
      Participant

      Hi David,
      This is really great!
      How many data points can non-members request (as opposed to members)? are there any other restrictions for non-members?
      Thank you,
      Laura

      • #197954
        Samuel Pun
        Participant

        Hi David,
        I’m using Excel XBRL add-in. I can log in and I can grab data by using the panel and creating the query using the panel. However, when using the actual API query in Excel, it doesn’t seem to work. It doesn’t even recognise the formula since it shows #NAME?. Any ideas?
        Thanks,
        Sam

      • #197964
        David Tauriello
        Keymaster

        Hi Sam – a couple of things to check:

        1. If you’re re-using queries from Google Sheets, the function is slightly different in Excel (=showData vs. =XBRL.showData)
        2. Excel limits the length of formulas to 255 characters. Our query generator breaks these up, but you may be using one that goes beyond this limit. To get around this, drop your formula in a cell (A1) and use =XBRL.showData(A1, “”, “”, “1”) to return the data. NOTE: the subsequent parameters are required in Excel, even if they’re empty.

        If neither of these helps, post the forumula you’re using in a reply here.

      • #197990
        Samuel Pun
        Participant

        Hi David,
        I’m using Excel. The auto generated formula is, for example, =XBRL.ShowData(“https://api.xbrl.us/api/v1/entity/search?entity.cik=0001799332&fields=entity.name,entity.limit(),entity.offset()&”,””, “”, “1”)

        no issue with number of characters as it’s <255.

        i think Excel is not recognising =XBRL.ShowData or any add-in functions.

        Werid thing is that I can request data but just not using the functions.

        Not sure if it’s because I’m using Excel 2019?

        Regards,
        Sam

      • #198032
        David Tauriello
        Keymaster

        Hi Sam – thanks for the additional detail and yes, your version of Excel is not compatible with the add-in – I’ve written to Microsoft to see why the add-in is available to users who cannot use it.

        The query you posted will work in Excel for Office 365. If you create a free account with Microsoft – https://www.office.com/launch/excel – you can install the add-in and use it with the web version of Excel.

    • #189509
      David Tauriello
      Keymaster

      Hi Laura – thanks for writing and I’m glad you’re interested in the XBRL Data Filed add-in for Excel.

      This is from the Terms of Use Agreement that governs access and us of our Public Filings Database:

      XBRL US Membership improves data access (see below). Sole Practitioners and Organizational Members also enjoy publishing rights and commercial use of data returned from our Database of Public Filings.

      Membership Type Records per query Record offset limit
      non-Member * 100 1,000
      Basic Individual * 500 2,000
      All Other Members 2,000 unlimited

      * Account limit: 100,000 queries

      In addition, the /document endpoint is not accessible to non-Members. Check out the documentation for full details on the XBRL API specification – https://xbrlus.github.io/xbrl-api

    • #189582
      Laura Rusu
      Participant

      Thank you very much, David!

      Kind regards,
      Laura

    • #193858
      Farrukh Javaid
      Participant

      Hello David,
      I cannot login on the XBRL API in the excel sheet despite using the current account credentials / ClientID / Client Secret etc. Every time I try to login it says login failed.
      Can you please help as how to further proceed with the login and use data?
      Thank you.

      Best Regards
      Farrukh Javaid

      • #193879
        David Tauriello
        Keymaster

        Hi Farrukh – please try the troubleshooting steps listed above, starting with using a private or incognito browser window to login and generate pairs at https://xbrl.us/access-token – make sure you login with your XBRL US Web account credentials (email and password), and not the ‘Sign in with Google’ option, and also be sure you have logged in with the same email address you used to request provisioning for your account.

    • #196073
      Elisa Roselli
      Participant

      Hi David,
      I’m trying to install the Excel add-in. I keep getting an error “We can’t load this add-in because we couldn’t connect to the catalog”. The Excel spreadsheet shows the XBRL Filed Data tab, but it won’t let me log in (just repeats the error in the wizard window).
      I am currently logged in on the xBRL web site and am a member of xBRL US. Is there a way around this?
      Thanks,

      Elisa Roselli

      • #196076
        David Tauriello
        Keymaster

        Hi Elisa – thanks for sending along the error message. In short, ‘we couldn’t connect to the catalog’ means the issue is in getting connected to the Microsoft Store to download the add-in.

        If your Microsoft Office license is held by an organization, there may be a restriction in place that prevents the use of Add-ins for security; in that case, you’ll need to work with your IT Team to request the Add-in be admin managed – this should make it available to you and anyone else in your organization.

        If your Microsoft Office license is yours personally, there may be a network restriction in place, and your IT Team would need to allow traffic to and from our domain and github (where the scripts for the add-in are stored). NOTE: while you might be able to install and use the add-in if the computer is outside of the network or VPN, but it might not function once the computer is back inside the network.

        We’ve had reports that while the add-in is blocked for download on the desktop, it is functional as an add-in using Excel on the web – https://www.office.com/launch/excel

        I hope this helps.

      • #196111
        Elisa Roselli
        Participant

        Hi David,

        Still no joy, either online or local. Do you know the URL of the catalog? In the Office Trust Center, I find a page where I can set up “Trusted Web Add-in Catalogs”, by providing the catalog URL, but https://xbrl-us.org doesn’t work.

        I am trying to get help from my company’s IT support, but they can’t make heads or tails of this problem. The only solution suggested so far was to uninstall and reinstall the whole Office 365 suite, which took much of yesterday and didn’t help at all.

      • #196112
        David Tauriello
        Keymaster

        Hi Elisa – I’m not aware of any Trust Center settings that make the published add-in work.

        Are you able to download, install and use other add-ins from the Office Store (https://appsource.microsoft.com/en-us/marketplace/apps?product=office%3Bexcel&page=1)?

        A Google search of the phrase you’re getting shows this as the top result among several that indicate the same information – that access is blocked by local policy, either on the network or in the Office 365 suite (nb. the add-in won’t work with earlier versions on Windows … could it be that this is the issue in your setup – ?): https://support.papersapp.com/support/solutions/articles/30000040701-troubleshooting-error-message-we-can-t-load-this-add-in-because-we-couldn-t-connect-to-the-catalog

        Assuming the issue is not related to the corporate firewall, here’s what Microsoft says needs to be done to make the Add-in available as admin-managed: https://docs.microsoft.com/en-us/microsoft-365/admin/manage/manage-deployment-of-add-ins?view=o365-worldwide

        To use the Excel Add-in without having your IT Team approve it for use in your company’s Office 365 profile, you can create a free account at https://live.com while you are on a computer that is not connected to a company network or VPN – like Google, Microsoft gives access to Office on the Web to registered users.

        Once you’ve logged in with your new Microsoft account to Excel on the Web, install the XBRL Filed Data add-in, then log in to the XBRL Filed Data add-in using your XBRL US Web account credentials and the client ID and secret you generated from our site.

        Assuming the new Microsoft account is not connected to your company and your connection to the Internet is not routing through your corporate LAN or VPN, you should be able to use the Excel Add-in.

    • #200771
      Magy Avedissian
      Participant

      Hi David,

      I seem to be having issues logging into the extension through Excel. I have tried generating a key in incognito mode and have made sure I am not logging in through the “Sign in through Google” option. Any advice?

      Thanks!

      • #200777
        David Tauriello
        Keymaster

        Hi Magy – you need to use Office 365 Excel and have all four pieces of information when you login to the add-in (XBRL US Web account email, password, client ID and secret). When you click the login button on the add-in task pane, a window should appear over the top of the spreadsheet (if you’re on the web, it may be below your browser window).

        If you’re opening one of our templates from the web with Office live, you’ll first need to make a copy of it to your account (they are read-only).

        Otherwise, please let me know what specific error you’re getting, and what version of Excel you’re using. Also please note if you’re on desktop or web version of Excel.

        Sincerely,
        David

Viewing 6 reply threads
  • You must be logged in to reply to this topic.

Comment

Upcoming XBRL US Events

Communications & Services Steering Committee Meeting
Tuesday, October 18, 2022

Domain Steering Committee Meeting
Tuesday, October 18, 2022

Get Started on the SEC’s Pay Vs Performance Disclosure Requirements
Wednesday, October 26, 2022

Variable Annuity & Life Insurance Cos – Get the Skill Set for XBRL
Tuesday, November 15, 2022