API Deribit

Deribit is een cryptovalutaderivatenplatform dat futures- en optiehandel in Bitcoin en Ethereum aanbiedt.

Ondersteunde API's

WebSocket API: maak verbinding met een websocket-server en biedt realtime marktgegevensupdates, accountwijzigingen en meer.
REST API: stuur HTTP-verzoeken om marktgegevens op te halen, orders te plaatsen, accountgegevens...

Eigenschappen

U kunt de volgende eigenschappen configureren in de Deribit-eigenschap.

ApiKey: u kunt een nieuwe api-key aanvragen in uw Deribit-account, kopieer de waarde gewoon naar deze property. Als de APIKey is ingesteld, zal de client zich tegen de private server authenticeren. Als deze leeg is, zijn alleen publieke channels beschikbaar.
ApiSecret: het is de geheime waarde van de API.
TestNet: indien ingeschakeld, wordt verbinding gemaakt met de Deribit TestNet-omgeving (standaard uitgeschakeld). Handig voor testen zonder echte fondsen te riskeren.
Resubscribe: indien ingeschakeld abonneert de client zich na een herverbinding automatisch opnieuw op de kanalen die actief waren voordat de verbinding werd verbroken (standaard false).

Verbinding

Wanneer de client succesvol verbinding maakt met Deribit-servers, wordt de gebeurtenis OnConnect geactiveerd. Nadat de gebeurtenis OnConnect is geactiveerd, kunt u beginnen met het verzenden en ontvangen van berichten naar/van Deribit-servers. Als u verbinding maakt met het privé-WebSocket-kanaal, moet u wachten totdat de gebeurtenis OnDeribitAuthentication is geactiveerd en controleren of de succesparameter true is, voordat u zich op een privékanaal abonneert.


oClient := TsgcWebSocketClient.Create(nil);
oDeribit := TsgcWS_API_Deribit.Create(nil);
oDeribit.Client := oClient;
oDeribit.Deribit.ApiKey := 'your_api_key';
oDeribit.Deribit.ApiSecret := 'your_api_secret';
oDeribit.Deribit.TestNet := False;
oClient.Active := True;
procedure OnConnect(Connection: TsgcWSConnection);
begin
  DoLog('#Deribit Connected');
end;

Gebeurtenissen

De Deribit-client implementeert de volgende gebeurtenissen om de verbindingsstroom te beheren en gegevens te ontvangen die door de WebSocket-server worden verzonden:

OnConnect: geactiveerd wanneer de websocket-client verbinding maakt met de WebSocket-server.
OnDisconnect: gegenereerd wanneer de WebSocket-client de verbinding verbreekt met de WebSocket-server.
OnDeribitAuthentication: wordt geactiveerd wanneer de client authenticeert tegen de privé-WebSocket-server.
OnDeribitSubscribe: wanneer de client zich abonneert op een websocket-kanaal.
OnDeribitUnSubscribe: wanneer de client zich afmeldt van een websocket-kanaal.
OnDeribitData: wanneer de client gegevens van de server ontvangt.
OnDeribitError: wanneer er een fout optreedt tijdens de Deribit websocket-verbinding.
OnDeribitHTTPException: wanneer er een fout optreedt tijdens het REST-verzoek.

WebSocket API

De websocketfeed biedt realtime marktgegevensupdates voor orders en transacties.

U kunt zich abonneren op de volgende openbare kanalen:

Methode	Beschrijving
SubscribeTicker	Abonneer op de ticker-stream voor een instrument. Geeft realtime prijs- en volumegegevens.
SubscribeTrades	Abonneer u op de stroom van recente transacties voor een instrument.
SubscribeOrderBook	Abonneer u op de orderboekstream. Ondersteunt instelbare groepering, diepteniveaus en updateintervallen.
SubscribeCandle	Abonneer op de candlestick-stream. Ondersteunt meerdere resoluties (bijv. 1, 3, 5, 10, 15, 30, 60, 120, 180, 360, 720, 1D).
SubscribePerpetual	Abonneer op perpetual contract-gegevens voor een instrument. Geeft financieringspercentage en andere perpetual-specifieke informatie.
SubscribeBookChange	Abonneer u op meldingen van orderboekwijzigingen voor een instrument.

U kunt zich abonneren op de volgende privékanalen (vereisen authenticatie):

Methode	Beschrijving
SubscribeOrders	Abonneer u op orderupdates voor een instrument.
SubscribePositions	Abonneer u op positie-updates. Ondersteunt filteren op valuta en instrumentsoort.
SubscribeAccountChanges	Abonneer u op accountsaldowijzigingen voor een valuta.
SubscribeUserTrades	Abonneer op gebruikershandel-updates voor een instrument.

Hieronder vindt u een voorbeeld van het abonneren op websocketkanalen.


procedure OnDeribitAuthentication(Sender: TObject; aSuccess: Boolean; const aError, aRawMessage: string);
begin
  if aSuccess then
  begin
    oDeribit.SubscribeOrders('BTC-PERPETUAL');
    oDeribit.SubscribePositions('BTC');
  end;
end;

REST API

De REST API biedt openbare en privémethoden om gegevens op te vragen van markten, handel, account en portemonnee. Toegang tot de REST API via de eigenschap REST_API van de component.

Marktgegevens (Publiek)

Methode	Beschrijving
GetInstruments	Beschikbare instrumenten ophalen voor een valuta.
GetTicker	Tickergegevens ophalen voor een instrument.
GetOrderBook	Haal het orderboek op voor een instrument.
GetTrades	Haal de meest recente transacties op voor een instrument.
GetCurrencies	Haal de lijst met ondersteunde valuta's op.
GetIndexPrice	Haal de huidige indexprijzen op voor een indexnaam.
GetFundingRateHistory	Haal de financieringsrente-geschiedenis op voor een instrument.
GetFundingRateValue	Haal de huidige financieringsrente op voor een instrument.
GetBookSummaryByCurrency	Boeksamenvattingen ophalen voor alle instrumenten van een valuta.
GetBookSummaryByInstrument	Get book summary for a specifiek instrument.

Handel (Privé)

Methode	Beschrijving
Kopen	Plaats een kooporder. Ondersteunt markt- en limietordertypen.
Verkopen	Plaatst een verkooporder. Ondersteunt markt- en limietordertypen.
CancelOrder	Annuleer een bestaande order op order-ID.
CancelAllOrders	Annuleer alle openstaande orders.
CancelAllByInstrument	Annuleer alle open orders voor een specifiek instrument.
EditOrder	Bewerk een bestaand order (wijzig hoeveelheid of prijs).
GetOpenOrders	Haal de lijst van open orders op voor een valuta.
GetOrderState	Haal de status op van een specifiek order.
GetOrderHistory	Haal de ordergeschiedenis op voor een valuta.

Account (Privé)

Methode	Beschrijving
GetPositions	Haal posities op voor een valuta.
GetAccountSummary	Haal de accountsamenvatting op voor een valuta.
GetSubAccounts	Haal de lijst met subaccounts op.
GetTransactionLog	Haal het transactielogboek op voor een valuta.

Portemonnee (Privé)

Methode	Beschrijving
GetDeposits	De stortingsgeschiedenis voor een valuta ophalen.
GetWithdrawals	Haal de opnamegeschiedenis op voor een valuta.
GetTransfers	Haal de overdrachtsgeschiedenis op voor een valuta.

Hieronder vindt u een voorbeeld van het gebruik van de REST API.


oDeribit := TsgcWS_API_Deribit.Create(nil);
oDeribit.Deribit.ApiKey := 'your_api_key';
oDeribit.Deribit.ApiSecret := 'your_api_secret';
// Get ticker
oDeribit.REST_API.GetTicker('BTC-PERPETUAL');
// Place a buy order
oDeribit.REST_API.Buy('BTC-PERPETUAL', 10, 'market');
// Get account summary
oDeribit.REST_API.GetAccountSummary('BTC');