¿Qué es WhiteBIT API?

WhiteBIT API es una herramienta de automatización que permite a los desarrolladores crear programas y aplicaciones que interactúan con nuestro intercambio. Se puede utilizar para crear y administrar órdenes para comprar y vender criptomonedas, obtener información sobre el mercado, el saldo de la cuenta y más.

¿Cómo usar WhiteBIT API?

Antes de utilizar la API, debemos habilitar la autenticación de dos factores (2FA) en la cuenta.

Después de eso, debe generar claves API, que se utilizan para autenticar al usuario y proporcionar integración con la API.

Siga las sencillas instrucciones para activar las claves:

• Vaya a la configuración de API en su cuenta y seleccione "Editar" en la sección correspondiente;
• Después de hacer clic en "Generar clave API", introduzca su código 2FA;
• La ventana que aparece contendrá un par de claves API. Guárdelos, ya que los necesitará para autenticar las operaciones en la interfaz API en el futuro.
  
   

Mantenga su Clave secreta almacenada de forma segura, ya que no será recuperable una vez que cierre esta página. Al mismo tiempo, su Clave pública siempre está disponible y no representa una amenaza cuando se comparte con terceros. A diferencia de la Clave secreta, la Clave pública ofrece pocas oportunidades para realizar acciones no deseadas.

• También puede seleccionar los endpoints que planea usar en la misma página. Para fines de prueba de claves API, se recomienda seleccionar todos los endpoints disponibles, ya que podrá editar esta selección en el futuro. Más adelante en el artículo se proporcionará más información sobre los endpoints;
• Luego, confirme sus acciones introduciendo el código 2FA;
• Y ahí lo tiene, ¡sus claves API están listas para usar!
  
   

Después de crear un par de claves API, es posible cambiar el acceso IP. Al utilizar la función de restricción de acceso a direcciones IP, puede incluir sus direcciones IPv4 e IPv6 en la lista de direcciones IP confiables.

Cuando esta función está activada, las claves API se desactivan automáticamente si se envía una solicitud de claves API desde otra dirección IP. Se enviará una notificación a su dirección de correo electrónico con la clave pública y la dirección IP desde la que se envió la solicitud.

Si esta dirección IP le pertenece y es confiable, la API se puede reactivar añadiéndola a la lista de direcciones IP confiables.

En cuanto a la lista de puntos finales disponibles, es importante tener en cuenta que cada categoría y subcategoría presentada es responsable de un grupo diferente de operaciones para administrar su cuenta de intercambio. Puede crear y utilizar sus claves para realizar operaciones en una o más de las siguientes categorías disponibles:

• Depósito;
• Retiro;
• Transferencia entre saldos;
• Saldo e historial de la billetera;
• Códigos;
• Saldo comercial e historial;
• Gestión de órdenes.
  
   

El manual técnico, presentado en un formato simple y accesible, proporciona información más detallada sobre la funcionalidad de la API de nuestro intercambio.

La documentación ampliada también está disponible en el repositorio de software público en GitHub.

 

También puede utilizar Demo Tokens para probar la funcionalidad de nuestra API.

Creación rápida de una clave API mediante OAuth

La creación rápida de claves API mediante OAuth permite conectar instantáneamente aplicaciones asociadas a WhiteBIT sin necesidad de configurar manualmente las claves API.

Tradicionalmente, al integrar aplicaciones de terceros, los usuarios tenían que crear manualmente las claves API, copiar datos confidenciales y configurar permisos, lo que suponía un proceso laborioso. La integración de OAuth 2.0 con WhiteBIT proporciona una autorización segura basada en tokens para aplicaciones asociadas, permitiéndoles acceder a la plataforma WhiteBIT en nombre de los usuarios. Esta implementación cumple con los estándares de la industria y, al mismo tiempo, ofrece funcionalidades especializadas diseñadas específicamente para el trading de criptomonedas y la gestión de cuentas.

Cómo crear rápidamente una clave API mediante OAuth

1. Debe iniciar la conexión a través de una aplicación de terceros. El sistema le redirigirá a la página de autorización OAuth de WhiteBIT.
2. Inicie sesión (si aún no lo ha hecho) y revise los ámbitos de acceso de OAuth: creación, lectura y eliminación de claves API.
3. A continuación, seleccione los endpoints específicos que planea utilizar para la clave API, aplicando las mismas reglas que para las claves creadas manualmente.
4. La ventana modal mostrará claramente todos los endpoints seleccionados. Si la lista incluye permisos para retiros de fondos, deberá confirmarlos explícitamente marcando la casilla correspondiente antes de continuar.
5. Para todas las autorizaciones OAuth, deberá confirmar sus acciones introduciendo el código 2FA.
6. Tras la verificación correcta mediante MFA, la aplicación intercambiará el código de autorización por un token de acceso OAuth y llamará al endpoint de creación de claves API. La clave secreta de la API se proporciona una sola vez y no puede recuperarse nuevamente.

La implementación de OAuth 2.0 de WhiteBIT admite una amplia gama de endpoints disponibles que pueden solicitarse durante la configuración del cliente, entre ellos:

• Acceso a la información de la cuenta;
• Saldo e historial de transacciones;
• Gestión de órdenes (lectura, creación y eliminación);
• Acceso a datos de mercado;
• Historial de operaciones;
• Y otros permisos de acceso más especializados.

La documentación ampliada también está disponible en el repositorio público de software de GitHub.

Aspectos importantes:

• Una clave por cada combinación plataforma-usuario. Solo se permite una clave API activa creada mediante OAuth para una misma plataforma y un mismo usuario. Si ya existe una clave, no podrá crearse una nueva hasta que la existente sea eliminada.
• Los tokens OAuth tienen una duración limitada. Los tokens de acceso son válidos durante 4 horas y solo pueden utilizarse para crear, gestionar y eliminar claves API, no para operar ni para retirar fondos.
• Las restricciones por direcciones IP se aplican automáticamente. Las claves creadas mediante OAuth están limitadas a los rangos de direcciones IP registrados por la plataforma. No es posible visualizar ni modificar la lista de IP permitidas para estas claves.
• Las claves no pueden modificarse después de su creación. Los endpoints, la lista de IP permitidas y el nombre de la clave no pueden editarse. No se admite la desactivación ni la reactivación; únicamente es posible eliminarlas.
• Condiciones para la eliminación automática: ausencia de actividad API durante 14 días, revocación del acceso por parte de la plataforma, cambio de contraseña de la cuenta o bloqueo de la cuenta por motivos relacionados con AML o cumplimiento normativo.
• El límite global de 50 claves API se aplica tanto a las claves creadas manualmente como a las creadas mediante OAuth.

WhiteBIT Webhook

Un webhook se utiliza para recibir comentarios del servidor sobre la ejecución de varios procesos en su cuenta, como la retirada exitosa de fondos o la activación de un código WB.

Para activar las claves de Webhook, debe seguir pasos similares a los de las claves API en la sección de configuración de Webhook de su cuenta. Hay varias formas de activación:

• Añadir la clave pública al registro de dominio TXT especificado al crear la clave;
• Añadir el archivo “whiteBIT-verification.txt” con el contenido de su clave pública de Webhook a la carpeta raíz de su sitio;
• Crear un endpoint "check-wb-webhooks" en su servidor que devolverá la clave pública del Webhook.
  
   

Para activar una clave de Webhook, debe crearla en el intercambio. Solo puede crear una clave de Webhook. Para hacer esto, siga los pasos a continuación:

• Vaya a la configuración de Webhook en su cuenta y seleccione "Editar" en la sección correspondiente;
• Al igual que con la creación de claves API, guarde la clave secreta en un lugar seguro. Una vez que cierre la página con el botón "Confirmar", la clave secreta ya no estará disponible;
• ¡Hecho! Se crearán claves de webhook.
  
   

Al igual que con las claves API, la creación de una clave Webhook no la habilita automáticamente. Debe mover el control deslizante a la posición activa para activar Webhook.

Puede encontrar información más detallada sobre la configuración y el uso de Webhook en la sección correspondiente de nuestra documentación de Webhook.

Webhook Service Level Agreement (SLA)

El envío continuo de Webhooks requiere que los servidores del cliente funcionen de manera estable y respondan correctamente. En caso de dificultades en el servidor del cliente (funcionamiento lento, falta de respuesta o respuesta incorrecta), se realiza un reenvío del Webhook. Si se acumula un gran número de reenvíos, el sistema se sobrecarga, lo que ralentiza el envío de Webhooks para todos los clientes.

Para resolver estos retrasos y realizar una verificación automática de la calidad del funcionamiento del Webhook del cliente, se ha implementado el SLA (Service Level Agreement). Su principio de funcionamiento consiste en que, si el SLA cae por debajo del nivel establecido (90%), el envío de Webhooks al cliente se desactiva.

Un Webhook se considera no procesado en los siguientes casos:

• la respuesta tarda más de 3 segundos;
• el estado HTTP ≠ 200.

Tenga en cuenta: cada Webhook de este tipo se reenviará hasta 5 veces.

El cálculo del SLA se realiza con la fórmula: SLA = (número de Webhooks exitosos) / (número total de intentos de envío).

Por ejemplo, si en un día se reciben 90 Webhooks exitosos de 100 enviados, el SLA será del 90%.

WebSocket de Best Bid/Ask en Tiempo Real

El acceso a datos de mercado en tiempo real es un requisito fundamental en el trading de alta frecuencia y en los sistemas automatizados de ejecución. Para satisfacer esta necesidad, hemos implementado un flujo dedicado de WebSocket que proporciona actualizaciones en vivo de los mejores precios de compra y venta (bid/ask) para todos los mercados compatibles. Este flujo está optimizado para ofrecer baja latencia y alta fiabilidad, lo que le permite tomar decisiones de trading basadas en información actualizada al instante.

Qué Ofrece Este Flujo

El flujo WebSocket de Mejor Oferta/Demanda proporciona una transmisión continua de datos que refleja los precios más altos de compra y más bajos de venta para cada símbolo. Cada actualización incluye el mejor precio de compra disponible (best bid) y el mejor precio de venta disponible (best ask), junto con las cantidades correspondientes e identificador del par de trading. La estructura está diseñada para entregar solo los datos más relevantes, evitando información innecesaria, pero manteniendo precisión y velocidad.

 

Cada mensaje incluye dos marcas de tiempo para garantizar total transparencia y apoyar operaciones sensibles a la latencia. La primera es la hora del evento (Event Time), que indica el momento en que nuestro servidor WebSocket envía el mensaje. La segunda es la hora de actualización (Update Time), que señala cuándo se modificaron por última vez los datos en el motor de emparejamiento. Este enfoque de doble marca de tiempo le permite calcular con precisión los retrasos en la transmisión y verificar la frescura de los datos. Esta coherencia facilita la integración para quienes ya estén familiarizados con protocolos de datos de mercado similares.

Ventajas Operativas

Este flujo es especialmente adecuado para casos que requieren acceso inmediato a precios precisos, como sistemas de trading automatizados y algoritmos de market making. Le permite mantener una vista en tiempo real de las condiciones del mercado, detectar cambios en el spread y ejecutar operaciones basadas en datos actualizados.

 

Una de las principales ventajas de este flujo es su latencia ultra baja: las actualizaciones se transmiten inmediatamente después de que se registran cambios internos. Esto garantiza que usted opere con la información más reciente posible. Además, el flujo facilita el cálculo del spread y permite un seguimiento eficiente de los niveles de liquidez en la parte superior del libro de órdenes. Al exponer tanto la hora de actualización de los datos como la hora de envío del mensaje, el sistema permite un monitoreo exhaustivo de los retrasos de red y las ventanas de reacción del mercado.

Integración y Estructura del Mensaje

Usted puede conectarse al punto final de WebSocket y suscribirse a las actualizaciones de los pares de trading seleccionados. Cada mensaje se entrega en formato JSON e incluye campos claramente definidos para el símbolo, precios bid y ask, volúmenes correspondientes y las dos marcas de tiempo. El formato es intencionadamente ligero para adaptarse a entornos de alto rendimiento y reducir la complejidad del análisis en su sistema.

 

El flujo WebSocket de Mejor Oferta/Demanda es un componente esencial de la infraestructura para el trading en tiempo real. Le ofrece visibilidad inmediata de los precios más competitivos de compra y venta en el mercado, con información de tiempo precisa. Este flujo está diseñado para apoyar decisiones de trading rápidas, informadas y automatizadas, brindando una base sólida para cualquier estrategia que dependa de los datos del libro de órdenes.

Preguntas frecuentes

¿Qué sucede con las claves API y Webhook cuando la autenticación de dos factores (2FA) está deshabilitada?

• Cuando 2FA está desactivada, sus claves API y Webhook se desactivan y solo se pueden reactivar cuando está activada.
  
   

¿Es posible crear y activar claves API y Webhook a través de la aplicación móvil WhiteBIT?

• Desafortunadamente no. La creación y activación de claves está disponible solo en la versión web de nuestro intercambio.
  
   

¿Las claves API tienen fecha de vencimiento y cuántas se pueden crear?

• Si una clave API permanece inactiva durante 14 días, se desactivará automáticamente por motivos de seguridad. El número máximo de claves disponibles es 50.
  
   

¿Puedo utilizar un dominio aleatorio para probar el rendimiento de las claves de Webhook?

• Nuestro sistema no permite tal acción. Para activar la clave Webhook, debe confirmar la propiedad del dominio.

Posibles errores al usar la API

This action is unauthorized. Enable your key in API settings.

Si te encuentras con este error, comprueba si has activado tu clave API. Para activarla, mueve el control deslizante «Acceso al endpoint» junto al endpoint necesario.

Si anteriormente configuraste una restricción de direcciones IP, tu clave API puede desactivarse al usarla desde una nueva dirección IP. Se enviará un correo electrónico correspondiente a tu dirección de correo.

Atención: si estás seguro de haber usado la clave API desde tu dirección IP, puedes añadirla a la lista de direcciones IP de confianza. Si no reconoces esa dirección IP, deberás crear una nueva clave API.

You don't have permission to use this endpoint. Please contact support for more details.

El endpoint que has utilizado está disponible solo para clientes B2B.

Too many requests.

Si el cuerpo de tu solicitud no contiene el parámetro «nonceWindow», añádelo. En caso de que el error no desaparezca tras añadir este parámetro, deberás crear una nueva clave API.

Si el parámetro «nonceWindow» ya se está utilizando en el cuerpo de tu solicitud, asegúrate de que los valores estén indicados en milisegundos.

The selected ticker is invalid.

El ticker de criptomoneda que introdujiste no es válido. Por favor, verifica que el ticker esté escrito correctamente.

Currency is not depositable/withdrawable.

Los depósitos/retiros de la criptomoneda seleccionada están actualmente cerrados. Las noticias sobre la disponibilidad de depósitos/retiros de criptomonedas se publican en nuestro canal de Telegram.