Home Forums The XBRL API Combining v1/relationship and v1/concept

This topic contains 1 reply, has 2 voices, and was last updated by  David Tauriello 3 weeks, 3 days ago.

  • Author
    Posts
  • #124707

    Tim Bui
    Participant

    When I use code A below, I get the desired concept.local-names, but the call does not return the “network.role-description” (the financial statements where the concept came from)–even as I added different “relationship” items in the code.

    A—=CONCATENATE(“https://api.xbrl.us/api/v1/concept/search?dts.id=257590&fields=concept.offset(0),concept.local-name.sort(ASC),concept.*,relationship.source-name,relationship.id,relationship.*,label.*”)

    When I use code B below, I do get the “network.role-description”, which I need.
    Is there a way that I can get the “network.role-description” to work in code A above?

    B–=CONCATENATE(“https://api.xbrl.us/api/v1/relationship/search?dts.id=257590&fields=concept.offset(2000),concept.local-name.sort(ASC),concept.*,relationship.source-name,relationship.id,relationship.*,label.*”)

    Thank you!

  • #126283

    David Tauriello
    Keymaster

    I’m not clear on what you are trying to return, and as far as I know, there’s no intersection of concept and relationship in the API currently. Please see the diagram on p. 20 of the documentation – https://xbrl.us/xbrl-api-documentation.

    In the A query, you cannot get relationship details from the concept endpoint, so those parameters should be removed from the ‘fields’ portion of the query. And with B, you cannot get concept details from the relationship endpoint, so those shouldn’t be included as ‘fields’ to return.

    Maybe you’re trying to use the relationship endpoint to get concepts included in a specific part of the filer’s report – ?

    A query like this will return details for Apple: /relationship/search?network.id=37096851,37096836&relationship.target-is-abstract=false&network.link-name=presentationLink&fields=network.id.sort(ASC),relationship.tree-sequence.sort(ASC),relationship.*

    If you look at relationship.target-name in the fields returned, these are the concepts included for the disclosures listed in network.role-description

You must be logged in to reply to this topic.

Comment