Navigator Actions / Deeplinks

The InvestSuite SDK supports deep linking to navigate directly to specific screens within the SDK. You can use the navigateTo handover method to navigate to any supported screen using a deeplink path string.

Usage¶

Using the `navigateTo` Handover¶

Call the navigateTo method on the HandoversToFlutterService with a deeplink path:

AndroidiOSReact NativeWeb ReactWeb Angular

val request = HandoversToFlutterServiceOuterClass.NavigateToRequest.newBuilder()
    .setDeeplink("/self/portfolio/PORTFOLIO_123/more")
    .build()

InvestSuiteEmbedding.instance().handoversToFlutterService().navigateTo(request)

Task {
    var request = NavigateToRequest()
    request.deeplink = "/self/portfolio/PORTFOLIO_123/more"

    let clientRequest = FlutterEmbeddingGRPCCore.ClientRequest<NavigateToRequest>(message: request)
    try await InvestSuiteEmbedding.shared.handoversToFlutterService().navigateTo(request: clientRequest)
}

const request = NavigateToRequest.create({ 
    deeplink: '/self/portfolio/PORTFOLIO_123/more' 
});
await handoversToFlutterServiceClient.navigateTo(request);

const request = NavigateToRequest.create({ 
    deeplink: '/self/portfolio/PORTFOLIO_123/more' 
});
await handoversToFlutterServiceClient.navigateTo(request);

const request = NavigateToRequest.create({ 
    deeplink: '/self/portfolio/PORTFOLIO_123/more' 
});
await this.handoversToFlutterServiceClient.navigateTo(request);

Path Parameters¶

Deeplink paths use the following parameter placeholders:

Parameter	Description	Example
`:portfolioId`	The unique identifier of a portfolio	`PORTFOLIO_123`
`:instrumentId`	The unique identifier of an instrument	`INSTR_456`
`:watchlistId`	The unique identifier of a watchlist	`WATCHLIST_789`
`:listId`	The unique identifier of an inspiration list	`LIST_001`
`:tradeTicketId`	The unique identifier of a trade ticket	`TICKET_123`
`:documentId`	The unique identifier of a document	`DOC_456`
`:fromDate`	Start date for date range (format: YYYY-MM-DD)	`2024-01-01`
`:toDate`	End date for date range (format: YYYY-MM-DD)	`2024-12-31`
`:type`	Transaction type	`ORDER`
`:transactionId`	The unique identifier of a transaction	`TXN_789`

Portfolio Status

The SDK only supports navigation to ACTIVE portfolios.

It is the responsibility of the client to ensure that only deeplinks for ACTIVE portfolios are used. An active portfolio is one that has status == "ACTIVE" AND archived == false.

Navigating to a portfolio in a different state will result in a loading state being shown.

Available Deeplinks¶

General / App-Level¶

Deeplink	Description
`/`	Home screen
`/login`	Login screen
`/redirect`	Redirect screen
`/welcome`	Welcome screen
`/menu/settings`	Settings menu
`/menu/settings/app-language`	Language settings
`/menu/settings/cookie-preferences`	Cookie preferences
`/accept-cookies`	Accept cookies screen
`/accept-cookies/cookie-preferences`	Cookie preferences from accept cookies
`/agreements/external/result`	External agreements result
`/unsigned-transactions`	Unsigned transactions list
`/unsigned-transactions/:type/:transactionId`	Specific unsigned transaction

Robo Investor¶

Discovery¶

Deeplink	Description
`/robo/discovery`	Robo discovery/onboarding

Portfolio Results¶

Deeplink	Description
`/robo/portfolio/:portfolioId/results/return`	Portfolio returns tab
`/robo/portfolio/:portfolioId/results/value`	Portfolio value tab
`/robo/portfolio/:portfolioId/results/details`	Portfolio details tab

Portfolio Composition¶

Deeplink	Description
`/robo/portfolio/:portfolioId/composition/assetallocation`	Asset allocation view
`/robo/portfolio/:portfolioId/composition/regions`	Regional distribution view
`/robo/portfolio/:portfolioId/composition/sectors`	Sector distribution view

Portfolio History¶

Deeplink	Description
`/robo/portfolio/:portfolioId/history/activity`	Activity history
`/robo/portfolio/:portfolioId/history/funding`	Funding history
`/robo/portfolio/:portfolioId/history/costs`	Costs history

Deeplink	Description
`/robo/portfolio/:portfolioId/menu`	Portfolio menu
`/robo/portfolio/:portfolioId/menu/edit`	Edit portfolio
`/robo/portfolio/:portfolioId/menu/documents`	Documents list
`/robo/portfolio/:portfolioId/menu/documents/account-statements`	Account statements
`/robo/portfolio/:portfolioId/menu/documents/account-statements/:fromDate/:toDate`	Account statements for date range
`/robo/portfolio/:portfolioId/menu/documents/:documentId`	Specific document
`/robo/portfolio/:portfolioId/menu/your-stories`	Your stories
`/robo/portfolio/:portfolioId/menu/your-stories/story/:documentId`	Specific story

Self Investor¶

Portfolio Composition¶

Deeplink	Description
`/self/portfolio/:portfolioId/composition`	Portfolio composition overview
`/self/portfolio/:portfolioId/composition/instrument/:instrumentId`	Instrument details
`/self/portfolio/:portfolioId/composition/instrument/:instrumentId/yourposition`	Your position in instrument
`/self/portfolio/:portfolioId/composition/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket for position
`/self/portfolio/:portfolioId/composition/instrument/:instrumentId/yourposition/dividend`	Dividend information
`/self/portfolio/:portfolioId/composition/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket
`/self/portfolio/:portfolioId/composition/search`	Search instruments
`/self/portfolio/:portfolioId/composition/search/instrument/:instrumentId`	Search result instrument
`/self/portfolio/:portfolioId/composition/search/instrument/:instrumentId/yourposition`	Your position from search
`/self/portfolio/:portfolioId/composition/search/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from search
`/self/portfolio/:portfolioId/composition/search/instrument/:instrumentId/yourposition/dividend`	Dividend from search
`/self/portfolio/:portfolioId/composition/search/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from search

Orders¶

Deeplink	Description
`/self/portfolio/:portfolioId/composition/orders/overview`	Orders overview
`/self/portfolio/:portfolioId/composition/orders/overview/tradeticket/:tradeTicketId`	Trade ticket from orders overview
`/self/portfolio/:portfolioId/composition/orders/history`	Orders history
`/self/portfolio/:portfolioId/composition/orders/history/tradeticket/:tradeTicketId`	Trade ticket from orders history

Cash¶

Deeplink	Description
`/self/portfolio/:portfolioId/composition/cash/overview`	Cash overview
`/self/portfolio/:portfolioId/composition/cash/history`	Cash history
`/self/portfolio/:portfolioId/composition/cash/history/tradeticket/:tradeTicketId`	Trade ticket from cash history

Watchlists¶

Deeplink	Description
`/self/portfolio/:portfolioId/watchlists/:watchlistId`	Watchlist view
`/self/portfolio/:portfolioId/watchlists/:watchlistId/instrument/:instrumentId`	Instrument in watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/instrument/:instrumentId/yourposition`	Your position from watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/instrument/:instrumentId/yourposition/dividend`	Dividend from watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search`	Search in watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search/instrument/:instrumentId`	Search result in watchlist
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search/instrument/:instrumentId/yourposition`	Your position from watchlist search
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from watchlist search
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search/instrument/:instrumentId/yourposition/dividend`	Dividend from watchlist search
`/self/portfolio/:portfolioId/watchlists/:watchlistId/search/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from watchlist search

Inspiration¶

Deeplink	Description
`/self/portfolio/:portfolioId/inspiration`	Inspiration hub
`/self/portfolio/:portfolioId/inspiration/list/:listId`	Inspiration list
`/self/portfolio/:portfolioId/inspiration/list/:listId/instrument/:instrumentId`	Instrument in list
`/self/portfolio/:portfolioId/inspiration/list/:listId/instrument/:instrumentId/yourposition`	Your position from list
`/self/portfolio/:portfolioId/inspiration/list/:listId/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from list
`/self/portfolio/:portfolioId/inspiration/list/:listId/instrument/:instrumentId/yourposition/dividend`	Dividend from list
`/self/portfolio/:portfolioId/inspiration/list/:listId/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from list
`/self/portfolio/:portfolioId/inspiration/instrument/:instrumentId`	Instrument from inspiration
`/self/portfolio/:portfolioId/inspiration/instrument/:instrumentId/yourposition`	Your position from inspiration
`/self/portfolio/:portfolioId/inspiration/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from inspiration
`/self/portfolio/:portfolioId/inspiration/instrument/:instrumentId/yourposition/dividend`	Dividend from inspiration
`/self/portfolio/:portfolioId/inspiration/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from inspiration
`/self/portfolio/:portfolioId/inspiration/search`	Search in inspiration
`/self/portfolio/:portfolioId/inspiration/search/instrument/:instrumentId`	Search result in inspiration
`/self/portfolio/:portfolioId/inspiration/search/instrument/:instrumentId/yourposition`	Your position from inspiration search
`/self/portfolio/:portfolioId/inspiration/search/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from inspiration search
`/self/portfolio/:portfolioId/inspiration/search/instrument/:instrumentId/yourposition/dividend`	Dividend from inspiration search
`/self/portfolio/:portfolioId/inspiration/search/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from inspiration search

Deeplink	Description
`/self/portfolio/:portfolioId/more`	Portfolio more menu
`/self/portfolio/:portfolioId/more/instrument/:instrumentId`	Instrument from more menu
`/self/portfolio/:portfolioId/more/instrument/:instrumentId/yourposition`	Your position from more menu
`/self/portfolio/:portfolioId/more/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from more menu
`/self/portfolio/:portfolioId/more/instrument/:instrumentId/yourposition/dividend`	Dividend from more menu
`/self/portfolio/:portfolioId/more/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from more menu
`/self/portfolio/:portfolioId/more/orders/overview`	Orders overview from more menu
`/self/portfolio/:portfolioId/more/orders/overview/tradeticket/:tradeTicketId`	Trade ticket from more orders overview
`/self/portfolio/:portfolioId/more/orders/history`	Orders history from more menu
`/self/portfolio/:portfolioId/more/orders/history/tradeticket/:tradeTicketId`	Trade ticket from more orders history
`/self/portfolio/:portfolioId/more/cash/overview`	Cash overview from more menu
`/self/portfolio/:portfolioId/more/cash/history`	Cash history from more menu
`/self/portfolio/:portfolioId/more/cash/history/tradeticket/:tradeTicketId`	Trade ticket from more cash history
`/self/portfolio/:portfolioId/more/search`	Search from more menu
`/self/portfolio/:portfolioId/more/search/instrument/:instrumentId`	Search result from more menu
`/self/portfolio/:portfolioId/more/search/instrument/:instrumentId/yourposition`	Your position from more search
`/self/portfolio/:portfolioId/more/search/instrument/:instrumentId/yourposition/tradeticket/:tradeTicketId`	Trade ticket from more search
`/self/portfolio/:portfolioId/more/search/instrument/:instrumentId/yourposition/dividend`	Dividend from more search
`/self/portfolio/:portfolioId/more/search/instrument/:instrumentId/yourposition/dividend/tradeticket/:tradeTicketId`	Dividend trade ticket from more search
`/self/portfolio/:portfolioId/more/documents`	Documents from more menu
`/self/portfolio/:portfolioId/more/documents/account-statements`	Account statements from more menu
`/self/portfolio/:portfolioId/more/documents/:fromDate/:toDate`	Documents for date range
`/self/portfolio/:portfolioId/more/documents/:documentId`	Specific document

Examples¶

/self/portfolio/P-ABC123/more

Navigate to a specific instrument in a portfolio¶

/self/portfolio/P-ABC123/composition/instrument/ISIN-US0378331005

Navigate to Robo portfolio results¶

/robo/portfolio/P-XYZ789/results/return

Navigate to a watchlist¶

/self/portfolio/P-ABC123/watchlists/WL-001

Navigate to account statements for a date range¶

/robo/portfolio/P-ABC123/menu/documents/account-statements/2024-01-01/2024-12-31

Navigator Actions / Deeplinks

Deeplinks / Navigation¶

Usage¶

Using the `navigateTo` Handover¶

Path Parameters¶

Available Deeplinks¶

General / App-Level¶

Robo Investor¶

Discovery¶

Portfolio Results¶

Portfolio Composition¶

Portfolio History¶

Portfolio Menu¶

Self Investor¶

Portfolio Composition¶

Orders¶

Cash¶

Watchlists¶

Inspiration¶

More Menu¶

Examples¶

Navigate to a Self Investor portfolio's more menu¶

Navigate to a specific instrument in a portfolio¶

Navigate to Robo portfolio results¶

Navigate to a watchlist¶

Navigate to account statements for a date range¶

See Also¶

Navigator Actions / Deeplinks

Deeplinks / Navigation¶

Usage¶

Using the navigateTo Handover¶

Path Parameters¶

Available Deeplinks¶

General / App-Level¶

Robo Investor¶

Discovery¶

Portfolio Results¶

Portfolio Composition¶

Portfolio History¶

Portfolio Menu¶

Self Investor¶

Portfolio Composition¶

Orders¶

Cash¶

Watchlists¶

Inspiration¶

More Menu¶

Examples¶

Navigate to a Self Investor portfolio's more menu¶

Navigate to a specific instrument in a portfolio¶

Navigate to Robo portfolio results¶

Navigate to a watchlist¶

Navigate to account statements for a date range¶

See Also¶

Using the `navigateTo` Handover¶