Crate sharesight_types Copy item path Source Auth AuthWithDetails CapitalGains Return a report on capital gains tax (for Australian portfolios only) CapitalGainsDiscountedCapitalGainDistributionsSuccess CapitalGainsLongTermParcelsSuccess CapitalGainsLossParcelsSuccess CapitalGainsNonDiscountedCapitalGainDistributionsSuccess CapitalGainsParameters CapitalGainsShortTermParcelsSuccess CapitalGainsSuccess CapitalGainsUrlDisplay CashAccountCreate Creates a new cash account within a portfolio. CashAccountCreateCashAccountLinksSuccess CashAccountCreateCashAccountParameters CashAccountCreateCashAccountSuccess CashAccountCreateParameters CashAccountCreateSuccess CashAccountCreateUrlDisplay CashAccountDelete Deletes an existing cash account. CashAccountDeleteParameters CashAccountDeleteUrlDisplay CashAccountShow Returns details about a cash account including its balance on a specified date. CashAccountShowLinksSuccess CashAccountShowParameters CashAccountShowSuccess CashAccountShowUrlDisplay CashAccountTransactionCreate Creates a new cash transaction within a cash account. CashAccountTransactionCreateCashAccountTransactionLinksSuccess CashAccountTransactionCreateCashAccountTransactionSuccess CashAccountTransactionCreateParameters CashAccountTransactionCreateSuccess CashAccountTransactionCreateUrlDisplay CashAccountTransactionDelete Deletes an existing cash account transaction. CashAccountTransactionDeleteParameters CashAccountTransactionDeleteUrlDisplay CashAccountTransactionType CashAccountTransactionUpdate Update an existing cash account transaction. CashAccountTransactionUpdateCashAccountTransactionLinksSuccess CashAccountTransactionUpdateCashAccountTransactionSuccess CashAccountTransactionUpdateParameters CashAccountTransactionUpdateSuccess CashAccountTransactionUpdateUrlDisplay CashAccountTransactionsList Returns list of transactions for a cash account. CashAccountTransactionsListCashAccountTransactionsLinksSuccess CashAccountTransactionsListCashAccountTransactionsSuccess CashAccountTransactionsListLinksSuccess CashAccountTransactionsListParameters CashAccountTransactionsListSuccess CashAccountTransactionsListUrlDisplay CashAccountUpdate Updates attributes on an existing cash account. CashAccountUpdateLinksSuccess CashAccountUpdateParameters CashAccountUpdateSuccess CashAccountUpdateUrlDisplay CashAccountsList 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. CashAccountsListCashAccountsLinksSuccess CashAccountsListCashAccountsSuccess CashAccountsListLinksSuccess CashAccountsListParameters CashAccountsListSuccess Currencies Access currency definitions CurrenciesCurrenciesSuccess CurrenciesSuccess Diversity Retrieves the Diversity Report for the underlying portfolio DiversityGroupsGroupElementsSuccess DiversityGroupsGroupSuccess DiversityGroupsSuccess DiversityParameters DiversitySuccess DiversityUrlDisplay DocumentShow Returns a specific document. DocumentShowParameters DocumentShowSuccess DocumentShowUrlDisplay GroupsList List all custom (and regular) groups which a user has defined GroupsListGroupsSuccess GroupsListSuccess HoldingMergesCreate 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. HoldingMergesCreateHoldingMergeSuccess HoldingMergesCreateHoldingMergeTradesSuccess HoldingMergesCreateParameters HoldingMergesCreateSuccess HoldingMergesCreateUrlDisplay HoldingMergesUpdate Update a holding merge. HoldingMergesUpdateHoldingMergeSuccess HoldingMergesUpdateHoldingMergeTradesSuccess HoldingMergesUpdateParameters HoldingMergesUpdateSuccess HoldingMergesUpdateUrlDisplay HoldingTrades Returns trade transactions for a holding. HoldingTradesApiTransactionSuccess HoldingTradesParameters HoldingTradesRejected Returns reject trade transactions for the holding. HoldingTradesRejectedApiTransactionSuccess HoldingTradesRejectedParameters HoldingTradesRejectedSuccess HoldingTradesRejectedTradesSuccess HoldingTradesRejectedUrlDisplay HoldingTradesSuccess HoldingTradesTradesSuccess HoldingTradesUrlDisplay IdentityByToken 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. IdentityByTokenParameters IdentityByTokenSuccess IdentitySignupByToken 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). IdentitySignupByTokenParameters IdentitySignupByTokenSuccess ListHoldingPayouts Returns payouts for the user’s holding between the two supplied dates. ListHoldingPayoutsLinksSuccess ListHoldingPayoutsParameters ListHoldingPayoutsPayoutsDrpTradeAttributesSuccess ListHoldingPayoutsPayoutsLinksSuccess ListHoldingPayoutsPayoutsSuccess ListHoldingPayoutsSuccess ListHoldingPayoutsUrlDisplay ListPortfolioPayouts Returns payouts for the user’s portfolio between the two supplied dates. ListPortfolioPayoutsLinksSuccess ListPortfolioPayoutsParameters ListPortfolioPayoutsPayoutsDrpTradeAttributesSuccess ListPortfolioPayoutsPayoutsLinksSuccess ListPortfolioPayoutsPayoutsSuccess ListPortfolioPayoutsSuccess ListPortfolioPayoutsUrlDisplay ListUserInstruments Returns a list of instruments in the current user’s portfolios. ListUserInstrumentsInstrumentsSuccess ListUserInstrumentsSuccess MembershipCreate Create a new membership for a user’s portfolio, using an existing user id or by creating a new user (providing email, etc.). MembershipCreateInvitationParameters MembershipCreateInvitationSuccess MembershipCreateLinksSuccess MembershipCreateMembershipParameters MembershipCreateParameters MembershipCreateSuccess MembershipCreateUserParameters MembershipCreateUserSuccess MembershipDelete Delete an existing user membership. MembershipDeleteParameters MembershipDeleteUrlDisplay MembershipList Lists memberships for the current user’s portfolios. MembershipListLinksSuccess MembershipListMembershipsInvitationSuccess MembershipListMembershipsLinksSuccess MembershipListMembershipsSuccess MembershipListMembershipsUserSuccess MembershipListPortfoliosSuccess MembershipListSuccess MembershipUpdate Update an existing user membership. MembershipUpdateInvitationSuccess MembershipUpdateLinksSuccess MembershipUpdateParameters MembershipUpdateSuccess MembershipUpdateUrlDisplay MembershipUpdateUserSuccess MyUser Access information on the current user MyUserSuccess MyUserUserSuccess PayoutConfirm 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. PayoutConfirmParameters PayoutConfirmPayoutDrpTradeAttributesParameters PayoutConfirmPayoutParameters PayoutConfirmPayoutSuccess PayoutConfirmSuccess PayoutCreate Creates a new payout for this portfolio. PayoutCreateParameters PayoutCreatePayoutDrpTradeAttributesParameters PayoutCreatePayoutDrpTradeAttributesSuccess PayoutCreatePayoutLinksSuccess PayoutCreatePayoutParameters PayoutCreatePayoutSuccess PayoutCreateSuccess PayoutDelete 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. PayoutDeleteParameters PayoutDeleteSuccess PayoutDeleteUrlDisplay PayoutReject 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. PayoutRejectParameters PayoutRejectPayoutSuccess PayoutRejectSuccess PayoutShow Returns a specific payout. PayoutShowDrpTradeAttributesSuccess PayoutShowLinksSuccess PayoutShowParameters PayoutShowSuccess PayoutShowUrlDisplay PayoutUpdate Updates a payout with the provided parameters PayoutUpdateDrpTradeAttributesSuccess PayoutUpdateLinksSuccess PayoutUpdateParameters PayoutUpdatePayoutDrpTradeAttributesParameters PayoutUpdatePayoutParameters PayoutUpdateSuccess PayoutUpdateUrlDisplay Performance Retrieves the Performance Report for the underlying portfolio. PerformanceCashAccountsSuccess PerformanceHoldingsSuccess PerformanceParameters PerformanceSubTotalsSuccess PerformanceSuccess PerformanceUrlDisplay PortfolioCreate Create a new portfolio for the current user. PortfolioCreateLinksSuccess PortfolioCreateParameters PortfolioCreatePortfolioParameters PortfolioCreateSuccess PortfolioDelete Delete an existing user portfolio PortfolioDeleteSuccess PortfolioList Returns list of portfolios for the user. If the user owns the portfolio, all the info related to it will be displayed. Otherwise only basic info is returned. PortfolioListLinksSuccess PortfolioListPortfoliosLinksSuccess PortfolioListPortfoliosSuccess PortfolioListSuccess PortfolioShow Returns a single portfolio with settings for the user. PortfolioShowLinksSuccess PortfolioShowSuccess PortfolioUpdate Update an existing portfolio for the user. PortfolioUpdateLinksSuccess PortfolioUpdateParameters PortfolioUpdatePortfolioParameters PortfolioUpdateSuccess RequestSingleSignOn 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 RequestSingleSignOnSuccess TradeConfirm 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. TradeConfirmParameters TradeConfirmSuccess TradeConfirmTradeSuccess TradeReject 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. TradeRejectParameters TradeRejectSuccess TradeRejectTradeSuccess Trades 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. TradesApiTransactionSuccess TradesCreate Create a trade against a Portfolio or an existing Holding. TradesCreateApiTransactionSuccess TradesCreateParameters TradesCreateSuccess TradesCreateTradeParameters TradesCreateTradeSuccess TradesDestroy Deletes a trade TradesDestroyApiTransactionSuccess TradesDestroyParameters TradesDestroySuccess TradesDestroyUrlDisplay TradesParameters TradesShow Returns a trade transaction. TradesShowApiTransactionSuccess TradesShowParameters TradesShowSuccess TradesShowUrlDisplay TradesSuccess TradesTradesSuccess TradesUpdate 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. TradesUpdateApiTransactionSuccess TradesUpdateParameters TradesUpdateSuccess TradesUpdateTradeParameters TradesUpdateTradeSuccess TradesUpdateUrlDisplay TradesUrlDisplay UnrealisedCgt Return a report on unrealised capital gains tax (for Australian portfolios only) UnrealisedCgtLongTermParcelsSuccess UnrealisedCgtLossesSuccess UnrealisedCgtParameters UnrealisedCgtShortTermParcelsSuccess UnrealisedCgtSuccess UnrealisedCgtUrlDisplay Valuation Retrieves the Valuation Report for the underlying portfolio. ValuationCashAccountsSuccess ValuationHoldingsSuccess ValuationParameters ValuationSubTotalsSuccess ValuationSuccess ValuationUrlDisplay ApiHttpMethod CashAccountTransactionTypeName Country Currency Market PayoutDescription SaleAllocationMethod TradeDescription DEFAULT_API_HOST ApiEndpoint