Nuevo

Nuevo

Iniciar sesión
Registrarse

Documentación API

Obtén información sobre cómo empezar con la API de REST de Nodecharts

La API REST de nodecharts.com entrega conocimiento sobre el estado de la blockchain de Bitcoin y su información agregada, debidamente analizada, curada y estructurada. Las consultas a la API REST se realizan mediante peticiones GET,  retornando datos disponibles para su consumo inmediato en formato JSON.

El endpoint de familias lista todas las métricas agrupadas por familias, con su nombre, endpoint y descripción.

Todas las métricas disponibles en el listado de gráficas del Estudio son accesibles desde la API.
En la página de Mi Cuenta – API puedes obtener este recurso, que podrás usar en tus peticiones a la API adjuntándolo a la URL. En nuestra documentación lo verás representado como {userhash}.

En el endpoint https://api.nodecharts.com/v1/metricinfo/{endpoint}/{userhash} puedes consultar los parámetros requeridos por cada métrica.

Puedes obtener los valores de {endpoint} y {userhash} aquí y aquí.

Nodecharts te devolverá una respuesta JSON con los atributos de nombre, descripción, familia a la que pertenece la métrica, el {endpoint} en el que realizarle peticiones y el atributo de parámetros de la métrica.

El atributo “params” nos indica los valores máximo (max) y mínimo (min) que puede tomar cada parámetro, y si son obligatorios (required).

Los parámetros de petición a una métrica son los siguientes:

  • “f”: From. Requerido. Número entero. Tiempo Unix inicial de la búsqueda.
  • “t”: To. No requerido. Número entero. Tiempo Unix final de la búsqueda. Si no se configura el sistema devolverá datos hasta el presente.
  • “i”: Intervalo. Requerido. Cadena de texto. Resolución o intervalo de datos. Puede tomar los siguientes valores:
    • “Block”. Intervalo en bloques.
    • “Hour”. Intervalo en horas.
    • “Day”. Intervalo en días.

Si no se establecen correctamente estos valores la consulta devolverá un error HTTP/1.1 400 Bad Request.

Ejemplo de petición de información sobre configuración de una métrica:

https://api.nodecharts.com/v1/metricinfo/cdd/bGaciOiJIUzs1NiJ9.eyJcpZXJpW1iGIwBpcwV0aW1Q.ufTu8ebD8

Para realizar una petición a una métrica consulta la dirección https://api.nodecharts.com/v1/metric/{endpoint}/{userhash}?{lista_de_params} Recuerda que la lista de endpoints para obtener tu {endpoint} la puedes obtener aquí. Para saber cómo completar los valores de {lista_de_params} de cada métrica puedes consultar su configuración en la dirección https://api.nodecharts.com/v1/metricinfo/{endpoint}/{userhash} Recuerda completar los parámetros {endpoint} y {userhash} antes de realizar esta petición.
Todas las métricas responden con la misma estructura de array JSON que puedes inmediatamente consumir. Estos son sus parámetros:
  • “t”: Número entero. Tiempo Unix del dato. En resolución de bloques indica el momento en el que se minó. En resoluciones de día y hora indica el cierre del intervalo.
  • “v”: Valor de la métrica.
  • “usd”: Precio en $USD al que cotizaba el intervalo solicitado.
Cada suscripción tiene un número de peticiones por minuto máximo, denominado cuota de peticiones. Esta cuota se consume (decrementa) por igual con las peticiones a la API REST o mediante la consulta de gráficas en el Estudio. Las gráficas compuestas pueden suponer la realización de múltiples peticiones simultáneas. La cuota de peticiones se restablece cada 60 segundos a su máximo disponible según la suscripción contratada. No todas las peticiones suponen consumo de cuota, como se explica aquí. En caso de superar las peticiones máximas por minuto el servicio entregará una respuesta HTTP/1.1. 429 Too Many Requests.

Cada métrica dispone de una configuración de restricciones de servicio determinada. Para saber el alcance de datos de tu suscripción desde la propia API puedes consultar en el endpoint https://api.nodecharts.com/v1/metricinfo/{endpoint}/{userhash} el parámetro “memberships”. Compáralo con el id de suscripción que puedes encontrar en tu página de Mi Cuenta.

Valores del atributo “memberships”:

  • “membership”: Número entero. Identificador de suscripción al que se aplica cada configuración de restricciones.
  • “offsets”: Cantidad de segundos de desplazamiento máximo, según suscripción, hacia atrás en el tiempo. El punto de inicio es el último bloque computado por el sistema, que corresponde al último estado de la cadena de bloques.
    Así, un valor de, por ejemplo, 259200 devolverá ese número de segundos (72 horas) en datos hacia atrás en la cadena de bloques desde el último bloque que el sistema haya computado.
    El valor -1 corresponde a ilimitado.
    Este atributo se divide en los siguientes:
    • “b-offset-block”: Desplazamiento máximo en bloques.
    • “b-offset-hour”: Desplazamiento máximo en horas.
    • “b-offset-day”: Desplazamiento máximo en días.
En el endpoint https://api.nodecharts.com/v1/ping puedes verificar el estado del sistema.  Éste recurso devuelve la versión del producto. Estamos trabajando activamente en ello, por lo que el número de versión cambiará con frecuencia.
¿No encuentras una respuesta?
Contacta con nosotros