Forum Replies Created

Viewing 15 posts - 1 through 15 (of 307 total)
  • Author
    Posts
  • in reply to: About XBRL US #111787
    David Tauriello
    Keymaster

    Forum Rules

    1. No Spam / Advertising / Self-promote in the forums

    These forums define spam as unsolicited advertisement for goods, services and/or other web sites, or posts with little, or completely unrelated content. Do not spam the forums with links to your site or product, or try to self-promote your website, business or forums etc.

    Spamming also includes sending private messages to a large number of different users.

    DO NOT ASK for email addresses or phone numbers or your account will be banned permanently and your posts will be deleted.

    2. Do not post copyright-infringing material

    Providing or asking for information on how to illegally obtain copyrighted materials is forbidden.

    3. Do not post “offensive” posts, links or images

    Any material which constitutes defamation, harassment, or abuse is strictly prohibited. Material that is sexually or otherwise obscene, racist, or otherwise overly discriminatory is not permitted on these forums. This includes user pictures. Use common sense while posting. This web site is operated by a non-profit standard-setting organization and serves as a reference for accounting, financial analyst, education and regulatory professionals.

    4. Do not cross post questions

    Please refrain from posting the same question in several forums. There is normally one forum which is most suitable in which to post your question.

    5. Do not PM users asking for help

    Do not send private messages to any users asking for help. If you need help, make a new thread in the appropriate forum then the whole community can help and benefit.

    6. Remain respectful of other members at all times

    All posts should be professional and courteous. You have every right to disagree with your fellow community members and explain your perspective.

    However, you are not free to attack, degrade, insult, or otherwise belittle them or the quality of this community. It does not matter what title or power you hold in these forums, you are expected to obey this rule.

    General Posting Guidelines

    1. Please use SEARCH first!

    There is a pretty good chance that unless you have some really odd or unique problem that it has been addressed on our forum before, please use the forum’s search feature first to see if there are already some good threads on the subject. It’s easy to search – just enter a few words for what you’re looking to learn about and click the “Search” button at the top right of the page.

    2. Be DESCRIPTIVE and don’t use vague topic names

    PLEASE post a descriptive topic name! Give a short summary of your problem IN THE SUBJECT.  (Don’t use attention getting subjects, they don’t get attention and only annoy people).

    Here’s a great list of topic subjects YOU SHOULD NOT POST:

    Help me,  Hello, Very urgent, I have a question!

    Generally ANYTHING similar to those is unacceptable. Just post your problem. Here examples of the proper way to post a questions:

    how to calculate net annual operating cash flows

    or

    where is the replay from last month’s inline XBRL webinar/

    Remember when people help you, they are doing YOU a favor

    Be patient, help people out by posting good descriptions of what you need help with, and not snapping at people with garbage such as

    “if you aren’t going to help don’t waste my time replying”.

    General Forum Questions

    Am I allowed more than one account?

    No, there is no reason why you should have more than one account with XBRL US. If you are banned from the forums, please do not create a new account. If you continue to create new accounts after you have been banned, your IP address will be blocked from the forums.

    What happens if I break a rule?

    If you break a rule, then you will either be warned or banned. A ban of your user account may either be temporary or permanent.

    The administrators and moderators also have the right to edit, delete, move or close any thread or post as they see necessary, without prior warning.

    What happens if I see a thread/post which has broken a rule?

    Please report the thread/post to the moderators or admin.

    Where can I find out who is in charge?

    Forum Moderators are identified in each of discussion thread. If you’re unable to find a moderator, send an email to info@xbrl.us

    in reply to: The XBRL API #111838
    David Tauriello
    Keymaster
    Watch an introductory webinar replay about retrieving data with the XBRL API

    Please follow the steps below to get data from the XBRL US Database of Public Filings in a Google Sheet.

    Installation:

    1. install the XBRL API Access Add-on to your Google Account first, using Chrome browser. Want to use your existing email with these resources, without creating a Gmail account? Visit https://accounts.google.com/SignUpWithoutGmail.

      We’ve had some users report issues when they have installed the add-on with Firefox and Edge.

    2. open a Google Sheet template and use the make a copy option under the File menu from within your Google account

      Do not use the ‘request edit access’ option under the view button or ‘Add to My Drive’ under the file menu – these will not work. Using “Make a copy…” under the File menu creates an independent copy of the XBRL Spreadsheet in your Google Account

    3. activate the add-on with the XBRL API Access >> Authentication Menu

      Click the login link in the panel that opens, and a browser window shows the XBRL US login prompt, where you can either login with your XBRL US Web account, or click ‘continue with Google’. Once you’re authenticated, a ‘Success! You can close this window.’ appears, and you can close the browser window that opened.

    4. after you’ve activated the Add-on, change the drop-down on the Main Sheet to a different query, OR change the tickers in the green background of the BScompare tab

      A ‘loading…’ message should appear (replacing the #ERROR or #NAME? text), and you should see data populate cells and rows within 30 seconds, depending on network connectivity and the size of the result set queried.

    5. once you’ve confirmed the data is flowing to this file, try other Google Sheet resources linked at right

    Troubleshooting:

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

    1. If you’re using the ‘Sign on with Google’ option to login, make sure your Google Account has a password – this is a requirement.
       
    2. Open your copy of one of the Google Spreadsheet templates in the browser’s incognito (Chrome) or private (Edge) mode, then open the XBRL API Access Add-on’s Authentication panel and Authorize the XBRL API. Once the Add-on is authorized, make a change to the Google Sheet to initiate a query. When you return to the ‘regular’ browsing tab, the issue should be resolved (you might need to refresh the browser tab).
       
    3. Toggle ‘Use in this document’ and/or uninstall and re-install the XBRL API access Add-on. Choose the “Manage Add-ons” option under the Add-ons menu, click the three dots in the top-right corner of the XBRL API access Add-on. If you have a ‘Use in this document’ option with a checkmark, click to uncheck, then repeat to re-apply the check and return to the sheet to change/test a query.
      If you’re still unable to return data, return to the three dots for the Add-on and uninstall. Reinstall the add-on from https://xbrl.us/xbrl-api-addon, then use the XBRL API Access Add-on menu option to display the right-side panel and click the Authorize link. Once the Add-on is authorized, make a change to the Google Sheet to initiate a query.
       
    4. Open your copy of the ‘XBRL Spreadsheet’ template, choose the ‘Config’ tab and copy / delete / restore the URLs in cells B2 and B3, then return to the ‘Main Sheet’ tab and change the query in cell B1 (make sure Display is set to ‘Query Results’).
      This step breaks and resets valid uses of the =showData() function – you can also use search and replace to add a * in front of the initial = for all formulas in the Google Sheet (stopping the formulas), then reverse the find and replace to remove the * from the front of the formulas.
       
    5. move all copies of XBRL API Google Sheet templates to the trash and then make a new copy of XBRL Spreadsheet – https://xbrl.us/xbrl-api-spreadsheet.
       
    6. Clear the cache in your browser, then close and re-open your copy of the Google Sheet template.

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

    in reply to: The XBRL API #111841
    David Tauriello
    Keymaster

    The Google Sheet and XBRL US API Access add-on were created so anyone with a Google Account can run basic queries and return data via the XBRL API from the XBRL US Public Database of Filings. A Google Account is not needed if you’re using the XBRL API for queries through another resource (Insomnia or another application interface).

    We’ve integrated Google’s login with the XBRL US Web site, so you can use either authentication platform when the XBRL US login prompt appears. If you’re using the same email address on both platforms, you’ll be able to post on these forums, authenticate to use the API, etc.

    If you don’t have a Google Account, you can create one using your current email (without creating an @gmail.com account) – use the link at right to get started.

    in reply to: The XBRL API #111865
    David Tauriello
    Keymaster

    In late 2015, we published our first set of APIs, documentation and related resources (Google Sheets, Microsoft Excel files) as a preliminary attempt at exposing data in the XBRL US Database of Public Filings – the Data Analysis Toolkit.

    Among the feedback we received about the APIs was a consistent request to make them ‘easier for non-XBRL people’ to understand and implement. The XBRL APIs do that, and more, so we’ve decided to shut down the ‘legacy’ APIs associated with the Data Analysis Toolkit in December, 2018.

    With participation from the XBRL Data Community in the form of live web exchange, submitted templates and support through these discussion forums, we expect interest in standardized financial data and a standard to retrieve the data will continue to grow.

    in reply to: The XBRL API #111972
    Revathy Ramanan
    Participant

    Is there an alternative way to write API queries which in turn uses the following conditions

    concept.local-name contains “FairValue”
    dimension.namespace is not equal to “http://xbrl.ifrs.org/taxonomy/2017-03-09/ifrs-full”

    in reply to: Is there a way to achieve logical text filters such as "contains"? #112159
    David Tauriello
    Keymaster

    Hi Revathy – this is a great question. The API itself won’t do this (right now?), but if you retrieve data into a Google Sheet, you can apply a filter over the return and use the spreadsheet filtering (see the BScompare tab of the XBRL Spreadsheet for an example of this at cells F23:J23)

    in reply to: The XBRL API #112974
    Peter Guldberg
    Participant

    So – if I understand this correctly, the report object does not have periods. Only a period-end. Only facts have fiscal period fields.

    If I want to find the latest fiscal period that a specific CIK has filed for that means I will first have to find a report.id for the latest 10-Q or 10-K, and then use that report.id to query for a specific fact, and then getting the period.fiscal-period from that fact. Since there will be facts from both the current and the previous period I will also have to make sure that I get the most recent fact and use the fiscal-period from that.

    Is there an easier way to try and find which fiscal period a report relates to? – Maybe if an entity had a fiscal year-end field?

    in reply to: Reports and periods #113051
    David Tauriello
    Keymaster

    Hi Peter – thanks for your good question. There are a couple of parameters and techniques you can use to return the ‘latest’ data. To find the ‘latest fiscal period’ that a specific CIK has filed, simply use ‘report.is-most-current=true’

    You can also use the .sort(ASC/DESC) switch with nearly all ‘fields’ that are returned. Applying sort to the period.instant and report.filing.date orders the period (for facts returned in a report).

    /report/fact/search?concept.local-name=Assets&entity.cik=XXXXXXXXXX&report.is-most-current=true&fields=period.instant.sort(DESC),report.filing-date.sort(DESC),report.document-type,report.restated-index,report.id,concept.local-name,fact.value,fact.id

    This will return the Assets reported by the CIK in the most current report, with the fact.values sorted by period. Remove the report.is-most-current parameter to see all values for the concept Assets.

    in reply to: Reports and periods #113062
    Peter Guldberg
    Participant

    Hi David – thanks a lot for your detailed answer.
    I can see how that will get me facts from what is the latest report.

    However – my problem is that I want to find the answer to “What is the latest fiscal period that this CIK has filed a report for?” – or similarly: “Which fiscal period is the latest report that this CIK has filed, for?”

    Because only facts have a fiscal-period, and reports have facts from several different fiscal periods, that makes it somewhat difficult.

    It would seem to me that a report could have a fiscal-period field, that could hold this value.

    Although – I can see how in your example, since the period.instant is sorted, the first fact that it returns should have a fiscal-period field that contains what I want. It just seems a somewhat round-about way to get it 🙂

    in reply to: Reports and periods #113087
    David Tauriello
    Keymaster

    Peter – thanks for the clarification; using only the /report endpoint, returning fields report.period-end and report.document-type lets you know ‘what is the latest fiscal period’ for a CIK (quarter or annual as of balance date)

    /report/search?entity.cik=XXXXXXXXXX&report.is-most-current=true&fields=report.entity-name,entity.cik,report.period-end,report.document-type,report.id,report.restated-index,report.sec-url

    in reply to: Reports and periods #113100
    Peter Guldberg
    Participant

    No, that is the whole problem – that does not tell me what the fiscal period is. It only tells me the end date and whether it is a 10-Q or a 10-K. With only that information I cannot distinguish a Q2 report from a Q3 report (or Q1 for that matter). For example the latest report from NKE is Q1 2019, but the period-end is 2018-08-31.

    However – in the meantime I found out that there are two facts named DocumentFiscalPeriodFocus and DocumentFiscalYearFocus. I can use those with the following query, to get the info I need:

    
    /report/fact/search?entity.ticker=nke&report.is-most-current=true&concept.local-name=DocumentFiscalPeriodFocus,DocumentFiscalYearFocus&fields=concept.local-name,fact.value,report.document-type,report.period-end,report.restated-index,report.id
    
    in reply to: Reports and periods #113160
    David Tauriello
    Keymaster

    Peter – thanks, for helping me to see the issue clearly and posting your solution. Our team is aware of your interest in getting this from the report endpoint.

    in reply to: Getting started with the XBRL Google Sheet and add-on #113573
    Natasha Pchelko
    Participant

    Getting error while activating the Add-on:

    ‘Error: Error retrieving token: unsupported_scope_type, Unsupported Scope Type (line 467, file “Service”, project “OAuth2”)’.

    As a result can’t activate the add-on with the XBRL API Access >> Authentication Menu

    in reply to: Getting started with the XBRL Google Sheet and add-on #113587
    David Tauriello
    Keymaster

    Hi Natasha – thanks for writing and apologies for the issue you had getting the add-on to authenticate. I’ve reset your record in our system – please try to use the add-on authentication again, and reply back if you’re still having issues.

    in reply to: The XBRL API #113880
    Adam Gerbert
    Participant

    I was hoping to use the API to validate against dqc rules by posting the required parameters, per the documentation, to the /api/v1/assertion/validate/ endpoint.

    However, I am only getting back this:
    {“error”:”invalid_scope”,”error_description”:”Invalid Scope”}

    This occurs if I use Insomnia, or my own code. It also occurs even if I remove all the additional fields. Is this a permission error of some sort? Any assistance is appreciated.

Viewing 15 posts - 1 through 15 (of 307 total)