Der lemon.markets Postman Workspace 📮

Joanne Snel8. Dezember 2021

Insights

Eine einfache Option, die lemon.markets API zu testen, ist die Postman Plattform. Mit Postman kannst Du API Calls direkt in Deinem Browser oder Deiner Desktop App durchführen. Dadurch weißt Du bereits bevor Du Dein Brokerage Produkt erstellt hast, was alles möglich ist. Wir haben einen lemon.markets Postman Workspace eingerichtet, in dem Du Dich mit den Endpunkten vertraut machen kannst, die wir in unseren Marktdaten und Trading APIs anbieten. Du wirst sehen, wie einfach es ist, z.B. einen Trade mit lemon.markets zu platzieren (Hinweis: es ist nur ein API Call).

Warum Postman? 📯

Postman ist eine einfach zu bedienende Anwendung, mit der Du eine API testen kannst, ohne manuell ein Test Environment einzurichten. Alles, was man tun muss, ist die Request URL zu spezifizieren, sich anhand eines API Keys autorisieren und die relevanten Query/Request Body Parameter einfügen. Zum Glück haben wir für Dich bereits einen lemon.markets Postman Workspace mit allen Requests eingerichtet. Du musst ihn nur noch forken, Deinen API Key eingeben und mit dem Senden von Requests beginnen.

Postman benutzen 👨 

Den lemon.markets Postman Workspace findest Du hier. Für den persönlichen Gebrauch musst Du den Workspace in Dein eigenes Postman Konto importieren. Schauen wir uns an, wie das geht!

Den Workspace forken 🍴

Wir gehen davon aus, dass Du bereits ein Postman Konto hast. Falls nicht, kannst Du es ganz einfach hier einrichten. Da der Workspace öffentlich ist, musst Du ihn in Deinen eigenen Workspace umwandeln, um Requests senden zu können.

Um unseren Workspace zu forken, klicke auf "..." neben der Sammlung Deiner Wahl und wähle "Create a fork".

Du musst der Fork einen Namen geben und einen Workspace auswählen, in den sie kopiert werden soll. Du kannst einen separaten Workspace für lemon.markets erstellen oder ihn einfach in den deinen Default Workspace kopieren.

Um Requests zu senden, musst Du mehrere Environment Variablen einrichten - wir haben dafür eine Vorlage erstellt (die Du auf dieselbe Weise forken kannst).

Die Environment Vorlagen findest Du auf der linken Seite unter dem Tab, Überraschung: "Environments".

Wir haben eine Vorlage für das Paper Money Trading und das Real Money Trading bereitgestellt. Vergewisse Dich, dass Du das Environment in denselben Workspace wie Deine geforkte Sammlung forkst.

Konfigurieren der Umgebung 🌳 

Um Dein Environment einzurichten, musst Du Deinen lemon.markets API Key eingeben (diesen findest Du in Deinem Dashboard). Da Dein Workspace nur für Dich zugänglich ist, spielt es keine Rolle, ob Du ihn unter "Initial Value" oder "Current Value" eingibst. Als “best practice” solltest Du sensible Informationen allerdings immer unter "Current Value" eingeben. Dadurch wird verhindert, dass die Informationen mit dem Postman Workspace synchronisiert werden (besonders wichtig, wenn Du in einem (halb-)öffentlichen Workspace arbeitest).

Dass Du Dich in Deinem geforkten Workspace befindest, erkennst Du an dem Ψ neben dem Environment Namen - ich habe meinen Fork 'lemon_tutorial' genannt.

Vergewissere Dich, dass Du alle Änderungen speicherst (obere rechte Ecke) und das Environment aktivierst, indem Du mit dem Mauszeiger über den Namen fährst und auf das Häkchen klickst, das grau werden sollte, wenn Du erfolgreich warst.

Wenn Du Deinen API Key und Dein Environment richtig eingerichtet hast, sollte das Environment in der oberen rechten Ecke erscheinen (wie im Screenshot unten zu sehen). Wenn Du bei dem Tab "Autorisierung" über eine der beiden Sammlungen navigierst, sollte der von Dir eingegebene Key angezeigt werden, wenn Du den Mauszeiger über {{API-KEY}} bewegst.

Wenn Du Deinen API Key nicht sehen kannst, stell sicher, dass Dein Environment gespeichert und aktiviert wurde (wenn Du mehr als ein Environment hast, musst Du sie möglicherweise manuell in der oberen rechten Ecke auswählen).

Sende Deinen ersten Request ❓

Die API Response kannst Du in der Konsole unten sehen, nachdem Du auf den blauen Button "Send" geklickt hast. Auf dem Screenshot ist mein "Postman Space" zu sehen, den ich am 24. November 2021 erstellt habe.

Du kannst auch Query Parameter in Deinem Request angeben. In diesem Fall kannst Du nach Paper Money und Real Money Spaces filtern. Dazu musst Du nur den "type" Key umschalten, einen Wert eingeben und den Request erneut ausführen. Mehr dazu im nächsten Abschnitt. 👇

Andere wichtige Überlegungen 🤔

Um den lemon.markets Workspace optimal nutzen zu können, empfehlen wir Dir die folgenden Tipps:

Einige Endpunkte, z. B. der Endpunkt /ohlc/ in unserer historische Marktdaten API, haben erforderliche Query Parameter. Für alle Query Parameter, die erforderlich sind, haben wir den Workspace so konfiguriert, dass der Parameter automatisch umgeschaltet wird (gekennzeichnet durch das markierte Kästchen). Ob es sich um einen optionalen oder einen erforderlichen Parameter handelt, ist auch in der Beschreibung zu finden. Darüber hinaus erfordern einige Requests auch Path Variablen als Eingabe - diese sind unter den Query Parametern aufgeführt (sie können in der Request-URL durch ein ':' erkannt werden). Wenn sie angegeben sind, sind sie immer erforderlich.

Beachte, dass "isin" der einzige erforderliche Query Parameter für diesen Endpunkt ist. Wir müssen auch die Path Variable "x1" angeben, um diesen Request zu senden.

Andere Endpunkte erfordern einen Request Body. Du erkennst dies an den grünen Punkten neben der Kopfzeile unterhalb der Request-URL. Für den Endpunkt /orders/ in unserer Trading API siehst Du beispielsweise den grünen Punkt neben "Body", was bedeutet, dass wir hier Informationen eingeben müssen. Hier gibt es eine Menge erforderlicher Variablen! Ich habe unten einige Beispielwerte eingegeben.

Auf dem obigen Screenshot siehst Du, dass ich eine Kauf Order für 2 Coinbase Aktien erteilt habe.

Alle anderen Requests folgen einem ähnlichen Format - bei einigen musst Du sowohl die Variablen "Params" als auch "Body" ausfüllen. Immer schön nach diesen grünen Punkten Ausschau halten!

Du bist bereit, alles Weitere auf eigene Faust zu erkunden! Wie wäre es, wenn Du versuchst, eine Order zu platzieren und zu aktivieren? Und dann einen Blick auf Deine Position wirfst? Schau Dir gerne auch unsere Dokumentation an, um zu sehen, was möglich ist.

Over to you! 🤝

Wir wollen wissen, wie wir diese Sammlung noch besser machen können! Wenn Dir irgendwelche Verbesserungen einfallen, zögere nicht, uns über Twitter, Instagram oder Slack zu kontaktieren. Und denk daran, wenn Du Dich noch nicht bei lemon.markets angemeldet hast, tu das jetzt, um Deine Reise in das automatisierte Trading zu starten.

Joanne von lemon.markets🍋