Crate sharesight_types
source · [−]Structs
Return a report on capital gains tax (for Australian portfolios only)
Creates a new cash account within a portfolio.
Deletes an existing cash account.
Returns details about a cash account including its balance on a specified date.
Creates a new cash transaction within a cash account.
Deletes an existing cash account transaction.
Update an existing cash account transaction.
Returns list of transactions for a cash account.
Updates attributes on an existing cash account.
Returns list of cash accounts for a portfolio. If you want to only access the cash account of one particular portfolios, use https://api.sharesight.com/api/v2/portfolios/:id/cash_accounts.json. The response will be the same.
Access currency definitions
Retrieves the Diversity Report for the underlying portfolio
Returns a specific document.
List all custom (and regular) groups which a user has defined
The Create a holding merge endpoint is designed to record a company merger in the situation where you hold shares in a listed company that is wholly acquired by another listed company.
Update a holding merge.
Returns trade transactions for a holding.
Returns reject trade transactions for the holding.
This takes a Google id token, from an approved mobile app. The token will be validated. If the email matches one registered with Sharesight (as the primary or Google ID email) then an access_token will be returned. Otherwise, a 404 error will be generated.
This takes a Google id token, from an approved mobile app. The token will be validated. A new Sharesight account (with no holdings) will be created. If the email matches one registered with Sharesight (as the primary or Google ID email) then an error will be returned. The access and refresh tokens will be returned. (Note that the user must create a holding before the account becomes useful).
Returns payouts for the user’s holding between the two supplied dates.
Returns payouts for the user’s portfolio between the two supplied dates.
Returns a list of instruments in the current user’s portfolios.
Create a new membership for a user’s portfolio, using an existing user id or by creating a new user (providing email, etc.).
Delete an existing user membership.
Lists memberships for the current user’s portfolios.
Update an existing user membership.
Access information on the current user
Confirm a payout. Tnis can be either a payout based on a company event or a payout based on the payment date of an interest payment.
Creates a new payout for this portfolio.
Deletes a confirmed payout, leaving an unconfirmed payout derived from the linked corporate action. (This is similar to the ‘Reset this payout’) button in the UI). See Reject Payout in order to hide the corporate action altogether.
Rejects an unconfirmed payout (based on a corporate action event). A payout derived from the linked corporate action will no longer appear in the users portfolio. (This is similar to the ‘Reject this Payout’ button in the UI). See Delete Payout in order to delete a confirmed payout.
Returns a specific payout.
Updates a payout with the provided parameters
Retrieves the Performance Report for the underlying portfolio.
Create a new portfolio for the current user.
Delete an existing user portfolio.
Returns list of portfolios for the user.
Returns a single portfolio with settings for the user.
Update an existing portfolio for the user.
Single sign on authorisation. The single sign-on operation returns a URL that will allow the user to login to their Sharesight account without the need to enter their email address and password. The URL is valid for one minute. A single sign-on link or button in your application should be implemented so that the user click initiates this API call and then the URL returned is launched in the user’s browser. A “redirect_to” parameter can be appended to the login url. After successfully been logged in, the user will be then redirected to the specified redirect_to path; example: https://api.sharesight.com/users/sign_in?signon-token=token&redirect_to=/portfolios/1
Confirm a trade. This can be either a trade based on a company event or a sell trade based on the maturity date of an interest instrument.
Reject a trade. This can be either a trade based on a company event or a sell trade based on the maturity date of an interest instrument.
Returns trade transactions for the user’s portfolio between the two supplied dates. If you want to only access the trades of a particular holding, use https://api.sharesight.com/api/v2/holdings/:holding_id/trades.json. The response will be the same.
Create a trade against a Portfolio or an existing Holding.
Deletes a trade
Returns a trade transaction.
Update an existing trade for the user. The trade is identified by the ‘id’. Any parameter supplied will replace that field on the trade. Other fields will remain unchanged.
Return a report on unrealised capital gains tax (for Australian portfolios only)
Retrieves the Valuation Report for the underlying portfolio.