Skip to content

API Spec for implementing any broker with AURUM 🤑

Notifications You must be signed in to change notification settings

stoqey/aurum-broker-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AURUM BROKER SPEC

NPM

This is for any one that wants to create a Broker provider for Aurum, you can also use it as a guide when using any aurum-based broker.

Features:

  • Broker events
  • Broker methods

Broker methods

Method Description
init Important method called to start start the broker, it's recommended to call this method after all events have been registered
getAccountSummary should return account details like accountId, account balance e.t.c
getOpenOrders Get all open order, not including filled orders
getAllPositions Get all portfolios that are currently invested in
enterPosition Start a new position/portfolio
exitPosition Exit an existing position
searchSymbol Search for a symbol
quoteSymbol Get quote
getMarketData Get historical data
getPriceUpdate Get realtime price updates
getScreener Get screener method

Broker events

onReady

this method should be called when broker is ready to accept/process requests.

onReady: (data: any) => Promise<any>;

onPortfolios

Called when portfolios change/requested, the application developer should save portfolios from this, because there is no guarantee that the broker saved, or worse-case e.g like when disconnected from broker e.t.c

onPortfolios: (portfolios: any[]) => Promise<any>;

onOrder

Called when an action has been made on a order, order status updated, filled, or returned when order lists are requested.

// order for buy/sell trades
onOrder: (order: any) => Promise<any>;

onMarketData

Returns historical data from calling getMarketData method

onMarketData: (data: any) => Promise<any>;

onPriceUpdate

Streams real-time price updates from any symbols added for watch list

onPriceUpdate: (data: any) => Promise<any>;

Changelog

23-05-2020 Version 0.0.8

  • Add getScreener to broker
  • Optional startDate

Current implementations

STOQEY INC