API Bitmex

Bitmex

 

Bitmex is a cryptocurrency exchange and derivative trading platform.

 

De volgende API's worden ondersteund:

 

1. WebSocket-streams: hiermee kunt u zich abonneren op bepaalde methoden en gegevens in realtime ontvangen. Gebeurtenissen worden door de server naar abonnees gepusht. Gebruikt WebSocket als protocol.
2. REST API: clients kunnen markt- en accountgegevens van de server opvragen. Vereist een API-sleutel en geheim voor authenticatie en gebruikt HTTPs als protocol.

 

Eigenschappen

De Bitmex API heeft 2 soorten methoden: openbaar en privé. Openbare methoden zijn toegankelijk zonder authenticatie, bijvoorbeeld: tickerprijzen opvragen. Sommige zijn privé en gerelateerd aan gebruikersgegevens; die methoden vereisen het gebruik van Bitmex API-sleutels.

 

• ApiKey: u kunt een nieuwe API-sleutel aanvragen in uw Bitmex-account; kopieer de waarde naar deze eigenschap.
• ApiSecret: het geheim van de API, houd dit veilig.
• TestNet: indien ingeschakeld, maakt dit verbinding met het Bitmex-demoaccount (standaard false).
• HTTPLogOptions: slaat een logboek van HTTP-verzoeken op in een tekstbestand
  • Enabled: indien ingeschakeld, worden alle HTTP-verzoeken van de WebSocket API opgeslagen.
  • FileName: volledig pad van de bestandsnaam waar logboeken worden opgeslagen

 

 

Meest voorkomende gebruiksgevallen

• WebSockets API
  • Verbinding maken met de WebSocket API
  • Abonneren op een WebSocket-kanaal

• REST API

  • Een Bitmex-order plaatsen

 

WebSocket API

 

  Subscribe / Unsubscribe

    

BitMEX staat toe om u te abonneren op realtime gegevens. Deze toegang is niet snelheidsbeperkt na verbinding en is de beste manier om de meest actuele gegevens naar uw programma's te krijgen. In sommige onderwerpen kunt u een Symbol doorgeven om gebeurtenissen op symbool te filteren, bijvoorbeeld: trades, quotes...

 

De volgende abonnementsonderwerpen zijn beschikbaar zonder authenticatie:

 

• btmAnnouncement: Site-aankondigingen

• btmChat: Trollbox-chat

• btmConnected: Statistieken van verbonden gebruikers/bots

• btmFunding: Updates van swap-financieringstarieven. Elke financieringsinterval verzonden (gewoonlijk 8 uur)

• btmInstrument: Instrumentupdates inclusief omzet en bied/laat

• btmInsurance: Dagelijkse updates van het Verzekeringsfonds

• btmLiquidation: Liquidatieorders zoals ze in het boek worden ingevoerd

• btmOrderBookL2_25: Bovenste 25 niveaus van het niveau 2-orderboek

• btmOrderBookL2: Volledig niveau 2-orderboek

• btmOrderBook10: Top 10 niveaus met traditionele volledige boekpush

• btmPublicNotifications: Systeembrede meldingen (gebruikt voor kortdurende berichten)

• btmQuote: Hoogste niveau van het boek

• btmQuoteBin1m: 1-minuut quote-bins

• btmQuoteBin5m: 5-minuten offertebins

• btmQuoteBin1h: Quote-bins van 1 uur

• btmQuoteBin1d: koersbins van 1 dag

• btmSettlement: Afrekeningen

• btmTrade: Live transacties

• btmTradeBin1m: handelsbins van 1 minuut

• btmTradeBin5m: handelsbins van 5 minuten

• btmTradeBin1h: handelsbins van 1 uur

• btmTradeBin1d: handelsbakken van 1 dag

 

De volgende onderwerpen vereisen verificatie:

 

• btmAffiliate: Affiliatestatus, zoals totaal aantal doorverwezen gebruikers & uitbetalingspercentage

• btmExecution: Individuele uitvoeringen; meerdere per order mogelijk

• btmOrder: Live-updates over uw orders

• btmMargin: Updates over uw huidige accountsaldo en margeverplichtingen

• btmPosition: Updates over uw posities

• btmPrivateNotifications: Individuele meldingen - momenteel niet gebruikt

• btmTransact: Deposit/Withdrawal updates

• btmWallet: Bitcoin-adressaldogegevens, inclusief totale stortingen & opnames

 

 

Voorbeeld van ontvangen berichten:

 

{
      "table":"orderBookL2_25",
      "keys":["symbol","id","side"],
      "types":{"id":"long","price":"float","side":"symbol","size":"long","symbol":"symbol"}
      "foreignKeys":{"side":"side","symbol":"instrument"},
      "attributes":{"id":"sorted","symbol":"grouped"},
      "action":"partial",
      "data":[
        {"symbol":"XBTUSD","id":17999992000,"side":"Sell","size":100,"price":80},
        {"symbol":"XBTUSD","id":17999993000,"side":"Sell","size":20,"price":70},
        {"symbol":"XBTUSD","id":17999994000,"side":"Sell","size":10,"price":60},
        {"symbol":"XBTUSD","id":17999995000,"side":"Buy","size":10,"price":50},
        {"symbol":"XBTUSD","id":17999996000,"side":"Buy","size":20,"price":40},
        {"symbol":"XBTUSD","id":17999997000,"side":"Buy","size":100,"price":30}
      ]
}
 
{
      "table":"orderBookL2_25",
      "action":"update",
      "data":[
        {"symbol":"XBTUSD","id":17999995000,"side":"Buy","size":5}
      ]
    }
{
      "table":"orderBookL2_25",
      "action":"delete",
      "data":[
        {"symbol":"XBTUSD","id":17999995000,"side":"Buy"}
      ]
}
{
      "table":"orderBookL2_25",
      "action":"insert",
      "data":[
        {"symbol":"XBTUSD","id":17999995500,"side":"Buy","size":10,"price":45},
      ]
}

Authenticatie

    

Als u zich wilt abonneren op gebruikersvergrendelde streams, moet u zich eerst verifiëren. Houd er rekening mee dat ongeldige authenticatie de verbinding sluit.

 

Voor gebruik van de BitMEX API is een API-sleutel vereist.

 

Permanente API-keys kunnen worden vergrendeld op IP-adresbereiken en naar believen worden ingetrokken zonder uw hoofdcredentials in gevaar te brengen. Ze hoeven ook niet te worden vernieuwd.

 

Om API-sleutelverificatie te gebruiken, moet u een API-sleutel genereren in uw account.

 

Call method Authenticate before subscribing to elk Authenticated Onderwerp.

CancelAllAfter (Dead Man's Switch)

The CancelAllAfter method implements the Dead Man's Switch feature. When called with a time-out value (in milliseconds), it instructs de server to cancel alle open orders if geen subsequent CancelAllAfter call is received within the time-out period. This is nuttig to ensure orders are geannuleerd in case of network verbreking.

REST API

 

Methode	Beschrijving
GetExecutions	Dit retourneert alle onbewerkte transacties, inclusief het openen en annuleren van orders, en wijzigingen in de orderstatus.
GetExecutionsTradeHistory	This returns more focused Transactions.
GetInstruments	Dit retourneert alle instrumenten en indices, inclusief die welke zijn afgewikkeld of van de lijst zijn verwijderd. Gebruik dit eindpunt als u wilt zoeken naar afzonderlijke instrumenten of een complexe filter wilt toepassen.
GetOrders	Om alleen open orders op te halen
PlaceOrder	Plaats een onbewerkt order met behulp van het TsgcHTTPBitmexOrder-object.
PlaceMarketOrder	Plaats een nieuwe MARKET-order.
PlaceLimitOrder	Plaats een nieuwe LIMIT-order.
PlaceStopOrder	Place a nieuw STOP order.
PlaceStopLimitOrder	Plaats een nieuwe STOPLIMIT-order.
AmendOrder	Wijzig een bestaande order.
CancelOrder	Annuleert een actieve order.
CancelAllOrders	Annuleer alle actieve orders.
CancelAllOrdersAfter	Annuleer alle orders na enige tijd.
ClosePosition	Sluit een open positie.
GetOrderBook	Huidig orderboek ophalen in verticaal formaat
GetPosition	Uw posities ophalen.
SetPositionIsolate	Schakel geïsoleerde marge of cross-marge per positie in.
SetPositionLeverage	Kies hefboom per positie.
SetPositionRiskLimit	Werk uw risicobegrenzing bij.
SetPositionTransferMargin	Eigen vermogen in of uit een positie overdragen.
GetQuotes	Offertes ophalen
GetTrades	Get Trades
GetFunding	Financieringsgegevens ophalen.
GetInsurance	Verzekeringsfondgegevens ophalen.
GetTradeBucketed	Haal bucketgegevens op voor transacties (OHLCV) met configureerbare bingroottes.
GetQuoteBucketed	Gebundelde koersgegevens ophalen met configureerbare bin-groottes.
GetSettlement	Afwikkelingsgegevens ophalen.
GetLiquidation	Liquidatieorders ophalen.
GetInstrumentIndices	Haal instrumentindices op.
GetInstrumentCompositeIndex	Samengestelde indexgegevens ophalen voor instrumenten.
GetStats	Haal beurs-brede statistieken op.
GetStatsHistory	Historische uitwisselingsstatistieken ophalen.
GetStatsHistoryUSD	Historische USD-wisselstatistieken ophalen.
GetUserMargin	Haal uw accountmargegegevens op.
GetUserWallet	Haal uw walletinformatie op.
GetUserWalletHistory	Haal uw walletransactiehistorie op.
GetUserWalletSummary	Een samenvatting van uw portemonnee ophalen.