moonstonks-boersenapi v1.4.1

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

async function placeBuyStopMarketOrder(shareId: string, amount: number, stop: number): Promise<Job>;

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

Eine Buy Stop Limit Order stellen

async function placeBuyStopLimitOrder(shareId: string, amount: number, limit: number, stop: number): Promise<Job>;

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

Eine Sell Market Order stellen

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

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

Eine Sell Limit Order stellen

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

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

Eine Sell Stop Market Order stellen

async function placeSellStopMarketOrder(shareId: string, amount: number, stop: number): Promise<Job>;

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

Eine Sell Stop Limit Order stellen

async function placeSellStopLimitOrder(shareId: string, amount: number, limit: number, stop: number): Promise<Job>;

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

Eine Order verwalten

Eine Order abfragen

async function getOrder(orderId: string): Promise<Order>;

orderManager
  .getOrder('orderId')
  .then((order) => console.log('Order', order))
  .catch((error) => console.error(error));

Eine Order löschen

async function deleteOrder(orderId: string): Promise<Job>;

orderManager
  .deleteOrder('orderId')
  .then((job) => console.log('Job', job))
  .catch((error) => console.error(error));

Einen Job löschen

async function deleteJob(jobId: string): Promise<boolean>;

const deleted = await orderManager.deleteJob('jobId');

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

static async function getShares(): Promise<Share[]>;

ShareManager.getShares();

Den aktuellen Kurs eines items erhalten

static async function getPrice(shareId: string): Promise<number>;

ShareManager.getPrice('shareId');

Die Preisentwicklung abrufen

static async function getPrices(shareId: string, options?: PriceOptions): Promise<Price[]>;

ShareManager.getPrices('shareId');
ShareManager.getPrices('shareId', { limit: 10 });
ShareManager.getPrices('shareId', { from: 1616751375000 });
ShareManager.getPrices('shareId', { until: 1616841375000 });
ShareManager.getPrices('shareId', { from: 1616751375000, until: 1616841375000 });
ShareManager.getPrices('shareId', { from: 1616751375000, until: 1616841375000, limit: 10 });

Market

import { MarketManager } from 'moonstonks-api';

Prüfen, ob der Market gerade geöffnet ist

static async function isOpen(): Promise<boolean>;

MarketManager.isOpen();

Prüfen, ob der Market gerade geschlossen ist

static async function isClosed(): Promise<boolean>;

MarketManager.isClosed();

Den aktuellen Status des Markets abrufen

static async function getStatus(): Promise<string>;

MarketManager.getStatus();

Datenmodelle

Order

Job

Share

Price

PriceOptions

Broker

DTOs

PlaceOrderDto

UnqueueJobDto

DeleteOrderDto

OrderCompletedDto

OrderDeletedDto

OrderMatchedDto

// TBC..