Introducción - Blockradar

¡Antes de comenzar!
Debes crear una cuenta gratuita de Blockradar con la que puedas probar la API. Te proporcionaremos claves de prueba que podrás usar para realizar llamadas a la API.

Colección de Postman

Ver la Colección de Postman

La API de Blockradar te da acceso a prácticamente todas las funciones que puedes usar en nuestro panel de control y te permite extenderlas para usar en tu producto. Se esfuerza por ser RESTful y está organizada en torno a los recursos principales con los que interactuarías, con algunas excepciones notables.

Solicitudes de Ejemplo

Proporcionamos llamadas de API de ejemplo junto a cada método usando cURL. Todo lo que necesitas hacer es insertar tus parámetros específicos y puedes probar las llamadas desde la línea de comandos. Consulta este tutorial sobre uso de cURL con APIs. También puedes usar Postman si no estás familiarizado con cURL. Postman es una plataforma fácil de usar para el desarrollo y prueba de APIs. Puedes explorar la Colección de Postman de Blockradar para entender cómo funcionan nuestras APIs.

Solicitudes y Respuestas

Tanto los datos del cuerpo de la solicitud como los datos de respuesta están formateados como JSON. El tipo de contenido para las respuestas siempre será application/json. Generalmente, todas las respuestas estarán en el siguiente formato:

{
  "statusCode": "[number]",
  "message": "[string]",
  "data": "[object]"
}

Claves

Propiedad	Tipo	Descripción
statusCode	number	Este es el código de estado de la solicitud que te permite saber si tu solicitud fue exitosa o no. Recomendamos que uses esto para determinar el resultado de una llamada a la API.
message	string	Este es un resumen de la respuesta y su estado. Por ejemplo, al intentar recuperar una lista de clientes, el mensaje podría decir “Transacciones obtenidas exitosamente”. En caso de un error, la clave message contendrá una descripción del error como en la situación del encabezado de autorización anterior. Esta es la única clave que es universal en todas las solicitudes.
data	object	Esto contiene los resultados de tu solicitud. Puede ser un objeto o un arreglo dependiendo de la solicitud realizada. Por ejemplo, una solicitud para recuperar una sola transacción devolverá un objeto de transacción en la clave data, mientras que la clave sería un arreglo de transacciones si se solicita una lista en su lugar.

Objeto Meta

La clave meta se usa para proporcionar contexto para el contenido de la clave data. Por ejemplo, si se está recuperando una lista de transacciones realizadas por un cliente, se pueden pasar parámetros de paginación para limitar el conjunto de resultados. La clave meta entonces contendrá un objeto con los siguientes atributos:

{
 "meta": {
    "totalItems": 704,
    "itemCount": 100,
    "itemsPerPage": 100,
    "totalPages": 8,
    "currentPage": 1
  }
}

Propiedad	Descripción
totalItems	El número total de elementos disponibles. Esto representa el recuento completo de elementos en todas las páginas.
itemCount	El número de elementos en la página actual. Esto indica cuántos elementos se están devolviendo en la respuesta actual.
itemsPerPage	El número máximo de elementos por página. Esto define el límite de paginación establecido para cada página. Predeterminado: 100
totalPages	El número total de páginas disponibles. Esto se calcula en función del número total de elementos y el número de elementos por página.
currentPage	El número de página actual. Esto indica qué página de la paginación se está devolviendo en la respuesta actual. Predeterminado: 1

Colección de Postman

​Solicitudes de Ejemplo

​Solicitudes y Respuestas

​Claves

​Objeto Meta

Solicitudes de Ejemplo

Solicitudes y Respuestas

Claves

Objeto Meta