stock-api

Stock api project is a backend project used simply to monitor the financial profit loss

• This app requires to sign up the user, currently used only for personal use

• Warning:

  • The database is not a persistent database (currently H2 database)

• In order to access this api, use below end-point to signup

  • This endpoint will store the user info in H2 DB

End-point to signup

## POST
 
/stock-app/signup

• INPUT:
  • Provide username and password in the body of POST request

 {
  "userName":"username",
  "password":"password"
 }

• OUTPUT:
  • Response

{
    "statusMessage": "Welcome <<username>> !!!, successfully signed up. Use API key to generate token.",
    "apiKey": "AA11223344556677BB"
}

Create jwt token to access other end-points

• Once signed up with the user name
• Hit the below end point, to generate the jwt token

## POST 
/stock-app/token

• INPUT:
  • Use signed up username and provided apiKey info in the body of POST request

 {
  "userName":"username",
  "apiKey":"AA11223344556677BB"
 }

• OUTPUT:
  • jwt token in JSON repsonse

{
    "status": "Token generated at 2021-11-12 08:33:58",
    "jwtToken": "xxxx.yyyy.zzzz"
}

To retrieve the API key use username and password, which will also generate jwt token

• Once signed up with the user name
• Hit the below end point, to get the API key and generated jwt token

 ## POST 
/stock-app/apikey

• INPUT:
  • username and password info in the body of POST request

 {
  "userName":"username",
  "password":"password"
 }

• OUTPUT:
  • jwt token in Json repsonse

{
    "status": "Token generated at 2021-11-12 14:17:31",
    "jwtToken": "xxxxx.yyyyy.zzzz",
    "apiKey": "AA11223344556677BB"
}

Adding single stock info

• In order to add stocks to the database use below end-point
  • use the token in the POST request HTTP header like below

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"

## POST
/stock/v1/add

• INPUT:
  • json input to be sent in the body of the POST request
  • use the same structure

{
    "symbol": "GAIN",
    "avgStockPrice": 10.5,
    "stockCount": 10
}

• Output:
  • JSON response after added the stock info to DB

{
    "status": "Successfully added stock",
    "stockInfo": [
        {
            "symbol": "GAIN1",
            "avgStockPrice": 10.5,
            "stockCount": 10.0
        }
    ]
}

In order to add list of stock using json Array

• pass the in JWT token as a Request header as below

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"

## POST request
/stock/v1/add/stocks

• INPUT:
• Pass the below json structure in the body of POST Http request.
• Use the generated JWT token to access the end-point, like below

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"

• NOTE: When there are duplicate symobls, those will NOT be stored to database Consolidate those and submit the request

[
   {
		"symbol": "MSFT",
		"stockCount": "10.0",
		"avgStockPrice": "200.50"
	},
	{
		"symbol": "INTC",
		"stockCount": "5.0",
		"avgStockPrice": "50.00"
    },
	{
		"symbol": "KR",
		"stockCount": "5.0",
		"avgStockPrice": "50.00"
   },
	{
		"symbol": "KR",
		"stockCount": "5.0",
		"avgStockPrice": "50.00"
   }
]

• OUTPUT : Response from the API

{
    "status": "Successfully added stocks - Consolidate duplicate symbols - KR",
    "stockInfo": [{
		"symbol": "MSFT",
		"stockCount": "10.0",
		"avgStockPrice": "200.50"
	 },
	 {
		"symbol": "INTC",
		"stockCount": "5.0",
		"avgStockPrice": "50.00"
     }]
}

To update the list of stock info, either by using the same list with updates on the stock count and stock average price

## PUT 
/stock/v1/update/stocks

• INPUT:
  • Use the generated JWT token to access the end-point, like below

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"

• MSFT (already exists in the system no change); GE (updated with stock count); GM (new stock to be updated)

 [
	{
		"symbol": "MSFT",
		"stockCount": "10.50",
		"avgStockPrice": "150.25"
	},
	{
		"symbol": "GE",
		"stockCount": "10.79",
		"avgStockPrice": "12.55"
	},
	{
		"symbol": "GM",
		"stockCount": "10.796152",
		"avgStockPrice": "10.55"
	}
]

• OUTPUT:

{
    "status": "Successfully updates the stock info",
    "stockInfo": [
        {
            "symbol": "GE",
            "avgStockPrice": 10.79,
            "stockCount": 12.55
        },
        {
            "symbol": "GM",
            "avgStockPrice": 10.796152,
            "stockCount": 10.55
        }
    ]
}

To get the stock details with computed metrics use below end-point

• The list of stock info stored under the specific user will be computed and displayed in the response

• INPUT

  • Pass the JWT token part of the POST request header.

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"  

## POST Endpoint with header Authorization token
/stock/v1/stock-info

• OUTPUT:

{
    "stockInfo": [
        {
            "symbol": "MSFT",
            "currentPrice": 336.06,
            "companyName": "Microsoft Corporation",
            "lastAccessed": "2021-11-07T17:38:31.7269808",
            "currentInvestedAmount": 111.1111,
            "actualInvestedAmount": 222.2222,
            "difference": 111.1111,
            "profitOrLoss": "** Profit **"
        },
        {
            "symbol": "INTC",
            "currentPrice": 50.92,
            "companyName": "Intel Corporation",
            "lastAccessed": "2021-11-07T17:38:31.8349824",
            "currentInvestedAmount": 111.111,
            "actualInvestedAmount": 222.2222,
            "difference": -11.1111,
            "profitOrLoss": "** Loss **"
        }
    ],
    "investedAmount": 1000.500,
    "currentMarketTotalAmount": 5000.000,
    "difference": 4000.500,
    "profitLossStatus": "**PROFIT**",
    "lastAccessed": "2021-11-07T17:38:31.8589826",
    "simpleStatus": "Successfully computed."
}

Endpoint to delete all stocks for specific user

• INPUT
  • Pass the JWT token part of the POST request header.

   Authorization : Bearer xxxxx.yyyy.zzzz
   Content-Type : "application/json"  

## DELETE REQUEST 
/stock/delete/all-symbols/force

Swagger open api v3 - access

• Use the direct url http://infinite-brook-26118.herokuapp.com/swagger-ui.html

Or

• Access end-point with URL - http://<domain>/swagger-ui/index.html
• Once Swagger UI is rendered, input /stockapp
• Most cases the swagger UI will open directly. If prompted provide username & password used during signup.