Publicado el 3 de febrero de 2024 por Editor
Navegar por el vasto panorama de datos financieros de EE. UU. ahora es más fácil. David Tauriello, vicepresidente de operaciones de XBRL US, ha compilado una lista útil de consejos y técnicas para optimizar su experiencia con la API proporcionada por XBRL US para acceder a información en las presentaciones de la SEC y la FERC. Ya sea que sea un profesional experimentado o simplemente se esté sumergiendo en el mundo de la consulta de datos, estos conocimientos están diseñados para mejorar la eficiencia, ahorrar tiempo y ampliar su comprensión de lo que es posible utilizar la API desarrollada por XBRL en EE.UU. para el análisis de datos financieros.
Aquí hay un adelanto de algunos de los consejos compartidos:
- Comience poco a poco, haga crecer una consulta y conozca sus límites: comience con una consulta enfocada y amplíela gradualmente para refinar sus resultados. Una consulta inicial que sea específica (quizás con una respuesta que ya conozca o que pueda verificar fácilmente) probará y confirmará su comprensión de la API XBRL.
- Ordene los ‘Campos a devolver’ antes de realizar la consulta para escanear rápidamente los resultados: este sencillo paso le permite escanear rápidamente los resultados e identificar información clave filtrando los campos elegidos en información en orden ascendente o descendente.
- Concéntrese en los ‘Campos para devolver’ para crear consultas más potentes: busque opciones para ampliar su consulta; la mayoría de los ‘Campos para devolver’ también se pueden buscar como parámetros.
Descubra la lista completa de consejos y técnicas consultando el artículo aquí.
Diez consejos y técnicas para utilizar la API XBRL
Publicado el viernes 19 de enero de 2024
Por: David Tauriello, vicepresidente de operaciones, XBRL US
Todo el mundo aprecia una buena propina. Si bien no sustituyen a una revisión exhaustiva de toda la información relevante, los atajos que mejoran la eficiencia, ahorran dinero o amplían una perspectiva son útiles y pueden tener un impacto duradero.
Desde 2018, hemos estado haciendo que los datos que hemos copiado en nuestra base de datos de presentaciones públicas de reguladores estadounidenses y europeos estén disponibles a través de la API XBRL.
En ese tiempo, hemos respondido miles de preguntas de miembros y no miembros de XBRL EE. UU. sobre los datos, la API de XBRL y los recursos que hemos puesto a disposición y que utilizan la API de XBRL para consultar nuestra recopilación de datos. Por lo que sabemos sobre estos recursos y lo que hemos escuchado de las personas que trabajan con ellos, los siguientes consejos y técnicas pueden ofrecerle información para su próxima sesión de consultas; haga clic en el consejo para obtener más información.
La extensión de hoja de cálculo XBRL Filed Data le permite crear consultas básicas que pueden manipularse aún más en la celda después de usar la opción predeterminada ‘Función + Datos’ para devolver datos a una hoja de cálculo. Asegúrese de probar también las otras opciones de salida: la opción ‘Datos’ es buena para resultados únicos; ‘Consulta’ ayuda a crear plantillas o compartir consultas con otros; y ‘SQL’ imprime un comando que se puede utilizar con la base de datos de registros públicos.
Una consulta inicial que sea específica (quizás con una respuesta que ya conozca o que pueda verificar fácilmente) probará y confirmará su comprensión de la API XBRL. La mayoría de los parámetros de filtrado en la API XBRL admiten listas separadas por comas (es decir, period.fiscal-year=2023,2022,2021 o concept.local-name=assets,liability), por lo que puede agregar o eliminar filtros fácilmente para obtener lo que necesita. . Es posible que le resulte más rápido editar una consulta en la celda de la hoja de cálculo que modificarla y volver a ejecutarla desde el panel de tareas.
Un beneficio secundario de iterar mientras se crea una consulta es que, al centrar las pruebas iniciales de consulta en confirmar los resultados conocidos antes de expandir la búsqueda, se ahorrará tiempo porque los conjuntos de resultados grandes (todos los datos reportados por una empresa a lo largo de todos los años) pueden tomar más tiempo para reunir y devolver que resultados más pequeños.
La mayoría de los miembros de XBRL EE. UU. pueden utilizar la API de XBRL para devolver todos los datos disponibles para una consulta, en conjuntos de 5000 filas a la vez (la mayoría de los informes 10-K tienen menos de 3000 hechos). Los no miembros pueden obtener hasta 1000 filas en conjuntos de 100. Al ordenar los resultados y utilizar el campo de compensación de un punto final, los lenguajes de programación pueden iterar o realizar un bucle en una consulta para obtener el máximo de datos, y los usuarios de extensiones de hojas de cálculo pueden especificar el desplazamiento en el texto correspondiente. campo como punto de partida para obtener resultados.
- Ordene los ‘Campos a devolver’ antes de realizar la consulta para escanear rápidamente los resultados.
En la extensión de hoja de cálculo XBRL Filed Data, los ‘Campos a devolver’ están ordenados alfabéticamente de forma predeterminada. Estos se pueden reorganizar arrastrando las etiquetas hacia arriba o hacia abajo y el signo + muestra una lista de búsqueda de otros atributos que se pueden agregar a los resultados.
Dentro de la lista de campos seleccionados, cada uno se puede configurar como orden ascendente o descendente usando las flechas a la derecha de cada campo en la lista. La API XBRL aplicará la clasificación en el orden en que los campos están organizados de izquierda a derecha cuando observa los resultados de la consulta (de arriba a abajo en los ‘Campos para devolver’ del complemento).
Usar la clasificación en al menos un campo que contiene valores diferentes es un requisito para usar el parámetro de compensación (la compensación es necesaria para obtener cualquiera o todos los resultados por encima del límite inicial de una cuenta).
Por ejemplo, si selecciona la función de hechos y pega 0000320193 (que es el identificador de entidad SEC para Apple Inc.) en el campo ‘u Obtener datos por código de entidad’ y luego hace clic en ‘Obtener’ para devolver datos de Apple, obtendrá una lista (ordenada por fact.id). Si luego hace clic en la flecha hacia arriba en concept.local-name y vuelve a hacer clic en ‘Obtener’, los datos se ordenarán en orden alfabético. Agregar clasificación a otros campos después de la clasificación alfabética (período.año fiscal, por ejemplo) aplicará esa clasificación después de la clasificación alfabética. Al igual que agregar parámetros, la clasificación también se puede manipular manualmente en la consulta agregando .sort(ASC) o .sort(DESC) a los campos.
Los formularios para crear consultas en el panel de tareas de la extensión de la hoja de cálculo no son un conjunto completo de opciones de búsqueda. La mayoría de los ‘Campos para devolver’ también se pueden buscar como parámetros cuando se agregan en el campo ‘Parámetros adicionales’ (simplemente no se muestran para mantener las opciones simples).
Por ejemplo, pegue 647772 en ‘Seleccionar informe por nombre de entidad’ y haga clic en ‘Obtener’ para obtener datos de Apple en 10 K, luego agregue el parámetro concept.is-monetary=true como ‘Parámetro adicional’ y haga clic en ‘Obtener ‘ nuevamente para consultar solo hechos monetarios en el informe. Agregue &concept.is-base=false a ‘Parámetros adicionales’ y tendrá conceptos monetarios que son elementos extendidos en el 10-K de Apple.
Una de las primeras cosas que puede notar acerca de los datos en un informe XBRL es que los valores duplicados son comunes. Esto se debe a que el mismo hecho se puede informar en varios informes, como en comparaciones de años anteriores.
Para ayudar a reducir la redundancia, un parámetro como fact.ultimus=true indica a la base de datos que devuelva un hecho si corresponde a la última instancia de un hecho informado según lo definido por sus atributos.
Por ejemplo, los ingresos anuales de Apple Inc. para 2021 aparecen en varios informes de la empresa:
Por cierto, las consultas de la API XBRL se muestran en el navegador: haga clic en el enlace, inicie sesión y vea los resultados.
Agregue &fact.ultimus=true a la consulta anterior y obtenga solo la última instancia de este hecho que aparece en un informe.
El parámetro único también reduce la repetición de hechos al comparar el contenido de cada fila de resultados con todos los demás y eliminar todas las ocurrencias menos una (única) para cada uno. Lo que es importante tener en cuenta es que si algún campo de resultado tiene información que difiere de otros (es decir, el tipo de documento de informe es 10-K frente a 10-Q), las filas se consideran únicas. Único es una opción de casilla de verificación cerca del botón «Obtener» en la extensión de la hoja de cálculo o puede agregar &único como filtro de consulta para crear un conjunto de resultados único.
Intente agregar &unique al final de esta consulta para reducir el resultado a una sola fila:
Una tercera opción para ayudar a reducir la repetición, fact.accuracy-index, es similar al índice ultimus, aunque este parámetro funciona a nivel de informe (y solo se remonta a 2018). Un valor de parámetro fact-accuracy-index de 1 devuelve la versión más precisa del hecho. Se puede utilizar como parámetro con un único informe (por identificación, acceso o URL) o se puede aplicar a un tipo de documento de informe específico (es decir, 10-K) para aislar los resultados. Este último caso es importante para los investigadores, ya que reguladores como la SEC amplían los requisitos de XBRL para incluir tipos de informes adicionales que no son tan conocidos como los 10-K y 10-Q. Esta discusión tiene más detalles sobre ultimus, singularidad y precisión.
La mayoría de los declarantes ante la SEC informan hechos no dimensionales en los estados financieros de la empresa (balance general, estado de resultados y flujo de caja). Un hecho sin dimensiones es en sí mismo un total; esto a veces se denomina valor predeterminado.
Las empresas suelen informar datos desglosados por descriptores adicionales (es decir, ventas por región o producto). Estos son hechos dimensionales: una dimensión es una forma de informar un hecho como Ingresos que se pueden informar como un total, pero también se pueden desglosar en tipos, como ingresos por tipo de producto o geografía. Al crear una consulta, la categoría (por ejemplo, Región Oriental o Región Occidental) se denomina miembro de la dimensión.
Un hecho con una dimensión (o varias dimensiones) tiene miembros que deben «acumularse» al valor predeterminado no dimensional. Dicho de otra manera: los hechos dimensionalizados combinados siempre cuentan una historia completa sobre su contraparte no dimensionalizada (es decir, el total). Ya sea que se trate de una historia sobre ofertas de productos y servicios, desempeño de ubicación geográfica u otra forma de analizar datos, una dimensión y sus miembros brindan una contabilidad completa del total.
En los puntos finales de hecho y de cubo de la API XBRL, el atributo de par de dimensiones es un mecanismo «abreviado» que muestra ambas facetas de este hecho.
Algunos campos de la extensión crean listas de opciones que se completan automáticamente para elegir a medida que las escribe (en la función de hechos, ‘Seleccionar informe por nombre de entidad’ y ‘Filtrar por nombre de concepto’ hacen esto). Puede obtener estos resultados como una consulta con datos en la hoja de cálculo haciendo clic en el icono azul que aparece junto a la etiqueta del campo.
Por ejemplo, escriba Apple Inc. en el campo ‘Informe por nombre de entidad’ y seleccione un informe, luego coloque el término «efectivo» en el campo ‘Filtrar por nombre de concepto’ y haga clic en el icono azul junto a la etiqueta de este parámetro. Esto pondrá la función, la consulta y una lista de todos los conceptos en el informe que incluyen la cadena «efectivo».
A continuación, edite la celda donde se encuentra la consulta para agregar «concept.namespace» como campo a incluir en los resultados, y podrá diferenciar los elementos de taxonomía base de los de extensión creados por la empresa.
Un informe XBRL contiene cubos que representan tablas financieras. Un cubo se puede extraer en su totalidad seleccionando la función cubo. La plantilla de hoja de cálculo FERC es un ejemplo del uso del extremo del cubo para extraer datos de estados financieros mediante una única consulta.
- Utilice opciones adicionales en la función ‘showData’ de la hoja de cálculo para personalizar los resultados.
Además de devolver resultados para la consulta desde la URL, se pueden definir tres argumentos opcionales (tipo, nombre de campo y encabezados de presentación) en la función de hoja de cálculo para refinar los resultados. La última posición establece si se muestran los encabezados de las columnas y las otras dos trabajan juntas para filtrar la salida; lea más sobre las instrucciones de implementación para cada opción.
Las vistas de informes «básicos» en nuestras plantillas de hojas de cálculo y ejemplos de código en los cuadernos de Jupyter están diseñados para permitir que los nuevos usuarios obtengan resultados con unas pocas teclas (todos tienen una empresa favorita sobre la que les gustaría saber más). Las consultas y fórmulas subyacentes de las hojas de cálculo se pueden reutilizar en nuevas hojas de cálculo para recopilar datos de empresas, sectores o tipos de informes específicos.
Cuando necesite saber más sobre lo que es posible (consultas anidadas, búsquedas de texto en documentos), revise la documentación, publique preguntas en el foro de discusión o únase a un horario de oficina. Obtenga más información sobre estas opciones en la página de la comunidad de datos XBRL.
Publicado originalmente: https://www.xbrl.org/news/top-tips-techniques-for-harnessing-the-power-of-the-api-provided-by-xbrl-us/