Skip to main content
Utilisez l’API Utilisateurs pour rechercher des utilisateurs, récupérer ou mettre à jour des profils, et vérifier si un utilisateur a accès à un compte, un produit ou une expérience.

Endpoints

Attributs

string
requis
ID de l’utilisateur, préfixé par user_.
object | null
requis
Le solde de l’utilisateur : liquidités personnelles + autres avoirs + dépôts encore en cours, plus les soldes des comptes qu’il possède. Calculé uniquement sur la vue de soi (récupérée avec l’ID réservé me) pour les appelants disposant de la portée de lecture du solde ; null sinon, ou lorsque include_balance=false.

Propriétés

object[]
requis
Soldes des comptes que l’utilisateur possède, du solde le plus élevé au plus faible. Exclut les comptes sans solde.

Propriétés

string
requis
L’ID du compte, qui ressemble à biz_*************.
string
requis
Le solde total du compte en USD.
string | null
requis
L’URL du logo du compte.
string | null
requis
Le nom d’affichage du compte.
string
requis
Solde combiné en USD de tous les comptes que l’utilisateur possède.
object[]
requis
Soldes de liquidités en monnaie fiduciaire, par devise.

Propriétés

number
requis
Solde disponible dans la devise native.
number
requis
Solde disponible converti en USD.
string
requis
Code de devise ISO en minuscules, tel que usd ou eur.
number
requis
Solde en cours de transfert vers le portefeuille ou la carte de l’utilisateur, converti en USD.
number
requis
Solde en attente converti en USD.
number | null
requis
Prix en USD par unité de devise native, ou null lorsqu’aucun taux de change n’est disponible.
number
requis
Solde réservé converti en USD.
number
requis
Montant retirable dans la devise native.
string
requis
Liquidités en monnaie fiduciaire en USD, y compris les montants en attente, en transit et en réserve.
object[]
requis
Avoirs en cryptomonnaies par jeton dans le portefeuille propre du registre.

Propriétés

string
requis
Montant détenu en unités natives du jeton, sous forme de chaîne décimale.
object
requis
Solde réparti en montants disponibles, en attente, en transit et en réserve, sous forme de chaînes décimales en unités natives. Les transferts entre le portefeuille et la carte de l’utilisateur sont indiqués dans in_transit jusqu’à leur arrivée.

Propriétés

string
requis
Montant que vous pouvez dépenser, envoyer ou retirer dès maintenant, en unités natives, sous forme de chaîne décimale.
string
requis
La partie de pending qui est déjà réglée et attend d’être transférée vers le portefeuille crypto du compte ou la Whop Card, où elle devient available. Le transfert commence généralement dans l’heure ; pendant son exécution, le montant est indiqué dans in_transit à la place. Les fonds transférés uniquement pour compléter le solde minimum conservé du compte ne sont pas inclus. En unités natives, sous forme de chaîne décimale.
string
requis
Montant en cours de transfert entre les propres destinations du compte, comme un rechargement de carte. En unités natives, sous forme de chaîne décimale.
string
requis
Montant des paiements récents encore en cours de règlement, en unités natives, sous forme de chaîne décimale.
object[]
requis
Date à laquelle le montant en attente devrait être réglé, une entrée par jour, la plus proche en premier. Les fonds sans jour de règlement prévu, y compris finishing_settlement, sont exclus ; ces entrées plus finishing_settlement peuvent donc totaliser moins que pending, jamais plus.

Propriétés

string
requis
Montant attendu ce jour-là, en unités natives, sous forme de chaîne décimale.
string
requis
Le jour où ces fonds devraient finir d’être réglés, sous forme de date ISO 8601.
string
requis
Montant retenu, en unités natives, sous forme de chaîne décimale. Récupérez les réserves du compte pour savoir pourquoi il est retenu et quand il sera débloqué.
string | null
requis
URL de l’icône du jeton.
string | null
requis
Le nom d’affichage du jeton.
number | null
requis
Prix en USD par jeton, ou null s’il est inconnu.
string
requis
Symbole d’affichage du jeton, tel que USDT, XAUT ou cbBTC.
number
requis
Valeur de l’avoir en USD.
string
requis
Avoirs en cryptomonnaies en USD.
string
requis
Soldes en monnaie fiduciaire en attente et en transit, plus les dépôts de trésorerie en cours, en USD.
string
requis
Le solde personnel de l’utilisateur en USD : liquidités (disponibles + en attente + en transit + réserve) + autres avoirs + dépôts encore en cours. Exclut les soldes des comptes (voir businesses_total_usd).
string
requis
Transferts de solde vers le portefeuille de l’utilisateur encore en cours, en USD.
object | null
requis
Le solde cumulé du portefeuille de l’utilisateur au fil du temps (points USD \{ t, v } plus last/min/max), pour le graphique du solde. Activez-le avec include_balance_history=true lorsque vous vous récupérez vous-même avec l’ID réservé me ; renseigné uniquement pour les appelants disposant de la portée de lecture du solde et null sinon. Un utilisateur sans activité de portefeuille renvoie une série vide.

Propriétés

object[]
requis
Points de solde cumulé sur la période demandée, du plus ancien au plus récent.

Propriétés

integer
requis
Horodatage du point, en secondes Unix.
number
requis
Solde cumulé du portefeuille à ce point, en USD.
number
requis
Valeur du point le plus récent, en USD.
number
requis
Valeur maximale sur la période, en USD.
number
requis
Valeur minimale sur la période, en USD.
object[]
requis
Les avoirs personnels de l’utilisateur, chacun avec sa valeur en USD et sa répartition, sous la même forme que les balances d’un compte. Vide lorsque total_usd est null.

Propriétés

string
requis
Montant total détenu en unités natives, sous forme de chaîne décimale.
object
requis
Solde réparti en montants disponibles, en attente et en réserve, sous forme de chaînes décimales en unités natives, avec les jours où le montant en attente devrait être réglé.

Propriétés

string
requis
Montant que vous pouvez dépenser, envoyer ou retirer dès maintenant, en unités natives, sous forme de chaîne décimale.
string
requis
La partie de pending qui est déjà réglée et attend d’être transférée vers le portefeuille crypto du compte ou la Whop Card, où elle devient available. Le transfert commence généralement dans l’heure ; pendant son exécution, le montant est indiqué dans in_transit à la place. Les fonds transférés uniquement pour compléter le solde minimum conservé du compte ne sont pas inclus. En unités natives, sous forme de chaîne décimale.
string
requis
Montant en cours de transfert entre les propres destinations du compte, comme un rechargement de carte. En unités natives, sous forme de chaîne décimale.
string
requis
Montant des paiements récents encore en cours de règlement, en unités natives, sous forme de chaîne décimale.
object[]
requis
Date à laquelle le montant en attente devrait être réglé, une entrée par jour, la plus proche en premier. Les fonds sans jour de règlement prévu, y compris finishing_settlement, sont exclus ; ces entrées plus finishing_settlement peuvent donc totaliser moins que pending, jamais plus.

Propriétés

string
requis
Montant attendu ce jour-là, en unités natives, sous forme de chaîne décimale.
string
requis
Le jour où ces fonds devraient finir d’être réglés, sous forme de date ISO 8601.
string
requis
Montant retenu, en unités natives, sous forme de chaîne décimale. Récupérez les réserves du compte pour savoir pourquoi il est retenu et quand il sera débloqué.
string | null
requis
URL de l’icône de l’avoir.
string
requis
Le nom d’affichage de l’avoir
number | null
requis
Prix en USD par unité, ou null lorsqu’aucun taux de change n’est disponible.
string
requis
Symbole d’affichage de l’avoir, tel que USDT, cbBTC ou EUR.
string | null
requis
Valeur de l’avoir en USD, ou null lorsqu’aucun taux de change n’est disponible.
object | null
requis
L’objet contenant la bannière de profil de l’utilisateur. null lorsque l’utilisateur n’a pas de bannière.

Propriétés

string
requis
URL de l’image de la bannière de profil.
string | null
requis
La biographie de l’utilisateur
object | null
requis
L’état de la demande de carte personnelle de l’utilisateur. Renseigné uniquement sur la vue de soi (récupérée avec l’ID réservé me) pour les appelants disposant de la portée de lecture du solde ; null sinon, ou lorsque l’utilisateur n’a jamais demandé de carte.

Propriétés

string | null
requis
Raison pour laquelle l’émetteur de la carte a refusé la demande. unsupported_state remplace unsupported_region pour une personne ou une entreprise vérifiée aux États-Unis. compliance couvre les contrôles de sanctions, de personnes politiquement exposées et de presse défavorable. other couvre les raisons qui ne figurent pas dans cette liste. null lorsque status n’est pas denied, ou lorsque l’émetteur n’a pas refusé la demande.Options disponibles : compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
requis
Indique si la demande de carte vérifie une entreprise (business, KYB) ou une personne (individual, identité du consommateur). null lorsque la demande n’est pas encore liée à une vérification.Options disponibles : individual, business
string
requis
L’état de la demande de carte. approved signifie que des cartes peuvent être émises. needs_verification signifie que le demandeur n’a pas encore terminé la vérification d’identité ; needs_information signifie qu’il l’a terminée, mais que les documents ont été rejetés pour une raison corrigeable et doivent être soumis à nouveau. pending et manual_review sont en cours. denied, locked et canceled sont définitifs.Options disponibles : approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
string | null
requis
La ville de l’utilisateur, déduite de son adresse IP. null lorsqu’elle est inconnue ou que l’utilisateur a désactivé le partage de localisation.
string | null
requis
Le pays de l’utilisateur sous forme de code ISO 3166-1 alpha-2, déduit de son adresse IP. null lorsqu’il est inconnu ou que l’utilisateur a désactivé le partage de localisation.
string
requis
Date de création de l’utilisateur, sous forme d’horodatage ISO 8601
string | null
requis
La date de naissance de l’utilisateur sous forme de date ISO 8601, comme 1998-04-23. Renseignée uniquement sur la vue de soi (récupérée avec l’ID réservé me) pour les appelants disposant de la portée de lecture de l’e-mail ; null sinon, ou lorsque l’utilisateur ne l’a pas renseignée.
object | null
requis
Le revenu brut de l’utilisateur en USD au fil du temps, y compris une répartition des commissions Partner. Renseigné uniquement lors de la lecture de soi pour un seul utilisateur, pour les appelants disposant de la portée de lecture du solde ; null sinon.

Propriétés

string | null
requis
La première fois que l’utilisateur a perçu un revenu brut, sous forme d’horodatage ISO 8601.
object
requis
Revenu brut provenant des comptes que l’utilisateur possède ou sur lesquels il dispose d’une autorisation de propriétaire.

Propriétés

string
requis
Revenu brut en USD sur les dernières 24 heures.
string
requis
Revenu brut en USD sur les 30 derniers jours.
string
requis
Revenu brut en USD sur les 7 derniers jours.
string
requis
Revenu brut total en USD depuis l’origine.
object
requis
Commissions Partner créditées sur le portefeuille de l’utilisateur. Les versements Partner en attente sont exclus jusqu’à leur crédit ; les annulations ultérieures ne réduisent pas le revenu brut.

Propriétés

string
requis
Revenu brut en USD sur les dernières 24 heures.
string
requis
Revenu brut en USD sur les 30 derniers jours.
string
requis
Revenu brut en USD sur les 7 derniers jours.
string
requis
Revenu brut total en USD depuis l’origine.
object
requis
Revenu brut provenant du portefeuille personnel de l’utilisateur.

Propriétés

string
requis
Revenu brut en USD sur les dernières 24 heures.
string
requis
Revenu brut en USD sur les 30 derniers jours.
string
requis
Revenu brut en USD sur les 7 derniers jours.
string
requis
Revenu brut total en USD depuis l’origine.
object
requis
Revenu brut provenant du portefeuille personnel de l’utilisateur plus les comptes qu’il possède ou sur lesquels il dispose d’une autorisation de propriétaire.

Propriétés

string
requis
Revenu brut en USD sur les dernières 24 heures.
string
requis
Revenu brut en USD sur les 30 derniers jours.
string
requis
Revenu brut en USD sur les 7 derniers jours.
string
requis
Revenu brut total en USD depuis l’origine.
string | null
requis
L’adresse e-mail de l’utilisateur. Renseignée uniquement sur la vue de soi (récupérée avec l’ID réservé me) pour les appelants disposant de la portée de lecture de l’e-mail ; null sinon, ou tant que le compte n’a pas encore d’e-mail confirmé.
integer
requis
Le nombre d’utilisateurs qui suivent cet utilisateur.
object | null
requis
Le Whop Level de l’utilisateur, calculé sur l’ensemble des comptes qu’il possède. current est public. Les champs de points et de dépenses sont renseignés uniquement lorsque vous vous récupérez vous-même avec l’ID réservé me et disposez de la portée de lecture du solde. null dans les listes, et lorsqu’aucun de ses comptes ne participe aux Whop Levels.

Propriétés

integer
requis
Le niveau applicable : le plus élevé atteint par l’utilisateur ce mois-ci ou au cours des 5 mois précédents, de 0 à 10. Public.
integer | null
requis
Points gagnés ce mois-ci sur l’ensemble des comptes que l’utilisateur possède, plus ses points partenaire, arrondis à l’inférieur. Un compte dont le solde net du mois est inférieur à zéro compte pour zéro. null sauf si vous vous récupérez vous-même avec l’ID réservé me et disposez de la portée de lecture du solde.
object | null
requis
Les points de ce mois-ci, répartis selon leur provenance. Chaque source est nette de ses remboursements, elle peut donc être négative. null sauf si vous vous récupérez vous-même avec l’ID réservé me et disposez de la portée de lecture du solde.

Propriétés

integer
requis
Points provenant des frais Whop Ads payés, nets des remboursements : 10 par dollar, arrondis vers zéro.
integer
requis
Points provenant des dépenses Whop Card capturées, nettes des remboursements : 10 par dollar, arrondis vers zéro.
integer
requis
Points provenant des comptes que le propriétaire a parrainés en tant que partenaire : 1 pour 3 gagnés par ces comptes, arrondis vers zéro.
integer
requis
Points provenant du volume de trading de contrats perpétuels exécuté via Whop : 1 par dollar échangé, arrondis vers zéro.
string | null
requis
Date à laquelle les points de ce mois-ci sont remis à zéro, sous forme d’horodatage ISO 8601. null sauf si vous vous récupérez vous-même avec l’ID réservé me et disposez de la portée de lecture du solde.
string | null
requis
Le nom d’affichage de l’utilisateur
object
requis
L’objet contenant l’avatar. Son url est toujours présente et correspond à une image de remplacement générée lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image de remplacement générée lorsque l’utilisateur n’a défini aucune photo.
Les comptes de réseaux sociaux et les sites web affichés sur le profil public de l’utilisateur. Vide lorsque l’utilisateur n’en a aucun.

Propriétés

string
requis
L’URL du lien.
string | null
requis
L’identifiant de l’utilisateur sur la plateforme, tel que saisi ou tel que fourni par le compte connecté. null pour les liens sans identifiant, comme un site personnel.
boolean
requis
Indique si Whop a vérifié que l’utilisateur possède le compte.
string
requis
La plateforme vers laquelle pointe le lien. website désigne un site personnel plutôt qu’une plateforme sociale.Options disponibles : x, instagram, facebook, tiktok, youtube, linkedin, twitch, website
string | null
requis
L’État ou la région de l’utilisateur, déduit de son adresse IP. null lorsqu’il est inconnu ou que l’utilisateur a désactivé le partage de localisation.
string | null
requis
Valeur totale en USD des avoirs personnels de l’utilisateur dans balances, pour ceux dont le taux de change est connu. Calculée uniquement sur la vue de soi (récupérée avec l’ID réservé me) pour les appelants disposant de la portée de lecture du solde ; null sinon, lorsque include_balance=false, ou lorsque la source du solde est indisponible.
trading_account | null
requis
L’adresse du compte de trading, un instantané de sa marge et de ses positions ouvertes, et ses abonnements WebSocket. Activez-le avec include_trading=true lors de la récupération de me. null sinon, sans autorisation de trading, ou sans portefeuille Ethereum.

Propriétés

string
requis
L’ID du portefeuille Whop associé à ce compte de trading, préfixé par cwal_.
string | null
requis
Le compte propriétaire de ce compte de trading, préfixé par biz_. null lorsqu’il appartient à un utilisateur.
object | null
requis
État spécifique à Hyperliquid. Présent lorsque provider vaut hyperliquid, sinon null.

Propriétés

string
requis
Adresse de portefeuille en minuscules qui détient le compte Hyperliquid.
string | null
requis
USDT0 dans le portefeuille Whop sur Plasma qu’une transaction deposit peut transférer vers ce compte, sous forme de chaîne décimale. null lorsque la chaîne n’a pas pu être lue.
object | null
requis
Valeur du compte et marge sur la plateforme d’échange principale et les marchés xyz, lues depuis Hyperliquid au plus une fois par seconde. null lorsque Hyperliquid n’a pas pu être lu. Utilisez websocket_subscriptions pour les mises à jour en direct.

Propriétés

object
requis
Valeur totale du compte en USD, y compris les profits et pertes latents.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Marge allouée aux positions ouvertes, en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Valeur notionnelle combinée des positions ouvertes, en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
USD pouvant être retirés dès maintenant sans clôturer de positions.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
trading_position[] | null
requis
Positions perpétuelles ouvertes sur la plateforme d’échange principale et les marchés xyz, lues depuis Hyperliquid au plus une fois par seconde. null lorsque Hyperliquid n’a pas pu être lu. Utilisez websocket_subscriptions pour les mises à jour en direct.

Propriétés

string
requis
ID de la position de trading, préfixé par trdpos_. Stable pour un marché au sein d’un même compte de trading.
object | null
requis
Prix d’entrée moyen en USD, ou null lorsque le fournisseur ne l’indique pas.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object | null
requis
Détails du contrat perpétuel Hyperliquid. Présent sur les positions Hyperliquid, sinon null.

Propriétés

object
requis
Financement payé sur la position sur plusieurs périodes, en USD.

Propriétés

object | null
requis
Financement payé sur ce marché sur l’ensemble de l’historique du compte, en USD, ou null lorsqu’il n’est pas disponible.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object | null
requis
Financement payé depuis la dernière modification de la taille de la position, en USD, ou null lorsqu’il n’est pas disponible.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object | null
requis
Financement payé depuis l’ouverture de la position, en USD, ou null lorsqu’il n’est pas disponible.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Mode de marge et multiplicateur de la position.

Propriétés

string
requis
cross partage la marge entre les positions. isolated limite la marge à cette position.Options disponibles : cross, isolated
integer
requis
Multiplicateur appliqué à la marge de la position, par exemple 10 pour 10x.
object | null
requis
Prix de liquidation estimé en USD, ou null lorsque Hyperliquid n’en indique aucun.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Marge allouée à la position, en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string
requis
Rendement des capitaux propres sous forme de chaîne de ratio décimal, par exemple 0.1 pour 10 %.
string
requis
Symbole du marché chez le fournisseur, par exemple ETH.
string
requis
object
requis
Valeur actuelle de la position en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string
requis
Options disponibles : long, short
string
requis
Taille absolue de la position sous forme de chaîne décimale.
object
requis
Profit ou perte latent en USD. Négatif en cas de perte.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object[]
requis
Abonnements pour les mises à jour en direct du compte. Envoyez chaque message tel quel après vous être connecté à websocket_url.

Propriétés

string
requis
Le flux de mises à jour en direct qu’ouvre cet abonnement.Options disponibles : clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
requis
Message d’abonnement JSON à envoyer tel quel via le WebSocket Hyperliquid.
string
requis
URL du WebSocket Hyperliquid à laquelle se connecter directement pour les mises à jour en direct.
string
requis
string
requis
Plateforme de trading qui détient les positions et les ordres.Options disponibles : hyperliquid
object | null
requis
Avoirs au comptant dans le portefeuille Whop avec leur prix d’entrée et leurs profits et pertes. null lorsqu’ils n’ont pas pu être lus.

Propriétés

object[]
requis
Chaque actif au comptant que le portefeuille détient encore, avec son prix d’entrée moyen et ses profits et pertes. Le prix de revient considère que les unités les plus anciennes sont vendues en premier et inclut les actifs provenant de l’extérieur de Whop.

Propriétés

object | null
requis
Le prix moyen payé par unité pour ce qui est encore détenu, en USD, en considérant que les unités les plus anciennes sont vendues en premier. null lorsqu’il n’est pas connu.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
Le montant payé en USD pour les unités encore détenues.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
string
requis
L’id du marché au comptant provenant de GET /trades/markets, tel que BTC, XAUT, ou le symbole d’une action tokenisée tel que AAPL.
object
requis
Gains et pertes déjà réalisés par la vente, en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
object
requis
La valeur des unités encore détenues moins leur cost_basis, en USD.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transfert.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Le nombre de décimales du montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Le nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est prélevé en centavos mais exprimé en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre selon votre propre locale.
number | null
requis
unrealized_pnl en pourcentage de cost_basis, où 2 signifie une hausse de 2 %. null lorsqu’il n’est pas connu.
string | null
requis
L’utilisateur propriétaire de ce compte de trading, préfixé par user_. null lorsqu’il appartient à un compte.
string
requis
Le nom d’utilisateur unique de l’utilisateur
object
requis
Statut de vérification d’identité des profils individual (KYC) et business (KYB) de l’utilisateur. Chacun vaut null jusqu’à sa création, sinon un status parmi not_started, pending, approved ou rejected.
string | null
requis
Date à laquelle l’utilisateur a reçu un badge vérifié, sous forme d’horodatage ISO 8601. null lorsque l’utilisateur n’est pas vérifié.
string | null
requis
Date à laquelle l’utilisateur est devenu un Whop Partner inscrit, sous forme d’horodatage ISO 8601. null s’il ne s’est jamais inscrit.
integer | null
requis
Nombre de comptes que l’utilisateur a parrainés sur Whop en tant que Whop Partner et qui ont traité plus de 1 $ de volume attribué à l’utilisateur. Renseigné uniquement lors de la récupération d’un seul utilisateur qui est un Verified Whop Partner ; null sinon.
string | null
requis
Date à laquelle l’utilisateur est devenu un Verified Whop Partner, sous forme d’horodatage ISO 8601. null pour les utilisateurs qui ne sont pas des Verified Whop Partners, y compris les partenaires ayant quitté le programme et les utilisateurs suspendus.
User