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

Viewing 3 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

    • #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

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

Comment