Skip to main content
Usa la API de Users para buscar usuarios, obtener o actualizar perfiles y comprobar si un usuario tiene acceso a una cuenta, un producto o una experiencia.

Endpoints

Atributos

string
requerido
ID del usuario, con el prefijo user_.
object | null
requerido
El saldo del usuario: efectivo personal + otros activos + depósitos aún en tránsito, más los saldos de las cuentas que posee. Se calcula solo en la vista propia (obtenida con el id reservado me) para quienes llaman con el alcance de lectura de saldo; null en caso contrario, o cuando include_balance=false.

Propiedades

object[]
requerido
Saldos de las cuentas que posee el usuario, de mayor a menor saldo. Excluye las cuentas sin saldo.

Propiedades

string
requerido
El ID de la cuenta, con el formato biz_*************.
string
requerido
El saldo total de la cuenta en USD.
string | null
requerido
La URL del logo de la cuenta.
string | null
requerido
El nombre visible de la cuenta.
string
requerido
Saldo combinado en USD de todas las cuentas que posee el usuario.
object[]
requerido
Saldos de efectivo fiduciario por divisa.

Propiedades

number
requerido
Saldo disponible en la divisa nativa.
number
requerido
Saldo disponible convertido a USD.
string
requerido
Código de divisa ISO en minúsculas, como usd o eur.
number
requerido
Saldo que se está moviendo a la propia billetera o tarjeta del usuario, convertido a USD.
number
requerido
Saldo pendiente convertido a USD.
number | null
requerido
Precio en USD por unidad de la divisa nativa, o null cuando no hay tipo de cambio disponible.
number
requerido
Saldo reservado convertido a USD.
number
requerido
Importe retirable en la divisa nativa.
string
requerido
Efectivo fiduciario en USD, incluidos los importes pendientes, en tránsito y en reserva.
object[]
requerido
Activos cripto por token en la propia billetera del libro mayor.

Propiedades

string
requerido
Importe mantenido en unidades nativas del token, como cadena decimal.
object
requerido
Saldo desglosado en importes disponibles, pendientes, en tránsito y en reserva, como cadenas decimales en unidades nativas. Las transferencias entre la propia billetera y la tarjeta del usuario se informan en in_transit hasta que llegan.

Propiedades

string
requerido
Importe que puedes gastar, enviar o retirar ahora, en unidades nativas, como cadena decimal.
string
requerido
La parte de pending que ya se ha liquidado y está esperando para pasar a la billetera de criptomonedas o a la Whop Card de la cuenta, donde pasa a ser available. El movimiento suele empezar en menos de una hora; mientras se ejecuta, el importe se informa en in_transit. No se incluye el dinero movido solo para recargar el saldo mínimo retenido de la cuenta. En unidades nativas, como cadena decimal.
string
requerido
Importe que se mueve entre los propios destinos de la cuenta, como una recarga de tarjeta. En unidades nativas, como cadena decimal.
string
requerido
Importe de pagos recientes que aún se están liquidando, en unidades nativas, como cadena decimal.
object[]
requerido
Cuándo se espera que se liquide el importe pendiente, una entrada por día, empezando por la más temprana. El dinero sin un día de liquidación programado, incluido finishing_settlement, queda fuera, por lo que estas entradas más finishing_settlement pueden sumar menos que pending, nunca más.

Propiedades

string
requerido
Importe esperado ese día, en unidades nativas, como cadena decimal.
string
requerido
El día en que se espera que este dinero termine de liquidarse, como fecha ISO 8601.
string
requerido
Importe retenido, en unidades nativas, como cadena decimal. Recupera las reservas de la cuenta para saber por qué se retiene y cuándo se libera.
string | null
requerido
URL del icono del token.
string | null
requerido
El nombre visible del token.
number | null
requerido
Precio en USD por token, o null cuando se desconoce.
string
requerido
Símbolo visible del token, como USDT, XAUT o cbBTC.
number
requerido
Valor en USD del activo.
string
requerido
Activos cripto en USD.
string
requerido
Saldos fiduciarios pendientes y en tránsito, más los depósitos de tesorería en curso, en USD.
string
requerido
El saldo personal del usuario en USD: efectivo (disponible + pendiente + en tránsito + reserva) + otros activos + depósitos aún en tránsito. Excluye los saldos de las cuentas (consulta businesses_total_usd).
string
requerido
Movimientos de saldo hacia la billetera del usuario aún en curso, en USD.
object | null
requerido
El saldo acumulado de la billetera del usuario a lo largo del tiempo (puntos en USD \{ t, v } más last/min/max), para el gráfico de saldo. Actívalo con include_balance_history=true al obtenerte a ti mismo con el id reservado me; solo se rellena para quienes llaman con el alcance de lectura de saldo y es null en caso contrario. Un usuario sin actividad en la billetera devuelve una serie vacía.

Propiedades

object[]
requerido
Puntos de saldo acumulado en la ventana solicitada, del más antiguo al más reciente.

Propiedades

integer
requerido
Marca de tiempo del punto, en segundos Unix.
number
requerido
Saldo acumulado de la billetera en este punto, en USD.
number
requerido
Valor del punto más reciente, en USD.
number
requerido
Valor máximo en la ventana, en USD.
number
requerido
Valor mínimo en la ventana, en USD.
object[]
requerido
Los activos personales del usuario, cada uno con su valor en USD y su desglose, con la misma forma que los balances de una cuenta. Vacío cuando total_usd es null.

Propiedades

string
requerido
Importe total mantenido en unidades nativas, como cadena decimal.
object
requerido
Saldo dividido en importes disponibles, pendientes y en reserva, como cadenas decimales en unidades nativas, con los días en que se espera que se liquide el importe pendiente.

Propiedades

string
requerido
Importe que puedes gastar, enviar o retirar ahora, en unidades nativas, como cadena decimal.
string
requerido
La parte de pending que ya se ha liquidado y está esperando para pasar a la billetera de criptomonedas o a la Whop Card de la cuenta, donde pasa a ser available. El movimiento suele empezar en menos de una hora; mientras se ejecuta, el importe se informa en in_transit. No se incluye el dinero movido solo para recargar el saldo mínimo retenido de la cuenta. En unidades nativas, como cadena decimal.
string
requerido
Importe que se mueve entre los propios destinos de la cuenta, como una recarga de tarjeta. En unidades nativas, como cadena decimal.
string
requerido
Importe de pagos recientes que aún se están liquidando, en unidades nativas, como cadena decimal.
object[]
requerido
Cuándo se espera que se liquide el importe pendiente, una entrada por día, empezando por la más temprana. El dinero sin un día de liquidación programado, incluido finishing_settlement, queda fuera, por lo que estas entradas más finishing_settlement pueden sumar menos que pending, nunca más.

Propiedades

string
requerido
Importe esperado ese día, en unidades nativas, como cadena decimal.
string
requerido
El día en que se espera que este dinero termine de liquidarse, como fecha ISO 8601.
string
requerido
Importe retenido, en unidades nativas, como cadena decimal. Recupera las reservas de la cuenta para saber por qué se retiene y cuándo se libera.
string | null
requerido
URL del icono del activo.
string
requerido
El nombre visible del activo
number | null
requerido
Precio en USD por unidad, o null cuando no hay ningún tipo de cambio disponible.
string
requerido
Símbolo visible del activo, como USDT, cbBTC o EUR.
string | null
requerido
Valor en USD del activo, o null cuando no hay ningún tipo de cambio disponible.
object | null
requerido
El contenedor del banner de perfil del usuario. null cuando el usuario no tiene banner.

Propiedades

string
requerido
URL de la imagen del banner de perfil.
string | null
requerido
La biografía del usuario
object | null
requerido
El estado de la solicitud de tarjeta personal del usuario. Solo se rellena en la vista propia (obtenida con el id reservado me) para quienes llaman con el alcance de lectura de saldo; null en caso contrario, o cuando el usuario nunca ha solicitado una tarjeta.

Propiedades

string | null
requerido
Motivo por el que el emisor de la tarjeta rechazó la solicitud. unsupported_state sustituye a unsupported_region para una persona o un negocio verificado en Estados Unidos. compliance abarca las comprobaciones de sanciones, personas expuestas políticamente y medios adversos. other abarca los motivos que no están en esta lista. null cuando status no es denied, o cuando el emisor no rechazó la solicitud.Opciones disponibles: compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
requerido
Si la solicitud de tarjeta verifica un negocio (business, KYB) o una persona (individual, identidad del consumidor). null cuando la solicitud aún no está vinculada a una verificación.Opciones disponibles: individual, business
string
requerido
En qué estado se encuentra la solicitud de tarjeta. approved significa que se pueden emitir tarjetas. needs_verification significa que el solicitante aún no ha completado la verificación de identidad; needs_information significa que sí lo hizo, pero los documentos se rechazaron por un motivo subsanable y deben volver a enviarse. pending y manual_review están en curso. denied, locked y canceled son definitivos.Opciones disponibles: approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
string | null
requerido
La ciudad del usuario, derivada de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string | null
requerido
El país del usuario como código ISO 3166-1 alfa-2, derivado de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string
requerido
Cuándo se creó el usuario, como marca de tiempo ISO 8601
string | null
requerido
La fecha de nacimiento del usuario como fecha ISO 8601, por ejemplo 1998-04-23. Solo se rellena en la vista propia (obtenida con el id reservado me) para quienes llaman con el alcance de lectura de correo electrónico; null en caso contrario, o cuando el usuario no ha establecido una.
object | null
requerido
Los ingresos brutos en USD del usuario a lo largo del tiempo, con un desglose de las comisiones de Partner. Solo se rellena en lecturas propias de un único usuario para quienes llaman con el alcance de lectura de saldo; null en caso contrario.

Propiedades

string | null
requerido
La primera vez que el usuario obtuvo ingresos brutos, como marca de tiempo ISO 8601.
object
requerido
Ingresos brutos de las cuentas que el usuario posee o en las que tiene autorización de propietario.

Propiedades

string
requerido
Ingresos brutos en USD durante las últimas 24 horas.
string
requerido
Ingresos brutos en USD durante los últimos 30 días.
string
requerido
Ingresos brutos en USD durante los últimos 7 días.
string
requerido
Ingresos brutos totales históricos en USD.
object
requerido
Comisiones de Partner abonadas en la billetera del usuario. Los pagos de Partner pendientes se excluyen hasta que se abonan; las reversiones posteriores no reducen los ingresos brutos.

Propiedades

string
requerido
Ingresos brutos en USD durante las últimas 24 horas.
string
requerido
Ingresos brutos en USD durante los últimos 30 días.
string
requerido
Ingresos brutos en USD durante los últimos 7 días.
string
requerido
Ingresos brutos totales históricos en USD.
object
requerido
Ingresos brutos de la billetera personal del usuario.

Propiedades

string
requerido
Ingresos brutos en USD durante las últimas 24 horas.
string
requerido
Ingresos brutos en USD durante los últimos 30 días.
string
requerido
Ingresos brutos en USD durante los últimos 7 días.
string
requerido
Ingresos brutos totales históricos en USD.
object
requerido
Ingresos brutos de la billetera personal del usuario más las cuentas que posee o en las que tiene autorización de propietario.

Propiedades

string
requerido
Ingresos brutos en USD durante las últimas 24 horas.
string
requerido
Ingresos brutos en USD durante los últimos 30 días.
string
requerido
Ingresos brutos en USD durante los últimos 7 días.
string
requerido
Ingresos brutos totales históricos en USD.
string | null
requerido
La dirección de correo electrónico del usuario. Solo se rellena en la vista propia (obtenida con el id reservado me) para quienes llaman con el alcance de lectura de correo electrónico; null en caso contrario, o mientras la cuenta aún no tenga un correo electrónico confirmado.
integer
requerido
El número de usuarios que siguen a este usuario.
object | null
requerido
El Whop Level del usuario, contado en todas las cuentas que posee. current es público. Los campos de puntos y gasto solo se rellenan cuando te obtienes a ti mismo con el id reservado me y tienes el alcance de lectura de saldo. null en las listas y cuando ninguna de sus cuentas está en Whop Levels.

Propiedades

integer
requerido
El nivel que se aplica: el más alto que el usuario alcanzó este mes o en los 5 meses anteriores, de 0 a 10. Público.
integer | null
requerido
Puntos obtenidos este mes en todas las cuentas que posee el usuario, más sus puntos de partner, redondeados hacia abajo. Una cuenta cuyo mes queda en negativo cuenta como cero. null a menos que te obtengas a ti mismo con el id reservado me y tengas el alcance de lectura de saldo.
object | null
requerido
Los puntos de este mes, desglosados según dónde se obtuvieron. Cada fuente es neta de sus reembolsos, por lo que una puede ser negativa. null a menos que te obtengas a ti mismo con el id reservado me y tengas el alcance de lectura de saldo.

Propiedades

integer
requerido
Puntos de los cargos pagados de Whop Ads, netos de reembolsos: 10 por cada dólar, redondeados hacia cero.
integer
requerido
Puntos del gasto capturado con Whop Card, netos de reembolsos: 10 por cada dólar, redondeados hacia cero.
integer
requerido
Puntos de las cuentas que el propietario refirió como socio: 1 por cada 3 que ganen, redondeados hacia cero.
integer
requerido
Puntos del volumen de trading de perpetuos ejecutado a través de Whop: 1 por cada dólar negociado, redondeados hacia cero.
string | null
requerido
Cuándo se restablecen a cero los puntos de este mes, como marca de tiempo ISO 8601. null a menos que te obtengas a ti mismo con el id reservado me y tengas el alcance de lectura de saldo.
string | null
requerido
El nombre visible del usuario
object
requerido
Contenedor del avatar. Su url siempre está presente y es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.

Propiedades

string
requerido
URL de la imagen del avatar. Siempre está presente. Es un marcador de posición generado cuando el usuario no ha definido ninguna imagen.
Las cuentas sociales y los sitios web del perfil público del usuario. Vacío cuando el usuario no tiene ninguno.

Propiedades

string
requerido
La URL del enlace.
string | null
requerido
El identificador del usuario en la plataforma, tal como se introdujo o como lo informa la cuenta conectada. null para enlaces sin identificador, como un sitio personal.
boolean
requerido
Si Whop verificó que el usuario es el propietario de la cuenta.
string
requerido
La plataforma a la que apunta el enlace. website es un sitio personal en lugar de una plataforma social.Opciones disponibles: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website
string | null
requerido
El estado o la región del usuario, derivado de su dirección IP. null cuando se desconoce o el usuario desactivó el uso compartido de la ubicación.
string | null
requerido
Valor total en USD de los activos personales del usuario en balances, entre los que tienen tipos de cambio conocidos. Se calcula solo en la vista propia (obtenida con el id reservado me) para quienes llaman con el alcance de lectura de saldo; null en caso contrario, cuando include_balance=false o cuando la fuente del saldo no está disponible.
trading_account | null
requerido
La dirección de la cuenta de trading, una instantánea de su margen y de sus posiciones abiertas, y sus suscripciones de WebSocket. Actívalo con include_trading=true al obtener me. null en caso contrario, sin permiso de trading o sin una billetera de Ethereum.

Propiedades

string
requerido
El ID de la billetera de Whop que respalda esta cuenta de trading, con el prefijo cwal_.
string | null
requerido
La cuenta propietaria de esta cuenta de trading, con el prefijo biz_. null cuando la posee un usuario.
object | null
requerido
Estado específico de Hyperliquid. Presente cuando provider es hyperliquid; en caso contrario, null.

Propiedades

string
requerido
Dirección de billetera en minúsculas que contiene la cuenta de Hyperliquid.
string | null
requerido
USDT0 en la billetera de Whop en Plasma que una operación deposit puede mover a esta cuenta, como cadena decimal. null cuando no se pudo leer la cadena.
object | null
requerido
Valor de la cuenta y margen en el exchange principal y en los mercados xyz, leídos de Hyperliquid como máximo una vez por segundo. null cuando no se pudo leer Hyperliquid. Usa websocket_subscriptions para recibir actualizaciones en tiempo real.

Propiedades

object
requerido
Valor total de la cuenta en USD, incluidas las ganancias y pérdidas no realizadas.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Margen asignado a las posiciones abiertas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Valor nocional combinado de las posiciones abiertas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
USD que se pueden retirar ahora sin cerrar posiciones.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
trading_position[] | null
requerido
Posiciones perpetuas abiertas en el exchange principal y en los mercados xyz, leídas de Hyperliquid como máximo una vez por segundo. null cuando no se pudo leer Hyperliquid. Usa websocket_subscriptions para recibir actualizaciones en tiempo real.

Propiedades

string
requerido
ID de la posición de trading, con el prefijo trdpos_. Estable para un mercado dentro de una cuenta de trading.
object | null
requerido
Precio de entrada medio en USD, o null cuando el proveedor lo omite.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Detalles del perpetuo de Hyperliquid. Presente en las posiciones de Hyperliquid; en caso contrario, null.

Propiedades

object
requerido
Funding pagado por la posición en varios periodos, en USD.

Propiedades

object | null
requerido
Funding pagado en este mercado a lo largo del historial de la cuenta, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Funding pagado desde el último cambio de tamaño de la posición, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object | null
requerido
Funding pagado desde que se abrió la posición, en USD, o null cuando no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Modo de margen y multiplicador de la posición.

Propiedades

string
requerido
cross comparte el margen entre posiciones. isolated limita el margen a esta posición.Opciones disponibles: cross, isolated
integer
requerido
Multiplicador aplicado al margen de la posición, como 10 para 10x.
object | null
requerido
Precio de liquidación estimado en USD, o null cuando Hyperliquid no informa de ninguno.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Margen asignado a la posición, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Rentabilidad sobre el capital como cadena de ratio decimal, como 0.1 para el 10 %.
string
requerido
Símbolo del mercado en el proveedor, como ETH.
string
requerido
object
requerido
Valor actual de la posición en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Opciones disponibles: long, short
string
requerido
Tamaño absoluto de la posición como cadena decimal.
object
requerido
Ganancia o pérdida no realizada en USD. Negativa en caso de pérdida.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object[]
requerido
Suscripciones para recibir actualizaciones de la cuenta en tiempo real. Envía cada message sin cambios después de conectarte a websocket_url.

Propiedades

string
requerido
El flujo de actualizaciones en tiempo real que abre esta suscripción.Opciones disponibles: clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
requerido
Mensaje de suscripción JSON que se debe enviar sin cambios por el WebSocket de Hyperliquid.
string
requerido
URL del WebSocket de Hyperliquid a la que conectarse directamente para recibir actualizaciones en tiempo real.
string
requerido
string
requerido
Plataforma de trading que contiene las posiciones y las órdenes.Opciones disponibles: hyperliquid
object | null
requerido
Activos al contado en la billetera de Whop con su precio de entrada y sus ganancias y pérdidas. null cuando no se pudo leer.

Propiedades

object[]
requerido
Cada activo al contado que la billetera aún contiene, con su precio de entrada medio y sus ganancias y pérdidas. La base de coste considera que las unidades más antiguas se venden primero e incluye los activos que llegaron desde fuera de Whop.

Propiedades

object | null
requerido
El precio medio pagado por unidad de lo que aún se mantiene, en USD, considerando que las unidades más antiguas se venden primero. null cuando no se conoce.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Lo que se pagó en USD por las unidades que aún se mantienen.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
El id del mercado al contado de GET /trades/markets, como BTC, XAUT o el ticker de una acción tokenizada, como AAPL.
object
requerido
Ganancias y pérdidas ya consolidadas mediante ventas, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
El valor de las unidades que aún se mantienen menos su cost_basis, en USD.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
number | null
requerido
unrealized_pnl como porcentaje de cost_basis, donde 2 significa una subida del 2 %. null cuando no se conoce.
string | null
requerido
El usuario propietario de esta cuenta de trading, con el prefijo user_. null cuando la posee una cuenta.
string
requerido
El nombre de usuario único del usuario
object
requerido
Estado de verificación de identidad de los perfiles individual (KYC) y business (KYB) del usuario. Cada uno es null hasta que se crea; en caso contrario, tiene un status de not_started, pending, approved o rejected.
string | null
requerido
Cuándo recibió el usuario una insignia de verificado, como marca de tiempo ISO 8601. null cuando el usuario no está verificado.
string | null
requerido
Cuándo se inscribió el usuario como Whop Partner, como marca de tiempo ISO 8601. null si nunca se inscribió.
integer | null
requerido
Número de cuentas que el usuario refirió a Whop como Whop Partner y que han procesado más de $1 en volumen atribuido al usuario. Solo se rellena al obtener un único usuario que sea Verified Whop Partner; null en caso contrario.
string | null
requerido
Cuándo se convirtió el usuario en Verified Whop Partner, como marca de tiempo ISO 8601. null para los usuarios que no son Verified Whop Partners, incluidos los partners que abandonaron el programa y los usuarios suspendidos.
User