1. Account
Navexa API
  • Start your Navexa journey
  • Authentication
  • Navexa MCP
  • Rate limits
  • Reports
    • Get ATO myTax report
      GET
    • Get ATO myTax report PDF
      GET
    • Get Capital Gains Tax report
      GET
    • List capital losses
      GET
    • Get tax overview for a period
      GET
    • List tax years
      GET
    • Get tax year status
      GET
    • Get Taxable Income report
      GET
    • Get tax readiness
      GET
    • Get Unrealised Capital Gains Tax report
      GET
  • Benchmark
    • Get the benchmark return for a portfolio
      GET
  • CashAccount
    • Get Cash Account
      GET
    • Delete a Cash Account
      DELETE
    • Get all Cash Accounts
      GET
    • Create a Cash Account
      POST
    • Update a Cash Account
      PUT
    • Get Cash Account Transactions
      GET
  • CashAccountTransactions
    • Get a Cash Account Transaction
      GET
    • Delete a Cash Account Transaction
      DELETE
    • Create a Cash Account Transaction
      POST
    • Update a Cash Account Transaction
      PUT
  • Clients
    • Get all Clients
    • Create a client
    • Gets Client
    • Update a client
    • Delete client
    • Get client Portfolios
    • Assign portfolios to client
  • Holdings
    • Get a holding
    • Update a holding
    • Delete a holding
    • Get a holding's trades
    • Get holding income records
    • Update a holding's symbol and exchange
  • PortfolioPerformance
    • Get portfolio performance
  • Portfolios
    • Get return contribution by holding
    • Get portfolio diversification
    • Get portfolio income calendar
    • Get portfolio return broken down by group
    • Get all portfolios
    • Create a portfolio
    • Get all portfolios, grouped
    • Get a portfolio
    • Update a portfolio
    • Delete a portfolio
    • Get all portfolio holdings
  • ProRataDistributions
    • Update ETF Distributions ProRata
  • StocksIncome
    • Add income to a holding
    • Get an income record
    • Update Income record
    • Delete an income record
    • Confirm Income record
  • TaxSettings
    • Get all portfolio tax settings
    • Get portfolio tax setting
    • Update portfolio tax settings
  • Trades
    • Get a trade
    • Update a trade
    • Delete a trade
    • Add a trade
    • Upload a trade attachment
    • Download a trade attachment
  • CustomInvestmentPrice
    • List Prices
    • Add a Price
    • Update a Price
    • Get a Price
    • Delete a Price
    • Bulk Add Prices
  • SimulateSell
    • Get the assessable capital gain for a simulated sell trade
  • Sources
    • Get all sources
  • HoldingTimeseries
    • Get holding timeseries
  • PortfolioTimeseries
    • Get portfolio timeseries
  • PortfolioTransactions
    • Get portfolio transactions
  • Securities
    • Search securities
  • CustomGroups
    • List custom groups
    • Create a custom group
    • Get a custom group
    • Update a custom group
    • Delete a custom group
    • List custom group assignments
    • Set custom group assignments
  • Account
    • Get account
      GET
    • List plan features
      GET
    • Get portfolio limits
      GET
    • List granted scopes
      GET
  • Imports
    • Upload broker files to import
    • Get an import's status
    • List an import's staged trades
    • Fix staged trades
    • Commit an import's staged trades
  • TradeParcels
    • Get the parcels for a sale
    • Select a parcel for a sale
    • Change a parcel selection
    • Remove a parcel selection
  • TransactionsBulk
    • Confirm, unconfirm or delete many transactions
    • Attach one file to many transactions
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • AccountLinkSettings
      • AccountSettings
      • AccountLinkViewModel
      • AddClientVM
      • AddTradeModel
      • AddPriceModel
      • AddClientModel
      • ApplicationUser
      • AuthorizeTokenRequest
      • BenchmarkSettings
      • CalculationSettings
      • AdjustmentData
      • CategoryPerformancePreferenceOptions
      • ChartPreferenceOptions
      • AssignPortfolioToClientVM
      • ChecklistItem
      • Client
      • AutomationSettings
      • ClientExpanded
      • CGTDistributionsModel
      • BillingSettings
      • ClientModel
      • CGTError
      • ClientPortfolio
      • CGTEventModel
      • ClientVM
      • CGTReportModel
      • ColumnSettings
      • ComponentColumn
      • CapitalGainLoss
      • ComponentSettings
      • CapitalGainsBreakdown
      • CreateCashAccountVM
      • CapitalGainsTaxSummary
      • CreateCashTransactionVM
      • CapitalGainsTaxSummaryModel
      • CreateComponentDTO
      • CashInterest
      • CreatePortfolioSettingsModel
      • CryptoIncome
      • CryptoTrade2
      • CustomGroupCategory
      • DiversificationPreferenceOptions
      • Dividend
      • ClientPortfolioVM
      • DividendDTO
      • DividendError
      • EmailSettings
      • EmbeddedComponent
      • FilterCriteria
      • CompanyListResponseDTO
      • GroupAccount
      • CompanyManagementDTO
      • GroupAccountResponse
      • GetPriceModel
      • GroupUserAdd
      • GroupUserLookup
      • CreateProPortfolioVM
      • GroupUserResponse
      • GroupUserUpdate
      • CryptoIncomeDTO
      • Holding
      • CryptoIncomeSummary
      • HoldingClassification
      • HoldingModel
      • HoldingNote
      • DateRange
      • HoldingPerformancePreferenceOptions
      • DeductionsSummary
      • HoldingPublisherData
      • HoldingSettingsModel
      • CryptocurrencyListResponseDTO
      • HoldingTaxSettings
      • CryptocurrencyManagementDTO
      • HoldingType
      • DividendData
      • IHoldingSettings
      • CustomerProfileDto
      • IncomeContributionsSettings
      • CustomerSearchResultDto
      • IncomeReturnPreferenceOptions
      • IntegrationMethodAccuracy
      • IntegrationMethodSupportLevel
      • ForeignTaxableIncomeSummary
      • IntegrationType
      • IntercomSettings
      • IosIapPurchase
      • IosIapSubscriptionInfo
      • ManageClientModel
      • Metadata
      • OnboardingChecklist
      • OnboardingSurvey
      • OverviewPreferences
      • OwnerPlan
      • GicIndustry
      • PaymentPlatform
      • GicIndustryGroup
      • Portfolio
      • GicSector
      • PortfolioDiviersifcationSettings
      • GicSubIndustry
      • PortfolioPreferences
      • HoldingReturnViewModel
      • PortfolioRequest
      • PortfolioSettings
      • PortfolioHoldingModel
      • HoldingSummaryPerformanceViewModel
      • PortfolioTaxSetting
      • PortfolioModel
      • PortfolioType
      • HoldingTaxSettingsVM
      • HoldingSymbolUpdateModel
      • ProRataTotals
      • HoldingTaxSettingsDTO
      • ProRegisterModel
      • HoldingTypeEnum
      • Provider
      • ProviderIntegrationMethod
      • SaleAllocationStrategies
      • IncomeIntegrationMapping
      • SharingSettings
      • IncomeIntegrationMappingDto
      • SubscriptionPlan
      • IncomeRecord
      • ImpersonationRequestDto
      • TestimonialInformation
      • ImpersonationResponseDto
      • TimeSpan
      • TrackingInformation
      • Trade
      • TradeMetadata
      • TradeType
      • InterestIncomeSummary
      • TradeTypeEnum
      • UpdateCashAccountVM
      • UpdateCashTransactionVM
      • UpsertIncomeRecord
      • IntercomAdmin
      • UpsertPortfolioModel
      • UpdatePriceModel
      • MyTaxIncomeSummary
      • IntercomAvatar
      • UserPortfolio
      • MyTaxReportModel
      • IntercomCanvasContext
      • UserPreferences
      • IntercomCanvasInitializeDto
      • UserSharedWith
      • IntercomCanvasSubmitDto
      • IntercomContact
      • IntercomCustomer
      • IntercomRevokeAccessDto
      • PortfolioPerformanceViewModel
      • PortfolioTaxSettingDTO
      • PortfolioTaxSettingsVM
      • SharePortfoliosVM
      • NotificationSettings
      • TaxableIncomeReportModel
      • TaxableIncomeSummary
      • TotalReturnViewModel
      • TradeIntegrationMapping
      • StartImpersonationDto
      • StopImpersonationDto
      • TrialEligibilityDto
      • TrialResetRequestDto
      • TrialResetResponseDto
      • UpdateAccountSettingsDto
      • UpdateUserProfileDto
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicAllocationBucket
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CashTransactionViewModel
    • Navexa.API.Controllers.PublicAPI.Account.Models.AccountAllowances
    • Navexa.API.Controllers.BFF_API.TaxSettings.Models.AllocationPanelDto
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CreateCashAccountVM
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicAllocationModel
    • Navexa.API.Controllers.PublicAPI.Account.Models.AccountFeature
    • Navexa.API.Controllers.BFF_API.TaxSettings.Models.SellParcelDto
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CreateCashTransactionVM
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicCalculateRebalanceRequest
    • Navexa.API.Controllers.PublicAPI.Account.Models.AccountModel
    • Navexa.API.Controllers.BulkFileUploadResponseDto
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicCalculateRebalanceResponse
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.GetCashAccountVM
    • Navexa.API.Controllers.PublicAPI.Account.Models.AccountPortfolioLimits
    • Navexa.API.Controllers.BulkFileUploadResultDto
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.UpdateCashAccountVM
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicDriftEntry
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.UpdateCashTransactionVM
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicDriftReport
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.AddClientVM
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicRebalanceLeg
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.ClientPortfolioVM
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.ClientVM
    • Navexa.API.Controllers.PublicAPI.Account.Models.AccountScopesModel
    • Navexa.API.Controllers.PublicAPI.CustomGroups.Models.CustomGroupAssignmentModel
    • Navexa.API.Controllers.PublicAPI.CustomGroups.Models.CustomGroupModel
    • Navexa.API.Controllers.PublicAPI.CustomGroups.Models.GroupCategoryModel
    • Navexa.API.Controllers.PublicAPI.CustomGroups.Models.HoldingGroupAssignmentModel
    • Navexa.API.Controllers.PublicAPI.CustomGroups.Models.UpsertCustomGroupModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.AddPriceModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.BulkAddPricesModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.BulkPriceEntry
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.GetPriceModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.UpdatePriceModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingIncomeModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingSettingsModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingSymbolUpdateModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingTimeseriesRequest
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingTradeModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.CreatePortfolioSettingsModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.DeletePortfolioResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.HoldingReturnViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.HoldingSummaryPerformanceViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioHoldingModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioPerformanceViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTimeseriesRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTransactionsRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioAutomationSettingsModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTransactionsResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioBenchmarkSettingsModel
    • Navexa.API.Controllers.PublicAPI.Imports.Models.ImportRefusal
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.SimulateSellRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioCalculationSettingsModel
    • Navexa.API.Controllers.PublicAPI.Imports.Models.ImportRefusalItem
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.SimulateSellResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioContributionRequest
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicImportFile
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.UpsertPortfolioModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionCryptoIncomeModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioDiversificationRequest
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicImportStatus
    • Navexa.API.Controllers.PublicAPI.ProRataDistributions.Models.ProRataTotals
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionDividendModel
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicSkippedRow
    • Navexa.API.Controllers.PublicAPI.Securities.Models.SecuritySearchResultModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionHoldingModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioIncomeCalendarRequest
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicStagedTrade
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionLegModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioListResponse
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicStagedTradeEdit
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionLinkModel
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicStagedTradeError
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesRange
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionModel
    • Navexa.API.Controllers.PublicAPI.Imports.Models.PublicStagedTradePage
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.Transactions.TransactionSourceModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioSettingsModel
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesSummary
    • Navexa.API.Controllers.PublicAPI.Sources.Models.SourceModel
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.CreateHoldingIncomeModel
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesMeta
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.CryptoIncomeRecord
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.IncomeRecord
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesPoint
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.UpsertCryptoIncomeModel
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.UpsertIncomeRecord
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTDistributionsModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTReportModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.TaxableIncomeReportModel
    • Navexa.API.Controllers.PublicAPI.TaxSettings.Models.HoldingTaxSettingsDTO
    • Navexa.API.Controllers.PublicAPI.TaxSettings.Models.PortfolioTaxSettingDTO
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTEventModel
    • Navexa.API.Controllers.PublicAPI.Trades.Models.TradeModel
    • Navexa.API.Controllers.Reports.TaxReports.CapitalGainsTaxReport.Models.HoldingTaxSettingsVM
    • Navexa.API.Controllers.Reports.TaxReports.CapitalGainsTaxReport.Models.PortfolioTaxSettingsVM
    • Navexa.API.DTOs.CryptoIncomeDTO
    • Navexa.API.ViewModels.AccountLinkViewModel
    • Navexa.API.Controllers.PublicAPI.Trades.Models.AddTradeModel
    • Navexa.API.ViewModels.BenchmarkReturnViewModel
    • Navexa.API.ViewModels.TotalReturnViewModel
    • Navexa.Core.DomainModels.CGTError
    • Navexa.API.Controllers.PublicAPI.Trades.Models.UpdateTradeModel
    • Navexa.Core.DomainModels.CapitalGainLoss
    • Navexa.Core.DomainModels.CapitalGainsBreakdown
    • Navexa.Core.DomainModels.CryptoIncomeSummary
    • Navexa.Core.DomainModels.DateRange
    • Navexa.Core.DomainModels.DeductionsSummary
    • Navexa.Core.DomainModels.ForeignTaxableIncomeSummary
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.PortfolioCapitalLossApplicationModel
    • Navexa.Core.DomainModels.InterestIncomeSummary
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.PortfolioCapitalLossModel
    • Navexa.Core.DomainModels.MyTaxIncomeSummary
    • Navexa.Core.DomainModels.MyTaxReportModel
    • Navexa.Core.DomainModels.TaxableIncomeSummary
    • Navexa.Core.DomainModels.TotalReturn
    • Navexa.Core.Enums.AMITDataSource
    • Navexa.Core.Enums.HoldingTypeEnum
    • Navexa.Core.Enums.TaxYearLockDriftStatus
    • Navexa.Core.Enums.TaxYearLockMode
    • Navexa.Core.Models.HoldingClassification
    • Navexa.Core.Services.PortfolioFilter.Models.FilterCriteria
    • Navexa.API.Filters.PlanFeatureRoute
    • Navexa.Core.Services.PortfolioFilter.Models.TransactionFilterItem
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CapitalGainsTaxSummaryModel
    • Navexa.Core.Services.TaxServices.TaxReports.TaxableIncome.Models.CashInterest
    • Navexa.Core.DomainModels.AMITReadinessDetail
    • Navexa.Core.Services.AllTransactionsReport.Models.TransactionFilterItem
    • Navexa.Core.Services.AllTransactionsReport.Models.TransactionFiltersRequest
    • Navexa.Core.DomainModels.CapitalGainsSummary
    • Navexa.API.Controllers.PublicAPI.Trades.Models.ParcelSelectionModel
    • Navexa.Core.Services.PortfolioFilter.Models.FilterNode
    • Navexa.Core.DomainModels.Charting.ChartingDataPoint
    • Navexa.Core.DomainModels.Charting.ContributionChartData
    • Navexa.Core.DomainModels.Charting.ContributionDataPoint
    • Navexa.API.Controllers.PublicAPI.Transactions.Models.BulkTransactionModel
    • Navexa.Core.DomainModels.Charting.DiversificationChartData
    • Navexa.API.Controllers.PublicAPI.Transactions.Models.BulkTransactionsModel
    • Navexa.Core.DomainModels.Charting.GroupedHoldingReturn
    • Navexa.Core.DomainModels.Charting.WeightedHolding
    • Navexa.Core.DomainModels.CurrentYearReadiness
    • Navexa.Core.DomainModels.FinancialYearStatus
    • Navexa.Core.DomainModels.FinancialYearSummary
    • Navexa.Core.DomainModels.AvailableParcel
    • Navexa.Core.DomainModels.HistoryReadiness
    • Navexa.Core.DomainModels.HoldingReturn
    • Navexa.Core.DomainModels.IncomeSummary
    • Navexa.Core.DomainModels.CapitalGainsTaxSummary
    • Navexa.Core.DomainModels.InvalidHoldingItem
    • Navexa.Core.DomainModels.Quote
    • Navexa.Core.DomainModels.ReadinessDetail
    • Navexa.Core.DomainModels.ReadinessStatus
    • Navexa.Core.DomainModels.TaxOverviewAllYearsResult
    • Navexa.Core.DomainModels.TaxOverviewResult
    • Navexa.Core.DomainModels.TaxOverviewStatusResult
    • Navexa.Core.DomainModels.TaxReadiness
    • Navexa.Core.DomainModels.TaxReadinessV2Result
    • Navexa.Core.DomainModels.TaxSettings
    • Navexa.Core.DomainModels.TotalPortfolioReturn
    • Navexa.Core.DomainModels.UnfinalisedAMITHolding
    • Navexa.Core.DomainModels.YearToConfirm
    • Navexa.Core.Services.Reports.IncomeCalendarService.Models.IncomeCalendarRecord
    • Navexa.Core.Services.Reports.IncomeCalendarService.Models.IncomeCalendarReport
    • Navexa.Core.Enums.ImportMode
    • Navexa.Core.Services.BulkTransactions.BulkRecalculation
    • Navexa.Core.Services.BulkTransactions.BulkTransactionItemResult
    • Navexa.Core.Services.BulkTransactions.BulkTransactionResult
    • Navexa.Core.Services.BulkTransactions.BulkTransactionSummary
    • Newtonsoft.Json.Linq.JToken
  1. Account

List granted scopes

GET
/v1/account/scopes
The scopes this connection holds. For an API key that is the key's own scopes, or every scope when the key has none set. For an OAuth caller it is what the user granted, narrowed to the application's ceiling. This route needs no scope of its own, so a caller can always read its own grant.
Access
Available on: every plan, including free trials

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v1/account/scopes' \
--header 'Authorization: <api-key>'

Responses

🟢200OK
application/json
Success
Bodyapplication/json

Example
{
    "scopes": [
        "string"
    ]
}
🟠401Unauthorized
🟠403Forbidden
🟠429
Modified at 2026-09-29 03:34:01
Previous
Get portfolio limits
Next
Upload broker files to import
Built with