PaperTrade 1.1.0

A .NET wrapper for Paper Trade's simulated investment portfolio API.  Invest in the stock market with fake money.

Install-Package PaperTrade -Version 1.1.0
dotnet add package PaperTrade --version 1.1.0
<PackageReference Include="PaperTrade" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PaperTrade --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Place this at the top of your code to import the PaperTrade namespace:

using PaperTrade;

Creating a new portfolio

First we must create a new simulated investing portfolio. The "CreatePortfolioAsync" method will asynchronously create a new simulated portfolio and return to you the portfolio ID (a GUID). Keep this in a safe place as it will be used for every other method and cannot be recovered if lost! The parameter of this method is your name, the owner of the portfolio.

string PortfolioId = await PaperTradeHelper.CreatePortfolioAsync("JohnDoe");
Console.WriteLine("Your portfolio ID is '" + PortfolioId + "'.");
Console.ReadLine();

Adding cash to your portfolio

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.EditCashAsync(1500f);

Purchasing one share of Microsoft stock

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.BuyStockAsync("MSFT", 1);

Selling one share of Amazon stock

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.SellStockAsync("AMZN", 1);

Calculate the net gain/loss of your portfolio

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
float profit = await pth.CalculateNetProfitAsync();

List your holdings

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
EquityHolding[] holdings = await pth.ListHoldingsAsync();
foreach (EquityHolding holding in holdings)
{
            Console.WriteLine(holding.Symbol + " - " + holding.Quantity.ToString("#,##0"));
}

Get your available cash balance

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
float CashAvailable = await pth.GetCashBalanceAsync();

Place this at the top of your code to import the PaperTrade namespace:

using PaperTrade;

Creating a new portfolio

First we must create a new simulated investing portfolio. The "CreatePortfolioAsync" method will asynchronously create a new simulated portfolio and return to you the portfolio ID (a GUID). Keep this in a safe place as it will be used for every other method and cannot be recovered if lost! The parameter of this method is your name, the owner of the portfolio.

string PortfolioId = await PaperTradeHelper.CreatePortfolioAsync("JohnDoe");
Console.WriteLine("Your portfolio ID is '" + PortfolioId + "'.");
Console.ReadLine();

Adding cash to your portfolio

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.EditCashAsync(1500f);

Purchasing one share of Microsoft stock

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.BuyStockAsync("MSFT", 1);

Selling one share of Amazon stock

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
await pth.SellStockAsync("AMZN", 1);

Calculate the net gain/loss of your portfolio

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
float profit = await pth.CalculateNetProfitAsync();

List your holdings

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
EquityHolding[] holdings = await pth.ListHoldingsAsync();
foreach (EquityHolding holding in holdings)
{
            Console.WriteLine(holding.Symbol + " - " + holding.Quantity.ToString("#,##0"));
}

Get your available cash balance

PaperTradeHelper pth = new PaperTradeHelper("a9fc4317-4329-48b8-ae6f-807fcf6c3b93");
float CashAvailable = await pth.GetCashBalanceAsync();

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.0 123 2/20/2020