Skip to content
Rachel Hamilton edited this page May 12, 2022 · 2 revisions

TradeSim - AiPi

Compiled by Rachel Hamilton using information from all other team members


Introduction

The purpose of the following documentation is to provide an overview of the TradeSim system. Our role is to build a TradeSim system that will be responsible for containing all information for a user to customize their own mini-ETF and set their own rules. The user will be able to track how well their mini-ETF is doing, and use this to decide where they want to invest their real money in the future. The goal is to create a system that will consist of a user's customized account, to help the user construct a portfolio of stocks, and define rules on how they should be traded to mimic an index tracking ETF by creating their own mini-ETF. The result will show the user how much capital they'll need to invest in the various stocks to make their own “mini-ETF” competitive against the established ETF on the market. The user is able to download these rules to a file, so they can use them for future reference when investing with their real money.


SRS do

SRS_AiPi-2.pdf cument

Overleaf link: https://www.overleaf.com/read/hpfwzjkwsynx


Functional Requirements

FR.1. A user should be able to define the rules against which the system should trade (including the amount to be invested). Our team's rules consist of the following:

FR.1.1. The system must allow the user to request certain companies by name or ticker.

  • FR.1.1.1. The system must allow the user to set a percentage in their specified company they want to invest in.

FR.1.2.The system must allow the user to request a percentage in a specific sector by name or ticker.

  • FR.1.2.1. The system must allow the user to set a percentage in their specified sector they want to invest in.

FR.1.3. The system must allow the user to request percentage in a specific industry by name or ticker.

  • FR.1.3.2. The system must allow the user to select a specific percentage in their specified industry they want to invest in.

FR.1.4. The system must allow the user to request a minimum amount of companies they want to invest in.
FR.1.5. The system must allow the user to set a balance period. (A balance threshold percentage).
FR.1.6. The system must allow the user to set a time period in which it must reconsider its stocks.
FR.1.7. The system must allow the user to define a percentage that a stock can drop before the ETF sells the stock automatically.
FR.1.8. The system must allow the user to set the market cap min and max values.
FR.1.9. The system must allow the user to set the earnings min and max value.
FR.1.10. The system must allow the user to set an amount to invest.
FR.1.11. The system must allow the user to reject specific companies by name or ticker.
FR.1.12. The system must allow the user to reject specific sectors by name or ticker.
FR.1.13. The system must allow the user to reject specific industries by name or ticker.
FR.1.14. The system must allow the user to invest in companies based in specific countries.

  • FR.1.14.1. The system must allow the user to set a percentage based on a country of a specific company.

FR.1.15. The system must allow the user to reject companies based in specific countries.
FR.1.16. The system must allow the user to minimize and maximize the price for shares.

FR.2. The system must apply the rules against historic market data.
FR.3. The system must compare the performance of the mini-ETF against other indexes in the market.
FR.4. The system must allow the user to be able to save their rules and also test these different rules against each other.


Use-Case Diagram

tender_3

Non-Functional Requirements

  1. The basic design of the TradeSim system should have a look that aligns with the UI of a trading web app.
  1. Data integrity

The TradeSim user must have access to certain information such as their rules created, that must remain private. This information cannot be leaked and should only be accessed by the TradeSim user.

  1. Security

Certain information on the users TradeSim account that needs to remain private, for the user's eyes only, can not be accessed by anyone else unless they login to their TradeSim account.

  1. Performance

All the features of the TradeSim system must function as expected according to the information and requirements given by the project owners.

Clone this wiki locally