README.md

MoonStonks Börsen API

Offizielle API der MoonStonks Börse, um jegliche Art von Order zu stellen.

Installation

npm install moonstonks-boersenapi

oder

yarn add moonstonks-boersenapi

Setup

import { BörsenAPI } from 'moonstonks-boersenapi';

public api = new BörsenAPI('moonstonks token')

Eine Order stellen

Es gibt viele verschiedene Orders, diese können je nach bedarf dynamisch oder statisch gestellt werden. Hierzu gibt es mehrere Methoden, welche über unsere BörsenAPI erreichbar sind.

import { OrderManager } from "moonstonks-boersenapi";

public orderManager = new OrderManager(api, 'onPlace' 'onMatch', 'onComplete', 'onDelete')

Eine Buy Market Order stellen

async function placeBuyMarketOrder(shareId: string, amount: number): Promise<Job>

orderManager.placeBuyMarketOrder("shareId", 20)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Buy Limit Order stellen

async function placeBuyLimitOrder(shareId: string, amount: number, limit: number): Promise<Job>

orderManager.placeBuyLimitOrder("shareId", 20, 200)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Buy Stop Market Order stellen

orderManager.placeBuyStopMarketOrder("shareId", 20, 200, 250)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Buy Stop Limit Order stellen

orderManager.placeBuyStopLimitOrder("shareId", 20, 200, 250, 260)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Sell Market Order stellen

orderManager.placeSellMarketOrder("shareId", 20)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Sell Limit Order stellen

orderManager.placeSellLimitOrder("shareId", 20, 210)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Sell Stop Market Order stellen

orderManager.placeSellStopMarketOrder("shareId", 20, 210, 150)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Eine Sell Stop Limit Order stellen

orderManager.placeSellStopLimitOrder("shareId", 20, 210, 150, 140)
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Shares

Shares sind items, welche in der MoonStonks Börse gehandelt werden können. Hierzu stellt die Börse verschiedene Methoden zur Verfügung, um Informationen wie den aktuellen Kurs, die Preisentwicklung und andere abzurufen.

import { ShareManager } from "moonstonks-boersenapi";

Alle handelbaren Items abrufen

ShareManager.getShares();

Den aktuellen Kurs eines items erhalten

ShareManager.getPrice("shareId");

Die Preisentwicklung abrufen

ShareManager.getPrices("shareId");
ShareManager.getPricesFrom("shareId", from);
ShareManager.getPricesUntil("shareId", until);
ShareManager.getPricesFromUntil("shareId", from, until);

Datenmodelle

Order

Attribut	Type	Beschreibung
id	string	TODO:
shareId	string	TODO:
timestamp	number	TODO:
type	"buy" | "sell"	TODO:
amount	number	TODO:
limit?	number	TODO:
stop?	number	TODO:
stopLimit?	number	TODO:

---

Job

Attribut	Type	Beschreibung
id	string	TODO:
data	{ dto: PlaceOrderDto | DeleteOrderDto, broker: Broker }	TODO:

---

Share

Attribut	Type	Beschreibung
id	string	TODO:
name	string	TODO:
color	string	TODO:
thumbnail	string	TODO:
price	string	TODO:

---

Price

Attribut	Type	Beschreibung
timestamp	number	TODO:
price	number	TODO:

---

Broker

Attribut	Type	Beschreibung
type	'private' | 'business' | 'simulation' | 'stockmarket'	TODO:
displayName	string	TODO:

DTOs

PlaceOrderDto

Attribut	Type	Beschreibung
shareId	string	TODO:
amount	number	TODO:
onPlace	string	TODO:
onMatch	string	TODO:
onComplete	string	TODO:
onDelete	string	TODO:
type	'buy' | 'sell'	TODO:
limit	number	TODO:
stop	number	TODO:
stopLimit	number	TODO:

UnqueueJobDto

Attribut	Type	Beschreibung
jobId	string	TODO:

---

DeleteOrderDto

Attribut	Type	Beschreibung
orderId	string	TODO:

---

// TBC..