Punto final de API

Todas tus solicitudes de API deben dirigirse al siguiente punto final de la API:

https://api.cryptohopper.com/v1/

Métodos de Solicitud Soportados

Parámetros de la solicitud

Hay cuatro tipos de parámetros que usamos en nuestra API: ruta, cadena de consulta, encabezado y parámetros del cuerpo de la solicitud. Los parámetros del cuerpo de la solicitud son datos enviados en el cuerpo de la solicitud JSON para las peticiones POST y PATCH. Los parámetros de encabezado son, obviamente, parámetros que deben enviarse en el encabezado. Más info sobre los parámetros de Encabezado, Ruta y Cadena de consulta se encuentra debajo.

Parámetros de Encabezado

Toda solicitud a nuestra API debe estar autenticada enviando los siguientes valores en el encabezado:

• access-token - Tu token de acceso recibido con la autenticación Oauth2.

Parámetros de ruta

Estos son parámetros que se suministran en la URI del endpoint. Por ejemplo, el endpoint GET Hopper:

https://api.cryptohopper.com/v1/hopper/{hopper_id}

Para recuperar un bot de trading por su ID único, tenés que reemplazar el valor de su ID en el placeholder {hopper_id}. Por ejemplo, para recuperar un bot con ID 37, tendrías que solicitar la siguiente URL:

https://api.cryptohopper.com/v1/hopper/37

Algunos endpoints requieren múltiples parámetros. Por ejemplo, si querés devolver un pedido específico del Hopper anterior, necesitás llamar a la siguiente URL:

https://api.cryptohopper.com/v1//hopper/{hopperId}/order/{orderId}

Y reemplazando los parámetros con el ID de Hopper y la orden, obtendrás:

https://api.cryptohopper.com/v1//hopper/37/order/231

Para una lista detallada de los parámetros requeridos en cada endpoint de la API, consulta nuestra guía de referencia de la API.

Parámetros de la consulta

Usamos este tipo de parámetros en las peticiones GET para filtrar y/o paginar datos. Estos parámetros no están especificados en la ruta, sino como un conjunto de valores separados por el carácter '&' en la cadena de la URL.

Por ejemplo, para recuperar las ordenes de compra de Bitcoin de un bot de trading, podrías llamar al endpoint Hopper Order así:

https://api.cryptohopper.com/v1/hopper/37/order/?order_type=buy&coin=btc
        

Mirando nuestra referencia de API, se ve que, en este caso, el parámetro order_type puede tomar los valores ‘buy’ o ‘sell’, y el parámetro coin puede ser cualquier código de moneda criptográfica en minúsculas.

Formato de respuesta

Todas las respuestas están en formato de objeto JSON. Por lo tanto, el tipo MIME que encuentras en todas nuestras respuestas será application/json. Consulta nuestra documentación de la referencia de la API para el formato JSON específico en el cuerpo de cada solicitud y respuesta.

Códigos de respuesta HTTP

Usamos los códigos de estado de respuesta definidos por los estándares RFC 2616 y RFC 6585..

Códigos de error HTTP

Mensajes de error

Cuando la API devuelve un código de error, adjuntará un objeto JSON con la descripción del error en su cuerpo. Un mensaje de error tendría un aspecto así:

{
            "status": 400,
            "error": 1,
            "message": "Missing required request parameters: [access_token]"
        }
        

Límites de Tasa

Nuestra API tiene un límite de solicitudes para repartir los recursos de ancho de banda de forma equitativa entre todos los usuarios. Los límites actuales son de 2 solicitudes por segundo por usuario, excepto para las órdenes de compra. En ese caso, el máximo de órdenes de compra que se pueden colocar es una cada 8 segundos.

Si superas el número de solicitudes disponibles por segundo, recibirás un código de respuesta de error 429. Revisa el encabezado Retry-After incluido en la respuesta, que indica los segundos que debes esperar para realizar otra solicitud.